dali/public-api/actors/actor.h

   1 #ifndef DALI_ACTOR_H
   2 #define DALI_ACTOR_H
   3
   4 /*
   5  * Copyright (c) 2018 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 // EXTERNAL INCLUDES
  22 #include <string>
  23 #include <cstdint> // uint32_t
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/actors/actor-enumerations.h>
  27 #include <dali/public-api/actors/draw-mode.h>
  28 #include <dali/public-api/math/radian.h>
  29 #include <dali/public-api/object/handle.h>
  30 #include <dali/public-api/object/property-index-ranges.h>
  31 #include <dali/public-api/signals/dali-signal.h>
  32
  33 #undef SIZE_WIDTH // Defined in later versions of cstdint but is used in this header
  34
  35 namespace Dali
  36 {
  37 /**
  38  * @addtogroup dali_core_actors
  39  * @{
  40  */
  41
  42 namespace Internal DALI_INTERNAL
  43 {
  44 class Actor;
  45 }
  46
  47 class Actor;
  48 class Renderer;
  49 struct Degree;
  50 class Quaternion;
  51 class Layer;
  52 struct KeyEvent;
  53 class TouchData;
  54 struct TouchEvent;
  55 struct HoverEvent;
  56 struct WheelEvent;
  57 struct Vector2;
  58 struct Vector3;
  59 struct Vector4;
  60
  61 typedef Rect<float> Padding;      ///< Padding definition @SINCE_1_0.0
  62
  63 /**
  64  * @brief Actor is the primary object with which Dali applications interact.
  65  *
  66  * UI controls can be built by combining multiple actors.
  67  *
  68  * <h3>Multi-Touch Events:</h3>
  69  *
  70  * Touch or hover events are received via signals; see Actor::TouchedSignal() and Actor::HoveredSignal() for more details.
  71  *
  72  * <i>Hit Testing Rules Summary:</i>
  73  *
  74  * - An actor is only hittable if the actor's touch or hover signal has a connection.
  75  * - An actor is only hittable when it is between the camera's near and far planes.
  76  * - If an actor is made insensitive, then the actor and its children are not hittable; see IsSensitive().
  77  * - If an actor's visibility flag is unset, then none of its children are hittable either; see IsVisible().
  78  * - To be hittable, an actor must have a non-zero size.
  79  * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor().
  80  *
  81  * <i>Hit Test Algorithm:</i>
  82  *
  83  * - Stage
  84  *   - Gets the first down and the last up touch events to the screen, regardless of actor touch event consumption.
  85  *   - Stage's root layer can be used to catch unconsumed touch events.
  86  *
  87  * - RenderTasks
  88  *   - Hit testing is dependent on the camera used, which is specific to each RenderTask.
  89  *
  90  * - Layers
  91  *   - For each RenderTask, hit testing starts from the top-most layer and we go through all the
  92  *     layers until we have a hit or there are none left.
  93  *   - Before we perform a hit test within a layer, we check if all the layer's parents are visible
  94  *     and sensitive.
  95  *   - If they are not, we skip hit testing the actors in that layer altogether.
  96  *   - If a layer is set to consume all touch, then we do not check any layers behind this layer.
  97  *
  98  * - Actors
  99  *   - The final part of hit testing is performed by walking through the actor tree within a layer.
 100  *   - The following pseudocode shows the algorithm used:
 101  *     @code
 102  *     HIT-TEST-WITHIN-LAYER( ACTOR )
 103  *     {
 104  *       // Only hit-test the actor and its children if it is sensitive and visible
 105  *       IF ( ACTOR-IS-SENSITIVE &&
 106  *            ACTOR-IS-VISIBLE &&
 107  *            ACTOR-IS-ON-STAGE )
 108  *       {
 109  *         // Depth-first traversal within current layer, visiting parent first
 110  *
 111  *         // Check whether current actor should be hit-tested.
 112  *         IF ( ( TOUCH-SIGNAL-NOT-EMPTY || HOVER-SIGNAL-NOT-EMPTY ) &&
 113  *              ACTOR-HAS-NON-ZERO-SIZE &&
 114  *              ACTOR-WORLD-COLOR-IS-NOT-TRANSPARENT )
 115  *         {
 116  *           // Hit-test current actor
 117  *           IF ( ACTOR-HIT )
 118  *           {
 119  *             IF ( ACTOR-IS-OVERLAY || ( DISTANCE-TO-ACTOR < DISTANCE-TO-LAST-HIT-ACTOR ) )
 120  *             {
 121  *               // The current actor is the closest actor that was underneath the touch.
 122  *               LAST-HIT-ACTOR = CURRENT-ACTOR
 123  *             }
 124  *           }
 125  *         }
 126  *
 127  *         // Keep checking children, in case we hit something closer.
 128  *         FOR-EACH CHILD (in order)
 129  *         {
 130  *           IF ( CHILD-IS-NOT-A-LAYER )
 131  *           {
 132  *             // Continue traversal for this child's sub-tree
 133  *             HIT-TEST-WITHIN-LAYER ( CHILD )
 134  *           }
 135  *           // else we skip hit-testing the child's sub-tree altogether.
 136  *         }
 137  *       }
 138  *     }
 139  *     @endcode
 140  *   - Overlays always take priority (i.e. they're considered closer) regardless of distance.
 141  *     The overlay children take priority over their parents, and overlay siblings take priority
 142  *     over their previous siblings (i.e. reverse of rendering order):
 143  *     @code
 144  *           1
 145  *          / \
 146  *         /   \
 147  *        2     5
 148  *       / \     \
 149  *      /   \     \
 150  *     3     4     6
 151  *
 152  *     Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest.
 153  *     @endcode
 154  *     For more information, see SetDrawMode().
 155  *
 156  * <i>Touch or hover Event Delivery:</i>
 157  *
 158  * - Delivery
 159  *   - The hit actor's touch or hover signal is emitted first; if it is not consumed by any of the listeners,
 160  *     the parent's touch or hover signal is emitted, and so on.
 161  *   - The following pseudocode shows the delivery mechanism:
 162  *     @code
 163  *     EMIT-TOUCH-SIGNAL( ACTOR )
 164  *     {
 165  *       IF ( TOUCH-SIGNAL-NOT-EMPTY )
 166  *       {
 167  *         // Only do the emission if touch signal of actor has connections.
 168  *         CONSUMED = TOUCHED-SIGNAL( TOUCH-EVENT )
 169  *       }
 170  *
 171  *       IF ( NOT-CONSUMED )
 172  *       {
 173  *         // If event is not consumed then deliver it to the parent unless we reach the root actor
 174  *         IF ( ACTOR-PARENT )
 175  *         {
 176  *           EMIT-TOUCH-SIGNAL( ACTOR-PARENT )
 177  *         }
 178  *       }
 179  *     }
 180  *
 181  *     EMIT-HOVER-SIGNAL( ACTOR )
 182  *     {
 183  *       IF ( HOVER-SIGNAL-NOT-EMPTY )
 184  *       {
 185  *         // Only do the emission if hover signal of actor has connections.
 186  *         CONSUMED = HOVERED-SIGNAL( HOVER-EVENT )
 187  *       }
 188  *
 189  *       IF ( NOT-CONSUMED )
 190  *       {
 191  *         // If event is not consumed then deliver it to the parent unless we reach the root actor.
 192  *         IF ( ACTOR-PARENT )
 193  *         {
 194  *           EMIT-HOVER-SIGNAL( ACTOR-PARENT )
 195  *         }
 196  *       }
 197  *     }
 198  *     @endcode
 199  *   - If there are several touch points, then the delivery is only to the first touch point's hit
 200  *     actor (and its parents). There will be NO touch or hover signal delivery for the hit actors of the
 201  *     other touch points.
 202  *   - The local coordinates are from the top-left (0.0f, 0.0f, 0.5f) of the hit actor.
 203  *
 204  * - Leave State
 205  *   - A "Leave" state is set when the first point exits the bounds of the previous first point's
 206  *     hit actor (primary hit actor).
 207  *   - When this happens, the last primary hit actor's touch or hover signal is emitted with a "Leave" state
 208  *     (only if it requires leave signals); see SetLeaveRequired().
 209  *
 210  * - Interrupted State
 211  *   - If a system event occurs which interrupts the touch or hover processing, then the last primary hit
 212  *     actor's touch or hover signals are emitted with an "Interrupted" state.
 213  *   - If the last primary hit actor, or one of its parents, is no longer touchable or hoverable, then its
 214  *     touch or hover signals are also emitted with an "Interrupted" state.
 215  *   - If the consumed actor on touch-down is not the same as the consumed actor on touch-up, then
 216  *     touch signals are also emitted from the touch-down actor with an "Interrupted" state.
 217  *   - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
 218  *     hover signals are also emitted from the hover-started actor with an "Interrupted" state.
 219  *
 220  * <h3>Key Events:</h3>
 221  *
 222  * Key events are received by an actor once set to grab key events, only one actor can be set as focused.
 223  *
 224  * @nosubgrouping
 225  *
 226  * Signals
 227  * | %Signal Name      | Method                       |
 228  * |-------------------|------------------------------|
 229  * | touched           | @ref TouchedSignal()         |
 230  * | hovered           | @ref HoveredSignal()         |
 231  * | wheelEvent        | @ref WheelEventSignal()      |
 232  * | onStage           | @ref OnStageSignal()         |
 233  * | offStage          | @ref OffStageSignal()        |
 234  * | onRelayout        | @ref OnRelayoutSignal()      |
 235  *
 236  * Actions
 237  * | %Action Name      | %Actor method called         |
 238  * |-------------------|------------------------------|
 239  * | show              | %SetVisible( true )          |
 240  * | hide              | %SetVisible( false )         |
 241  * @SINCE_1_0.0
 242  */
 243
 244 class DALI_CORE_API Actor : public Handle
 245 {
 246 public:
 247
 248   /**
 249    * @brief Enumeration for the instance of properties belonging to the Actor class.
 250    * @SINCE_1_0.0
 251    */
 252   struct Property
 253   {
 254     /**
 255      * @brief Enumeration for instance of properties belonging to the Actor class.
 256      * @SINCE_1_0.0
 257      */
 258     enum
 259     {
 260       PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "parentOrigin",          type Vector3     (constraint-input) @SINCE_1_0.0
 261       PARENT_ORIGIN_X,                                    ///< name "parentOriginX",         type float       (constraint-input) @SINCE_1_0.0
 262       PARENT_ORIGIN_Y,                                    ///< name "parentOriginY",         type float       (constraint-input) @SINCE_1_0.0
 263       PARENT_ORIGIN_Z,                                    ///< name "parentOriginZ",         type float       (constraint-input) @SINCE_1_0.0
 264       ANCHOR_POINT,                                       ///< name "anchorPoint",           type Vector3     (constraint-input) @SINCE_1_0.0
 265       ANCHOR_POINT_X,                                     ///< name "anchorPointX",          type float       (constraint-input) @SINCE_1_0.0
 266       ANCHOR_POINT_Y,                                     ///< name "anchorPointY",          type float       (constraint-input) @SINCE_1_0.0
 267       ANCHOR_POINT_Z,                                     ///< name "anchorPointZ",          type float       (constraint-input) @SINCE_1_0.0
 268       SIZE,                                               ///< name "size",                  type Vector3     (animatable / constraint-input) @SINCE_1_0.0
 269       SIZE_WIDTH,                                         ///< name "sizeWidth",             type float       (animatable / constraint-input) @SINCE_1_0.0
 270       SIZE_HEIGHT,                                        ///< name "sizeHeight",            type float       (animatable / constraint-input) @SINCE_1_0.0
 271       SIZE_DEPTH,                                         ///< name "sizeDepth",             type float       (animatable / constraint-input) @SINCE_1_0.0
 272       POSITION,                                           ///< name "position",              type Vector3     (animatable / constraint-input) @SINCE_1_0.0
 273       POSITION_X,                                         ///< name "positionX",             type float       (animatable / constraint-input) @SINCE_1_0.0
 274       POSITION_Y,                                         ///< name "positionY",             type float       (animatable / constraint-input) @SINCE_1_0.0
 275       POSITION_Z,                                         ///< name "positionZ",             type float       (animatable / constraint-input) @SINCE_1_0.0
 276       WORLD_POSITION,                                     ///< name "worldPosition",         type Vector3     (read-only / constraint-input) @SINCE_1_0.0
 277       WORLD_POSITION_X,                                   ///< name "worldPositionX",        type float       (read-only / constraint-input) @SINCE_1_0.0
 278       WORLD_POSITION_Y,                                   ///< name "worldPositionY",        type float       (read-only / constraint-input) @SINCE_1_0.0
 279       WORLD_POSITION_Z,                                   ///< name "worldPositionZ",        type float       (read-only / constraint-input) @SINCE_1_0.0
 280       ORIENTATION,                                        ///< name "orientation",           type Quaternion  (animatable / constraint-input) @SINCE_1_0.0
 281       WORLD_ORIENTATION,                                  ///< name "worldOrientation",      type Quaternion  (read-only / constraint-input) @SINCE_1_0.0
 282       SCALE,                                              ///< name "scale",                 type Vector3     (animatable / constraint-input) @SINCE_1_0.0
 283       SCALE_X,                                            ///< name "scaleX",                type float       (animatable / constraint-input) @SINCE_1_0.0
 284       SCALE_Y,                                            ///< name "scaleY",                type float       (animatable / constraint-input) @SINCE_1_0.0
 285       SCALE_Z,                                            ///< name "scaleZ",                type float       (animatable / constraint-input) @SINCE_1_0.0
 286       WORLD_SCALE,                                        ///< name "worldScale",            type Vector3     (read-only / constraint-input) @SINCE_1_0.0
 287       VISIBLE,                                            ///< name "visible",               type bool        (animatable / constraint-input) @SINCE_1_0.0
 288       COLOR,                                              ///< name "color",                 type Vector4     (animatable / constraint-input) @SINCE_1_0.0
 289       COLOR_RED,                                          ///< name "colorRed",              type float       (animatable / constraint-input) @SINCE_1_0.0
 290       COLOR_GREEN,                                        ///< name "colorGreen",            type float       (animatable / constraint-input) @SINCE_1_0.0
 291       COLOR_BLUE,                                         ///< name "colorBlue",             type float       (animatable / constraint-input) @SINCE_1_0.0
 292       COLOR_ALPHA,                                        ///< name "colorAlpha",            type float       (animatable / constraint-input) @SINCE_1_0.0
 293       WORLD_COLOR,                                        ///< name "worldColor",            type Vector4     (read-only / constraint-input) @SINCE_1_0.0
 294       WORLD_MATRIX,                                       ///< name "worldMatrix",           type Matrix      (read-only / constraint-input) @SINCE_1_0.0
 295       NAME,                                               ///< name "name",                  type std::string @SINCE_1_0.0
 296       SENSITIVE,                                          ///< name "sensitive",             type bool        @SINCE_1_0.0
 297       LEAVE_REQUIRED,                                     ///< name "leaveRequired",         type bool        @SINCE_1_0.0
 298       INHERIT_ORIENTATION,                                ///< name "inheritOrientation",    type bool        @SINCE_1_0.0
 299       INHERIT_SCALE,                                      ///< name "inheritScale",          type bool        @SINCE_1_0.0
 300       COLOR_MODE,                                         ///< name "colorMode",             type std::string @SINCE_1_0.0
 301       RESERVED_PROPERTY_01,                               ///< name "reservedProperty01", This property is removed because it's deprecated.
 302       DRAW_MODE,                                          ///< name "drawMode",              type std::string @SINCE_1_0.0
 303       SIZE_MODE_FACTOR,                                   ///< name "sizeModeFactor",        type Vector3     @SINCE_1_0.0
 304       WIDTH_RESIZE_POLICY,                                ///< name "widthResizePolicy",     type String      @SINCE_1_0.0
 305       HEIGHT_RESIZE_POLICY,                               ///< name "heightResizePolicy",    type String      @SINCE_1_0.0
 306       SIZE_SCALE_POLICY,                                  ///< name "sizeScalePolicy",       type String      @SINCE_1_0.0
 307       WIDTH_FOR_HEIGHT,                                   ///< name "widthForHeight",        type bool        @SINCE_1_0.0
 308       HEIGHT_FOR_WIDTH,                                   ///< name "heightForWidth",        type bool        @SINCE_1_0.0
 309       PADDING,                                            ///< name "padding",               type Vector4     @SINCE_1_0.0
 310       MINIMUM_SIZE,                                       ///< name "minimumSize",           type Vector2     @SINCE_1_0.0
 311       MAXIMUM_SIZE,                                       ///< name "maximumSize",           type Vector2     @SINCE_1_0.0
 312       INHERIT_POSITION,                                   ///< name "inheritPosition",       type bool        @SINCE_1_1.24
 313       CLIPPING_MODE,                                      ///< name "clippingMode",          type String      @SINCE_1_2_5
 314
 315       /**
 316        * @brief The direction of the layout.
 317        * @details Name "layoutDirection", type LayoutDirection::Type (Property::INTEGER) or Property::STRING.
 318        * @SINCE_1_2.60
 319        * @see LayoutDirection::Type for supported values.
 320        */
 321       LAYOUT_DIRECTION,
 322
 323       /**
 324        * @brief Determines whether child actors inherit the layout direction from a parent.
 325        * @details Name "layoutDirectionInheritance", type Property::BOOLEAN.
 326        * @SINCE_1_2.60
 327        */
 328       INHERIT_LAYOUT_DIRECTION,
 329     };
 330   };
 331
 332   // Typedefs
 333
 334   typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType;        ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
 335   typedef Signal< bool (Actor, const TouchData&) >  TouchDataSignalType;    ///< Touch signal type @SINCE_1_1.37
 336   typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType;        ///< Hover signal type @SINCE_1_0.0
 337   typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type @SINCE_1_0.0
 338   typedef Signal< void (Actor) > OnStageSignalType;                         ///< Stage connection signal type @SINCE_1_0.0
 339   typedef Signal< void (Actor) > OffStageSignalType;                        ///< Stage disconnection signal type @SINCE_1_0.0
 340   typedef Signal< void (Actor) > OnRelayoutSignalType;                      ///< Called when the actor is relaid out @SINCE_1_0.0
 341   typedef Signal< void ( Actor, LayoutDirection::Type ) > LayoutDirectionChangedSignalType; ///< Layout direction changes signal type. @SINCE_1_2.60
 342
 343   // Creation
 344
 345   /**
 346    * @brief Creates an uninitialized Actor; this can be initialized with Actor::New().
 347    *
 348    * Calling member functions with an uninitialized Actor handle is not allowed.
 349    * @SINCE_1_0.0
 350    */
 351   Actor();
 352
 353   /**
 354    * @brief Creates an initialized Actor.
 355    *
 356    * @SINCE_1_0.0
 357    * @return A handle to a newly allocated Dali resource
 358    */
 359   static Actor New();
 360
 361   /**
 362    * @brief Downcasts a handle to Actor handle.
 363    *
 364    * If handle points to an Actor object, the downcast produces valid handle.
 365    * If not, the returned handle is left uninitialized.
 366    *
 367    * @SINCE_1_0.0
 368    * @param[in] handle to An object
 369    * @return handle to a Actor object or an uninitialized handle
 370    */
 371   static Actor DownCast( BaseHandle handle );
 372
 373   /**
 374    * @brief Dali::Actor is intended as a base class.
 375    *
 376    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 377    * @SINCE_1_0.0
 378    */
 379   ~Actor();
 380
 381   /**
 382    * @brief Copy constructor.
 383    *
 384    * @SINCE_1_0.0
 385    * @param[in] copy The actor to copy
 386    */
 387   Actor(const Actor& copy);
 388
 389   /**
 390    * @brief Assignment operator
 391    *
 392    * @SINCE_1_0.0
 393    * @param[in] rhs The actor to copy
 394    * @return A reference to this
 395    */
 396   Actor& operator=(const Actor& rhs);
 397
 398   /**
 399    * @brief Retrieves the Actor's name.
 400    *
 401    * @SINCE_1_0.0
 402    * @return The Actor's name
 403    * @pre The Actor has been initialized.
 404    */
 405   const std::string& GetName() const;
 406
 407   /**
 408    * @brief Sets the Actor's name.
 409    *
 410    * @SINCE_1_0.0
 411    * @param[in] name The new name
 412    * @pre The Actor has been initialized.
 413    */
 414   void SetName(const std::string& name);
 415
 416   /**
 417    * @brief Retrieves the unique ID of the actor.
 418    *
 419    * @SINCE_1_0.0
 420    * @return The ID
 421    * @pre The Actor has been initialized.
 422    */
 423   uint32_t GetId() const;
 424
 425   // Containment
 426
 427   /**
 428    * @brief Queries whether an actor is the root actor, which is owned by the Stage.
 429    *
 430    * @SINCE_1_0.0
 431    * @return True if the actor is the root actor
 432    * @pre The Actor has been initialized.
 433    */
 434   bool IsRoot() const;
 435
 436   /**
 437    * @brief Queries whether the actor is connected to the Stage.
 438    *
 439    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
 440    * @SINCE_1_0.0
 441    * @return True if the actor is connected to the Stage
 442    * @pre The Actor has been initialized.
 443    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
 444    */
 445   bool OnStage() const;
 446
 447   /**
 448    * @brief Queries whether the actor is of class Dali::Layer.
 449    *
 450    * @SINCE_1_0.0
 451    * @return True if the actor is a layer
 452    * @pre The Actor has been initialized.
 453    */
 454   bool IsLayer() const;
 455
 456   /**
 457    * @brief Gets the layer in which the actor is present.
 458    *
 459    * @SINCE_1_0.0
 460    * @return The layer, which will be uninitialized if the actor is off-stage
 461    * @pre The Actor has been initialized.
 462    */
 463   Layer GetLayer();
 464
 465   /**
 466    * @brief Adds a child Actor to this Actor.
 467    *
 468    * @SINCE_1_0.0
 469    * @param[in] child The child
 470    * @pre This Actor (the parent) has been initialized.
 471    * @pre The child actor has been initialized.
 472    * @pre The child actor is not the same as the parent actor.
 473    * @pre The actor is not the Root actor.
 474    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 475    * even if the handle passed into this method is reset or destroyed.
 476    * @note If the child already has a parent, it will be removed from old parent
 477    * and reparented to this actor. This may change child's position, color,
 478    * scale etc as it now inherits them from this actor.
 479    */
 480   void Add(Actor child);
 481
 482   /**
 483    * @brief Removes a child Actor from this Actor.
 484    *
 485    * If the actor was not a child of this actor, this is a no-op.
 486    * @SINCE_1_0.0
 487    * @param[in] child The child
 488    * @pre This Actor (the parent) has been initialized.
 489    * @pre The child actor is not the same as the parent actor.
 490    */
 491   void Remove(Actor child);
 492
 493   /**
 494    * @brief Removes an actor from its parent.
 495    *
 496    * If the actor has no parent, this method does nothing.
 497    * @SINCE_1_0.0
 498    * @pre The (child) actor has been initialized.
 499    */
 500   void Unparent();
 501
 502   /**
 503    * @brief Retrieves the number of children held by the actor.
 504    *
 505    * @SINCE_1_0.0
 506    * @return The number of children
 507    * @pre The Actor has been initialized.
 508    */
 509   uint32_t GetChildCount() const;
 510
 511   /**
 512    * @brief Retrieve and child actor by index.
 513    *
 514    * @SINCE_1_0.0
 515    * @param[in] index The index of the child to retrieve
 516    * @return The actor for the given index or empty handle if children not initialized
 517    * @pre The Actor has been initialized.
 518    */
 519   Actor GetChildAt( uint32_t index ) const;
 520
 521   /**
 522    * @brief Search through this actor's hierarchy for an actor with the given name.
 523    *
 524    * The actor itself is also considered in the search.
 525    * @SINCE_1_0.0
 526    * @param[in] actorName The name of the actor to find
 527    * @return A handle to the actor if found, or an empty handle if not
 528    * @pre The Actor has been initialized.
 529    */
 530   Actor FindChildByName(const std::string& actorName);
 531
 532   /**
 533    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 534    *
 535    * The actor itself is also considered in the search.
 536    * @SINCE_1_0.0
 537    * @param[in] id The ID of the actor to find
 538    * @return A handle to the actor if found, or an empty handle if not
 539    * @pre The Actor has been initialized.
 540    */
 541   Actor FindChildById( const uint32_t id );
 542
 543   /**
 544    * @brief Retrieves the actor's parent.
 545    *
 546    * @SINCE_1_0.0
 547    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid
 548    * @pre The actor has been initialized.
 549    */
 550   Actor GetParent() const;
 551
 552   // Positioning
 553
 554   /**
 555    * @brief Sets the origin of an actor, within its parent's area.
 556    *
 557    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 558    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 559    * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
 560    * An actor's position is the distance between this origin, and the actor's anchor-point.
 561    * @image html parent-origin.png
 562    * @SINCE_1_0.0
 563    * @param[in] origin The new parent-origin
 564    * @pre The Actor has been initialized.
 565    * @see Dali::ParentOrigin for predefined parent origin values
 566    */
 567   void SetParentOrigin(const Vector3& origin);
 568
 569   /**
 570    * @brief Retrieves the parent-origin of an actor.
 571    *
 572    * @SINCE_1_0.0
 573    * @return The current parent-origin
 574    * @pre The Actor has been initialized.
 575    */
 576   Vector3 GetCurrentParentOrigin() const;
 577
 578   /**
 579    * @brief Sets the anchor-point of an actor.
 580    *
 581    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
 582    * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
 583    * bottom-right corner. The default anchor point is
 584    * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
 585    * An actor position is the distance between its parent-origin and this anchor-point.
 586    * An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
 587    * @image html anchor-point.png
 588    * @SINCE_1_0.0
 589    * @param[in] anchorPoint The new anchor-point
 590    * @pre The Actor has been initialized.
 591    * @see Dali::AnchorPoint for predefined anchor point values
 592    */
 593   void SetAnchorPoint(const Vector3& anchorPoint);
 594
 595   /**
 596    * @brief Retrieves the anchor-point of an actor.
 597    *
 598    * @SINCE_1_0.0
 599    * @return The current anchor-point
 600    * @pre The Actor has been initialized.
 601    */
 602   Vector3 GetCurrentAnchorPoint() const;
 603
 604   /**
 605    * @brief Sets the size of an actor.
 606    *
 607    * Geometry can be scaled to fit within this area.
 608    * This does not interfere with the actors scale factor.
 609    * The actors default depth is the minimum of width & height.
 610    * @SINCE_1_0.0
 611    * @param [in] width The new width
 612    * @param [in] height The new height
 613    * @pre The actor has been initialized.
 614    */
 615   void SetSize(float width, float height);
 616
 617   /**
 618    * @brief Sets the size of an actor.
 619    *
 620    * Geometry can be scaled to fit within this area.
 621    * This does not interfere with the actors scale factor.
 622    * @SINCE_1_0.0
 623    * @param[in] width The size of the actor along the x-axis
 624    * @param[in] height The size of the actor along the y-axis
 625    * @param[in] depth The size of the actor along the z-axis
 626    * @pre The actor has been initialized.
 627    */
 628   void SetSize(float width, float height, float depth);
 629
 630   /**
 631    * @brief Sets the size of an actor.
 632    *
 633    * Geometry can be scaled to fit within this area.
 634    * This does not interfere with the actors scale factor.
 635    * The actors default depth is the minimum of width & height.
 636    * @SINCE_1_0.0
 637    * @param[in] size The new size
 638    * @pre The actor has been initialized.
 639    */
 640   void SetSize(const Vector2& size);
 641
 642   /**
 643    * @brief Sets the size of an actor.
 644    *
 645    * Geometry can be scaled to fit within this area.
 646    * This does not interfere with the actors scale factor.
 647    * @SINCE_1_0.0
 648    * @param [in] size The new size
 649    * @pre The actor has been initialized.
 650    */
 651   void SetSize(const Vector3& size);
 652
 653   /**
 654    * @brief Retrieves the actor's size.
 655    *
 656    * @SINCE_1_0.0
 657    * @return The actor's target size
 658    * @pre The actor has been initialized.
 659    * @note This return is the value that was set using SetSize or the target size of an animation.
 660    *       It may not match the current value in some cases, i.e. when the animation is progressing or the maximum or minimum size is set.
 661    */
 662   Vector3 GetTargetSize() const;
 663
 664   /**
 665    * @brief Retrieves the actor's size.
 666    *
 667    * @SINCE_1_0.0
 668    * @return The actor's current size
 669    * @pre The actor has been initialized.
 670    * @note This property can be animated; the return value may not match the value written with SetSize().
 671    */
 672   Vector3 GetCurrentSize() const;
 673
 674   /**
 675    * @brief Returns the natural size of the actor.
 676    *
 677    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 678    *
 679    * @SINCE_1_0.0
 680    * @return The actor's natural size
 681    */
 682   Vector3 GetNaturalSize() const;
 683
 684   /**
 685    * @brief Sets the position of the Actor.
 686    *
 687    * By default, sets the position vector between the parent origin and anchor point (default).
 688    *
 689    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 690    *
 691    * @image html actor-position.png
 692    * The Actor's z position will be set to 0.0f.
 693    * @SINCE_1_0.0
 694    * @param[in] x The new x position
 695    * @param[in] y The new y position
 696    * @pre The Actor has been initialized.
 697    */
 698   void SetPosition(float x, float y);
 699
 700   /**
 701    * @brief Sets the position of the Actor.
 702    *
 703    * By default, sets the position vector between the parent origin and anchor point (default).
 704    *
 705    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 706    *
 707    * @image html actor-position.png
 708    * @SINCE_1_0.0
 709    * @param[in] x The new x position
 710    * @param[in] y The new y position
 711    * @param[in] z The new z position
 712    * @pre The Actor has been initialized.
 713    */
 714   void SetPosition(float x, float y, float z);
 715
 716   /**
 717    * @brief Sets the position of the Actor.
 718    *
 719    * By default, sets the position vector between the parent origin and anchor point (default).
 720    *
 721    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 722    *
 723    * @image html actor-position.png
 724    * @SINCE_1_0.0
 725    * @param[in] position The new position
 726    * @pre The Actor has been initialized.
 727    */
 728   void SetPosition(const Vector3& position);
 729
 730   /**
 731    * @brief Sets the position of an actor along the X-axis.
 732    *
 733    * @SINCE_1_0.0
 734    * @param[in] x The new x position
 735    * @pre The Actor has been initialized.
 736    */
 737   void SetX(float x);
 738
 739   /**
 740    * @brief Sets the position of an actor along the Y-axis.
 741    *
 742    * @SINCE_1_0.0
 743    * @param[in] y The new y position
 744    * @pre The Actor has been initialized.
 745    */
 746   void SetY(float y);
 747
 748   /**
 749    * @brief Sets the position of an actor along the Z-axis.
 750    *
 751    * @SINCE_1_0.0
 752    * @param[in] z The new z position
 753    * @pre The Actor has been initialized.
 754    */
 755   void SetZ(float z);
 756
 757   /**
 758    * @brief Translates an actor relative to its existing position.
 759    *
 760    * @SINCE_1_0.0
 761    * @param[in] distance The actor will move by this distance
 762    * @pre The actor has been initialized.
 763    */
 764   void TranslateBy(const Vector3& distance);
 765
 766   /**
 767    * @brief Retrieves the position of the Actor.
 768    *
 769    * @SINCE_1_0.0
 770    * @return The Actor's current position
 771    * @pre The Actor has been initialized.
 772    * @note This property can be animated; the return value may not match the value written with SetPosition().
 773    */
 774   Vector3 GetCurrentPosition() const;
 775
 776   /**
 777    * @brief Retrieves the world-position of the Actor.
 778    *
 779    * @SINCE_1_0.0
 780    * @return The Actor's current position in world coordinates
 781    * @pre The Actor has been initialized.
 782    * @note The actor may not have a world-position unless it has been added to the stage.
 783    */
 784   Vector3 GetCurrentWorldPosition() const;
 785
 786   /**
 787    * @brief Sets whether a child actor inherits it's parent's position.
 788    *
 789    * Default is to inherit.
 790    * Switching this off means that using SetPosition() sets the actor's world position, i.e. translates from
 791    * the world origin (0,0,0) to the anchor point of the actor.
 792    * @SINCE_1_1.24
 793    * @param[in] inherit - @c true if the actor should inherit position, @c false otherwise
 794    * @pre The Actor has been initialized.
 795    */
 796   inline void SetInheritPosition( bool inherit )
 797   {
 798     SetProperty(Property::INHERIT_POSITION, inherit );
 799   }
 800
 801   /**
 802    * @brief Returns whether the actor inherits its parent's position.
 803    *
 804    * @SINCE_1_1.24
 805    * @return @c true if the actor inherits its parent position, @c false if it uses world position
 806    * @pre The Actor has been initialized.
 807    */
 808   inline bool IsPositionInherited() const
 809   {
 810     return GetProperty(Property::INHERIT_POSITION ).Get<bool>();
 811   }
 812
 813   /**
 814    * @brief Sets the orientation of the Actor.
 815    *
 816    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 817    * @SINCE_1_0.0
 818    * @param[in] angle The new orientation angle in degrees
 819    * @param[in] axis The new axis of orientation
 820    * @pre The Actor has been initialized.
 821    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 822    */
 823   void SetOrientation( const Degree& angle, const Vector3& axis )
 824   {
 825     SetOrientation( Radian( angle ), axis );
 826   }
 827
 828   /**
 829    * @brief Sets the orientation of the Actor.
 830    *
 831    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 832    * @SINCE_1_0.0
 833    * @param[in] angle The new orientation angle in radians
 834    * @param[in] axis The new axis of orientation
 835    * @pre The Actor has been initialized.
 836    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 837    */
 838   void SetOrientation(const Radian& angle, const Vector3& axis);
 839
 840   /**
 841    * @brief Sets the orientation of the Actor.
 842    *
 843    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 844    * @SINCE_1_0.0
 845    * @param[in] orientation The new orientation
 846    * @pre The Actor has been initialized.
 847    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 848    */
 849   void SetOrientation(const Quaternion& orientation);
 850
 851   /**
 852    * @brief Applies a relative rotation to an actor.
 853    *
 854    * @SINCE_1_0.0
 855    * @param[in] angle The angle to the rotation to combine with the existing orientation
 856    * @param[in] axis The axis of the rotation to combine with the existing orientation
 857    * @pre The actor has been initialized.
 858    */
 859   void RotateBy( const Degree& angle, const Vector3& axis )
 860   {
 861     RotateBy( Radian( angle ), axis );
 862   }
 863
 864   /**
 865    * @brief Applies a relative rotation to an actor.
 866    *
 867    * @SINCE_1_0.0
 868    * @param[in] angle The angle to the rotation to combine with the existing orientation
 869    * @param[in] axis The axis of the rotation to combine with the existing orientation
 870    * @pre The actor has been initialized.
 871    */
 872   void RotateBy(const Radian& angle, const Vector3& axis);
 873
 874   /**
 875    * @brief Applies a relative rotation to an actor.
 876    *
 877    * @SINCE_1_0.0
 878    * @param[in] relativeRotation The rotation to combine with the existing orientation
 879    * @pre The actor has been initialized.
 880    */
 881   void RotateBy(const Quaternion& relativeRotation);
 882
 883   /**
 884    * @brief Retrieves the Actor's orientation.
 885    *
 886    * @SINCE_1_0.0
 887    * @return The current orientation
 888    * @pre The Actor has been initialized.
 889    * @note This property can be animated; the return value may not match the value written with SetOrientation().
 890    */
 891   Quaternion GetCurrentOrientation() const;
 892
 893   /**
 894    * @brief Sets whether a child actor inherits it's parent's orientation.
 895    *
 896    * Default is to inherit.
 897    * Switching this off means that using SetOrientation() sets the actor's world orientation.
 898    * @SINCE_1_0.0
 899    * @param[in] inherit - @c true if the actor should inherit orientation, @c false otherwise
 900    * @pre The Actor has been initialized.
 901    */
 902   void SetInheritOrientation(bool inherit);
 903
 904   /**
 905    * @brief Returns whether the actor inherits its parent's orientation.
 906    *
 907    * @SINCE_1_0.0
 908    * @return @c true if the actor inherits its parent orientation, @c false if it uses world orientation
 909    * @pre The Actor has been initialized.
 910    */
 911   bool IsOrientationInherited() const;
 912
 913   /**
 914    * @brief Retrieves the world-orientation of the Actor.
 915    *
 916    * @SINCE_1_0.0
 917    * @return The Actor's current orientation in the world
 918    * @pre The Actor has been initialized.
 919    * @note The actor will not have a world-orientation, unless it has previously been added to the stage.
 920    */
 921   Quaternion GetCurrentWorldOrientation() const;
 922
 923   /**
 924    * @brief Sets the scale factor applied to an actor.
 925    *
 926    * @SINCE_1_0.0
 927    * @param[in] scale The scale factor applied on all axes
 928    * @pre The Actor has been initialized.
 929    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 930    */
 931   void SetScale(float scale);
 932
 933   /**
 934    * @brief Sets the scale factor applied to an actor.
 935    *
 936    * @SINCE_1_0.0
 937    * @param[in] scaleX The scale factor applied along the x-axis
 938    * @param[in] scaleY The scale factor applied along the y-axis
 939    * @param[in] scaleZ The scale factor applied along the z-axis
 940    * @pre The Actor has been initialized.
 941    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 942    */
 943   void SetScale(float scaleX, float scaleY, float scaleZ);
 944
 945   /**
 946    * @brief Sets the scale factor applied to an actor.
 947    *
 948    * @SINCE_1_0.0
 949    * @param[in] scale A vector representing the scale factor for each axis
 950    * @pre The Actor has been initialized.
 951    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 952    */
 953   void SetScale(const Vector3& scale);
 954
 955   /**
 956    * @brief Applies a relative scale to an actor.
 957    *
 958    * @SINCE_1_0.0
 959    * @param[in] relativeScale The scale to combine with the actor's existing scale
 960    * @pre The actor has been initialized.
 961    */
 962   void ScaleBy(const Vector3& relativeScale);
 963
 964   /**
 965    * @brief Retrieves the scale factor applied to an actor.
 966    *
 967    * @SINCE_1_0.0
 968    * @return A vector representing the scale factor for each axis
 969    * @pre The Actor has been initialized.
 970    * @note This property can be animated; the return value may not match the value written with SetScale().
 971    */
 972   Vector3 GetCurrentScale() const;
 973
 974   /**
 975    * @brief Retrieves the world-scale of the Actor.
 976    *
 977    * @SINCE_1_0.0
 978    * @return The Actor's current scale in the world
 979    * @pre The Actor has been initialized.
 980    * @note The actor will not have a world-scale, unless it has previously been added to the stage.
 981    */
 982   Vector3 GetCurrentWorldScale() const;
 983
 984   /**
 985    * @brief Sets whether a child actor inherits it's parent's scale.
 986    *
 987    * Default is to inherit.
 988    * Switching this off means that using SetScale() sets the actor's world scale.
 989    * @SINCE_1_0.0
 990    * @param[in] inherit - @c true if the actor should inherit scale, @c false otherwise
 991    * @pre The Actor has been initialized.
 992    */
 993   void SetInheritScale( bool inherit );
 994
 995   /**
 996    * @brief Returns whether the actor inherits its parent's scale.
 997    *
 998    * @SINCE_1_0.0
 999    * @return @c true if the actor inherits its parent scale, @c false if it uses world scale
1000    * @pre The Actor has been initialized.
1001    */
1002   bool IsScaleInherited() const;
1003
1004   /**
1005    * @brief Retrieves the world-matrix of the actor.
1006    *
1007    * @SINCE_1_0.0
1008    * @return The Actor's current world matrix
1009    * @pre The Actor has been initialized.
1010    * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
1011    */
1012   Matrix GetCurrentWorldMatrix() const;
1013
1014   // Visibility & Color
1015
1016   /**
1017    * @brief Sets the visibility flag of an actor.
1018    *
1019    * @SINCE_1_0.0
1020    * @param[in] visible The new visibility flag
1021    * @pre The actor has been initialized.
1022    * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
1023    * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
1024    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
1025    *       rendered if all of its parents have visibility set to true.
1026    */
1027   void SetVisible(bool visible);
1028
1029   /**
1030    * @brief Retrieves the visibility flag of an actor.
1031    *
1032    * @SINCE_1_0.0
1033    * @return The visibility flag
1034    * @pre The actor has been initialized.
1035    * @note This property can be animated; the return value may not match the value written with SetVisible().
1036    * @note If an actor is not visible, then the actor and its children will not be rendered.
1037    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
1038    *       rendered if all of its parents have visibility set to true.
1039    */
1040   bool IsVisible() const;
1041
1042   /**
1043    * @brief Sets the opacity of an actor.
1044    *
1045    * @SINCE_1_0.0
1046    * @param[in] opacity The new opacity
1047    * @pre The actor has been initialized.
1048    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
1049    */
1050   void SetOpacity(float opacity);
1051
1052   /**
1053    * @brief Retrieves the actor's opacity.
1054    *
1055    * @SINCE_1_0.0
1056    * @return The actor's opacity
1057    * @pre The actor has been initialized.
1058    * @note This property can be animated; the return value may not match the value written with SetOpacity().
1059    */
1060   float GetCurrentOpacity() const;
1061
1062   /**
1063    * @brief Sets the actor's color; this is an RGBA value.
1064    *
1065    * The final color of the actor depends on its color mode.
1066    * @SINCE_1_0.0
1067    * @param[in] color The new color
1068    * @pre The Actor has been initialized.
1069    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
1070    */
1071   void SetColor(const Vector4& color);
1072
1073   /**
1074    * @brief Retrieves the actor's color.
1075    *
1076    * Actor's own color is not clamped.
1077    * @SINCE_1_0.0
1078    * @return The color
1079    * @pre The Actor has been initialized.
1080    * @note This property can be animated; the return value may not match the value written with SetColor().
1081    */
1082   Vector4 GetCurrentColor() const;
1083
1084   /**
1085    * @brief Sets the actor's color mode.
1086    *
1087    * This specifies whether the Actor uses its own color, or inherits
1088    * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
1089    * @SINCE_1_0.0
1090    * @param[in] colorMode ColorMode to use
1091    * @pre The Actor has been initialized.
1092    */
1093   void SetColorMode( ColorMode colorMode );
1094
1095   /**
1096    * @brief Returns the actor's color mode.
1097    *
1098    * @SINCE_1_0.0
1099    * @return Currently used colorMode
1100    * @pre The Actor has been initialized.
1101    */
1102   ColorMode GetColorMode() const;
1103
1104   /**
1105    * @brief Retrieves the world-color of the Actor, where each component is clamped within the 0->1 range.
1106    *
1107    * @SINCE_1_0.0
1108    * @return The Actor's current color in the world
1109    * @pre The Actor has been initialized.
1110    * @note The actor will not have a world-color, unless it has previously been added to the stage.
1111    */
1112   Vector4 GetCurrentWorldColor() const;
1113
1114   /**
1115    * @brief Sets how the actor and its children should be drawn.
1116    *
1117    * Not all actors are renderable, but DrawMode can be inherited from any actor.
1118    * If an object is in a 3D layer, it will be depth-tested against
1119    * other objects in the world i.e. it may be obscured if other objects are in front.
1120    *
1121    * If DrawMode::OVERLAY_2D is used, the actor and its children will be drawn as a 2D overlay.
1122    * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1123    * For overlay actors, the drawing order is with respect to tree levels of Actors,
1124    * and depth-testing will not be used.
1125
1126    * @SINCE_1_0.0
1127    * @param[in] drawMode The new draw-mode to use
1128    * @note Layers do not inherit the DrawMode from their parents.
1129    */
1130   void SetDrawMode( DrawMode::Type drawMode );
1131
1132   /**
1133    * @brief Queries how the actor and its children will be drawn.
1134    *
1135    * @SINCE_1_0.0
1136    * @return Return the draw mode type
1137    */
1138   DrawMode::Type GetDrawMode() const;
1139
1140   // Input Handling
1141
1142   /**
1143    * @brief Sets whether an actor should emit touch or hover signals.
1144    *
1145    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1146    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1147    * hover event signal will be emitted.
1148    *
1149    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1150    * @code
1151    * actor.SetSensitive(false);
1152    * @endcode
1153    *
1154    * Then, to re-enable the touch or hover event signal emission, the application should call:
1155    * @code
1156    * actor.SetSensitive(true);
1157    * @endcode
1158    *
1159    * @SINCE_1_0.0
1160    * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise
1161    * @pre The Actor has been initialized.
1162    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1163    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1164    *       hittable if all of its parents have sensitivity set to true.
1165    * @see @see TouchedSignal() and HoveredSignal().
1166    */
1167   void SetSensitive(bool sensitive);
1168
1169   /**
1170    * @brief Queries whether an actor emits touch or hover event signals.
1171    *
1172    * @SINCE_1_0.0
1173    * @return @c true, if emission of touch or hover event signals is enabled, @c false otherwise
1174    * @pre The Actor has been initialized.
1175    * @note If an actor is not sensitive, then it's children will not be hittable either.
1176    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1177    *       hittable if all of its parents have sensitivity set to true.
1178    */
1179   bool IsSensitive() const;
1180
1181   /**
1182    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1183    *
1184    * @SINCE_1_0.0
1185    * @param[out] localX On return, the X-coordinate relative to the actor
1186    * @param[out] localY On return, the Y-coordinate relative to the actor
1187    * @param[in] screenX The screen X-coordinate
1188    * @param[in] screenY The screen Y-coordinate
1189    * @return True if the conversion succeeded
1190    * @pre The Actor has been initialized.
1191    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1192    */
1193   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1194
1195   /**
1196    * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1197    * the boundary of the actor.
1198    *
1199    * @SINCE_1_0.0
1200    * @param[in] required Should be set to true if a Leave event is required
1201    * @pre The Actor has been initialized.
1202    * @note By default, this is set to false as most actors do not require this.
1203    * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
1204    *
1205    */
1206   void SetLeaveRequired(bool required);
1207
1208   /**
1209    * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1210    * the boundary of the actor.
1211    *
1212    * @SINCE_1_0.0
1213    * @return @c true if a Leave event is required, @c false otherwise
1214    * @pre The Actor has been initialized.
1215    */
1216   bool GetLeaveRequired() const;
1217
1218   /**
1219    * @brief Sets whether the actor should be focusable by keyboard navigation.
1220    *
1221    * The default is false.
1222    * @SINCE_1_0.0
1223    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1224    * false otherwise
1225    * @pre The Actor has been initialized.
1226    */
1227   void SetKeyboardFocusable( bool focusable );
1228
1229   /**
1230    * @brief Returns whether the actor is focusable by keyboard navigation.
1231    *
1232    * @SINCE_1_0.0
1233    * @return @c true if the actor is focusable by keyboard navigation, @c false if not
1234    * @pre The Actor has been initialized.
1235    */
1236   bool IsKeyboardFocusable() const;
1237
1238   /**
1239    * @brief Raise actor above the next sibling actor.
1240    *
1241    * @SINCE_1_2.60
1242    * @pre The Actor has been initialized.
1243    * @pre The Actor has been parented.
1244    */
1245   void Raise();
1246
1247   /**
1248    * @brief Lower the actor below the previous sibling actor.
1249    *
1250    * @SINCE_1_2.60
1251    * @pre The Actor has been initialized.
1252    * @pre The Actor has been parented.
1253    */
1254   void Lower();
1255
1256   /**
1257    * @brief Raise actor above all other sibling actors.
1258    *
1259    * @SINCE_1_2.60
1260    * @pre The Actor has been initialized.
1261    * @pre The Actor has been parented.
1262    */
1263   void RaiseToTop();
1264
1265   /**
1266    * @brief Lower actor to the bottom of all other sibling actors.
1267    *
1268    * @SINCE_1_2.60
1269    * @pre The Actor has been initialized.
1270    * @pre The Actor has been parented.
1271    */
1272   void LowerToBottom();
1273
1274   /**
1275    * @brief Raises the actor above the target actor.
1276    *
1277    * @SINCE_1_2.60
1278    * @param[in] target The target actor
1279    * @pre The Actor has been initialized.
1280    * @pre The Actor has been parented.
1281    * @pre The target actor is a sibling.
1282    */
1283   void RaiseAbove( Actor target );
1284
1285   /**
1286    * @brief Lower the actor to below the target actor.
1287    *
1288    * @SINCE_1_2.60
1289    * @param[in] target The target actor
1290    * @pre The Actor has been initialized.
1291    * @pre The Actor has been parented.
1292    * @pre The target actor is a sibling.
1293    */
1294   void LowerBelow( Actor target );
1295
1296   // SIZE NEGOTIATION
1297
1298   /**
1299    * @brief Sets the resize policy to be used for the given dimension(s).
1300    *
1301    * @SINCE_1_0.0
1302    * @param[in] policy The resize policy to use
1303    * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions
1304    */
1305   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1306
1307   /**
1308    * @brief Returns the resize policy used for a single dimension.
1309    *
1310    * @SINCE_1_0.0
1311    * @param[in] dimension The dimension to get policy for
1312    * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found
1313    */
1314   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1315
1316   /**
1317    * @brief Sets the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1318    *
1319    * @SINCE_1_0.0
1320    * @param[in] policy The policy to use for when the size is set
1321    */
1322   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1323
1324   /**
1325    * @brief Returns the size scale policy in use.
1326    *
1327    * @SINCE_1_0.0
1328    * @return Return the size scale policy
1329    */
1330   SizeScalePolicy::Type GetSizeScalePolicy() const;
1331
1332   /**
1333    * @brief Sets the relative to parent size factor of the actor.
1334    *
1335    * This factor is only used when ResizePolicy is set to either:
1336    * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1337    * This actor's size is set to the actor's size multiplied by or added to this factor,
1338    * depending on ResizePolicy ( See SetResizePolicy() ).
1339    *
1340    * @SINCE_1_0.0
1341    * @param[in] factor A Vector3 representing the relative factor to be applied to each axis
1342    * @pre The Actor has been initialized.
1343    */
1344   void SetSizeModeFactor( const Vector3& factor );
1345
1346   /**
1347    * @brief Retrieves the relative to parent size factor of the actor.
1348    *
1349    * @SINCE_1_0.0
1350    * @return The Actor's current relative size factor
1351    * @pre The Actor has been initialized.
1352    */
1353   Vector3 GetSizeModeFactor() const;
1354
1355   /**
1356    * @brief Calculates the height of the actor given a width.
1357    *
1358    * The natural size is used for default calculation.
1359    * size 0 is treated as aspect ratio 1:1.
1360    *
1361    * @SINCE_1_0.0
1362    * @param[in] width Width to use
1363    * @return Return the height based on the width
1364    */
1365   float GetHeightForWidth( float width );
1366
1367   /**
1368    * @brief Calculates the width of the actor given a height.
1369    *
1370    * The natural size is used for default calculation.
1371    * size 0 is treated as aspect ratio 1:1.
1372    *
1373    * @SINCE_1_0.0
1374    * @param[in] height Height to use
1375    * @return Return the width based on the height
1376    */
1377   float GetWidthForHeight( float height );
1378
1379   /**
1380    * @brief Returns the value of negotiated dimension for the given dimension.
1381    *
1382    * @SINCE_1_0.0
1383    * @param[in] dimension The dimension to retrieve
1384    * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found
1385    */
1386   float GetRelayoutSize( Dimension::Type dimension ) const;
1387
1388   /**
1389    * @brief Sets the padding for use in layout.
1390    *
1391    * @SINCE_1_0.0
1392    * @param[in] padding Padding for the actor
1393    */
1394   void SetPadding( const Padding& padding );
1395
1396   /**
1397    * @brief Returns the value of the padding.
1398    *
1399    * @SINCE_1_0.0
1400    * @param[in] paddingOut The returned padding data
1401    */
1402   void GetPadding( Padding& paddingOut ) const;
1403
1404   /**
1405    * @brief Sets the minimum size an actor can be assigned in size negotiation.
1406    *
1407    * @SINCE_1_0.0
1408    * @param[in] size The minimum size
1409    */
1410   void SetMinimumSize( const Vector2& size );
1411
1412   /**
1413    * @brief Returns the minimum relayout size.
1414    *
1415    * @SINCE_1_0.0
1416    * @return Return the minimum size
1417    */
1418   Vector2 GetMinimumSize();
1419
1420   /**
1421    * @brief Sets the maximum size an actor can be assigned in size negotiation.
1422    *
1423    * @SINCE_1_0.0
1424    * @param[in] size The maximum size
1425    */
1426   void SetMaximumSize( const Vector2& size );
1427
1428   /**
1429    * @brief Returns the maximum relayout size.
1430    *
1431    * @SINCE_1_0.0
1432    * @return Return the maximum size
1433    */
1434   Vector2 GetMaximumSize();
1435
1436   /**
1437    * @brief Gets depth in the hierarchy for the actor.
1438    *
1439    * @SINCE_1_0.0
1440    * @return The current depth in the hierarchy of the actor, or @c -1 if actor is not in the hierarchy
1441    */
1442   int32_t GetHierarchyDepth();
1443
1444 public: // Renderer
1445
1446   /**
1447    * @brief Adds a renderer to this actor.
1448    *
1449    * @SINCE_1_0.0
1450    * @param[in] renderer Renderer to add to the actor
1451    * @return The index of the Renderer that was added
1452    * @pre The renderer must be initialized.
1453    *
1454    */
1455   uint32_t AddRenderer( Renderer& renderer );
1456
1457   /**
1458    * @brief Gets the number of renderers on this actor.
1459    *
1460    * @SINCE_1_0.0
1461    * @return The number of renderers on this actor
1462    */
1463   uint32_t GetRendererCount() const;
1464
1465   /**
1466    * @brief Gets a Renderer by index.
1467    *
1468    * @SINCE_1_0.0
1469    * @param[in] index The index of the renderer to fetch
1470    * @return The renderer at the specified index
1471    * @pre The index must be between 0 and GetRendererCount()-1
1472    *
1473    */
1474   Renderer GetRendererAt( uint32_t index );
1475
1476   /**
1477    * @brief Removes a renderer from the actor.
1478    *
1479    * @SINCE_1_0.0
1480    * @param[in] renderer Handle to the renderer that is to be removed
1481    */
1482   void RemoveRenderer( Renderer& renderer );
1483
1484   /**
1485    * @brief Removes a renderer from the actor by index.
1486    *
1487    * @SINCE_1_0.0
1488    * @param[in] index Index of the renderer that is to be removed
1489    * @pre The index must be between 0 and GetRendererCount()-1
1490    *
1491    */
1492   void RemoveRenderer( uint32_t index );
1493
1494 public: // Signals
1495
1496   /**
1497    * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1498    * @brief This signal is emitted when touch input is received.
1499    *
1500    * A callback of the following type may be connected:
1501    * @code
1502    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1503    * @endcode
1504    * The return value of True, indicates that the touch event should be consumed.
1505    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1506    * @SINCE_1_0.0
1507    * @return The signal to connect to
1508    * @pre The Actor has been initialized.
1509    */
1510   TouchSignalType& TouchedSignal() DALI_DEPRECATED_API;
1511
1512   /**
1513    * @brief This signal is emitted when touch input is received.
1514    *
1515    * A callback of the following type may be connected:
1516    * @code
1517    *   bool YourCallbackName( Actor actor, TouchData& touch );
1518    * @endcode
1519    * The return value of True, indicates that the touch event has been consumed.
1520    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1521    * @SINCE_1_1.37
1522    * @return The signal to connect to
1523    * @pre The Actor has been initialized.
1524    */
1525   TouchDataSignalType& TouchSignal();
1526
1527   /**
1528    * @brief This signal is emitted when hover input is received.
1529    *
1530    * A callback of the following type may be connected:
1531    * @code
1532    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1533    * @endcode
1534    * The return value of True, indicates that the hover event should be consumed.
1535    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1536    * @SINCE_1_0.0
1537    * @return The signal to connect to
1538    * @pre The Actor has been initialized.
1539    */
1540   HoverSignalType& HoveredSignal();
1541
1542   /**
1543    * @brief This signal is emitted when wheel event is received.
1544    *
1545    * A callback of the following type may be connected:
1546    * @code
1547    *   bool YourCallbackName(Actor actor, const WheelEvent& event);
1548    * @endcode
1549    * The return value of True, indicates that the wheel event should be consumed.
1550    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1551    * @SINCE_1_0.0
1552    * @return The signal to connect to
1553    * @pre The Actor has been initialized.
1554    */
1555   WheelEventSignalType& WheelEventSignal();
1556
1557   /**
1558    * @brief This signal is emitted after the actor has been connected to the stage.
1559    *
1560    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1561    * @SINCE_1_0.0
1562    * @return The signal to connect to
1563    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1564    *
1565    * @note When the parent of a set of actors is connected to the stage, then all of the children
1566    * will received this callback.
1567    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1568    *
1569    * @code
1570    *
1571    *       A (parent)
1572    *      / \
1573    *     B   C
1574    *    / \   \
1575    *   D   E   F
1576    *
1577    * @endcode
1578    */
1579   OnStageSignalType& OnStageSignal();
1580
1581   /**
1582    * @brief This signal is emitted after the actor has been disconnected from the stage.
1583    *
1584    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1585    *
1586    * @SINCE_1_0.0
1587    * @return The signal to connect to
1588    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1589    * will received this callback, starting with the leaf actors.
1590    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1591    *
1592    * @code
1593    *
1594    *       A (parent)
1595    *      / \
1596    *     B   C
1597    *    / \   \
1598    *   D   E   F
1599    *
1600    * @endcode
1601    *
1602    */
1603   OffStageSignalType& OffStageSignal();
1604
1605   /**
1606    * @brief This signal is emitted after the size has been set on the actor during relayout
1607    *
1608    * @SINCE_1_0.0
1609    * @return The signal
1610    */
1611   OnRelayoutSignalType& OnRelayoutSignal();
1612
1613   /**
1614    * @brief This signal is emitted when the layout direction property of this or a parent actor is changed.
1615    *
1616    * A callback of the following type may be connected:
1617    * @code
1618    *   void YourCallbackName( Actor actor, LayoutDirection::Type type );
1619    * @endcode
1620    * actor: The actor, or child of actor, whose layout direction has changed
1621    * type: Whether the actor's layout direction property has changed or a parent's.
1622    *
1623    * @SINCE_1_2.60
1624    * @return The signal to connect to
1625    * @pre The Actor has been initialized.
1626    */
1627   LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal();
1628
1629 public: // Not intended for application developers
1630
1631   /// @cond internal
1632   /**
1633    * @brief This constructor is used by Actor::New() methods.
1634    *
1635    * @SINCE_1_0.0
1636    * @param [in] actor A pointer to a newly allocated Dali resource
1637    */
1638   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1639   /// @endcond
1640 };
1641
1642 /**
1643  * @brief Helper for discarding an actor handle.
1644  *
1645  * If the handle is empty, this method does nothing.  Otherwise
1646  * Actor::Unparent() will be called, followed by Actor::Reset().
1647  * @SINCE_1_0.0
1648  * @param[in,out] actor A handle to an actor, or an empty handle
1649  */
1650 inline void UnparentAndReset( Actor& actor )
1651 {
1652   if( actor )
1653   {
1654     actor.Unparent();
1655     actor.Reset();
1656   }
1657 }
1658
1659 /**
1660  * @}
1661  */
1662 } // namespace Dali
1663
1664 #endif // DALI_ACTOR_H