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       DRAW_MODE,                                          ///< name "drawMode",              type std::string @SINCE_1_0.0
 302       SIZE_MODE_FACTOR,                                   ///< name "sizeModeFactor",        type Vector3     @SINCE_1_0.0
 303       WIDTH_RESIZE_POLICY,                                ///< name "widthResizePolicy",     type String      @SINCE_1_0.0
 304       HEIGHT_RESIZE_POLICY,                               ///< name "heightResizePolicy",    type String      @SINCE_1_0.0
 305       SIZE_SCALE_POLICY,                                  ///< name "sizeScalePolicy",       type String      @SINCE_1_0.0
 306       WIDTH_FOR_HEIGHT,                                   ///< name "widthForHeight",        type bool        @SINCE_1_0.0
 307       HEIGHT_FOR_WIDTH,                                   ///< name "heightForWidth",        type bool        @SINCE_1_0.0
 308       PADDING,                                            ///< name "padding",               type Vector4     @SINCE_1_0.0
 309       MINIMUM_SIZE,                                       ///< name "minimumSize",           type Vector2     @SINCE_1_0.0
 310       MAXIMUM_SIZE,                                       ///< name "maximumSize",           type Vector2     @SINCE_1_0.0
 311       INHERIT_POSITION,                                   ///< name "inheritPosition",       type bool        @SINCE_1_1.24
 312       CLIPPING_MODE,                                      ///< name "clippingMode",          type String      @SINCE_1_2_5
 313
 314       /**
 315        * @brief The direction of the layout.
 316        * @details Name "layoutDirection", type LayoutDirection::Type (Property::INTEGER) or Property::STRING.
 317        * @SINCE_1_2.60
 318        * @see LayoutDirection::Type for supported values.
 319        */
 320       LAYOUT_DIRECTION,
 321
 322       /**
 323        * @brief Determines whether child actors inherit the layout direction from a parent.
 324        * @details Name "layoutDirectionInheritance", type Property::BOOLEAN.
 325        * @SINCE_1_2.60
 326        */
 327       INHERIT_LAYOUT_DIRECTION,
 328     };
 329   };
 330
 331   // Typedefs
 332
 333   typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType;        ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
 334   typedef Signal< bool (Actor, const TouchData&) >  TouchDataSignalType;    ///< Touch signal type @SINCE_1_1.37
 335   typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType;        ///< Hover signal type @SINCE_1_0.0
 336   typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type @SINCE_1_0.0
 337   typedef Signal< void (Actor) > OnStageSignalType;                         ///< Stage connection signal type @SINCE_1_0.0
 338   typedef Signal< void (Actor) > OffStageSignalType;                        ///< Stage disconnection signal type @SINCE_1_0.0
 339   typedef Signal< void (Actor) > OnRelayoutSignalType;                      ///< Called when the actor is relaid out @SINCE_1_0.0
 340   typedef Signal< void ( Actor, LayoutDirection::Type ) > LayoutDirectionChangedSignalType; ///< Layout direction changes signal type. @SINCE_1_2.60
 341
 342   // Creation
 343
 344   /**
 345    * @brief Creates an uninitialized Actor; this can be initialized with Actor::New().
 346    *
 347    * Calling member functions with an uninitialized Actor handle is not allowed.
 348    * @SINCE_1_0.0
 349    */
 350   Actor();
 351
 352   /**
 353    * @brief Creates an initialized Actor.
 354    *
 355    * @SINCE_1_0.0
 356    * @return A handle to a newly allocated Dali resource
 357    */
 358   static Actor New();
 359
 360   /**
 361    * @brief Downcasts a handle to Actor handle.
 362    *
 363    * If handle points to an Actor object, the downcast produces valid handle.
 364    * If not, the returned handle is left uninitialized.
 365    *
 366    * @SINCE_1_0.0
 367    * @param[in] handle to An object
 368    * @return handle to a Actor object or an uninitialized handle
 369    */
 370   static Actor DownCast( BaseHandle handle );
 371
 372   /**
 373    * @brief Dali::Actor is intended as a base class.
 374    *
 375    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 376    * @SINCE_1_0.0
 377    */
 378   ~Actor();
 379
 380   /**
 381    * @brief Copy constructor.
 382    *
 383    * @SINCE_1_0.0
 384    * @param[in] copy The actor to copy
 385    */
 386   Actor(const Actor& copy);
 387
 388   /**
 389    * @brief Assignment operator
 390    *
 391    * @SINCE_1_0.0
 392    * @param[in] rhs The actor to copy
 393    * @return A reference to this
 394    */
 395   Actor& operator=(const Actor& rhs);
 396
 397   /**
 398    * @brief Retrieves the Actor's name.
 399    *
 400    * @SINCE_1_0.0
 401    * @return The Actor's name
 402    * @pre The Actor has been initialized.
 403    */
 404   const std::string& GetName() const;
 405
 406   /**
 407    * @brief Sets the Actor's name.
 408    *
 409    * @SINCE_1_0.0
 410    * @param[in] name The new name
 411    * @pre The Actor has been initialized.
 412    */
 413   void SetName(const std::string& name);
 414
 415   /**
 416    * @brief Retrieves the unique ID of the actor.
 417    *
 418    * @SINCE_1_0.0
 419    * @return The ID
 420    * @pre The Actor has been initialized.
 421    */
 422   uint32_t GetId() const;
 423
 424   // Containment
 425
 426   /**
 427    * @brief Queries whether an actor is the root actor, which is owned by the Stage.
 428    *
 429    * @SINCE_1_0.0
 430    * @return True if the actor is the root actor
 431    * @pre The Actor has been initialized.
 432    */
 433   bool IsRoot() const;
 434
 435   /**
 436    * @brief Queries whether the actor is connected to the Stage.
 437    *
 438    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
 439    * @SINCE_1_0.0
 440    * @return True if the actor is connected to the Stage
 441    * @pre The Actor has been initialized.
 442    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
 443    */
 444   bool OnStage() const;
 445
 446   /**
 447    * @brief Queries whether the actor is of class Dali::Layer.
 448    *
 449    * @SINCE_1_0.0
 450    * @return True if the actor is a layer
 451    * @pre The Actor has been initialized.
 452    */
 453   bool IsLayer() const;
 454
 455   /**
 456    * @brief Gets the layer in which the actor is present.
 457    *
 458    * @SINCE_1_0.0
 459    * @return The layer, which will be uninitialized if the actor is off-stage
 460    * @pre The Actor has been initialized.
 461    */
 462   Layer GetLayer();
 463
 464   /**
 465    * @brief Adds a child Actor to this Actor.
 466    *
 467    * @SINCE_1_0.0
 468    * @param[in] child The child
 469    * @pre This Actor (the parent) has been initialized.
 470    * @pre The child actor has been initialized.
 471    * @pre The child actor is not the same as the parent actor.
 472    * @pre The actor is not the Root actor.
 473    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 474    * even if the handle passed into this method is reset or destroyed.
 475    * @note If the child already has a parent, it will be removed from old parent
 476    * and reparented to this actor. This may change child's position, color,
 477    * scale etc as it now inherits them from this actor.
 478    */
 479   void Add(Actor child);
 480
 481   /**
 482    * @brief Removes a child Actor from this Actor.
 483    *
 484    * If the actor was not a child of this actor, this is a no-op.
 485    * @SINCE_1_0.0
 486    * @param[in] child The child
 487    * @pre This Actor (the parent) has been initialized.
 488    * @pre The child actor is not the same as the parent actor.
 489    */
 490   void Remove(Actor child);
 491
 492   /**
 493    * @brief Removes an actor from its parent.
 494    *
 495    * If the actor has no parent, this method does nothing.
 496    * @SINCE_1_0.0
 497    * @pre The (child) actor has been initialized.
 498    */
 499   void Unparent();
 500
 501   /**
 502    * @brief Retrieves the number of children held by the actor.
 503    *
 504    * @SINCE_1_0.0
 505    * @return The number of children
 506    * @pre The Actor has been initialized.
 507    */
 508   uint32_t GetChildCount() const;
 509
 510   /**
 511    * @brief Retrieve and child actor by index.
 512    *
 513    * @SINCE_1_0.0
 514    * @param[in] index The index of the child to retrieve
 515    * @return The actor for the given index or empty handle if children not initialized
 516    * @pre The Actor has been initialized.
 517    */
 518   Actor GetChildAt( uint32_t index ) const;
 519
 520   /**
 521    * @brief Search through this actor's hierarchy for an actor with the given name.
 522    *
 523    * The actor itself is also considered in the search.
 524    * @SINCE_1_0.0
 525    * @param[in] actorName The name of the actor to find
 526    * @return A handle to the actor if found, or an empty handle if not
 527    * @pre The Actor has been initialized.
 528    */
 529   Actor FindChildByName(const std::string& actorName);
 530
 531   /**
 532    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 533    *
 534    * The actor itself is also considered in the search.
 535    * @SINCE_1_0.0
 536    * @param[in] id The ID of the actor to find
 537    * @return A handle to the actor if found, or an empty handle if not
 538    * @pre The Actor has been initialized.
 539    */
 540   Actor FindChildById( const uint32_t id );
 541
 542   /**
 543    * @brief Retrieves the actor's parent.
 544    *
 545    * @SINCE_1_0.0
 546    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid
 547    * @pre The actor has been initialized.
 548    */
 549   Actor GetParent() const;
 550
 551   // Positioning
 552
 553   /**
 554    * @brief Sets the origin of an actor, within its parent's area.
 555    *
 556    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 557    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 558    * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
 559    * An actor's position is the distance between this origin, and the actor's anchor-point.
 560    * @image html parent-origin.png
 561    * @SINCE_1_0.0
 562    * @param[in] origin The new parent-origin
 563    * @pre The Actor has been initialized.
 564    * @see Dali::ParentOrigin for predefined parent origin values
 565    */
 566   void SetParentOrigin(const Vector3& origin);
 567
 568   /**
 569    * @brief Retrieves the parent-origin of an actor.
 570    *
 571    * @SINCE_1_0.0
 572    * @return The current parent-origin
 573    * @pre The Actor has been initialized.
 574    */
 575   Vector3 GetCurrentParentOrigin() const;
 576
 577   /**
 578    * @brief Sets the anchor-point of an actor.
 579    *
 580    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
 581    * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
 582    * bottom-right corner. The default anchor point is
 583    * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
 584    * An actor position is the distance between its parent-origin and this anchor-point.
 585    * An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
 586    * @image html anchor-point.png
 587    * @SINCE_1_0.0
 588    * @param[in] anchorPoint The new anchor-point
 589    * @pre The Actor has been initialized.
 590    * @see Dali::AnchorPoint for predefined anchor point values
 591    */
 592   void SetAnchorPoint(const Vector3& anchorPoint);
 593
 594   /**
 595    * @brief Retrieves the anchor-point of an actor.
 596    *
 597    * @SINCE_1_0.0
 598    * @return The current anchor-point
 599    * @pre The Actor has been initialized.
 600    */
 601   Vector3 GetCurrentAnchorPoint() const;
 602
 603   /**
 604    * @brief Sets the size of an actor.
 605    *
 606    * Geometry can be scaled to fit within this area.
 607    * This does not interfere with the actors scale factor.
 608    * The actors default depth is the minimum of width & height.
 609    * @SINCE_1_0.0
 610    * @param [in] width The new width
 611    * @param [in] height The new height
 612    * @pre The actor has been initialized.
 613    */
 614   void SetSize(float width, float height);
 615
 616   /**
 617    * @brief Sets the size of an actor.
 618    *
 619    * Geometry can be scaled to fit within this area.
 620    * This does not interfere with the actors scale factor.
 621    * @SINCE_1_0.0
 622    * @param[in] width The size of the actor along the x-axis
 623    * @param[in] height The size of the actor along the y-axis
 624    * @param[in] depth The size of the actor along the z-axis
 625    * @pre The actor has been initialized.
 626    */
 627   void SetSize(float width, float height, float depth);
 628
 629   /**
 630    * @brief Sets the size of an actor.
 631    *
 632    * Geometry can be scaled to fit within this area.
 633    * This does not interfere with the actors scale factor.
 634    * The actors default depth is the minimum of width & height.
 635    * @SINCE_1_0.0
 636    * @param[in] size The new size
 637    * @pre The actor has been initialized.
 638    */
 639   void SetSize(const Vector2& size);
 640
 641   /**
 642    * @brief Sets the size of an actor.
 643    *
 644    * Geometry can be scaled to fit within this area.
 645    * This does not interfere with the actors scale factor.
 646    * @SINCE_1_0.0
 647    * @param [in] size The new size
 648    * @pre The actor has been initialized.
 649    */
 650   void SetSize(const Vector3& size);
 651
 652   /**
 653    * @brief Retrieves the actor's size.
 654    *
 655    * @SINCE_1_0.0
 656    * @return The actor's target size
 657    * @pre The actor has been initialized.
 658    * @note This return is the value that was set using SetSize or the target size of an animation.
 659    *       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.
 660    */
 661   Vector3 GetTargetSize() const;
 662
 663   /**
 664    * @brief Retrieves the actor's size.
 665    *
 666    * @SINCE_1_0.0
 667    * @return The actor's current size
 668    * @pre The actor has been initialized.
 669    * @note This property can be animated; the return value may not match the value written with SetSize().
 670    */
 671   Vector3 GetCurrentSize() const;
 672
 673   /**
 674    * @brief Returns the natural size of the actor.
 675    *
 676    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 677    *
 678    * @SINCE_1_0.0
 679    * @return The actor's natural size
 680    */
 681   Vector3 GetNaturalSize() const;
 682
 683   /**
 684    * @brief Sets the position of the Actor.
 685    *
 686    * By default, sets the position vector between the parent origin and anchor point (default).
 687    *
 688    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 689    *
 690    * @image html actor-position.png
 691    * The Actor's z position will be set to 0.0f.
 692    * @SINCE_1_0.0
 693    * @param[in] x The new x position
 694    * @param[in] y The new y position
 695    * @pre The Actor has been initialized.
 696    */
 697   void SetPosition(float x, float y);
 698
 699   /**
 700    * @brief Sets the position of the Actor.
 701    *
 702    * By default, sets the position vector between the parent origin and anchor point (default).
 703    *
 704    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 705    *
 706    * @image html actor-position.png
 707    * @SINCE_1_0.0
 708    * @param[in] x The new x position
 709    * @param[in] y The new y position
 710    * @param[in] z The new z position
 711    * @pre The Actor has been initialized.
 712    */
 713   void SetPosition(float x, float y, float z);
 714
 715   /**
 716    * @brief Sets the position of the Actor.
 717    *
 718    * By default, sets the position vector between the parent origin and anchor point (default).
 719    *
 720    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 721    *
 722    * @image html actor-position.png
 723    * @SINCE_1_0.0
 724    * @param[in] position The new position
 725    * @pre The Actor has been initialized.
 726    */
 727   void SetPosition(const Vector3& position);
 728
 729   /**
 730    * @brief Sets the position of an actor along the X-axis.
 731    *
 732    * @SINCE_1_0.0
 733    * @param[in] x The new x position
 734    * @pre The Actor has been initialized.
 735    */
 736   void SetX(float x);
 737
 738   /**
 739    * @brief Sets the position of an actor along the Y-axis.
 740    *
 741    * @SINCE_1_0.0
 742    * @param[in] y The new y position
 743    * @pre The Actor has been initialized.
 744    */
 745   void SetY(float y);
 746
 747   /**
 748    * @brief Sets the position of an actor along the Z-axis.
 749    *
 750    * @SINCE_1_0.0
 751    * @param[in] z The new z position
 752    * @pre The Actor has been initialized.
 753    */
 754   void SetZ(float z);
 755
 756   /**
 757    * @brief Translates an actor relative to its existing position.
 758    *
 759    * @SINCE_1_0.0
 760    * @param[in] distance The actor will move by this distance
 761    * @pre The actor has been initialized.
 762    */
 763   void TranslateBy(const Vector3& distance);
 764
 765   /**
 766    * @brief Retrieves the position of the Actor.
 767    *
 768    * @SINCE_1_0.0
 769    * @return The Actor's current position
 770    * @pre The Actor has been initialized.
 771    * @note This property can be animated; the return value may not match the value written with SetPosition().
 772    */
 773   Vector3 GetCurrentPosition() const;
 774
 775   /**
 776    * @brief Retrieves the world-position of the Actor.
 777    *
 778    * @SINCE_1_0.0
 779    * @return The Actor's current position in world coordinates
 780    * @pre The Actor has been initialized.
 781    * @note The actor may not have a world-position unless it has been added to the stage.
 782    */
 783   Vector3 GetCurrentWorldPosition() const;
 784
 785   /**
 786    * @brief Sets whether a child actor inherits it's parent's position.
 787    *
 788    * Default is to inherit.
 789    * Switching this off means that using SetPosition() sets the actor's world position, i.e. translates from
 790    * the world origin (0,0,0) to the anchor point of the actor.
 791    * @SINCE_1_1.24
 792    * @param[in] inherit - @c true if the actor should inherit position, @c false otherwise
 793    * @pre The Actor has been initialized.
 794    */
 795   inline void SetInheritPosition( bool inherit )
 796   {
 797     SetProperty(Property::INHERIT_POSITION, inherit );
 798   }
 799
 800   /**
 801    * @brief Returns whether the actor inherits its parent's position.
 802    *
 803    * @SINCE_1_1.24
 804    * @return @c true if the actor inherits its parent position, @c false if it uses world position
 805    * @pre The Actor has been initialized.
 806    */
 807   inline bool IsPositionInherited() const
 808   {
 809     return GetProperty(Property::INHERIT_POSITION ).Get<bool>();
 810   }
 811
 812   /**
 813    * @brief Sets the orientation of the Actor.
 814    *
 815    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 816    * @SINCE_1_0.0
 817    * @param[in] angle The new orientation angle in degrees
 818    * @param[in] axis The new axis of orientation
 819    * @pre The Actor has been initialized.
 820    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 821    */
 822   void SetOrientation( const Degree& angle, const Vector3& axis )
 823   {
 824     SetOrientation( Radian( angle ), axis );
 825   }
 826
 827   /**
 828    * @brief Sets the orientation of the Actor.
 829    *
 830    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 831    * @SINCE_1_0.0
 832    * @param[in] angle The new orientation angle in radians
 833    * @param[in] axis The new axis of orientation
 834    * @pre The Actor has been initialized.
 835    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 836    */
 837   void SetOrientation(const Radian& angle, const Vector3& axis);
 838
 839   /**
 840    * @brief Sets the orientation of the Actor.
 841    *
 842    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 843    * @SINCE_1_0.0
 844    * @param[in] orientation The new orientation
 845    * @pre The Actor has been initialized.
 846    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 847    */
 848   void SetOrientation(const Quaternion& orientation);
 849
 850   /**
 851    * @brief Applies a relative rotation to an actor.
 852    *
 853    * @SINCE_1_0.0
 854    * @param[in] angle The angle to the rotation to combine with the existing orientation
 855    * @param[in] axis The axis of the rotation to combine with the existing orientation
 856    * @pre The actor has been initialized.
 857    */
 858   void RotateBy( const Degree& angle, const Vector3& axis )
 859   {
 860     RotateBy( Radian( angle ), axis );
 861   }
 862
 863   /**
 864    * @brief Applies a relative rotation to an actor.
 865    *
 866    * @SINCE_1_0.0
 867    * @param[in] angle The angle to the rotation to combine with the existing orientation
 868    * @param[in] axis The axis of the rotation to combine with the existing orientation
 869    * @pre The actor has been initialized.
 870    */
 871   void RotateBy(const Radian& angle, const Vector3& axis);
 872
 873   /**
 874    * @brief Applies a relative rotation to an actor.
 875    *
 876    * @SINCE_1_0.0
 877    * @param[in] relativeRotation The rotation to combine with the existing orientation
 878    * @pre The actor has been initialized.
 879    */
 880   void RotateBy(const Quaternion& relativeRotation);
 881
 882   /**
 883    * @brief Retrieves the Actor's orientation.
 884    *
 885    * @SINCE_1_0.0
 886    * @return The current orientation
 887    * @pre The Actor has been initialized.
 888    * @note This property can be animated; the return value may not match the value written with SetOrientation().
 889    */
 890   Quaternion GetCurrentOrientation() const;
 891
 892   /**
 893    * @brief Sets whether a child actor inherits it's parent's orientation.
 894    *
 895    * Default is to inherit.
 896    * Switching this off means that using SetOrientation() sets the actor's world orientation.
 897    * @SINCE_1_0.0
 898    * @param[in] inherit - @c true if the actor should inherit orientation, @c false otherwise
 899    * @pre The Actor has been initialized.
 900    */
 901   void SetInheritOrientation(bool inherit);
 902
 903   /**
 904    * @brief Returns whether the actor inherits its parent's orientation.
 905    *
 906    * @SINCE_1_0.0
 907    * @return @c true if the actor inherits its parent orientation, @c false if it uses world orientation
 908    * @pre The Actor has been initialized.
 909    */
 910   bool IsOrientationInherited() const;
 911
 912   /**
 913    * @brief Retrieves the world-orientation of the Actor.
 914    *
 915    * @SINCE_1_0.0
 916    * @return The Actor's current orientation in the world
 917    * @pre The Actor has been initialized.
 918    * @note The actor will not have a world-orientation, unless it has previously been added to the stage.
 919    */
 920   Quaternion GetCurrentWorldOrientation() const;
 921
 922   /**
 923    * @brief Sets the scale factor applied to an actor.
 924    *
 925    * @SINCE_1_0.0
 926    * @param[in] scale The scale factor applied on all axes
 927    * @pre The Actor has been initialized.
 928    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 929    */
 930   void SetScale(float scale);
 931
 932   /**
 933    * @brief Sets the scale factor applied to an actor.
 934    *
 935    * @SINCE_1_0.0
 936    * @param[in] scaleX The scale factor applied along the x-axis
 937    * @param[in] scaleY The scale factor applied along the y-axis
 938    * @param[in] scaleZ The scale factor applied along the z-axis
 939    * @pre The Actor has been initialized.
 940    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 941    */
 942   void SetScale(float scaleX, float scaleY, float scaleZ);
 943
 944   /**
 945    * @brief Sets the scale factor applied to an actor.
 946    *
 947    * @SINCE_1_0.0
 948    * @param[in] scale A vector representing the scale factor for each axis
 949    * @pre The Actor has been initialized.
 950    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 951    */
 952   void SetScale(const Vector3& scale);
 953
 954   /**
 955    * @brief Applies a relative scale to an actor.
 956    *
 957    * @SINCE_1_0.0
 958    * @param[in] relativeScale The scale to combine with the actor's existing scale
 959    * @pre The actor has been initialized.
 960    */
 961   void ScaleBy(const Vector3& relativeScale);
 962
 963   /**
 964    * @brief Retrieves the scale factor applied to an actor.
 965    *
 966    * @SINCE_1_0.0
 967    * @return A vector representing the scale factor for each axis
 968    * @pre The Actor has been initialized.
 969    * @note This property can be animated; the return value may not match the value written with SetScale().
 970    */
 971   Vector3 GetCurrentScale() const;
 972
 973   /**
 974    * @brief Retrieves the world-scale of the Actor.
 975    *
 976    * @SINCE_1_0.0
 977    * @return The Actor's current scale in the world
 978    * @pre The Actor has been initialized.
 979    * @note The actor will not have a world-scale, unless it has previously been added to the stage.
 980    */
 981   Vector3 GetCurrentWorldScale() const;
 982
 983   /**
 984    * @brief Sets whether a child actor inherits it's parent's scale.
 985    *
 986    * Default is to inherit.
 987    * Switching this off means that using SetScale() sets the actor's world scale.
 988    * @SINCE_1_0.0
 989    * @param[in] inherit - @c true if the actor should inherit scale, @c false otherwise
 990    * @pre The Actor has been initialized.
 991    */
 992   void SetInheritScale( bool inherit );
 993
 994   /**
 995    * @brief Returns whether the actor inherits its parent's scale.
 996    *
 997    * @SINCE_1_0.0
 998    * @return @c true if the actor inherits its parent scale, @c false if it uses world scale
 999    * @pre The Actor has been initialized.
1000    */
1001   bool IsScaleInherited() const;
1002
1003   /**
1004    * @brief Retrieves the world-matrix of the actor.
1005    *
1006    * @SINCE_1_0.0
1007    * @return The Actor's current world matrix
1008    * @pre The Actor has been initialized.
1009    * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
1010    */
1011   Matrix GetCurrentWorldMatrix() const;
1012
1013   // Visibility & Color
1014
1015   /**
1016    * @brief Sets the visibility flag of an actor.
1017    *
1018    * @SINCE_1_0.0
1019    * @param[in] visible The new visibility flag
1020    * @pre The actor has been initialized.
1021    * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
1022    * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
1023    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
1024    *       rendered if all of its parents have visibility set to true.
1025    */
1026   void SetVisible(bool visible);
1027
1028   /**
1029    * @brief Retrieves the visibility flag of an actor.
1030    *
1031    * @SINCE_1_0.0
1032    * @return The visibility flag
1033    * @pre The actor has been initialized.
1034    * @note This property can be animated; the return value may not match the value written with SetVisible().
1035    * @note If an actor is not visible, then the actor and its children will not be rendered.
1036    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
1037    *       rendered if all of its parents have visibility set to true.
1038    */
1039   bool IsVisible() const;
1040
1041   /**
1042    * @brief Sets the opacity of an actor.
1043    *
1044    * @SINCE_1_0.0
1045    * @param[in] opacity The new opacity
1046    * @pre The actor has been initialized.
1047    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
1048    */
1049   void SetOpacity(float opacity);
1050
1051   /**
1052    * @brief Retrieves the actor's opacity.
1053    *
1054    * @SINCE_1_0.0
1055    * @return The actor's opacity
1056    * @pre The actor has been initialized.
1057    * @note This property can be animated; the return value may not match the value written with SetOpacity().
1058    */
1059   float GetCurrentOpacity() const;
1060
1061   /**
1062    * @brief Sets the actor's color; this is an RGBA value.
1063    *
1064    * The final color of the actor depends on its color mode.
1065    * @SINCE_1_0.0
1066    * @param[in] color The new color
1067    * @pre The Actor has been initialized.
1068    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
1069    */
1070   void SetColor(const Vector4& color);
1071
1072   /**
1073    * @brief Retrieves the actor's color.
1074    *
1075    * Actor's own color is not clamped.
1076    * @SINCE_1_0.0
1077    * @return The color
1078    * @pre The Actor has been initialized.
1079    * @note This property can be animated; the return value may not match the value written with SetColor().
1080    */
1081   Vector4 GetCurrentColor() const;
1082
1083   /**
1084    * @brief Sets the actor's color mode.
1085    *
1086    * This specifies whether the Actor uses its own color, or inherits
1087    * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
1088    * @SINCE_1_0.0
1089    * @param[in] colorMode ColorMode to use
1090    * @pre The Actor has been initialized.
1091    */
1092   void SetColorMode( ColorMode colorMode );
1093
1094   /**
1095    * @brief Returns the actor's color mode.
1096    *
1097    * @SINCE_1_0.0
1098    * @return Currently used colorMode
1099    * @pre The Actor has been initialized.
1100    */
1101   ColorMode GetColorMode() const;
1102
1103   /**
1104    * @brief Retrieves the world-color of the Actor, where each component is clamped within the 0->1 range.
1105    *
1106    * @SINCE_1_0.0
1107    * @return The Actor's current color in the world
1108    * @pre The Actor has been initialized.
1109    * @note The actor will not have a world-color, unless it has previously been added to the stage.
1110    */
1111   Vector4 GetCurrentWorldColor() const;
1112
1113   /**
1114    * @brief Sets how the actor and its children should be drawn.
1115    *
1116    * Not all actors are renderable, but DrawMode can be inherited from any actor.
1117    * If an object is in a 3D layer, it will be depth-tested against
1118    * other objects in the world i.e. it may be obscured if other objects are in front.
1119    *
1120    * If DrawMode::OVERLAY_2D is used, the actor and its children will be drawn as a 2D overlay.
1121    * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1122    * For overlay actors, the drawing order is with respect to tree levels of Actors,
1123    * and depth-testing will not be used.
1124
1125    * @SINCE_1_0.0
1126    * @param[in] drawMode The new draw-mode to use
1127    * @note Layers do not inherit the DrawMode from their parents.
1128    */
1129   void SetDrawMode( DrawMode::Type drawMode );
1130
1131   /**
1132    * @brief Queries how the actor and its children will be drawn.
1133    *
1134    * @SINCE_1_0.0
1135    * @return Return the draw mode type
1136    */
1137   DrawMode::Type GetDrawMode() const;
1138
1139   // Input Handling
1140
1141   /**
1142    * @brief Sets whether an actor should emit touch or hover signals.
1143    *
1144    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1145    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1146    * hover event signal will be emitted.
1147    *
1148    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1149    * @code
1150    * actor.SetSensitive(false);
1151    * @endcode
1152    *
1153    * Then, to re-enable the touch or hover event signal emission, the application should call:
1154    * @code
1155    * actor.SetSensitive(true);
1156    * @endcode
1157    *
1158    * @SINCE_1_0.0
1159    * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise
1160    * @pre The Actor has been initialized.
1161    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1162    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1163    *       hittable if all of its parents have sensitivity set to true.
1164    * @see @see TouchedSignal() and HoveredSignal().
1165    */
1166   void SetSensitive(bool sensitive);
1167
1168   /**
1169    * @brief Queries whether an actor emits touch or hover event signals.
1170    *
1171    * @SINCE_1_0.0
1172    * @return @c true, if emission of touch or hover event signals is enabled, @c false otherwise
1173    * @pre The Actor has been initialized.
1174    * @note If an actor is not sensitive, then it's children will not be hittable either.
1175    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1176    *       hittable if all of its parents have sensitivity set to true.
1177    */
1178   bool IsSensitive() const;
1179
1180   /**
1181    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1182    *
1183    * @SINCE_1_0.0
1184    * @param[out] localX On return, the X-coordinate relative to the actor
1185    * @param[out] localY On return, the Y-coordinate relative to the actor
1186    * @param[in] screenX The screen X-coordinate
1187    * @param[in] screenY The screen Y-coordinate
1188    * @return True if the conversion succeeded
1189    * @pre The Actor has been initialized.
1190    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1191    */
1192   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1193
1194   /**
1195    * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1196    * the boundary of the actor.
1197    *
1198    * @SINCE_1_0.0
1199    * @param[in] required Should be set to true if a Leave event is required
1200    * @pre The Actor has been initialized.
1201    * @note By default, this is set to false as most actors do not require this.
1202    * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
1203    *
1204    */
1205   void SetLeaveRequired(bool required);
1206
1207   /**
1208    * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1209    * the boundary of the actor.
1210    *
1211    * @SINCE_1_0.0
1212    * @return @c true if a Leave event is required, @c false otherwise
1213    * @pre The Actor has been initialized.
1214    */
1215   bool GetLeaveRequired() const;
1216
1217   /**
1218    * @brief Sets whether the actor should be focusable by keyboard navigation.
1219    *
1220    * The default is false.
1221    * @SINCE_1_0.0
1222    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1223    * false otherwise
1224    * @pre The Actor has been initialized.
1225    */
1226   void SetKeyboardFocusable( bool focusable );
1227
1228   /**
1229    * @brief Returns whether the actor is focusable by keyboard navigation.
1230    *
1231    * @SINCE_1_0.0
1232    * @return @c true if the actor is focusable by keyboard navigation, @c false if not
1233    * @pre The Actor has been initialized.
1234    */
1235   bool IsKeyboardFocusable() const;
1236
1237   /**
1238    * @brief Raise actor above the next sibling actor.
1239    *
1240    * @SINCE_1_2.60
1241    * @pre The Actor has been initialized.
1242    * @pre The Actor has been parented.
1243    */
1244   void Raise();
1245
1246   /**
1247    * @brief Lower the actor below the previous sibling actor.
1248    *
1249    * @SINCE_1_2.60
1250    * @pre The Actor has been initialized.
1251    * @pre The Actor has been parented.
1252    */
1253   void Lower();
1254
1255   /**
1256    * @brief Raise actor above all other sibling actors.
1257    *
1258    * @SINCE_1_2.60
1259    * @pre The Actor has been initialized.
1260    * @pre The Actor has been parented.
1261    */
1262   void RaiseToTop();
1263
1264   /**
1265    * @brief Lower actor to the bottom of all other sibling actors.
1266    *
1267    * @SINCE_1_2.60
1268    * @pre The Actor has been initialized.
1269    * @pre The Actor has been parented.
1270    */
1271   void LowerToBottom();
1272
1273   /**
1274    * @brief Raises the actor above the target actor.
1275    *
1276    * @SINCE_1_2.60
1277    * @param[in] target The target actor
1278    * @pre The Actor has been initialized.
1279    * @pre The Actor has been parented.
1280    * @pre The target actor is a sibling.
1281    */
1282   void RaiseAbove( Actor target );
1283
1284   /**
1285    * @brief Lower the actor to below the target actor.
1286    *
1287    * @SINCE_1_2.60
1288    * @param[in] target The target actor
1289    * @pre The Actor has been initialized.
1290    * @pre The Actor has been parented.
1291    * @pre The target actor is a sibling.
1292    */
1293   void LowerBelow( Actor target );
1294
1295   // SIZE NEGOTIATION
1296
1297   /**
1298    * @brief Sets the resize policy to be used for the given dimension(s).
1299    *
1300    * @SINCE_1_0.0
1301    * @param[in] policy The resize policy to use
1302    * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions
1303    */
1304   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1305
1306   /**
1307    * @brief Returns the resize policy used for a single dimension.
1308    *
1309    * @SINCE_1_0.0
1310    * @param[in] dimension The dimension to get policy for
1311    * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found
1312    */
1313   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1314
1315   /**
1316    * @brief Sets the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1317    *
1318    * @SINCE_1_0.0
1319    * @param[in] policy The policy to use for when the size is set
1320    */
1321   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1322
1323   /**
1324    * @brief Returns the size scale policy in use.
1325    *
1326    * @SINCE_1_0.0
1327    * @return Return the size scale policy
1328    */
1329   SizeScalePolicy::Type GetSizeScalePolicy() const;
1330
1331   /**
1332    * @brief Sets the relative to parent size factor of the actor.
1333    *
1334    * This factor is only used when ResizePolicy is set to either:
1335    * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1336    * This actor's size is set to the actor's size multiplied by or added to this factor,
1337    * depending on ResizePolicy ( See SetResizePolicy() ).
1338    *
1339    * @SINCE_1_0.0
1340    * @param[in] factor A Vector3 representing the relative factor to be applied to each axis
1341    * @pre The Actor has been initialized.
1342    */
1343   void SetSizeModeFactor( const Vector3& factor );
1344
1345   /**
1346    * @brief Retrieves the relative to parent size factor of the actor.
1347    *
1348    * @SINCE_1_0.0
1349    * @return The Actor's current relative size factor
1350    * @pre The Actor has been initialized.
1351    */
1352   Vector3 GetSizeModeFactor() const;
1353
1354   /**
1355    * @brief Calculates the height of the actor given a width.
1356    *
1357    * The natural size is used for default calculation.
1358    * size 0 is treated as aspect ratio 1:1.
1359    *
1360    * @SINCE_1_0.0
1361    * @param[in] width Width to use
1362    * @return Return the height based on the width
1363    */
1364   float GetHeightForWidth( float width );
1365
1366   /**
1367    * @brief Calculates the width of the actor given a height.
1368    *
1369    * The natural size is used for default calculation.
1370    * size 0 is treated as aspect ratio 1:1.
1371    *
1372    * @SINCE_1_0.0
1373    * @param[in] height Height to use
1374    * @return Return the width based on the height
1375    */
1376   float GetWidthForHeight( float height );
1377
1378   /**
1379    * @brief Returns the value of negotiated dimension for the given dimension.
1380    *
1381    * @SINCE_1_0.0
1382    * @param[in] dimension The dimension to retrieve
1383    * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found
1384    */
1385   float GetRelayoutSize( Dimension::Type dimension ) const;
1386
1387   /**
1388    * @brief Sets the padding for use in layout.
1389    *
1390    * @SINCE_1_0.0
1391    * @param[in] padding Padding for the actor
1392    */
1393   void SetPadding( const Padding& padding );
1394
1395   /**
1396    * @brief Returns the value of the padding.
1397    *
1398    * @SINCE_1_0.0
1399    * @param[in] paddingOut The returned padding data
1400    */
1401   void GetPadding( Padding& paddingOut ) const;
1402
1403   /**
1404    * @brief Sets the minimum size an actor can be assigned in size negotiation.
1405    *
1406    * @SINCE_1_0.0
1407    * @param[in] size The minimum size
1408    */
1409   void SetMinimumSize( const Vector2& size );
1410
1411   /**
1412    * @brief Returns the minimum relayout size.
1413    *
1414    * @SINCE_1_0.0
1415    * @return Return the minimum size
1416    */
1417   Vector2 GetMinimumSize();
1418
1419   /**
1420    * @brief Sets the maximum size an actor can be assigned in size negotiation.
1421    *
1422    * @SINCE_1_0.0
1423    * @param[in] size The maximum size
1424    */
1425   void SetMaximumSize( const Vector2& size );
1426
1427   /**
1428    * @brief Returns the maximum relayout size.
1429    *
1430    * @SINCE_1_0.0
1431    * @return Return the maximum size
1432    */
1433   Vector2 GetMaximumSize();
1434
1435   /**
1436    * @brief Gets depth in the hierarchy for the actor.
1437    *
1438    * @SINCE_1_0.0
1439    * @return The current depth in the hierarchy of the actor, or @c -1 if actor is not in the hierarchy
1440    */
1441   int32_t GetHierarchyDepth();
1442
1443 public: // Renderer
1444
1445   /**
1446    * @brief Adds a renderer to this actor.
1447    *
1448    * @SINCE_1_0.0
1449    * @param[in] renderer Renderer to add to the actor
1450    * @return The index of the Renderer that was added
1451    * @pre The renderer must be initialized.
1452    *
1453    */
1454   uint32_t AddRenderer( Renderer& renderer );
1455
1456   /**
1457    * @brief Gets the number of renderers on this actor.
1458    *
1459    * @SINCE_1_0.0
1460    * @return The number of renderers on this actor
1461    */
1462   uint32_t GetRendererCount() const;
1463
1464   /**
1465    * @brief Gets a Renderer by index.
1466    *
1467    * @SINCE_1_0.0
1468    * @param[in] index The index of the renderer to fetch
1469    * @return The renderer at the specified index
1470    * @pre The index must be between 0 and GetRendererCount()-1
1471    *
1472    */
1473   Renderer GetRendererAt( uint32_t index );
1474
1475   /**
1476    * @brief Removes a renderer from the actor.
1477    *
1478    * @SINCE_1_0.0
1479    * @param[in] renderer Handle to the renderer that is to be removed
1480    */
1481   void RemoveRenderer( Renderer& renderer );
1482
1483   /**
1484    * @brief Removes a renderer from the actor by index.
1485    *
1486    * @SINCE_1_0.0
1487    * @param[in] index Index of the renderer that is to be removed
1488    * @pre The index must be between 0 and GetRendererCount()-1
1489    *
1490    */
1491   void RemoveRenderer( uint32_t index );
1492
1493 public: // Signals
1494
1495   /**
1496    * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1497    * @brief This signal is emitted when touch input is received.
1498    *
1499    * A callback of the following type may be connected:
1500    * @code
1501    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1502    * @endcode
1503    * The return value of True, indicates that the touch event should be consumed.
1504    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1505    * @SINCE_1_0.0
1506    * @return The signal to connect to
1507    * @pre The Actor has been initialized.
1508    */
1509   TouchSignalType& TouchedSignal() DALI_DEPRECATED_API;
1510
1511   /**
1512    * @brief This signal is emitted when touch input is received.
1513    *
1514    * A callback of the following type may be connected:
1515    * @code
1516    *   bool YourCallbackName( Actor actor, TouchData& touch );
1517    * @endcode
1518    * The return value of True, indicates that the touch event has been consumed.
1519    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1520    * @SINCE_1_1.37
1521    * @return The signal to connect to
1522    * @pre The Actor has been initialized.
1523    */
1524   TouchDataSignalType& TouchSignal();
1525
1526   /**
1527    * @brief This signal is emitted when hover input is received.
1528    *
1529    * A callback of the following type may be connected:
1530    * @code
1531    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1532    * @endcode
1533    * The return value of True, indicates that the hover event should be consumed.
1534    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1535    * @SINCE_1_0.0
1536    * @return The signal to connect to
1537    * @pre The Actor has been initialized.
1538    */
1539   HoverSignalType& HoveredSignal();
1540
1541   /**
1542    * @brief This signal is emitted when wheel event is received.
1543    *
1544    * A callback of the following type may be connected:
1545    * @code
1546    *   bool YourCallbackName(Actor actor, const WheelEvent& event);
1547    * @endcode
1548    * The return value of True, indicates that the wheel event should be consumed.
1549    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1550    * @SINCE_1_0.0
1551    * @return The signal to connect to
1552    * @pre The Actor has been initialized.
1553    */
1554   WheelEventSignalType& WheelEventSignal();
1555
1556   /**
1557    * @brief This signal is emitted after the actor has been connected to the stage.
1558    *
1559    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1560    * @SINCE_1_0.0
1561    * @return The signal to connect to
1562    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1563    *
1564    * @note When the parent of a set of actors is connected to the stage, then all of the children
1565    * will received this callback.
1566    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1567    *
1568    * @code
1569    *
1570    *       A (parent)
1571    *      / \
1572    *     B   C
1573    *    / \   \
1574    *   D   E   F
1575    *
1576    * @endcode
1577    */
1578   OnStageSignalType& OnStageSignal();
1579
1580   /**
1581    * @brief This signal is emitted after the actor has been disconnected from the stage.
1582    *
1583    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1584    *
1585    * @SINCE_1_0.0
1586    * @return The signal to connect to
1587    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1588    * will received this callback, starting with the leaf actors.
1589    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1590    *
1591    * @code
1592    *
1593    *       A (parent)
1594    *      / \
1595    *     B   C
1596    *    / \   \
1597    *   D   E   F
1598    *
1599    * @endcode
1600    *
1601    */
1602   OffStageSignalType& OffStageSignal();
1603
1604   /**
1605    * @brief This signal is emitted after the size has been set on the actor during relayout
1606    *
1607    * @SINCE_1_0.0
1608    * @return The signal
1609    */
1610   OnRelayoutSignalType& OnRelayoutSignal();
1611
1612   /**
1613    * @brief This signal is emitted when the layout direction property of this or a parent actor is changed.
1614    *
1615    * A callback of the following type may be connected:
1616    * @code
1617    *   void YourCallbackName( Actor actor, LayoutDirection::Type type );
1618    * @endcode
1619    * actor: The actor, or child of actor, whose layout direction has changed
1620    * type: Whether the actor's layout direction property has changed or a parent's.
1621    *
1622    * @SINCE_1_2.60
1623    * @return The signal to connect to
1624    * @pre The Actor has been initialized.
1625    */
1626   LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal();
1627
1628 public: // Not intended for application developers
1629
1630   /// @cond internal
1631   /**
1632    * @brief This constructor is used by Actor::New() methods.
1633    *
1634    * @SINCE_1_0.0
1635    * @param [in] actor A pointer to a newly allocated Dali resource
1636    */
1637   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1638   /// @endcond
1639 };
1640
1641 /**
1642  * @brief Helper for discarding an actor handle.
1643  *
1644  * If the handle is empty, this method does nothing.  Otherwise
1645  * Actor::Unparent() will be called, followed by Actor::Reset().
1646  * @SINCE_1_0.0
1647  * @param[in,out] actor A handle to an actor, or an empty handle
1648  */
1649 inline void UnparentAndReset( Actor& actor )
1650 {
1651   if( actor )
1652   {
1653     actor.Unparent();
1654     actor.Reset();
1655   }
1656 }
1657
1658 /**
1659  * @}
1660  */
1661 } // namespace Dali
1662
1663 #endif // DALI_ACTOR_H