dali/public-api/actors/layer.h

   1 #ifndef __DALI_LAYER_H__
   2 #define __DALI_LAYER_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 namespace Internal DALI_INTERNAL
  32 {
  33 class Layer;
  34 }
  35
  36 /**
  37  * @brief Rectangle describing area on screen that a layer can draw to.
  38  *
  39  * @see Dali::Layer::SetClippingBox()
  40  */
  41 typedef Rect<int> ClippingBox;
  42
  43 /**
  44  * @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
  45  *
  46  * When added to the stage, a layer can be ordered relative to other layers. The bottom
  47  * layer is at depth zero. The stage provides a default layer for it's children.
  48  *
  49  * Layered actors inherit position etc. as normal, but are drawn in an order determined
  50  * by the layers. The depth buffer is cleared before each layer is rendered unless depth
  51  * test is disabled or there's no need for it based on the layers contents;
  52  * actors in lower layers cannot obscure actors in higher layers.
  53  *
  54  * If depth test is disabled, there is no performance overhead from clearing the depth buffer.
  55  *
  56  * Actions
  57  * | %Action Name    | %Layer method called |
  58  * |-----------------|----------------------|
  59  * | raise           | @ref Raise()         |
  60  * | lower           | @ref Lower()         |
  61  * | raise-to-top    | @ref RaiseToTop()    |
  62  * | lower-to-bottom | @ref LowerToBottom() |
  63  */
  64 class DALI_IMPORT_API Layer : public Actor
  65 {
  66 public:
  67
  68   /**
  69    * @brief An enumeration of properties belonging to the Layer class.
  70    * Properties additional to Actor.
  71    */
  72   struct Property
  73   {
  74     enum
  75     {
  76       CLIPPING_ENABLE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "clipping-enable",  type bool
  77       CLIPPING_BOX,                                                 ///< name "clipping-box",     type Rect<int>
  78       BEHAVIOR,                                                     ///< name "behavior",         type String
  79     };
  80   };
  81
  82   /**
  83    * @brief Enumeration for the behavior of the layer.
  84    *
  85    * Check each value to see how it affects the layer.
  86    */
  87   enum Behavior
  88   {
  89     /**
  90      * @brief Layer doesn't make use of the depth test.
  91      *
  92      * This mode is expected to have better performance than the 3D mode.
  93      * When using this mode any ordering would be with respect to depth-index property of Renderers.
  94      */
  95     LAYER_2D,
  96
  97     /**
  98      * @brief Layer will use depth test and do several clears.
  99      *
 100      * When using this mode depth depth test will be used. A depth clear will happen for each distinct
 101      * depth-index value in the layer, opaque renderers are drawn first and write to the depth buffer.
 102      * Then transparent renderers are drawn with depth test enabled but depth write switched off.
 103      */
 104     LAYER_3D,
 105   };
 106
 107   /*
 108    * TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
 109    * For 2D layers, this value will be multiplied to the actor depth in the tree and added to the depth index
 110    * to obtain the value which will be used for ordering
 111    */
 112   enum TreeDepthMultiplier
 113   {
 114     TREE_DEPTH_MULTIPLIER = 10000,
 115   };
 116   /**
 117    * @brief The sort function type.
 118    *
 119    * @param[in] position this is the actor translation from camera.
 120    */
 121   typedef float (*SortFunctionType)( const Vector3& position );
 122
 123   /**
 124    * @brief Create an empty Layer handle.
 125    *
 126    * This can be initialised with Layer::New(...)
 127    */
 128   Layer();
 129
 130   /**
 131    * @brief Create a Layer object.
 132    *
 133    * @return A handle to a newly allocated Layer
 134    */
 135   static Layer New();
 136
 137   /**
 138    * @brief Downcast an Object handle to Layer.
 139    *
 140    * If handle points to a Layer the downcast produces valid
 141    * handle. If not the returned handle is left uninitialized.
 142    * @param[in] handle to An object
 143    * @return handle to a Layer or an uninitialized handle
 144    */
 145   static Layer DownCast( BaseHandle handle );
 146
 147   /**
 148    * @brief Destructor
 149    *
 150    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 151    */
 152   ~Layer();
 153
 154   /**
 155    * @brief Copy constructor
 156    *
 157    * @param [in] copy The actor to copy.
 158    */
 159   Layer(const Layer& copy);
 160
 161   /**
 162    * @brief Assignment operator
 163    *
 164    * @param [in] rhs The actor to copy.
 165    */
 166   Layer& operator=(const Layer& rhs);
 167
 168   /**
 169    * @brief Query the depth of the layer
 170    *
 171    * 0 is bottom most layer, higher number is on top
 172    * @pre layer is on the stage
 173    * If layer is not added to the stage, returns 0.
 174    * @return the current depth of the layer.
 175    */
 176   unsigned int GetDepth() const;
 177
 178   /**
 179    * @brief Increment the depth of the layer.
 180    *
 181    * @pre layer is on the stage
 182    */
 183   void Raise();
 184
 185   /**
 186    * @brief Decrement the depth of the layer.
 187    *
 188    * @pre layer is on the stage
 189    */
 190   void Lower();
 191
 192   /**
 193    * @brief Ensures the layers depth is greater than the target layer.
 194    *
 195    * If the layer already is above target layer its depth is not changed
 196    * If the layer was below target, its new depth will be immediately above target
 197    * Note! All layers between this layer and target get new depth values
 198    * @pre layer is on the stage
 199    * @pre target layer is on the stage
 200    * @param target layer to get above of
 201    */
 202   void RaiseAbove( Layer target );
 203
 204   /**
 205    * @brief Ensures the layers depth is less than the target layer.
 206    *
 207    * If the layer already is below the layer its depth is not changed
 208    * If the layer was above target, its new depth will be immediately below target
 209    * Note! All layers between this layer and target get new depth values
 210    * @pre layer is on the stage
 211    * @pre target layer is on the stage
 212    * @param target layer to get below of
 213    */
 214   void LowerBelow( Layer target );
 215
 216   /**
 217    * @brief Raises the layer to the top.
 218    * @pre layer is on the stage
 219    */
 220   void RaiseToTop();
 221
 222   /**
 223    * @brief Lowers the layer to the bottom.
 224    * @pre layer is on the stage
 225    */
 226   void LowerToBottom();
 227
 228   /**
 229    * @brief Moves the layer directly above the given layer.
 230    *
 231    * After the call this layers depth will be immediately above target
 232    * Note! All layers between this layer and target get new depth values
 233    * @pre layer is on the stage
 234    * @pre target layer is on the stage
 235    * @param target layer to get on top of
 236    */
 237   void MoveAbove( Layer target );
 238
 239   /**
 240    * @brief Moves the layer directly below the given layer.
 241    *
 242    * After the call this layers depth will be immediately below target
 243    * Note! All layers between this layer and target get new depth values
 244    * @pre layer is on the stage
 245    * @pre target layer is on the stage
 246    * @param target layer to get below of
 247    */
 248   void MoveBelow( Layer target );
 249
 250   /**
 251    * @brief Set the behavior of the layer
 252    *
 253    * @param[in] behavior The desired behavior
 254    */
 255   void SetBehavior( Behavior behavior );
 256
 257   /**
 258    * @brief Get the behavior of the layer
 259    *
 260    * @return The behavior of the layer
 261    */
 262   Behavior GetBehavior() const;
 263
 264   /**
 265    * @brief Sets whether clipping is enabled for a layer.
 266    *
 267    * Clipping is initially disabled; see also SetClippingBox().
 268    * @param [in] enabled True if clipping is enabled.
 269    *
 270    * @note When clipping is enabled, the default clipping box is empty (0,0,0,0) which means everything is clipped.
 271    */
 272   void SetClipping(bool enabled);
 273
 274   /**
 275    * @brief Query whether clipping is enabled for a layer.
 276    * @return True if clipping is enabled.
 277    */
 278   bool IsClipping() const;
 279
 280   /**
 281    * @brief Sets the clipping box of a layer, in window coordinates.
 282    *
 283    * The contents of the layer will not be visible outside this box, when clipping is
 284    * enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
 285    * You can only do rectangular clipping using this API in window coordinates.
 286    * For other kinds of clipping, @see Dali::Actor::SetDrawMode().
 287    * @param [in] x The X-coordinate of the top-left corner of the box.
 288    * @param [in] y The Y-coordinate of the top-left corner of the box.
 289    * @param [in] width  The width of the box.
 290    * @param [in] height The height of the box.
 291    */
 292   void SetClippingBox(int x, int y, int width, int height);
 293
 294   /**
 295    * @brief Sets the clipping box of a layer, in window coordinates.
 296    *
 297    * The contents of the layer will not be visible outside this box, when clipping is
 298    * enabled. The default clipping box is empty (0,0,0,0).
 299    * @param [in] box The clipping box
 300    */
 301   void SetClippingBox(ClippingBox box);
 302
 303   /**
 304    * @brief Retrieves the clipping box of a layer, in window coordinates.
 305    *
 306    * @return The clipping box
 307    */
 308   ClippingBox GetClippingBox() const;
 309
 310   // Depth test
 311
 312   /**
 313    * @brief Whether to disable the depth test.
 314    *
 315    * 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.
 316    * However, it's possible to disable the depth test by calling this method.
 317    *
 318    * @param[in] disable \e true disables depth test. \e false sets the default behavior.
 319    */
 320   void SetDepthTestDisabled( bool disable );
 321
 322   /**
 323    * @brief Retrieves whether depth test is disabled.
 324    *
 325    * @return \e true if depth test is disabled.
 326    */
 327   bool IsDepthTestDisabled() const;
 328
 329   // Sorting
 330
 331   /**
 332    * @brief This allows the user to specify the sort function that the layer should use.
 333    *
 334    * The sort function is used to determine the order in which the actors are drawn
 335    * and input is processed on the actors in the layer.
 336    *
 337    * A function of the following type should be used:
 338    * @code
 339    *  float YourSortFunction(const Vector3& position);
 340    * @endcode
 341    *
 342    * @note If the sort function returns a low number, the actor the data applies to will be
 343    * drawn in front of an actor whose data yields a high value from the sort function.
 344    *
 345    * @note All child layers use the same sort function.  If a child layer is added to this
 346    * layer then the sort function used by the child layer will also be the same.
 347    *
 348    * @param[in]  function  The sort function pointer
 349   */
 350   void SetSortFunction( SortFunctionType function );
 351
 352   /**
 353    * @brief This allows the user to specify whether this layer should consume touch (including gestures).
 354    *
 355    * If set, any layers behind this layer will not be hit-test.
 356    *
 357    * @param[in]  consume  Whether the layer should consume touch (including gestures).
 358    */
 359   void SetTouchConsumed( bool consume );
 360
 361   /**
 362    * @brief Retrieves whether the layer consumes touch (including gestures).
 363    *
 364    * @return true if consuming touch, false otherwise.
 365    */
 366   bool IsTouchConsumed() const;
 367
 368   /**
 369    * @brief This allows the user to specify whether this layer should consume hover.
 370    *
 371    * If set, any layers behind this layer will not be hit-test.
 372    *
 373    * @param[in]  consume  Whether the layer should consume hover.
 374    */
 375   void SetHoverConsumed( bool consume );
 376
 377   /**
 378    * @brief Retrieves whether the layer consumes hover.
 379    *
 380    * @return true if consuming hover, false otherwise.
 381    */
 382   bool IsHoverConsumed() const;
 383
 384 public: // Not intended for application developers
 385
 386   /**
 387    * @brief This constructor is used by Dali New() methods.
 388    *
 389    * @param [in] Layer A pointer to a newly allocated Dali resource
 390    */
 391   explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
 392 };
 393
 394 } // namespace Dali
 395
 396 #endif //__DALI_LAYER_H__