5 * Copyright (c) 2023 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/graphics-api/graphics-controller.h>
26 #include <dali/graphics-api/graphics-render-target-create-info.h>
27 #include <dali/public-api/common/vector-wrapper.h>
28 #include <dali/public-api/math/vector2.h>
29 #include <dali/public-api/math/vector4.h>
30 #include <dali/public-api/object/handle.h>
41 namespace Internal DALI_INTERNAL
58 * Scene creates a "world" that can be bound to a surface for rendering.
61 class DALI_CORE_API Scene : public BaseHandle
64 using EventProcessingFinishedSignalType = Signal<void()>; ///< Event Processing finished signal type
65 using KeyEventSignalType = Signal<void(const Dali::KeyEvent&)>; ///< Key event signal type
66 using KeyEventGeneratedSignalType = Signal<bool(const Dali::KeyEvent&)>; ///< key event generated signal type
67 using TouchEventSignalType = Signal<void(const Dali::TouchEvent&)>; ///< Touch signal type
68 using WheelEventSignalType = Signal<void(const Dali::WheelEvent&)>; ///< WheelEvent signal type
69 using WheelEventGeneratedSignalType = Signal<bool(const Dali::WheelEvent&)>; ///< WheelEvent generated signal type
71 using FrameCallbackContainer = std::vector<std::pair<std::unique_ptr<CallbackBase>, int32_t> >;
74 * @brief Create an initialized Scene handle.
76 * @param[in] size The size of the set surface for this scene
77 * @param[in] windowOrientation The rotated angle of the set surface for this scene
78 * @param[in] screenOrientation The rotated angle of the screen
80 * @return a handle to a newly allocated Dali resource.
82 static Scene New(Size size, int32_t windowOrientation = 0, int32_t screenOrientation = 0);
85 * @brief Downcast an Object handle to Scene handle.
87 * If handle points to a Scene object the downcast produces
88 * valid handle. If not the returned handle is left uninitialized.
89 * @param[in] handle to An object
90 * @return handle to a Scene object or an uninitialized handle
92 static Scene DownCast(BaseHandle handle);
95 * @brief Create an uninitialized Scene handle.
97 * This can be initialized with Scene::New(). Calling member
98 * functions with an uninitialized Dali::Object is not allowed.
105 * This is non-virtual since derived Handle types must not contain data or virtual methods.
110 * @brief This copy constructor is required for (smart) pointer semantics.
112 * @param [in] handle A reference to the copied handle
114 Scene(const Scene& handle);
117 * @brief This assignment operator is required for (smart) pointer semantics.
119 * @param [in] rhs A reference to the copied handle
120 * @return A reference to this
122 Scene& operator=(const Scene& rhs);
125 * @brief This move constructor is required for (smart) pointer semantics.
127 * @param [in] handle A reference to the moved handle
129 Scene(Scene&& handle);
132 * @brief This move assignment operator is required for (smart) pointer semantics.
134 * @param [in] rhs A reference to the moved handle
135 * @return A reference to this
137 Scene& operator=(Scene&& rhs);
140 * @brief Adds a child Actor to the Scene.
142 * The child will be referenced.
143 * @param[in] actor The child
144 * @pre The actor has been initialized.
145 * @pre The actor does not have a parent.
147 void Add(Actor actor);
150 * @brief Removes a child Actor from the Scene.
152 * The child will be unreferenced.
153 * @param[in] actor The child
154 * @pre The actor has been added to the stage.
156 void Remove(Actor actor);
159 * @brief Returns the size of the Scene in pixels as a Vector.
161 * The x component will be the width of the Scene in pixels.
162 * The y component will be the height of the Scene in pixels.
164 * @return The size of the Scene as a Vector
166 Size GetSize() const;
169 * Sets horizontal and vertical pixels per inch value that is used by the display
170 * @param[in] dpi Horizontal and vertical dpi value
172 void SetDpi(Vector2 dpi);
175 * @brief Retrieves the DPI of the display device to which the scene is connected.
177 * @return The horizontal and vertical DPI
179 Vector2 GetDpi() const;
182 * @brief Sets the background color.
184 * @param[in] color The new background color
186 void SetBackgroundColor(const Vector4& color);
189 * @brief Gets the background color of the render surface.
191 * @return The background color
193 Vector4 GetBackgroundColor() const;
196 * @brief Retrieves the list of render-tasks.
198 * @return A valid handle to a RenderTaskList
200 Dali::RenderTaskList GetRenderTaskList() const;
203 * @brief Returns the Scene's Root Layer.
205 * @return The root layer
207 Layer GetRootLayer() const;
210 * @brief Returns the Scene's Overlay Layer.
211 * If there is no overlay layer yet, this creates the layer and an associated render task.
213 * @return The overlay layer
215 Layer GetOverlayLayer();
218 * @brief Queries the number of on-stage layers.
220 * Note that a default layer is always provided (count >= 1).
221 * @return The number of layers
223 uint32_t GetLayerCount() const;
226 * @brief Retrieves the layer at a specified depth.
228 * @param[in] depth The depth
229 * @return The layer found at the given depth
230 * @pre Depth is less than layer count; see GetLayerCount().
232 Layer GetLayer(uint32_t depth) const;
235 * @brief Informs the scene that the set surface has been resized.
237 * @param[in] width The new width of the set surface
238 * @param[in] height The new height of the set surface
240 void SurfaceResized(float width, float height);
243 * @brief Informs the scene that the surface has been replaced.
245 void SurfaceReplaced();
248 * @brief Removes the scene graph object.
250 void RemoveSceneObject();
253 * @brief Discards this Scene from the Core.
258 * @brief Sets the render target for the surface.
260 * @param[in] renderTarget The render target create info for the surface
262 void SetSurfaceRenderTarget(const Graphics::RenderTargetCreateInfo& createInfo);
265 * @brief Retrieve the Scene that the given actor belongs to.
268 static Integration::Scene Get(Actor actor);
271 * This function is called when an event is queued.
272 * @param[in] event A event to queue.
274 void QueueEvent(const Integration::Event& event);
277 * This function is called by Core when events are processed.
279 void ProcessEvents();
282 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
284 * @param[in] callback The function to call
285 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
287 * @note A callback of the following type may be used:
289 * void MyFunction( int32_t frameId );
291 * This callback will be deleted once it is called.
293 * @note Ownership of the callback is passed onto this class.
295 void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
298 * @brief Adds a callback that is called when the frame is displayed on the display.
300 * @param[in] callback The function to call
301 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
303 * @note A callback of the following type may be used:
305 * void MyFunction( int32_t frameId );
307 * This callback will be deleted once it is called.
309 * @note Ownership of the callback is passed onto this class.
311 void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
314 * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
316 * @param[out] callbacks The callback list
318 * @note This is called in the update thread.
320 void GetFrameRenderedCallback(FrameCallbackContainer& callbacks);
323 * @brief Gets the callback list that is called when the frame is displayed on the display.
325 * @param[out] callbacks The callback list
327 * @note This is called in the update thread.
329 void GetFramePresentedCallback(FrameCallbackContainer& callbacks);
332 * @brief Informs the scene that the set surface has been rotated.
334 * @param[in] width The width of rotated surface
335 * @param[in] height The height of rotated surface
336 * @param[in] windowOrientation the current window orientation
337 * @param[in] screenOrientation the current screen orientation
339 void SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
342 * @brief Gets the current surface orientation. It gets the value from the scene object.
344 * @return The current surface orientation.
346 int32_t GetCurrentSurfaceOrientation() const;
349 * @brief Gets the current screen orientation. It gets the value from the scene object.
351 * @return The current screen orientation.
353 int32_t GetCurrentScreenOrientation() const;
356 * @brief Gets the current surface rectangle. It gets the value from the scene object.
358 * @return The current surface rectangle
360 const Rect<int32_t>& GetCurrentSurfaceRect() const;
363 * Query wheter the surface rect is changed or not.
364 * @return true if the surface rect is changed.
366 bool IsSurfaceRectChanged() const;
369 * @brief Send message to acknowledge for completing window rotation with current window orientation.
371 * If this function is called, the message is sent to render thread, then mSurfaceRectChanged in scene-graph-scene is set with true.
372 * After that, render thread checks whether window rotation event is received, mSurfaceRectChanged and the neccessary flag are set.
373 * If they are all true, rotation done function is called to complete window rotation.
375 void SetRotationCompletedAcknowledgement();
378 * @brief Query wheter is set to acknowledge for completing surface rotation.
379 * @return true it should be acknowledged.
381 * If SetRotationCompletedAcknowledgement() is called and the related message is received to scene-graph-scene,
382 * then mSurfaceRectChanged in scene-graph-scene is set with true.
384 * When this function is called, the mSurfaceRectChanged in scene-graph-scene is return.
385 * Then, the flag will be reset.
387 * @note This function should be not called the application's main thread.
388 * Because this function should be called in windwow surface's postrender() function to complete window rotation manually.
390 bool IsRotationCompletedAcknowledgementSet() const;
393 * @brief This signal is emitted just after the event processing is finished.
395 * @return The signal to connect to
397 EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
400 * @brief This signal is emitted when key event is received.
402 * A callback of the following type may be connected:
404 * void YourCallbackName(const KeyEvent& event);
406 * @return The signal to connect to
408 KeyEventSignalType& KeyEventSignal();
411 * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
413 * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
414 * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
415 * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
417 * A callback of the following type may be connected:
419 * bool YourCallbackName(const KeyEvent& event);
422 * @return The return is true if KeyEvent is consumed, otherwise false.
424 KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
427 * @brief The user would connect to this signal to intercept a KeyEvent at window.
429 * Intercepts KeyEvents in the window before dispatching KeyEvents to the control.
430 * If a KeyEvent is consumed, no KeyEvent is delivered to the control.
432 * A callback of the following type may be connected:
434 * bool YourCallbackName(const KeyEvent& event);
437 * @return The return is true if KeyEvent is consumed, otherwise false.
439 KeyEventGeneratedSignalType& InterceptKeyEventSignal();
442 * @brief This signal is emitted when the screen is touched and when the touch ends
443 * (i.e. the down & up touch events only).
445 * If there are multiple touch points, then this will be emitted when the first touch occurs and
446 * then when the last finger is lifted.
447 * An interrupted event will also be emitted (if it occurs).
448 * A callback of the following type may be connected:
450 * void YourCallbackName( TouchEvent event );
453 * @return The touch signal to connect to
454 * @note Motion events are not emitted.
456 TouchEventSignalType& TouchedSignal();
459 * @brief This signal is emitted when wheel event is received.
461 * A callback of the following type may be connected:
463 * void YourCallbackName(const WheelEvent& event);
465 * @return The signal to connect to
467 WheelEventSignalType& WheelEventSignal();
470 * @brief When a custom wheel event occurs, it need to process the focused actor first.
472 * Therefore, KeyboardFocusManager first checks whether WheelEvent is generated as WheelEventGeneratedSignal.
473 * After that wheelEventProcessor must invoke WheelEvent only if wheelEventGeneratedSignal () is not consumed.
475 * This is only valid for custom wheel events.
477 * A callback of the following type may be connected:
479 * bool YourCallbackName(const WheelEvent& event);
482 * @return The return is true if WheelEvent is consumed, otherwise false.
484 WheelEventGeneratedSignalType& WheelEventGeneratedSignal();
486 public: // Not intended for application developers
488 * @brief This constructor is used by Dali::New() methods.
490 * @param[in] scene A pointer to an internal Scene resource
492 explicit DALI_INTERNAL Scene(Internal::Scene* scene);
495 } // namespace Integration
499 #endif // DALI_SCENE_H