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 An enumeration of properties belonging to the Layer class.
  86    *
  87    * Properties additional to Actor.
  88    *
  89    * @SINCE_1_0.0
  90    */
  91   struct Property
  92   {
  93     enum
  94     {
  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
  98     };
  99   };
 100
 101   /**
 102    * @brief Enumeration for the behavior of the layer.
 103    *
 104    * Check each value to see how it affects the layer.
 105    * @SINCE_1_0.0
 106    */
 107   enum Behavior
 108   {
 109     /**
 110      * @DEPRECATED_1_1.45, use LAYER_UI instead
 111      * @brief UI control rendering mode
 112      * @SINCE_1_0.0
 113      * @see LAYER_UI
 114      */
 115     LAYER_2D,
 116
 117     /**
 118      * @brief UI control rendering mode (default mode).
 119      *
 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.
 122      *
 123      * For the following actor tree the rendering order will be A first, then B & C and finally D,E,F regardless of their
 124      * Z positions.
 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.
 127      *
 128      * @code
 129      *
 130      *     Layer1 (parent)
 131      *       |
 132      *       A
 133      *      / \
 134      *     B   C
 135      *    / \   \
 136      *   D   E   F
 137      *
 138      * @endcode
 139      *
 140      * @SINCE_1_1.45
 141      */
 142     LAYER_UI = LAYER_2D,
 143
 144     /**
 145      * @brief Layer will use depth test.
 146      *
 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.
 157      *
 158      * @SINCE_1_0.0
 159      */
 160     LAYER_3D
 161
 162   };
 163
 164   /**
 165    * @brief TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
 166    * @SINCE_1_0.0
 167    */
 168   enum TreeDepthMultiplier
 169   {
 170     TREE_DEPTH_MULTIPLIER = 10000,
 171   };
 172   /**
 173    * @brief The sort function type
 174    *
 175    * @SINCE_1_0.0
 176    * @param[in] position This is the actor translation from camera.
 177    */
 178   typedef float (*SortFunctionType)( const Vector3& position );
 179
 180   /**
 181    * @brief Create an empty Layer handle.
 182    *
 183    * This can be initialised with Layer::New(...).
 184    * @SINCE_1_0.0
 185    */
 186   Layer();
 187
 188   /**
 189    * @brief Create a Layer object.
 190    *
 191    * @SINCE_1_0.0
 192    * @return A handle to a newly allocated Layer
 193    */
 194   static Layer New();
 195
 196   /**
 197    * @brief Downcast a handle to Layer handle.
 198    *
 199    * If handle points to a Layer the downcast produces valid
 200    * handle. If not the returned handle is left uninitialized.
 201    * @SINCE_1_0.0
 202    * @param[in] handle Handle to An object
 203    * @return Handle to a Layer or an uninitialized handle
 204    */
 205   static Layer DownCast( BaseHandle handle );
 206
 207   /**
 208    * @brief Destructor
 209    *
 210    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 211    * @SINCE_1_0.0
 212    */
 213   ~Layer();
 214
 215   /**
 216    * @brief Copy constructor
 217    *
 218    * @SINCE_1_0.0
 219    * @param [in] copy The actor to copy
 220    */
 221   Layer(const Layer& copy);
 222
 223   /**
 224    * @brief Assignment operator
 225    *
 226    * @SINCE_1_0.0
 227    * @param [in] rhs The actor to copy
 228    * @return A reference to this
 229    */
 230   Layer& operator=(const Layer& rhs);
 231
 232   /**
 233    * @brief Query the depth of the layer
 234    *
 235    * 0 is bottom most layer, higher number is on top.
 236    * @SINCE_1_0.0
 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.
 240    */
 241   unsigned int GetDepth() const;
 242
 243   /**
 244    * @brief Increment the depth of the layer.
 245    *
 246    * @SINCE_1_0.0
 247    * @pre Layer is on the stage.
 248    */
 249   void Raise();
 250
 251   /**
 252    * @brief Decrement the depth of the layer.
 253    *
 254    * @SINCE_1_0.0
 255    * @pre Layer is on the stage.
 256    */
 257   void Lower();
 258
 259   /**
 260    * @brief Ensures the layers depth is greater than the target layer.
 261    *
 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.
 264    * @SINCE_1_0.0
 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.
 269    */
 270   void RaiseAbove( Layer target );
 271
 272   /**
 273    * @brief Ensures the layers depth is less than the target layer.
 274    *
 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.
 277    * @SINCE_1_0.0
 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.
 282    */
 283   void LowerBelow( Layer target );
 284
 285   /**
 286    * @brief Raises the layer to the top.
 287    * @SINCE_1_0.0
 288    * @pre Layer is on the stage.
 289    */
 290   void RaiseToTop();
 291
 292   /**
 293    * @brief Lowers the layer to the bottom.
 294    * @SINCE_1_0.0
 295    * @pre layer is on the stage.
 296    */
 297   void LowerToBottom();
 298
 299   /**
 300    * @brief Moves the layer directly above the given layer.
 301    *
 302    * After the call this layers depth will be immediately above target.
 303    * @SINCE_1_0.0
 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.
 308    */
 309   void MoveAbove( Layer target );
 310
 311   /**
 312    * @brief Moves the layer directly below the given layer.
 313    *
 314    * After the call this layers depth will be immediately below target.
 315    * @SINCE_1_0.0
 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.
 320    */
 321   void MoveBelow( Layer target );
 322
 323   /**
 324    * @brief Set the behavior of the layer.
 325    *
 326    * @SINCE_1_0.0
 327    * @param[in] behavior The desired behavior
 328    */
 329   void SetBehavior( Behavior behavior );
 330
 331   /**
 332    * @brief Get the behavior of the layer.
 333    *
 334    * @SINCE_1_0.0
 335    * @return The behavior of the layer
 336    */
 337   Behavior GetBehavior() const;
 338
 339   /**
 340    * @brief Sets whether clipping is enabled for a layer.
 341    *
 342    * Clipping is initially disabled; see also SetClippingBox().
 343    * @SINCE_1_0.0
 344    * @param [in] enabled True if clipping is enabled.
 345    *
 346    * @note When clipping is enabled, the default clipping box is empty (0,0,0,0) which means everything is clipped.
 347    */
 348   void SetClipping(bool enabled);
 349
 350   /**
 351    * @brief Query whether clipping is enabled for a layer.
 352    * @SINCE_1_0.0
 353    * @return True if clipping is enabled.
 354    */
 355   bool IsClipping() const;
 356
 357   /**
 358    * @brief Sets the clipping box of a layer, in window coordinates.
 359    *
 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.
 363    * @SINCE_1_0.0
 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
 368    */
 369   void SetClippingBox(int x, int y, int width, int height);
 370
 371   /**
 372    * @brief Sets the clipping box of a layer, in window coordinates.
 373    *
 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).
 376    * @SINCE_1_0.0
 377    * @param [in] box The clipping box
 378    */
 379   void SetClippingBox(ClippingBox box);
 380
 381   /**
 382    * @brief Retrieves the clipping box of a layer, in window coordinates.
 383    *
 384    * @SINCE_1_0.0
 385    * @return The clipping box
 386    */
 387   ClippingBox GetClippingBox() const;
 388
 389   // Depth test
 390
 391   /**
 392    * @brief Whether to disable the depth test.
 393    *
 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.
 396    *
 397    * @SINCE_1_0.0
 398    * @param[in] disable \e True disables depth test. \e false sets the default behavior.
 399    */
 400   void SetDepthTestDisabled( bool disable );
 401
 402   /**
 403    * @brief Retrieves whether depth test is disabled.
 404    *
 405    * @SINCE_1_0.0
 406    * @return \e True if depth test is disabled.
 407    */
 408   bool IsDepthTestDisabled() const;
 409
 410   // Sorting
 411
 412   /**
 413    * @brief This allows the user to specify the sort function that the layer should use.
 414    *
 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.
 417    *
 418    * A function of the following type should be used:
 419    * @code
 420    *  float YourSortFunction(const Vector3& position);
 421    * @endcode
 422    *
 423    * @SINCE_1_0.0
 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.
 427    *
 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.
 430    *
 431   */
 432   void SetSortFunction( SortFunctionType function );
 433
 434   /**
 435    * @brief This allows the user to specify whether this layer should consume touch (including gestures).
 436    *
 437    * If set, any layers behind this layer will not be hit-test.
 438    *
 439    * @SINCE_1_0.0
 440    * @param[in]  consume  Whether the layer should consume touch (including gestures).
 441    */
 442   void SetTouchConsumed( bool consume );
 443
 444   /**
 445    * @brief Retrieves whether the layer consumes touch (including gestures).
 446    *
 447    * @SINCE_1_0.0
 448    * @return True if consuming touch, false otherwise.
 449    */
 450   bool IsTouchConsumed() const;
 451
 452   /**
 453    * @brief This allows the user to specify whether this layer should consume hover.
 454    *
 455    * If set, any layers behind this layer will not be hit-test.
 456    *
 457    * @SINCE_1_0.0
 458    * @param[in]  consume  Whether the layer should consume hover.
 459    */
 460   void SetHoverConsumed( bool consume );
 461
 462   /**
 463    * @brief Retrieves whether the layer consumes hover.
 464    *
 465    * @SINCE_1_0.0
 466    * @return True if consuming hover, false otherwise.
 467    */
 468   bool IsHoverConsumed() const;
 469
 470 public: // Not intended for application developers
 471
 472   /**
 473    * @internal
 474    * @brief This constructor is used by Layer::New() methods.
 475    *
 476    * @SINCE_1_0.0
 477    * @param [in] Layer A pointer to a newly allocated Dali resource
 478    */
 479   explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
 480 };
 481
 482 /**
 483  * @}
 484  */
 485 } // namespace Dali
 486
 487 #endif // DALI_LAYER_H