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     };
  79   };
  80
  81   /**
  82    * @brief The sort function type.
  83    *
  84    * The position value is the actor translation from camera.
  85    * The sortModifier is the user value that can be used to sort coplanar actors/nodes. This value is
  86    * the one set by calling RenderableActor::SetSortModifier().
  87    *
  88    * A high return value means that the actor will be positioned further away by the sort algorithm.
  89    * @see RenderableActor::SetSortModifier
  90    */
  91   typedef float (*SortFunctionType)(const Vector3& position, float sortModifier);
  92
  93   /**
  94    * @brief Create an empty Layer handle.
  95    *
  96    * This can be initialised with Layer::New(...)
  97    */
  98   Layer();
  99
 100   /**
 101    * @brief Create a Layer object.
 102    *
 103    * @return A handle to a newly allocated Layer
 104    */
 105   static Layer New();
 106
 107   /**
 108    * @brief Downcast an Object handle to Layer.
 109    *
 110    * If handle points to a Layer the downcast produces valid
 111    * handle. If not the returned handle is left uninitialized.
 112    * @param[in] handle to An object
 113    * @return handle to a Layer or an uninitialized handle
 114    */
 115   static Layer DownCast( BaseHandle handle );
 116
 117   /**
 118    * @brief Destructor
 119    *
 120    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 121    */
 122   ~Layer();
 123
 124   /**
 125    * @brief Copy constructor
 126    *
 127    * @param [in] copy The actor to copy.
 128    */
 129   Layer(const Layer& copy);
 130
 131   /**
 132    * @brief Assignment operator
 133    *
 134    * @param [in] rhs The actor to copy.
 135    */
 136   Layer& operator=(const Layer& rhs);
 137
 138   /**
 139    * @brief Query the depth of the layer
 140    *
 141    * 0 is bottom most layer, higher number is on top
 142    * @pre layer is on the stage
 143    * If layer is not added to the stage, returns 0.
 144    * @return the current depth of the layer.
 145    */
 146   unsigned int GetDepth() const;
 147
 148   /**
 149    * @brief Increment the depth of the layer.
 150    *
 151    * @pre layer is on the stage
 152    */
 153   void Raise();
 154
 155   /**
 156    * @brief Decrement the depth of the layer.
 157    *
 158    * @pre layer is on the stage
 159    */
 160   void Lower();
 161
 162   /**
 163    * @brief Ensures the layers depth is greater than the target layer.
 164    *
 165    * If the layer already is above target layer its depth is not changed
 166    * If the layer was below target, its new depth will be immediately above target
 167    * Note! All layers between this layer and target get new depth values
 168    * @pre layer is on the stage
 169    * @pre target layer is on the stage
 170    * @param target layer to get above of
 171    */
 172   void RaiseAbove( Layer target );
 173
 174   /**
 175    * @brief Ensures the layers depth is less than the target layer.
 176    *
 177    * If the layer already is below the layer its depth is not changed
 178    * If the layer was above target, its new depth will be immediately below target
 179    * Note! All layers between this layer and target get new depth values
 180    * @pre layer is on the stage
 181    * @pre target layer is on the stage
 182    * @param target layer to get below of
 183    */
 184   void LowerBelow( Layer target );
 185
 186   /**
 187    * @brief Raises the layer to the top.
 188    * @pre layer is on the stage
 189    */
 190   void RaiseToTop();
 191
 192   /**
 193    * @brief Lowers the layer to the bottom.
 194    * @pre layer is on the stage
 195    */
 196   void LowerToBottom();
 197
 198   /**
 199    * @brief Moves the layer directly above the given layer.
 200    *
 201    * After the call this layers depth will be immediately above target
 202    * Note! All layers between this layer and target get new depth values
 203    * @pre layer is on the stage
 204    * @pre target layer is on the stage
 205    * @param target layer to get on top of
 206    */
 207   void MoveAbove( Layer target );
 208
 209   /**
 210    * @brief Moves the layer directly below the given layer.
 211    *
 212    * After the call this layers depth will be immediately below target
 213    * Note! All layers between this layer and target get new depth values
 214    * @pre layer is on the stage
 215    * @pre target layer is on the stage
 216    * @param target layer to get below of
 217    */
 218   void MoveBelow( Layer target );
 219
 220   /**
 221    * @brief Sets whether clipping is enabled for a layer.
 222    *
 223    * Clipping is initially disabled; see also SetClippingBox().
 224    * @param [in] enabled True if clipping is enabled.
 225    *
 226    * @note When clipping is enabled, the default clipping box is empty (0,0,0,0) which means everything is clipped.
 227    */
 228   void SetClipping(bool enabled);
 229
 230   /**
 231    * @brief Query whether clipping is enabled for a layer.
 232    * @return True if clipping is enabled.
 233    */
 234   bool IsClipping() const;
 235
 236   /**
 237    * @brief Sets the clipping box of a layer, in window coordinates.
 238    *
 239    * The contents of the layer will not be visible outside this box, when clipping is
 240    * enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
 241    * You can only do rectangular clipping using this API in window coordinates.
 242    * For other kinds of clipping, @see Dali::Actor::SetDrawMode().
 243    * @param [in] x The X-coordinate of the top-left corner of the box.
 244    * @param [in] y The Y-coordinate of the top-left corner of the box.
 245    * @param [in] width  The width of the box.
 246    * @param [in] height The height of the box.
 247    */
 248   void SetClippingBox(int x, int y, int width, int height);
 249
 250   /**
 251    * @brief Sets the clipping box of a layer, in window coordinates.
 252    *
 253    * The contents of the layer will not be visible outside this box, when clipping is
 254    * enabled. The default clipping box is empty (0,0,0,0).
 255    * @param [in] box The clipping box
 256    */
 257   void SetClippingBox(ClippingBox box);
 258
 259   /**
 260    * @brief Retrieves the clipping box of a layer, in window coordinates.
 261    *
 262    * @return The clipping box
 263    */
 264   ClippingBox GetClippingBox() const;
 265
 266   // Depth test
 267
 268   /**
 269    * @brief Whether to disable the depth test.
 270    *
 271    * 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.
 272    * However, it's possible to disable the depth test by calling this method.
 273    *
 274    * @param[in] disable \e true disables depth test. \e false sets the default behaviour.
 275    */
 276   void SetDepthTestDisabled( bool disable );
 277
 278   /**
 279    * @brief Retrieves whether depth test is disabled.
 280    *
 281    * @return \e true if depth test is disabled.
 282    */
 283   bool IsDepthTestDisabled() const;
 284
 285   // Sorting
 286
 287   /**
 288    * @brief This sort function sorts translucent actors according to the Z-value in view space.
 289    *
 290    * This is useful for 2D user interfaces.
 291    *
 292    * This is the default sorting function.
 293    *
 294    * We return a negative z value as in our translation, a low z means that it should
 295    * be sorted further away and a high z means that it should be closer.
 296    * @param[in] position     position of actor in view space
 297    * @param[in] sortModifier additional sort modifer
 298    * @return depth
 299    */
 300   static float ZValue(const Vector3& position, float sortModifier);
 301
 302   /**
 303    * @brief This allows the user to specify the sort function that the layer should use.
 304    *
 305    * The sort function is used to determine the order in which the actors are drawn
 306    * and input is processed on the actors in the layer.
 307    *
 308    * A function of the following type should be used:
 309    * @code
 310    *  float YourSortFunction(const Vector3& position, float sortModifier);
 311    * @endcode
 312    *
 313    * @note If the sort function returns a low number, the actor the data applies to will be
 314    * drawn in front of an actor whose data yields a high value from the sort function.
 315    *
 316    * @note All child layers use the same sort function.  If a child layer is added to this
 317    * layer then the sort function used by the child layer will also be the same.
 318    *
 319    * @param[in]  function  The sort function pointer
 320   */
 321   void SetSortFunction( SortFunctionType function );
 322
 323   /**
 324    * @brief This allows the user to specify whether this layer should consume touch (including gestures).
 325    *
 326    * If set, any layers behind this layer will not be hit-test.
 327    *
 328    * @param[in]  consume  Whether the layer should consume touch (including gestures).
 329    */
 330   void SetTouchConsumed( bool consume );
 331
 332   /**
 333    * @brief Retrieves whether the layer consumes touch (including gestures).
 334    *
 335    * @return true if consuming touch, false otherwise.
 336    */
 337   bool IsTouchConsumed() const;
 338
 339   /**
 340    * @brief This allows the user to specify whether this layer should consume hover.
 341    *
 342    * If set, any layers behind this layer will not be hit-test.
 343    *
 344    * @param[in]  consume  Whether the layer should consume hover.
 345    */
 346   void SetHoverConsumed( bool consume );
 347
 348   /**
 349    * @brief Retrieves whether the layer consumes hover.
 350    *
 351    * @return true if consuming hover, false otherwise.
 352    */
 353   bool IsHoverConsumed() const;
 354
 355 public: // Not intended for application developers
 356
 357   /**
 358    * @brief This constructor is used by Dali New() methods.
 359    *
 360    * @param [in] Layer A pointer to a newly allocated Dali resource
 361    */
 362   explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
 363 };
 364
 365 } // namespace Dali
 366
 367 #endif //__DALI_LAYER_H__