dali/public-api/actors/layer.h

   1 #ifndef DALI_LAYER_H
   2 #define DALI_LAYER_H
   3
   4 /*
   5  * Copyright (c) 2016 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 // INTERNAL INCLUDES
  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>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_core_actors
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class Layer;
  38 }
  39
  40 /**
  41  * @brief Rectangle describing area on screen that a layer can draw to.
  42  *
  43  * @SINCE_1_0.0
  44  * @see Dali::Layer::SetClippingBox()
  45  */
  46 typedef Rect<int> ClippingBox;
  47
  48 /**
  49  * @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
  50  *
  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()).
  53  *
  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.
  58  *
  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.
  64  *
  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.
  68  *
  69  * If depth test is disabled, there is no performance overhead from clearing the depth buffer.
  70  *
  71  * Actions
  72  * | %Action Name    | %Layer method called |
  73  * |-----------------|----------------------|
  74  * | raise           | @ref Raise()         |
  75  * | lower           | @ref Lower()         |
  76  * | raiseToTop      | @ref RaiseToTop()    |
  77  * | lowerToBottom   | @ref LowerToBottom() |
  78  * @SINCE_1_0.0
  79  */
  80 class DALI_IMPORT_API Layer : public Actor
  81 {
  82 public:
  83
  84   /**
  85    * @brief Enumeration for the instance of properties belonging to the Layer class.
  86    *
  87    * Properties additional to Actor.
  88    * @SINCE_1_0.0
  89    */
  90   struct Property
  91   {
  92     /**
  93      * @brief Enumeration for the instance of properties belonging to the Layer class.
  94      *
  95      * Properties additional to Actor.
  96      * @SINCE_1_0.0
  97      */
  98     enum
  99     {
 100       CLIPPING_ENABLE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "clippingEnable",   type bool @SINCE_1_0.0
 101       CLIPPING_BOX,                                                 ///< name "clippingBox",      type Rect<int> @SINCE_1_0.0
 102       BEHAVIOR,                                                     ///< name "behavior",         type String @SINCE_1_0.0
 103     };
 104   };
 105
 106   /**
 107    * @brief Enumeration for the behavior of the layer.
 108    *
 109    * Check each value to see how it affects the layer.
 110    * @SINCE_1_0.0
 111    */
 112   enum Behavior
 113   {
 114     /**
 115      * @DEPRECATED_1_1.45, use LAYER_UI instead
 116      * @brief UI control rendering mode.
 117      * @SINCE_1_0.0
 118      * @see LAYER_UI
 119      */
 120     LAYER_2D,
 121
 122     /**
 123      * @brief UI control rendering mode (default mode).
 124      *
 125      * This mode is designed for UI controls. In this mode renderer order will be respective to tree hierarchy of Actors.
 126      * This mode is expected to have better performance than LAYER_3D as renderers can be sorted more efficiently.
 127      *
 128      * For the following actor tree the rendering order will be A first, then B & C and finally D,E,F regardless of their
 129      * Z positions.
 130      * Rendering order between siblings, such as D, E & F or B & C, is determined based on the renderers depth index.
 131      * In UI we don't normally expect overlap. If you have two overlapped actors, make them parent-child to guarantee order of all renderers.
 132      *
 133      * @code
 134      *
 135      *     Layer1 (parent)
 136      *       |
 137      *       A
 138      *      / \
 139      *     B   C
 140      *    / \   \
 141      *   D   E   F
 142      *
 143      * @endcode
 144      *
 145      * @SINCE_1_1.45
 146      */
 147     LAYER_UI = LAYER_2D,
 148
 149     /**
 150      * @brief Layer will use depth test.
 151      *
 152      * When using this mode, depth test will be used. A depth clear will happen for each layer,
 153      * which means actors in a layer "above" other layers will be rendered in front of actors in
 154      * those layers regardless of their Z positions (see Layer::Raise() and Layer::Lower()).
 155      * Opaque renderers are drawn first and write to the depth buffer.
 156      * Then transparent renderers are drawn with depth test enabled but depth write switched off.
 157      * Transparent renderers are drawn based on their distance from the camera.
 158      * A renderers DEPTH_INDEX property is used to offset the distance to the camera when ordering transparent renderers.
 159      * This is useful if you want to define the draw order of two or more transparent renderers that are
 160      * equal distance from the camera.
 161      * Unlike LAYER_UI, parent-child relationship does not affect rendering order at all.
 162      *
 163      * @SINCE_1_0.0
 164      */
 165     LAYER_3D
 166
 167   };
 168
 169   /**
 170    * @brief Enumeration for TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
 171    * @SINCE_1_0.0
 172    */
 173   enum TreeDepthMultiplier
 174   {
 175     TREE_DEPTH_MULTIPLIER = 10000,
 176   };
 177   /**
 178    * @brief The sort function type.
 179    *
 180    * @SINCE_1_0.0
 181    * @param[in] position This is the actor translation from camera
 182    */
 183   typedef float (*SortFunctionType)( const Vector3& position );
 184
 185   /**
 186    * @brief Creates an empty Layer handle.
 187    *
 188    * This can be initialized with Layer::New(...).
 189    * @SINCE_1_0.0
 190    */
 191   Layer();
 192
 193   /**
 194    * @brief Creates a Layer object.
 195    *
 196    * @SINCE_1_0.0
 197    * @return A handle to a newly allocated Layer
 198    */
 199   static Layer New();
 200
 201   /**
 202    * @brief Downcasts a handle to Layer handle.
 203    *
 204    * If handle points to a Layer, the downcast produces valid handle.
 205    * If not, the returned handle is left uninitialized.
 206    * @SINCE_1_0.0
 207    * @param[in] handle Handle to an object
 208    * @return Handle to a Layer or an uninitialized handle
 209    */
 210   static Layer DownCast( BaseHandle handle );
 211
 212   /**
 213    * @brief Destructor.
 214    *
 215    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 216    * @SINCE_1_0.0
 217    */
 218   ~Layer();
 219
 220   /**
 221    * @brief Copy constructor.
 222    *
 223    * @SINCE_1_0.0
 224    * @param[in] copy The actor to copy
 225    */
 226   Layer(const Layer& copy);
 227
 228   /**
 229    * @brief Assignment operator.
 230    *
 231    * @SINCE_1_0.0
 232    * @param[in] rhs The actor to copy
 233    * @return A reference to this
 234    */
 235   Layer& operator=(const Layer& rhs);
 236
 237   /**
 238    * @brief Queries the depth of the layer.
 239    *
 240    * 0 is the bottom most layer, higher number is on top.
 241    * @SINCE_1_0.0
 242    * @return The current depth of the layer
 243    * @pre Layer is on the stage.
 244    * If layer is not added to the stage, returns 0.
 245    */
 246   unsigned int GetDepth() const;
 247
 248   /**
 249    * @brief Increments the depth of the layer.
 250    *
 251    * @SINCE_1_0.0
 252    * @pre Layer is on the stage.
 253    */
 254   void Raise();
 255
 256   /**
 257    * @brief Decrements the depth of the layer.
 258    *
 259    * @SINCE_1_0.0
 260    * @pre Layer is on the stage.
 261    */
 262   void Lower();
 263
 264   /**
 265    * @brief Ensures the layers depth is greater than the target layer.
 266    *
 267    * If the layer already is above the target layer, its depth is not changed.
 268    * If the layer was below target, its new depth will be immediately above target.
 269    * @SINCE_1_0.0
 270    * @param target Layer to get above of
 271    * @pre Layer is on the stage.
 272    * @pre Target layer is on the stage.
 273    * @note All layers between this layer and target get new depth values.
 274    */
 275   void RaiseAbove( Layer target );
 276
 277   /**
 278    * @brief Ensures the layers depth is less than the target layer.
 279    *
 280    * If the layer already is below the target layer, its depth is not changed.
 281    * If the layer was above target, its new depth will be immediately below target.
 282    * @SINCE_1_0.0
 283    * @param target Layer to get below of
 284    * @pre Layer is on the stage.
 285    * @pre Target layer is on the stage.
 286    * @note All layers between this layer and target get new depth values.
 287    */
 288   void LowerBelow( Layer target );
 289
 290   /**
 291    * @brief Raises the layer to the top.
 292    * @SINCE_1_0.0
 293    * @pre Layer is on the stage.
 294    */
 295   void RaiseToTop();
 296
 297   /**
 298    * @brief Lowers the layer to the bottom.
 299    * @SINCE_1_0.0
 300    * @pre layer is on the stage.
 301    */
 302   void LowerToBottom();
 303
 304   /**
 305    * @brief Moves the layer directly above the given layer.
 306    *
 307    * After the call, this layers depth will be immediately above target.
 308    * @SINCE_1_0.0
 309    * @param target Layer to get on top of
 310    * @pre Layer is on the stage.
 311    * @pre Target layer is on the stage.
 312    * @note All layers between this layer and target get new depth values.
 313    */
 314   void MoveAbove( Layer target );
 315
 316   /**
 317    * @brief Moves the layer directly below the given layer.
 318    *
 319    * After the call, this layers depth will be immediately below target.
 320    * @SINCE_1_0.0
 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.
 325    */
 326   void MoveBelow( Layer target );
 327
 328   /**
 329    * @brief Sets the behavior of the layer.
 330    *
 331    * @SINCE_1_0.0
 332    * @param[in] behavior The desired behavior
 333    */
 334   void SetBehavior( Behavior behavior );
 335
 336   /**
 337    * @brief Gets the behavior of the layer.
 338    *
 339    * @SINCE_1_0.0
 340    * @return The behavior of the layer
 341    */
 342   Behavior GetBehavior() const;
 343
 344   /**
 345    * @brief Sets whether clipping is enabled for a layer.
 346    *
 347    * Clipping is initially disabled; see also SetClippingBox().
 348    * @SINCE_1_0.0
 349    * @param[in] enabled True if clipping is enabled
 350    *
 351    * @note When clipping is enabled, the default clipping box is empty (0,0,0,0), which means everything is clipped.
 352    */
 353   void SetClipping(bool enabled);
 354
 355   /**
 356    * @brief Queries whether clipping is enabled for a layer.
 357    * @SINCE_1_0.0
 358    * @return True if clipping is enabled
 359    */
 360   bool IsClipping() const;
 361
 362   /**
 363    * @brief Sets the clipping box of a layer, in window coordinates.
 364    *
 365    * The contents of the layer will not be visible outside this box, when clipping is
 366    * enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
 367    * You can only do rectangular clipping using this API in window coordinates.
 368    * @SINCE_1_0.0
 369    * @param[in] x The X-coordinate of the top-left corner of the box
 370    * @param[in] y The Y-coordinate of the top-left corner of the box
 371    * @param[in] width The width of the box
 372    * @param[in] height The height of the box
 373    */
 374   void SetClippingBox(int x, int y, int width, int height);
 375
 376   /**
 377    * @brief Sets the clipping box of a layer in window coordinates.
 378    *
 379    * The contents of the layer will not be visible outside this box when clipping is
 380    * enabled. The default clipping box is empty (0,0,0,0).
 381    * @SINCE_1_0.0
 382    * @param[in] box The clipping box
 383    */
 384   void SetClippingBox(ClippingBox box);
 385
 386   /**
 387    * @brief Retrieves the clipping box of a layer in window coordinates.
 388    *
 389    * @SINCE_1_0.0
 390    * @return The clipping box
 391    */
 392   ClippingBox GetClippingBox() const;
 393
 394   // Depth test
 395
 396   /**
 397    * @brief Whether to disable the depth test.
 398    *
 399    * 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.
 400    * However, it's possible to disable the depth test by calling this method.
 401    *
 402    * @SINCE_1_0.0
 403    * @param[in] disable \e True disables depth test. \e false sets the default behavior
 404    */
 405   void SetDepthTestDisabled( bool disable );
 406
 407   /**
 408    * @brief Retrieves whether depth test is disabled.
 409    *
 410    * @SINCE_1_0.0
 411    * @return \e True if depth test is disabled
 412    */
 413   bool IsDepthTestDisabled() const;
 414
 415   // Sorting
 416
 417   /**
 418    * @brief This allows the user to specify the sort function that the layer should use.
 419    *
 420    * The sort function is used to determine the order in which the actors are drawn
 421    * and input is processed on the actors in the layer.
 422    *
 423    * A function of the following type should be used:
 424    * @code
 425    *  float YourSortFunction(const Vector3& position);
 426    * @endcode
 427    *
 428    * @SINCE_1_0.0
 429    * @param[in] function The sort function pointer
 430    * @note If the sort function returns a low number, the actor with the data will be
 431    * drawn in front of an actor whose data yields a high value from the sort function.
 432    *
 433    * @note All child layers use the same sort function. If a child layer is added to this
 434    * layer, then the sort function used by the child layer will also be the same.
 435    *
 436   */
 437   void SetSortFunction( SortFunctionType function );
 438
 439   /**
 440    * @brief This allows the user to specify whether this layer should consume touch (including gestures).
 441    *
 442    * If set, any layers behind this layer will not be hit-test.
 443    *
 444    * @SINCE_1_0.0
 445    * @param[in] consume Whether the layer should consume touch (including gestures)
 446    */
 447   void SetTouchConsumed( bool consume );
 448
 449   /**
 450    * @brief Retrieves whether the layer consumes touch (including gestures).
 451    *
 452    * @SINCE_1_0.0
 453    * @return @c True if consuming touch, @c false otherwise
 454    */
 455   bool IsTouchConsumed() const;
 456
 457   /**
 458    * @brief This allows the user to specify whether this layer should consume hover.
 459    *
 460    * If set, any layers behind this layer will not be hit-test.
 461    *
 462    * @SINCE_1_0.0
 463    * @param[in] consume Whether the layer should consume hover
 464    */
 465   void SetHoverConsumed( bool consume );
 466
 467   /**
 468    * @brief Retrieves whether the layer consumes hover.
 469    *
 470    * @SINCE_1_0.0
 471    * @return @c True if consuming hover, @c false otherwise
 472    */
 473   bool IsHoverConsumed() const;
 474
 475 public: // Not intended for application developers
 476
 477   /**
 478    * @internal
 479    * @brief This constructor is used by Layer::New() methods.
 480    *
 481    * @SINCE_1_0.0
 482    * @param[in] Layer A pointer to a newly allocated Dali resource
 483    */
 484   explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
 485 };
 486
 487 /**
 488  * @}
 489  */
 490 } // namespace Dali
 491
 492 #endif // DALI_LAYER_H