5 * Copyright (c) 2016 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/ref-object.h>
23 #include <dali/public-api/actors/actor.h>
24 #include <dali/public-api/math/rect.h>
25 #include <dali/public-api/math/vector3.h>
26 #include <dali/public-api/images/frame-buffer-image.h>
31 * @addtogroup dali_core_actors
35 namespace Internal DALI_INTERNAL
41 * @brief Rectangle describing area on screen that a layer can draw to
44 * @see Dali::Layer::SetClippingBox()
46 typedef Rect<int> ClippingBox;
49 * @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
51 * When added to the stage, a layer can be ordered relative to other layers. The bottom
52 * layer is at depth zero. The stage provides a default layer for it's children (see Stage::GetRootLayer()).
54 * Layered actors inherit position etc. as normal, but are drawn in an order determined
55 * by the layers. In case of LAYER_3D, the depth buffer is cleared before each layer is rendered unless depth
56 * test is disabled or there's no need for it based on the layers contents;
57 * actors in lower layers cannot obscure actors in higher layers.
59 * A layer has either LAYER_2D or LAYER_3D mode. LAYER_2D has better performance,
60 * the depth test is disabled, and a child actor hides its parent actor.
61 * LAYER_3D uses the depth test, thus a close actor hides a farther one.
62 * LAYER_2D is the default mode and recommended for general cases.
63 * See Layer::Behavior and SetBehavior() for more information.
65 * Layer is a type of Actor, thus can have parent or children actors.
66 * A layer influences rendering of its all descendant actors,
67 * until another layer appears in the actor tree and manages its own subtree.
69 * If depth test is disabled, there is no performance overhead from clearing the depth buffer.
72 * | %Action Name | %Layer method called |
73 * |-----------------|----------------------|
74 * | raise | @ref Raise() |
75 * | lower | @ref Lower() |
76 * | raiseToTop | @ref RaiseToTop() |
77 * | lowerToBottom | @ref LowerToBottom() |
80 class DALI_IMPORT_API Layer : public Actor
85 * @brief An enumeration of properties belonging to the Layer class.
87 * Properties additional to Actor.
95 CLIPPING_ENABLE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "clippingEnable", type bool @SINCE_1_0.0
96 CLIPPING_BOX, ///< name "clippingBox", type Rect<int> @SINCE_1_0.0
97 BEHAVIOR, ///< name "behavior", type String @SINCE_1_0.0
102 * @brief Enumeration for the behavior of the layer.
104 * Check each value to see how it affects the layer.
110 * @DEPRECATED_1_1.45, use LAYER_UI instead
111 * @brief UI control rendering mode
118 * @brief UI control rendering mode (default mode).
120 * This mode is designed for UI controls. In this mode renderer order will be respective to tree hierarchy of Actors.
121 * This mode is expected to have better performance than LAYER_3D as renderers can be sorted more efficiently.
123 * For the following actor tree the rendering order will be A first, then B & C and finally D,E,F regardless of their
125 * Rendering order between siblings, such as D, E & F or B & C, is determined based on the renderers depth index.
126 * In UI we don't normally expect overlap. If you have two overlapped actors, make them parent-child to guarantee order of all renderers.
145 * @brief Layer will use depth test.
147 * When using this mode depth test will be used. A depth clear will happen for each layer,
148 * which means actors in a layer "above" other layers will be rendered in front of actors in
149 * those layers regardless of their Z positions (see Layer::Raise() and Layer::Lower()).
150 * Opaque renderers are drawn first and write to the depth buffer.
151 * Then transparent renderers are drawn with depth test enabled but depth write switched off.
152 * Transparent renderers are drawn based on their distance from the camera.
153 * A renderers DEPTH_INDEX property is used to offset the distance to the camera when ordering transparent renderers.
154 * This is useful if you want to define the draw order of two or more transparent renderers that are
155 * equal distance from the camera.
156 * Unlike LAYER_UI, parent-child relationship does not affect rendering order at all.
165 * @brief TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
168 enum TreeDepthMultiplier
170 TREE_DEPTH_MULTIPLIER = 10000,
173 * @brief The sort function type
176 * @param[in] position This is the actor translation from camera.
178 typedef float (*SortFunctionType)( const Vector3& position );
181 * @brief Create an empty Layer handle.
183 * This can be initialised with Layer::New(...).
189 * @brief Create a Layer object.
192 * @return A handle to a newly allocated Layer
197 * @brief Downcast a handle to Layer handle.
199 * If handle points to a Layer the downcast produces valid
200 * handle. If not the returned handle is left uninitialized.
202 * @param[in] handle Handle to An object
203 * @return Handle to a Layer or an uninitialized handle
205 static Layer DownCast( BaseHandle handle );
210 * This is non-virtual since derived Handle types must not contain data or virtual methods.
216 * @brief Copy constructor
219 * @param [in] copy The actor to copy
221 Layer(const Layer& copy);
224 * @brief Assignment operator
227 * @param [in] rhs The actor to copy
228 * @return A reference to this
230 Layer& operator=(const Layer& rhs);
233 * @brief Query the depth of the layer
235 * 0 is bottom most layer, higher number is on top.
237 * @return The current depth of the layer
238 * @pre Layer is on the stage.
239 * If layer is not added to the stage, returns 0.
241 unsigned int GetDepth() const;
244 * @brief Increment the depth of the layer.
247 * @pre Layer is on the stage.
252 * @brief Decrement the depth of the layer.
255 * @pre Layer is on the stage.
260 * @brief Ensures the layers depth is greater than the target layer.
262 * If the layer already is above the target layer its depth is not changed.
263 * If the layer was below target, its new depth will be immediately above target.
265 * @param target Layer to get above of
266 * @pre Layer is on the stage.
267 * @pre Target layer is on the stage.
268 * @note All layers between this layer and target get new depth values.
270 void RaiseAbove( Layer target );
273 * @brief Ensures the layers depth is less than the target layer.
275 * If the layer already is below the target layer its depth is not changed.
276 * If the layer was above target, its new depth will be immediately below target.
278 * @param target Layer to get below of
279 * @pre Layer is on the stage.
280 * @pre Target layer is on the stage.
281 * @note All layers between this layer and target get new depth values.
283 void LowerBelow( Layer target );
286 * @brief Raises the layer to the top.
288 * @pre Layer is on the stage.
293 * @brief Lowers the layer to the bottom.
295 * @pre layer is on the stage.
297 void LowerToBottom();
300 * @brief Moves the layer directly above the given layer.
302 * After the call this layers depth will be immediately above target.
304 * @param target Layer to get on top of
305 * @pre Layer is on the stage.
306 * @pre Target layer is on the stage.
307 * @note All layers between this layer and target get new depth values.
309 void MoveAbove( Layer target );
312 * @brief Moves the layer directly below the given layer.
314 * After the call this layers depth will be immediately below target.
316 * @param target Layer to get below of
317 * @pre Layer is on the stage.
318 * @pre Target layer is on the stage.
319 * @note All layers between this layer and target get new depth values.
321 void MoveBelow( Layer target );
324 * @brief Set the behavior of the layer.
327 * @param[in] behavior The desired behavior
329 void SetBehavior( Behavior behavior );
332 * @brief Get the behavior of the layer.
335 * @return The behavior of the layer
337 Behavior GetBehavior() const;
340 * @brief Sets whether clipping is enabled for a layer.
342 * Clipping is initially disabled; see also SetClippingBox().
344 * @param [in] enabled True if clipping is enabled.
346 * @note When clipping is enabled, the default clipping box is empty (0,0,0,0) which means everything is clipped.
348 void SetClipping(bool enabled);
351 * @brief Query whether clipping is enabled for a layer.
353 * @return True if clipping is enabled.
355 bool IsClipping() const;
358 * @brief Sets the clipping box of a layer, in window coordinates.
360 * The contents of the layer will not be visible outside this box, when clipping is
361 * enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
362 * You can only do rectangular clipping using this API in window coordinates.
364 * @param [in] x The X-coordinate of the top-left corner of the box
365 * @param [in] y The Y-coordinate of the top-left corner of the box
366 * @param [in] width The width of the box
367 * @param [in] height The height of the box
369 void SetClippingBox(int x, int y, int width, int height);
372 * @brief Sets the clipping box of a layer, in window coordinates.
374 * The contents of the layer will not be visible outside this box, when clipping is
375 * enabled. The default clipping box is empty (0,0,0,0).
377 * @param [in] box The clipping box
379 void SetClippingBox(ClippingBox box);
382 * @brief Retrieves the clipping box of a layer, in window coordinates.
385 * @return The clipping box
387 ClippingBox GetClippingBox() const;
392 * @brief Whether to disable the depth test.
394 * By default a layer enables depth test if there is more than one opaque actor or if there is one opaque actor and one, or more, transparent actors in LAYER_3D mode.
395 * However, it's possible to disable the depth test by calling this method.
398 * @param[in] disable \e True disables depth test. \e false sets the default behavior.
400 void SetDepthTestDisabled( bool disable );
403 * @brief Retrieves whether depth test is disabled.
406 * @return \e True if depth test is disabled.
408 bool IsDepthTestDisabled() const;
413 * @brief This allows the user to specify the sort function that the layer should use.
415 * The sort function is used to determine the order in which the actors are drawn
416 * and input is processed on the actors in the layer.
418 * A function of the following type should be used:
420 * float YourSortFunction(const Vector3& position);
424 * @param[in] function The sort function pointer
425 * @note If the sort function returns a low number, the actor with the data will be
426 * drawn in front of an actor whose data yields a high value from the sort function.
428 * @note All child layers use the same sort function. If a child layer is added to this
429 * layer then the sort function used by the child layer will also be the same.
432 void SetSortFunction( SortFunctionType function );
435 * @brief This allows the user to specify whether this layer should consume touch (including gestures).
437 * If set, any layers behind this layer will not be hit-test.
440 * @param[in] consume Whether the layer should consume touch (including gestures).
442 void SetTouchConsumed( bool consume );
445 * @brief Retrieves whether the layer consumes touch (including gestures).
448 * @return True if consuming touch, false otherwise.
450 bool IsTouchConsumed() const;
453 * @brief This allows the user to specify whether this layer should consume hover.
455 * If set, any layers behind this layer will not be hit-test.
458 * @param[in] consume Whether the layer should consume hover.
460 void SetHoverConsumed( bool consume );
463 * @brief Retrieves whether the layer consumes hover.
466 * @return True if consuming hover, false otherwise.
468 bool IsHoverConsumed() const;
470 public: // Not intended for application developers
474 * @brief This constructor is used by Layer::New() methods.
477 * @param [in] Layer A pointer to a newly allocated Dali resource
479 explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
487 #endif // DALI_LAYER_H