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