5 * Copyright (c) 2020 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
51 * Scene creates a "world" that can be bound to a surface for rendering.
54 class DALI_CORE_API Scene : public BaseHandle
57 using EventProcessingFinishedSignalType = Signal<void()>; ///< Event Processing finished signal type
58 using KeyEventSignalType = Signal<void(const Dali::KeyEvent&)>; ///< Key event signal type
59 using KeyEventGeneratedSignalType = Signal<bool(const Dali::KeyEvent&)>; ///< key event generated signal type
60 using TouchEventSignalType = Signal<void(const Dali::TouchEvent&)>; ///< Touch signal type
61 using WheelEventSignalType = Signal<void(const Dali::WheelEvent&)>; ///< WheelEvent signal type
63 using FrameCallbackContainer = std::vector<std::pair<std::unique_ptr<CallbackBase>, int32_t> >;
66 * @brief Create an initialized Scene handle.
68 * @param[in] size The size of the set surface for this scene
70 * @return a handle to a newly allocated Dali resource.
72 static Scene New(Size size);
75 * @brief Downcast an Object handle to Scene handle.
77 * If handle points to a Scene object the downcast produces
78 * valid handle. If not the returned handle is left uninitialized.
79 * @param[in] handle to An object
80 * @return handle to a Scene object or an uninitialized handle
82 static Scene DownCast(BaseHandle handle);
85 * @brief Create an uninitialized Scene handle.
87 * This can be initialized with Scene::New(). Calling member
88 * functions with an uninitialized Dali::Object is not allowed.
95 * This is non-virtual since derived Handle types must not contain data or virtual methods.
100 * @brief This copy constructor is required for (smart) pointer semantics.
102 * @param [in] handle A reference to the copied handle
104 Scene(const Scene& handle);
107 * @brief This assignment operator is required for (smart) pointer semantics.
109 * @param [in] rhs A reference to the copied handle
110 * @return A reference to this
112 Scene& operator=(const Scene& rhs);
115 * @brief Adds a child Actor to the Scene.
117 * The child will be referenced.
118 * @param[in] actor The child
119 * @pre The actor has been initialized.
120 * @pre The actor does not have a parent.
122 void Add(Actor actor);
125 * @brief Removes a child Actor from the Scene.
127 * The child will be unreferenced.
128 * @param[in] actor The child
129 * @pre The actor has been added to the stage.
131 void Remove(Actor actor);
134 * @brief Returns the size of the Scene in pixels as a Vector.
136 * The x component will be the width of the Scene in pixels.
137 * The y component will be the height of the Scene in pixels.
139 * @return The size of the Scene as a Vector
141 Size GetSize() const;
144 * Sets horizontal and vertical pixels per inch value that is used by the display
145 * @param[in] dpi Horizontal and vertical dpi value
147 void SetDpi(Vector2 dpi);
150 * @brief Retrieves the DPI of the display device to which the scene is connected.
152 * @return The horizontal and vertical DPI
154 Vector2 GetDpi() const;
157 * @brief Sets the background color.
159 * @param[in] color The new background color
161 void SetBackgroundColor(const Vector4& color);
164 * @brief Gets the background color of the render surface.
166 * @return The background color
168 Vector4 GetBackgroundColor() const;
171 * @brief Retrieves the list of render-tasks.
173 * @return A valid handle to a RenderTaskList
175 Dali::RenderTaskList GetRenderTaskList() const;
178 * @brief Returns the Scene's Root Layer.
180 * @return The root layer
182 Layer GetRootLayer() const;
185 * @brief Queries the number of on-stage layers.
187 * Note that a default layer is always provided (count >= 1).
188 * @return The number of layers
190 uint32_t GetLayerCount() const;
193 * @brief Retrieves the layer at a specified depth.
195 * @param[in] depth The depth
196 * @return The layer found at the given depth
197 * @pre Depth is less than layer count; see GetLayerCount().
199 Layer GetLayer(uint32_t depth) const;
202 * @brief Informs the scene that the set surface has been resized.
204 * @param[in] width The new width of the set surface
205 * @param[in] height The new height of the set surface
207 void SurfaceResized(float width, float height);
210 * @brief Informs the scene that the surface has been replaced.
212 void SurfaceReplaced();
215 * @brief Discards this Scene from the Core.
220 * @brief Retrieve the Scene that the given actor belongs to.
223 static Integration::Scene Get(Actor actor);
226 * This function is called when an event is queued.
227 * @param[in] event A event to queue.
229 void QueueEvent(const Integration::Event& event);
232 * This function is called by Core when events are processed.
234 void ProcessEvents();
237 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
239 * @param[in] callback The function to call
240 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
242 * @note A callback of the following type may be used:
244 * void MyFunction( int frameId );
246 * This callback will be deleted once it is called.
248 * @note Ownership of the callback is passed onto this class.
250 void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
253 * @brief Adds a callback that is called when the frame is displayed on the display.
255 * @param[in] callback The function to call
256 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
258 * @note A callback of the following type may be used:
260 * void MyFunction( int frameId );
262 * This callback will be deleted once it is called.
264 * @note Ownership of the callback is passed onto this class.
266 void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
269 * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
271 * @param[out] callbacks The callback list
273 * @note This is called in the update thread.
275 void GetFrameRenderedCallback(FrameCallbackContainer& callbacks);
278 * @brief Gets the callback list that is called when the frame is displayed on the display.
280 * @param[out] callbacks The callback list
282 * @note This is called in the update thread.
284 void GetFramePresentedCallback(FrameCallbackContainer& callbacks);
287 * @brief This signal is emitted just after the event processing is finished.
289 * @return The signal to connect to
291 EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
294 * @brief This signal is emitted when key event is received.
296 * A callback of the following type may be connected:
298 * void YourCallbackName(const KeyEvent& event);
300 * @return The signal to connect to
302 KeyEventSignalType& KeyEventSignal();
305 * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
307 * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
308 * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
309 * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
311 * A callback of the following type may be connected:
313 * bool YourCallbackName(const KeyEvent& event);
316 * @return The return is true if KeyEvent is consumed, otherwise false.
318 KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
321 * @brief This signal is emitted when the screen is touched and when the touch ends
322 * (i.e. the down & up touch events only).
324 * If there are multiple touch points, then this will be emitted when the first touch occurs and
325 * then when the last finger is lifted.
326 * An interrupted event will also be emitted (if it occurs).
327 * A callback of the following type may be connected:
329 * void YourCallbackName( TouchEvent event );
332 * @return The touch signal to connect to
333 * @note Motion events are not emitted.
335 TouchEventSignalType& TouchedSignal();
338 * @brief This signal is emitted when wheel event is received.
340 * A callback of the following type may be connected:
342 * void YourCallbackName(const WheelEvent& event);
344 * @return The signal to connect to
346 WheelEventSignalType& WheelEventSignal();
348 public: // Not intended for application developers
350 * @brief This constructor is used by Dali::New() methods.
352 * @param[in] scene A pointer to an internal Scene resource
354 explicit DALI_INTERNAL Scene(Internal::Scene* scene);
357 } // namespace Integration
361 #endif // DALI_SCENE_H