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.
22 #include <cstdint> // uint32_t
25 #include <dali/public-api/object/ref-object.h>
26 #include <dali/public-api/actors/actor.h>
27 #include <dali/public-api/math/rect.h>
28 #include <dali/public-api/math/vector3.h>
33 * @addtogroup dali_core_actors
37 namespace Internal DALI_INTERNAL
43 * @brief Rectangle describing area on screen that a layer can draw to.
46 * @see Dali::Layer::SetClippingBox()
48 typedef Rect<int32_t> ClippingBox;
51 * @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
53 * When added to the stage, a layer can be ordered relative to other
54 * layers. The bottom layer is at depth zero. The stage provides a default
55 * layer for it's children (see Stage::GetRootLayer()).
57 * Layered actors inherit position etc. as normal, but are drawn in an order
58 * determined by the layers. In case of LAYER_3D, the depth buffer is cleared
59 * before each layer is rendered unless depth test is disabled or there's no
60 * need for it based on the layer's contents; actors in lower layers cannot
61 * obscure actors in higher layers.
63 * A layer has either LAYER_UI or LAYER_3D mode. LAYER_UI has better
64 * performance, the depth test is disabled, and a child actor hides its
65 * parent actor. LAYER_3D uses the depth test, thus a close actor hides a
66 * farther one. LAYER_UI is the default mode and recommended for general
67 * cases. See Layer::Behavior and SetBehavior() for more information.
69 * Layer is a type of Actor, thus can have parent or children actors. A
70 * layer influences rendering of its all descendant actors, until another
71 * layer appears in the actor tree and manages its own subtree.
73 * If depth test is disabled, there is no performance overhead from clearing
77 * | %Action Name | %Layer method called |
78 * |-----------------|----------------------|
79 * | raise | @ref Raise() |
80 * | lower | @ref Lower() |
81 * | raiseToTop | @ref RaiseToTop() |
82 * | lowerToBottom | @ref LowerToBottom() |
85 class DALI_CORE_API Layer : public Actor
90 * @brief Enumeration for the instance of properties belonging to the Layer class.
92 * Properties additional to Actor.
98 * @brief Enumeration for the instance of properties belonging to the Layer class.
100 * Properties additional to Actor.
105 CLIPPING_ENABLE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "clippingEnable", type bool @SINCE_1_0.0
106 CLIPPING_BOX, ///< name "clippingBox", type Rect<int32_t> @SINCE_1_0.0
107 BEHAVIOR, ///< name "behavior", type integer or string @SINCE_1_0.0
110 * @brief The current depth of the layer.
111 * @details Name "depth", type Property::INTEGER. Read-only
112 * @note 0 is the bottom most layer, higher number is on top.
113 * @note Layer should be on the stage. If layer is not added to the stage, the depth is 0.
119 * @brief Whether to enable the depth test.
120 * @details Name "depthTest", type Property::BOOLEAN.
121 * @note By default a layer enables depth test if there is more than one opaque actor
122 * or if there is one opaque actor and one, or more, transparent actors in LAYER_3D mode.
123 * However, it's possible to disable the depth test by setting this property to False.
129 * @brief Whether this layer should consume touch (including gestures).
130 * @details Name "consumesTouch", type Property::BOOLEAN.
131 * @note When this is True, any layers behind this layer will not be hit-test.
137 * @brief Whether this layer should consume hover (including gestures).
138 * @details Name "consumesHover", type Property::BOOLEAN.
139 * @note When this is True, any layers behind this layer will not be hit-test.
147 * @brief Enumeration for the behavior of the layer.
149 * Check each value to see how it affects the layer.
155 * @brief UI control rendering mode (default mode).
157 * This mode is designed for UI controls that can overlap. In this
158 * mode renderer order will be respective to the tree hierarchy of
161 * The rendering order is depth first, so for the following actor tree,
162 * A will be drawn first, then B, D, E, then C, F. This ensures that
163 * overlapping actors are drawn as expected (whereas, with breadth first
164 * traversal, the actors would interleave).
178 * To change the order of sibling actors, use the Actor::Raise and
179 * Actor::Lower APIs. Within an actor, the Renderer depth index dictates
180 * the order the renderers are drawn.
187 * @brief Layer will use depth test.
189 * This mode is designed for a 3 dimensional scene where actors in front
190 * of other actors will obscure them, i.e. the actors are sorted by the
191 * distance from the camera.
193 * When using this mode, a depth test will be used. A depth clear will
194 * happen for each layer, which means actors in a layer "above" other
195 * layers will be rendered in front of actors in those layers regardless
196 * of their Z positions (see Layer::Raise() and Layer::Lower()).
198 * Opaque renderers are drawn first and write to the depth buffer. Then
199 * transparent renderers are drawn with depth test enabled but depth
200 * write switched off. Transparent renderers are drawn based on their
201 * distance from the camera. A renderer's DEPTH_INDEX property is used to
202 * offset the distance to the camera when ordering transparent renderers.
204 * This is useful if you want to define the draw order of two or more
205 * transparent renderers that are equal distance from the camera. Unlike
206 * LAYER_UI, parent-child relationship does not affect rendering order at
216 * @DEPRECATED_1_2.26. Not intended for application use.
218 * @brief Enumeration for TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
221 enum TreeDepthMultiplier
223 TREE_DEPTH_MULTIPLIER = 10000,
227 * @brief The sort function type.
230 * @param[in] position This is the actor translation from camera
232 typedef float (*SortFunctionType)( const Vector3& position );
235 * @brief Creates an empty Layer handle.
237 * This can be initialized with Layer::New(...).
243 * @brief Creates a Layer object.
246 * @return A handle to a newly allocated Layer
251 * @brief Downcasts a handle to Layer handle.
253 * If handle points to a Layer, the downcast produces valid handle.
254 * If not, the returned handle is left uninitialized.
256 * @param[in] handle Handle to an object
257 * @return Handle to a Layer or an uninitialized handle
259 static Layer DownCast( BaseHandle handle );
264 * This is non-virtual since derived Handle types must not contain data or virtual methods.
270 * @brief Copy constructor.
273 * @param[in] copy The actor to copy
275 Layer(const Layer& copy);
278 * @brief Assignment operator.
281 * @param[in] rhs The actor to copy
282 * @return A reference to this
284 Layer& operator=(const Layer& rhs);
287 * @brief Increments the depth of the layer.
290 * @pre Layer is on the stage.
295 * @brief Decrements the depth of the layer.
298 * @pre Layer is on the stage.
303 * @brief Ensures the layers depth is greater than the target layer.
305 * If the layer already is above the target layer, its depth is not changed.
306 * If the layer was below target, its new depth will be immediately above target.
308 * @param target Layer to get above of
309 * @pre Layer is on the stage.
310 * @pre Target layer is on the stage.
311 * @note All layers between this layer and target get new depth values.
313 void RaiseAbove( Layer target );
316 * @brief Ensures the layers depth is less than the target layer.
318 * If the layer already is below the target layer, its depth is not changed.
319 * If the layer was above target, its new depth will be immediately below target.
321 * @param target Layer to get below of
322 * @pre Layer is on the stage.
323 * @pre Target layer is on the stage.
324 * @note All layers between this layer and target get new depth values.
326 void LowerBelow( Layer target );
329 * @brief Raises the layer to the top.
331 * @pre Layer is on the stage.
336 * @brief Lowers the layer to the bottom.
338 * @pre layer is on the stage.
340 void LowerToBottom();
343 * @brief Moves the layer directly above the given layer.
345 * After the call, this layers depth will be immediately above target.
347 * @param target Layer to get on top of
348 * @pre Layer is on the stage.
349 * @pre Target layer is on the stage.
350 * @note All layers between this layer and target get new depth values.
352 void MoveAbove( Layer target );
355 * @brief Moves the layer directly below the given layer.
357 * After the call, this layers depth will be immediately below target.
359 * @param target Layer to get below of
360 * @pre Layer is on the stage.
361 * @pre Target layer is on the stage.
362 * @note All layers between this layer and target get new depth values.
364 void MoveBelow( Layer target );
369 * @brief This allows the user to specify the sort function that the layer should use.
371 * The sort function is used to determine the order in which the actors are drawn
372 * and input is processed on the actors in the layer.
374 * A function of the following type should be used:
376 * float YourSortFunction(const Vector3& position);
380 * @param[in] function The sort function pointer
381 * @note If the sort function returns a low number, the actor with the data will be
382 * drawn in front of an actor whose data yields a high value from the sort function.
384 * @note All child layers use the same sort function. If a child layer is added to this
385 * layer, then the sort function used by the child layer will also be the same.
388 void SetSortFunction( SortFunctionType function );
391 * @brief Retrieves whether the layer consumes hover.
394 * @return @c True if consuming hover, @c false otherwise
396 bool IsHoverConsumed() const;
398 public: // Not intended for application developers
402 * @brief This constructor is used by Layer::New() methods.
405 * @param[in] Layer A pointer to a newly allocated Dali resource
407 explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
416 #endif // DALI_LAYER_H