5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
25 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali/public-api/math/vector2.h>
27 #include <dali/public-api/math/vector4.h>
28 #include <dali/public-api/object/handle.h>
39 namespace Internal DALI_INTERNAL
56 * Scene creates a "world" that can be bound to a surface for rendering.
59 class DALI_CORE_API Scene : public BaseHandle
62 using EventProcessingFinishedSignalType = Signal<void()>; ///< Event Processing finished signal type
63 using KeyEventSignalType = Signal<void(const Dali::KeyEvent&)>; ///< Key event signal type
64 using KeyEventGeneratedSignalType = Signal<bool(const Dali::KeyEvent&)>; ///< key event generated signal type
65 using TouchEventSignalType = Signal<void(const Dali::TouchEvent&)>; ///< Touch signal type
66 using WheelEventSignalType = Signal<void(const Dali::WheelEvent&)>; ///< WheelEvent signal type
68 using FrameCallbackContainer = std::vector<std::pair<std::unique_ptr<CallbackBase>, int32_t> >;
71 * @brief Create an initialized Scene handle.
73 * @param[in] size The size of the set surface for this scene
74 * @param[in] orientation The rotated angle of the set surface for this scene
76 * @return a handle to a newly allocated Dali resource.
78 static Scene New(Size size, int32_t orientation = 0);
81 * @brief Downcast an Object handle to Scene handle.
83 * If handle points to a Scene object the downcast produces
84 * valid handle. If not the returned handle is left uninitialized.
85 * @param[in] handle to An object
86 * @return handle to a Scene object or an uninitialized handle
88 static Scene DownCast(BaseHandle handle);
91 * @brief Create an uninitialized Scene handle.
93 * This can be initialized with Scene::New(). Calling member
94 * functions with an uninitialized Dali::Object is not allowed.
101 * This is non-virtual since derived Handle types must not contain data or virtual methods.
106 * @brief This copy constructor is required for (smart) pointer semantics.
108 * @param [in] handle A reference to the copied handle
110 Scene(const Scene& handle);
113 * @brief This assignment operator is required for (smart) pointer semantics.
115 * @param [in] rhs A reference to the copied handle
116 * @return A reference to this
118 Scene& operator=(const Scene& rhs);
121 * @brief Adds a child Actor to the Scene.
123 * The child will be referenced.
124 * @param[in] actor The child
125 * @pre The actor has been initialized.
126 * @pre The actor does not have a parent.
128 void Add(Actor actor);
131 * @brief Removes a child Actor from the Scene.
133 * The child will be unreferenced.
134 * @param[in] actor The child
135 * @pre The actor has been added to the stage.
137 void Remove(Actor actor);
140 * @brief Returns the size of the Scene in pixels as a Vector.
142 * The x component will be the width of the Scene in pixels.
143 * The y component will be the height of the Scene in pixels.
145 * @return The size of the Scene as a Vector
147 Size GetSize() const;
150 * Sets horizontal and vertical pixels per inch value that is used by the display
151 * @param[in] dpi Horizontal and vertical dpi value
153 void SetDpi(Vector2 dpi);
156 * @brief Retrieves the DPI of the display device to which the scene is connected.
158 * @return The horizontal and vertical DPI
160 Vector2 GetDpi() const;
163 * @brief Sets the background color.
165 * @param[in] color The new background color
167 void SetBackgroundColor(const Vector4& color);
170 * @brief Gets the background color of the render surface.
172 * @return The background color
174 Vector4 GetBackgroundColor() const;
177 * @brief Retrieves the list of render-tasks.
179 * @return A valid handle to a RenderTaskList
181 Dali::RenderTaskList GetRenderTaskList() const;
184 * @brief Returns the Scene's Root Layer.
186 * @return The root layer
188 Layer GetRootLayer() const;
191 * @brief Queries the number of on-stage layers.
193 * Note that a default layer is always provided (count >= 1).
194 * @return The number of layers
196 uint32_t GetLayerCount() const;
199 * @brief Retrieves the layer at a specified depth.
201 * @param[in] depth The depth
202 * @return The layer found at the given depth
203 * @pre Depth is less than layer count; see GetLayerCount().
205 Layer GetLayer(uint32_t depth) const;
208 * @brief Informs the scene that the set surface has been resized.
210 * @param[in] width The new width of the set surface
211 * @param[in] height The new height of the set surface
213 void SurfaceResized(float width, float height);
216 * @brief Informs the scene that the surface has been replaced.
218 void SurfaceReplaced();
221 * @brief Discards this Scene from the Core.
226 * @brief Sets the render target for the surface.
228 * @param[in] renderTarget The render target for the surface
230 void SetSurfaceRenderTarget(Graphics::RenderTarget* renderTarget);
233 * @brief Retrieve the Scene that the given actor belongs to.
236 static Integration::Scene Get(Actor actor);
239 * This function is called when an event is queued.
240 * @param[in] event A event to queue.
242 void QueueEvent(const Integration::Event& event);
245 * This function is called by Core when events are processed.
247 void ProcessEvents();
250 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
252 * @param[in] callback The function to call
253 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
255 * @note A callback of the following type may be used:
257 * void MyFunction( int32_t frameId );
259 * This callback will be deleted once it is called.
261 * @note Ownership of the callback is passed onto this class.
263 void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
266 * @brief Adds a callback that is called when the frame is displayed on the display.
268 * @param[in] callback The function to call
269 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
271 * @note A callback of the following type may be used:
273 * void MyFunction( int32_t frameId );
275 * This callback will be deleted once it is called.
277 * @note Ownership of the callback is passed onto this class.
279 void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
282 * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
284 * @param[out] callbacks The callback list
286 * @note This is called in the update thread.
288 void GetFrameRenderedCallback(FrameCallbackContainer& callbacks);
291 * @brief Gets the callback list that is called when the frame is displayed on the display.
293 * @param[out] callbacks The callback list
295 * @note This is called in the update thread.
297 void GetFramePresentedCallback(FrameCallbackContainer& callbacks);
300 * @brief Informs the scene that the set surface has been rotated.
302 * @param[in] width The width of rotated surface
303 * @param[in] height The height of rotated surface
304 * @param[in] orientation The orientation of rotated surface
306 void SurfaceRotated(float width, float height, int32_t orientation);
309 * @brief Gets the current surface orientation. It gets the value from the scene object.
311 * @return The current surface orientation.
313 int32_t GetCurrentSurfaceOrientation() const;
316 * @brief Gets the current surface rectangle. It gets the value from the scene object.
318 * @return The current surface rectangle
320 const Rect<int32_t>& GetCurrentSurfaceRect() const;
323 * Query wheter the surface rect is changed or not.
324 * @return true if the surface rect is changed.
326 bool IsSurfaceRectChanged() const;
329 * @brief Send message to acknowledge for completing window rotation with current window orientation.
331 * If this function is called, the message is sent to render thread, then mSurfaceRectChanged in scene-graph-scene is set with true.
332 * After that, render thread checks whether window rotation event is received, mSurfaceRectChanged and the neccessary flag are set.
333 * If they are all true, rotation done function is called to complete window rotation.
335 void SetRotationCompletedAcknowledgement();
338 * @brief Query wheter is set to acknowledge for completing surface rotation.
339 * @return true it should be acknowledged.
341 * If SetRotationCompletedAcknowledgement() is called and the related message is received to scene-graph-scene,
342 * then mSurfaceRectChanged in scene-graph-scene is set with true.
344 * When this function is called, the mSurfaceRectChanged in scene-graph-scene is return.
345 * Then, the flag will be reset.
347 * @note This function should be not called the application's main thread.
348 * Because this function should be called in windwow surface's postrender() function to complete window rotation manually.
350 bool IsRotationCompletedAcknowledgementSet() const;
353 * @brief This signal is emitted just after the event processing is finished.
355 * @return The signal to connect to
357 EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
360 * @brief This signal is emitted when key event is received.
362 * A callback of the following type may be connected:
364 * void YourCallbackName(const KeyEvent& event);
366 * @return The signal to connect to
368 KeyEventSignalType& KeyEventSignal();
371 * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
373 * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
374 * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
375 * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
377 * A callback of the following type may be connected:
379 * bool YourCallbackName(const KeyEvent& event);
382 * @return The return is true if KeyEvent is consumed, otherwise false.
384 KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
387 * @brief This signal is emitted when the screen is touched and when the touch ends
388 * (i.e. the down & up touch events only).
390 * If there are multiple touch points, then this will be emitted when the first touch occurs and
391 * then when the last finger is lifted.
392 * An interrupted event will also be emitted (if it occurs).
393 * A callback of the following type may be connected:
395 * void YourCallbackName( TouchEvent event );
398 * @return The touch signal to connect to
399 * @note Motion events are not emitted.
401 TouchEventSignalType& TouchedSignal();
404 * @brief This signal is emitted when wheel event is received.
406 * A callback of the following type may be connected:
408 * void YourCallbackName(const WheelEvent& event);
410 * @return The signal to connect to
412 WheelEventSignalType& WheelEventSignal();
414 public: // Not intended for application developers
416 * @brief This constructor is used by Dali::New() methods.
418 * @param[in] scene A pointer to an internal Scene resource
420 explicit DALI_INTERNAL Scene(Internal::Scene* scene);
423 } // namespace Integration
427 #endif // DALI_SCENE_H