5 * Copyright (c) 2019 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.
22 #include <dali/public-api/object/handle.h>
23 #include <dali/public-api/math/vector2.h>
35 namespace Internal DALI_INTERNAL
49 * Scene creates a "world" that can be bound to a surface for rendering.
52 class DALI_CORE_API Scene : public BaseHandle
55 typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type
56 typedef Signal< void (const Dali::KeyEvent&) > KeyEventSignalType; ///< Key event signal type
57 typedef Signal< void (const Dali::TouchData&) > TouchSignalType; ///< Touch signal type
58 typedef Signal< void (const Dali::WheelEvent&) > WheelEventSignalType; ///< Touched signal type
61 * @brief Create an initialized Scene handle.
63 * @param[in] size The size of the scene in pixels as a Vector
65 * @return a handle to a newly allocated Dali resource.
67 static Scene New( const Size& size );
70 * @brief Downcast an Object handle to Scene handle.
72 * If handle points to a Scene object the downcast produces
73 * valid handle. If not the returned handle is left uninitialized.
74 * @param[in] handle to An object
75 * @return handle to a Scene object or an uninitialized handle
77 static Scene DownCast( BaseHandle handle );
80 * @brief Create an uninitialized Scene handle.
82 * This can be initialized with Scene::New(). Calling member
83 * functions with an uninitialized Dali::Object is not allowed.
90 * This is non-virtual since derived Handle types must not contain data or virtual methods.
95 * @brief This copy constructor is required for (smart) pointer semantics.
97 * @param [in] handle A reference to the copied handle
99 Scene(const Scene& handle);
102 * @brief This assignment operator is required for (smart) pointer semantics.
104 * @param [in] rhs A reference to the copied handle
105 * @return A reference to this
107 Scene& operator=(const Scene& rhs);
110 * @brief Adds a child Actor to the Scene.
112 * The child will be referenced.
113 * @param[in] actor The child
114 * @pre The actor has been initialized.
115 * @pre The actor does not have a parent.
117 void Add(Actor actor);
120 * @brief Removes a child Actor from the Scene.
122 * The child will be unreferenced.
123 * @param[in] actor The child
124 * @pre The actor has been added to the stage.
126 void Remove(Actor actor);
129 * @brief Returns the size of the Scene in pixels as a Vector.
131 * The x component will be the width of the Scene in pixels.
132 * The y component will be the height of the Scene in pixels.
134 * @return The size of the Scene as a Vector
136 Size GetSize() const;
139 * Sets horizontal and vertical pixels per inch value that is used by the display
140 * @param[in] dpi Horizontal and vertical dpi value
142 void SetDpi( Vector2 dpi );
145 * @brief Retrieves the DPI of the display device to which the scene is connected.
147 * @return The horizontal and vertical DPI
149 Vector2 GetDpi() const;
152 * @brief Retrieves the list of render-tasks.
154 * @return A valid handle to a RenderTaskList
156 Dali::RenderTaskList GetRenderTaskList() const;
159 * @brief Returns the Scene's Root Layer.
161 * @return The root layer
163 Layer GetRootLayer() const;
166 * @brief Queries the number of on-stage layers.
168 * Note that a default layer is always provided (count >= 1).
169 * @return The number of layers
171 uint32_t GetLayerCount() const;
174 * @brief Retrieves the layer at a specified depth.
176 * @param[in] depth The depth
177 * @return The layer found at the given depth
178 * @pre Depth is less than layer count; see GetLayerCount().
180 Layer GetLayer( uint32_t depth ) const;
183 * @brief Binds the rendering surface to the scene
185 * @return The root layer
187 void SetSurface( Integration::RenderSurface& surface );
190 * @brief Gets the rendering surface bound to the scene
192 * @return The render surface
194 Integration::RenderSurface* GetSurface() const;
197 * @brief Retrieve the Scene that the given actor belongs to.
200 static Integration::Scene Get( Actor actor );
203 * This function is called when an event is queued.
204 * @param[in] event A event to queue.
206 void QueueEvent( const Integration::Event& event );
209 * This function is called by Core when events are processed.
211 void ProcessEvents();
214 * @brief This signal is emitted just after the event processing is finished.
216 * @return The signal to connect to
218 EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
221 * @brief This signal is emitted when key event is received.
223 * A callback of the following type may be connected:
225 * void YourCallbackName(const KeyEvent& event);
227 * @return The signal to connect to
229 KeyEventSignalType& KeyEventSignal();
232 * @brief This signal is emitted when the screen is touched and when the touch ends
233 * (i.e. the down & up touch events only).
235 * If there are multiple touch points, then this will be emitted when the first touch occurs and
236 * then when the last finger is lifted.
237 * An interrupted event will also be emitted (if it occurs).
238 * A callback of the following type may be connected:
240 * void YourCallbackName( TouchData event );
243 * @return The touch signal to connect to
244 * @note Motion events are not emitted.
246 TouchSignalType& TouchSignal();
249 * @brief This signal is emitted when wheel event is received.
251 * A callback of the following type may be connected:
253 * void YourCallbackName(const WheelEvent& event);
255 * @return The signal to connect to
257 WheelEventSignalType& WheelEventSignal();
259 public: // Not intended for application developers
262 * @brief This constructor is used by Dali::New() methods.
264 * @param[in] scene A pointer to an internal Scene resource
266 explicit DALI_INTERNAL Scene(Internal::Scene* scene);
269 } // namespace Integration
273 #endif // DALI_SCENE_H