1 #ifndef __DALI_STAGE_H__
2 #define __DALI_STAGE_H__
5 * Copyright (c) 2014 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/base-handle.h>
23 #include <dali/public-api/signals/dali-signal-v2.h>
25 namespace Dali DALI_IMPORT_API
28 namespace Internal DALI_INTERNAL
41 class DynamicsWorldConfig;
46 * @brief The Stage is a top-level object used for displaying a tree of Actors.
48 * Multiple stage/window support is not currently provided.
50 class Stage : public BaseHandle
54 typedef SignalV2< void (const KeyEvent&)> KeyEventSignalV2; ///< Key event signal type
55 typedef SignalV2< void () > EventProcessingFinishedSignalV2; ///< Event Processing finished signal type
56 typedef SignalV2< void (const TouchEvent&)> TouchedSignalV2; ///< Touched signal type
58 static const Vector4 DEFAULT_BACKGROUND_COLOR; ///< Default black background.
59 static const Vector4 DEBUG_BACKGROUND_COLOR; ///< Green background, useful when debugging.
62 static const char* const SIGNAL_KEY_EVENT; ///< name "key-event"
63 static const char* const SIGNAL_EVENT_PROCESSING_FINISHED; ///< name "event-processing-finished"
64 static const char* const SIGNAL_TOUCHED; ///< name "touched"
67 * @brief Allows the creation of an empty stage handle.
69 * To retrieve the current stage, this handle can be set using Stage::GetCurrent().
74 * @brief Get the current Stage.
76 * @return The current stage or an empty handle if Core has not been created or has been already destroyed.
78 static Stage GetCurrent();
81 * @brief Query whether the Stage exists; this should only return false during or after destruction of Dali core.
83 * @return True when it's safe to call Stage::GetCurrent().
85 static bool IsInstalled();
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 Stage(const Stage& 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 Stage& operator=(const Stage& rhs);
110 * @brief This method is defined to allow assignment of the NULL value,
111 * and will throw an exception if passed any other value.
113 * Assigning to NULL is an alias for Reset().
114 * @param [in] rhs A NULL pointer
115 * @return A reference to this handle
117 Stage& operator=(BaseHandle::NullType* rhs);
122 * @brief Adds a child Actor to the Stage.
124 * The child will be referenced.
125 * @pre The actor has been initialized.
126 * @pre The actor does not have a parent.
127 * @param [in] actor The child.
129 void Add(Actor& actor);
132 * @brief Removes a child Actor from the Stage.
134 * The child will be unreferenced.
135 * @pre The actor has been added to the stage.
136 * @param [in] actor The child.
138 void Remove(Actor& actor);
141 * @brief Returns the size of the Stage in pixels as a Vector.
143 * The x component will be the width of the Stage in pixels
144 * The y component will be the height of the Stage in pixels
145 * The z component will be the distance between far and near planes
146 * @return The size of the Stage as a Vector.
148 Vector2 GetSize() const;
153 * @brief Retrieve the list of render-tasks.
155 * @return A valid handle to a RenderTaskList.
157 RenderTaskList GetRenderTaskList() const;
162 * @brief Query the number of on-stage layers.
164 * Note that a default layer is always provided (count >= 1).
165 * @return The number of layers.
167 unsigned int GetLayerCount() const;
170 * @brief Retrieve the layer at a specified depth.
172 * @pre depth is less than layer count; see GetLayerCount().
173 * @param[in] depth The depth.
174 * @return The layer found at the given depth.
176 Layer GetLayer(unsigned int depth) const;
179 * @brief Returns the Stage's Root Layer.
181 * @return The root layer.
183 Layer GetRootLayer() const;
188 * @brief Set the background color of the stage.
190 * @param[in] color The new background color.
192 void SetBackgroundColor(Vector4 color);
195 * @brief Retrieve the background color of the stage.
197 * @return The background color.
199 Vector4 GetBackgroundColor() const;
202 * @brief Retrieve the DPI of the display device to which the stage is connected.
204 * @return the horizontal and vertical DPI
206 Vector2 GetDpi() const;
209 * @brief Get the Object registry.
211 * @return The object registry.
213 ObjectRegistry GetObjectRegistry() const;
218 * @brief Initialise the dynamics simulation and create a DynamicsWorld object.
220 * Only one instance of DynamicsWorld will be created, so calling this method multiple times
221 * will return the same DynamicsWorld object.
222 * @param[in] config A DynamicsWorldConfig object describing the required capabilities of the dynamics world.
223 * @return A handle to the world object of the dynamics simulation, or an empty handle if Dynamics capable
224 * of supporting the requirement in config is not available on the platform.
226 DynamicsWorld InitializeDynamics(DynamicsWorldConfig config);
229 * @brief Get a handle to the world object of the dynamics simulation.
231 * @return A handle to the world object of the dynamics simulation
233 DynamicsWorld GetDynamicsWorld();
236 * @brief Terminate the dynamics simulation.
238 * Calls Actor::DisableDynamics on all dynamics enabled actors,
239 * all handles to any DynamicsBody or DynamicsJoint objects held by applications
240 * will become detached from their actors and the simulation therefore should be discarded.
242 void TerminateDynamics();
247 * @brief Keep rendering for at least the given amount of time.
249 * By default Dali will stop rendering when no Actor positions are being set, and when no animations are running etc.
250 * This method is useful to force screen refreshes e.g. when updating a NativeImage.
251 * @param durationSeconds to keep rendering, 0 means render at least one more frame
253 void KeepRendering( float durationSeconds );
258 * @brief This signal is emitted when key event is received.
260 * A callback of the following type may be connected:
262 * void YourCallbackName(const KeyEvent& event);
264 * @return The signal to connect to.
266 KeyEventSignalV2& KeyEventSignal();
269 * @brief This signal is emitted just after the event processing is finished.
271 * @return The signal to connect to.
273 EventProcessingFinishedSignalV2& EventProcessingFinishedSignal();
276 * @brief This signal is emitted when the screen is touched and when the touch ends
277 * (i.e. the down & up touch events only).
279 * If there are multiple touch points, then this will be emitted when the first touch occurs and
280 * then when the last finger is lifted.
281 * An interrupted event will also be emitted.
282 * A callback of the following type may be connected:
284 * void YourCallbackName(const TouchEvent& event);
287 * @note Motion events are not emitted.
288 * @return The touch signal to connect to.
290 TouchedSignalV2& TouchedSignal();
292 public: // Not intended for application developers
295 * @brief This constructor is used by Dali GetCurrent() methods.
297 * @param [in] stage A pointer to a Dali resource
299 explicit DALI_INTERNAL Stage(Internal::Stage* stage);
304 #endif // __DALI_STAGE_H__