dali/public-api/actors/layer.h

   1 #ifndef DALI_LAYER_H
   2 #define DALI_LAYER_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstdint> // uint32_t
  23
  24 // INTERNAL INCLUDES
  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>
  29
  30 namespace Dali
  31 {
  32 /**
  33  * @addtogroup dali_core_actors
  34  * @{
  35  */
  36
  37 namespace Internal DALI_INTERNAL
  38 {
  39 class Layer;
  40 }
  41
  42 /**
  43  * @brief Rectangle describing area on screen that a layer can draw to.
  44  *
  45  * @SINCE_1_0.0
  46  * @see Dali::Layer::SetClippingBox()
  47  */
  48 using ClippingBox = Rect<int32_t>;
  49
  50 /**
  51  * @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
  52  *
  53  * When added to a scene, a layer can be ordered relative to other
  54  * layers. The bottom layer is at depth zero. A scene provides a default
  55  * layer for its children.
  56  *
  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.
  62  *
  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.
  68  *
  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.
  72  *
  73  * If depth test is disabled, there is no performance overhead from clearing
  74  * the depth buffer.
  75  *
  76  * Actions
  77  * | %Action Name    | %Layer method called |
  78  * |-----------------|----------------------|
  79  * | raise           | @ref Raise()         |
  80  * | lower           | @ref Lower()         |
  81  * | raiseToTop      | @ref RaiseToTop()    |
  82  * | lowerToBottom   | @ref LowerToBottom() |
  83  * @SINCE_1_0.0
  84  */
  85 class DALI_CORE_API Layer : public Actor
  86 {
  87 public:
  88
  89   /**
  90    * @brief Enumeration for the instance of properties belonging to the Layer class.
  91    *
  92    * Properties additional to Actor.
  93    * @SINCE_1_0.0
  94    */
  95   struct Property
  96   {
  97     /**
  98      * @brief Enumeration for the instance of properties belonging to the Layer class.
  99      *
 100      * Properties additional to Actor.
 101      * @SINCE_1_0.0
 102      */
 103     enum
 104     {
 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
 108
 109       /**
 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.
 114        * @SINCE_1_9.16
 115        */
 116       DEPTH,
 117
 118       /**
 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.
 124        * @SINCE_1_9.16
 125        */
 126       DEPTH_TEST,
 127
 128       /**
 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.
 132        * @SINCE_1_9.16
 133        */
 134       CONSUMES_TOUCH,
 135
 136       /**
 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.
 140        * @SINCE_1_9.16
 141        */
 142       CONSUMES_HOVER,
 143     };
 144   };
 145
 146   /**
 147    * @brief Enumeration for the behavior of the layer.
 148    *
 149    * Check each value to see how it affects the layer.
 150    * @SINCE_1_0.0
 151    */
 152   enum Behavior
 153   {
 154     /**
 155      * @brief UI control rendering mode (default mode).
 156      *
 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
 159      * Actors.
 160      *
 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).
 165      *
 166      * @code
 167      *
 168      *     Layer1 (parent)
 169      *       |
 170      *       A
 171      *      / \
 172      *     B   C
 173      *    / \   \
 174      *   D   E   F
 175      *
 176      * @endcode
 177      *
 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.
 181      *
 182      * @SINCE_1_1.45
 183      */
 184     LAYER_UI,
 185
 186     /**
 187      * @brief Layer will use depth test.
 188      *
 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.
 192      *
 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()).
 197      *
 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.
 203      *
 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
 207      * all.
 208      *
 209      * @SINCE_1_0.0
 210      */
 211     LAYER_3D
 212
 213   };
 214
 215   /**
 216    * @brief The sort function type.
 217    *
 218    * @SINCE_1_0.0
 219    * @param[in] position This is the actor translation from camera
 220    */
 221   using SortFunctionType = float ( * )( const Vector3& );
 222
 223   /**
 224    * @brief Creates an empty Layer handle.
 225    *
 226    * This can be initialized with Layer::New(...).
 227    * @SINCE_1_0.0
 228    */
 229   Layer();
 230
 231   /**
 232    * @brief Creates a Layer object.
 233    *
 234    * @SINCE_1_0.0
 235    * @return A handle to a newly allocated Layer
 236    */
 237   static Layer New();
 238
 239   /**
 240    * @brief Downcasts a handle to Layer handle.
 241    *
 242    * If handle points to a Layer, the downcast produces valid handle.
 243    * If not, the returned handle is left uninitialized.
 244    * @SINCE_1_0.0
 245    * @param[in] handle Handle to an object
 246    * @return Handle to a Layer or an uninitialized handle
 247    */
 248   static Layer DownCast( BaseHandle handle );
 249
 250   /**
 251    * @brief Destructor.
 252    *
 253    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 254    * @SINCE_1_0.0
 255    */
 256   ~Layer();
 257
 258   /**
 259    * @brief Copy constructor.
 260    *
 261    * @SINCE_1_0.0
 262    * @param[in] copy The actor to copy
 263    */
 264   Layer(const Layer& copy);
 265
 266   /**
 267    * @brief Assignment operator.
 268    *
 269    * @SINCE_1_0.0
 270    * @param[in] rhs The actor to copy
 271    * @return A reference to this
 272    */
 273   Layer& operator=(const Layer& rhs);
 274
 275   /**
 276    * @brief Move constructor.
 277    *
 278    * @SINCE_1_9.22
 279    * @param[in] rhs The layer to move
 280    */
 281   Layer( Layer&& rhs );
 282
 283   /**
 284    * @brief Move assignment operator.
 285    *
 286    * @SINCE_1_9.22
 287    * @param[in] rhs The layer to move
 288    * @return A reference to this
 289    */
 290   Layer& operator=( Layer&& rhs );
 291
 292   /**
 293    * @brief Increments the depth of the layer.
 294    *
 295    * @SINCE_1_0.0
 296    * @pre Layer is on the stage.
 297    */
 298   void Raise();
 299
 300   /**
 301    * @brief Decrements the depth of the layer.
 302    *
 303    * @SINCE_1_0.0
 304    * @pre Layer is on the stage.
 305    */
 306   void Lower();
 307
 308   /**
 309    * @brief Ensures the layers depth is greater than the target layer.
 310    *
 311    * If the layer already is above the target layer, its depth is not changed.
 312    * If the layer was below target, its new depth will be immediately above target.
 313    * @SINCE_1_0.0
 314    * @param target Layer to get above of
 315    * @pre Layer is on the stage.
 316    * @pre Target layer is on the stage.
 317    * @note All layers between this layer and target get new depth values.
 318    */
 319   void RaiseAbove( Layer target );
 320
 321   /**
 322    * @brief Ensures the layers depth is less than the target layer.
 323    *
 324    * If the layer already is below the target layer, its depth is not changed.
 325    * If the layer was above target, its new depth will be immediately below target.
 326    * @SINCE_1_0.0
 327    * @param target Layer to get below of
 328    * @pre Layer is on the stage.
 329    * @pre Target layer is on the stage.
 330    * @note All layers between this layer and target get new depth values.
 331    */
 332   void LowerBelow( Layer target );
 333
 334   /**
 335    * @brief Raises the layer to the top.
 336    * @SINCE_1_0.0
 337    * @pre Layer is on the stage.
 338    */
 339   void RaiseToTop();
 340
 341   /**
 342    * @brief Lowers the layer to the bottom.
 343    * @SINCE_1_0.0
 344    * @pre layer is on the stage.
 345    */
 346   void LowerToBottom();
 347
 348   /**
 349    * @brief Moves the layer directly above the given layer.
 350    *
 351    * After the call, this layers depth will be immediately above target.
 352    * @SINCE_1_0.0
 353    * @param target Layer to get on top of
 354    * @pre Layer is on the stage.
 355    * @pre Target layer is on the stage.
 356    * @note All layers between this layer and target get new depth values.
 357    */
 358   void MoveAbove( Layer target );
 359
 360   /**
 361    * @brief Moves the layer directly below the given layer.
 362    *
 363    * After the call, this layers depth will be immediately below target.
 364    * @SINCE_1_0.0
 365    * @param target Layer to get below of
 366    * @pre Layer is on the stage.
 367    * @pre Target layer is on the stage.
 368    * @note All layers between this layer and target get new depth values.
 369    */
 370   void MoveBelow( Layer target );
 371
 372   // Sorting
 373
 374   /**
 375    * @brief This allows the user to specify the sort function that the layer should use.
 376    *
 377    * The sort function is used to determine the order in which the actors are drawn
 378    * and input is processed on the actors in the layer.
 379    *
 380    * A function of the following type should be used:
 381    * @code
 382    *  float YourSortFunction(const Vector3& position);
 383    * @endcode
 384    *
 385    * @SINCE_1_0.0
 386    * @param[in] function The sort function pointer
 387    * @note If the sort function returns a low number, the actor with the data will be
 388    * drawn in front of an actor whose data yields a high value from the sort function.
 389    *
 390    * @note All child layers use the same sort function. If a child layer is added to this
 391    * layer, then the sort function used by the child layer will also be the same.
 392    *
 393   */
 394   void SetSortFunction( SortFunctionType function );
 395
 396   /**
 397    * @brief Retrieves whether the layer consumes hover.
 398    *
 399    * @SINCE_1_0.0
 400    * @return @c True if consuming hover, @c false otherwise
 401    */
 402   bool IsHoverConsumed() const;
 403
 404 public: // Not intended for application developers
 405
 406   /// @cond internal
 407   /**
 408    * @brief This constructor is used by Layer::New() methods.
 409    *
 410    * @SINCE_1_0.0
 411    * @param[in] Layer A pointer to a newly allocated Dali resource
 412    */
 413   explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
 414   /// @endcond
 415 };
 416
 417 /**
 418  * @}
 419  */
 420 } // namespace Dali
 421
 422 #endif // DALI_LAYER_H