dali/public-api/actors/actor.h

   1 #ifndef __DALI_ACTOR_H__
   2 #define __DALI_ACTOR_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/actors/actor-enumerations.h>
  26 #include <dali/public-api/actors/draw-mode.h>
  27 #include <dali/public-api/math/radian.h>
  28 #include <dali/public-api/object/handle.h>
  29 #include <dali/public-api/object/property-index-ranges.h>
  30 #include <dali/public-api/signals/dali-signal.h>
  31 namespace Dali
  32 {
  33 /**
  34  * @addtogroup dali_core_actors
  35  * @{
  36  */
  37
  38 namespace Internal DALI_INTERNAL
  39 {
  40 class Actor;
  41 }
  42
  43 class Actor;
  44 class Renderer;
  45 struct Degree;
  46 class Quaternion;
  47 class Layer;
  48 struct KeyEvent;
  49 class TouchData;
  50 struct TouchEvent;
  51 struct HoverEvent;
  52 struct WheelEvent;
  53 struct Vector2;
  54 struct Vector3;
  55 struct Vector4;
  56
  57 typedef Rect<float> Padding;      ///< Padding definition @SINCE_1_0.0
  58
  59 /**
  60  * @brief Actor is the primary object with which Dali applications interact.
  61  *
  62  * UI controls can be built by combining multiple actors.
  63  *
  64  * <h3>Multi-Touch Events:</h3>
  65  *
  66  * Touch or hover events are received via signals; see Actor::TouchedSignal() and Actor::HoveredSignal() for more details.
  67  *
  68  * <i>Hit Testing Rules Summary:</i>
  69  *
  70  * - An actor is only hittable if the actor's touch or hover signal has a connection.
  71  * - An actor is only hittable when it is between the camera's near and far planes.
  72  * - If an actor is made insensitive, then the actor and its children are not hittable; see IsSensitive()
  73  * - If an actor's visibility flag is unset, then none of its children are hittable either; see IsVisible()
  74  * - To be hittable, an actor must have a non-zero size.
  75  * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor()
  76  *
  77  * <i>Hit Test Algorithm:</i>
  78  *
  79  * - Stage
  80  *   - Gets the first down and the last up touch events to the screen, regardless of actor touch event consumption.
  81  *   - Stage's root layer can be used to catch unconsumed touch events.
  82  *
  83  * - RenderTasks
  84  *   - Hit testing is dependent on the camera used, which is specific to each RenderTask.
  85  *
  86  * - Layers
  87  *   - For each RenderTask, hit testing starts from the top-most layer and we go through all the
  88  *     layers until we have a hit or there are none left.
  89  *   - Before we perform a hit test within a layer, we check if all the layer's parents are visible
  90  *     and sensitive.
  91  *   - If they are not, we skip hit testing the actors in that layer altogether.
  92  *   - If a layer is set to consume all touch, then we do not check any layers behind this layer.
  93  *
  94  * - Actors
  95  *   - The final part of hit testing is performed by walking through the actor tree within a layer.
  96  *   - The following pseudocode shows the algorithm used:
  97  *     @code
  98  *     HIT-TEST-WITHIN-LAYER( ACTOR )
  99  *     {
 100  *       // Only hit-test the actor and its children if it is sensitive and visible
 101  *       IF ( ACTOR-IS-SENSITIVE &&
 102  *            ACTOR-IS-VISIBLE &&
 103  *            ACTOR-IS-ON-STAGE )
 104  *       {
 105  *         // Depth-first traversal within current layer, visiting parent first
 106  *
 107  *         // Check whether current actor should be hit-tested.
 108  *         IF ( ( TOUCH-SIGNAL-NOT-EMPTY || HOVER-SIGNAL-NOT-EMPTY ) &&
 109  *              ACTOR-HAS-NON-ZERO-SIZE &&
 110  *              ACTOR-WORLD-COLOR-IS-NOT-TRANSPARENT )
 111  *         {
 112  *           // Hit-test current actor
 113  *           IF ( ACTOR-HIT )
 114  *           {
 115  *             IF ( ACTOR-IS-OVERLAY || ( DISTANCE-TO-ACTOR < DISTANCE-TO-LAST-HIT-ACTOR ) )
 116  *             {
 117  *               // The current actor is the closest actor that was underneath the touch.
 118  *               LAST-HIT-ACTOR = CURRENT-ACTOR
 119  *             }
 120  *           }
 121  *         }
 122  *
 123  *         // Keep checking children, in case we hit something closer.
 124  *         FOR-EACH CHILD (in order)
 125  *         {
 126  *           IF ( CHILD-IS-NOT-A-LAYER )
 127  *           {
 128  *             // Continue traversal for this child's sub-tree
 129  *             HIT-TEST-WITHIN-LAYER ( CHILD )
 130  *           }
 131  *           // else we skip hit-testing the child's sub-tree altogether.
 132  *         }
 133  *       }
 134  *     }
 135  *     @endcode
 136  *   - Overlays always take priority (i.e. they're considered closer) regardless of distance.
 137  *     The overlay children take priority over their parents, and overlay siblings take priority
 138  *     over their previous siblings (i.e. reverse of rendering order):
 139  *     @code
 140  *           1
 141  *          / \
 142  *         /   \
 143  *        2     5
 144  *       / \     \
 145  *      /   \     \
 146  *     3     4     6
 147  *
 148  *     Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest.
 149  *     @endcode
 150  *   - Stencil Actors can be used to influence the result of hits on renderable actors within a layer.
 151  *     If a Stencil Actor exists on a layer and that Actor is marked visible then a successful
 152  *     hit on a renderable actor can only take place in the area that the stencil Actor marks as visible.
 153  *     The hit can be in any Stencil Actor in that layer, but must be in the region of one of them.
 154  *     Stencil Actor inheritance behaves as with rendering in that any child of a Stencil Actor will
 155  *     also be considered a Stencil Actor.
 156  *     Non-renderable actors can be hit regardless of whether a stencil actor is hit or not.
 157  *
 158  * <i>Touch or hover Event Delivery:</i>
 159  *
 160  * - Delivery
 161  *   - The hit actor's touch or hover signal is emitted first; if it is not consumed by any of the listeners,
 162  *     the parent's touch or hover signal is emitted, and so on.
 163  *   - The following pseudocode shows the delivery mechanism:
 164  *     @code
 165  *     EMIT-TOUCH-SIGNAL( ACTOR )
 166  *     {
 167  *       IF ( TOUCH-SIGNAL-NOT-EMPTY )
 168  *       {
 169  *         // Only do the emission if touch signal of actor has connections.
 170  *         CONSUMED = TOUCHED-SIGNAL( TOUCH-EVENT )
 171  *       }
 172  *
 173  *       IF ( NOT-CONSUMED )
 174  *       {
 175  *         // If event is not consumed then deliver it to the parent unless we reach the root actor
 176  *         IF ( ACTOR-PARENT )
 177  *         {
 178  *           EMIT-TOUCH-SIGNAL( ACTOR-PARENT )
 179  *         }
 180  *       }
 181  *     }
 182  *
 183  *     EMIT-HOVER-SIGNAL( ACTOR )
 184  *     {
 185  *       IF ( HOVER-SIGNAL-NOT-EMPTY )
 186  *       {
 187  *         // Only do the emission if hover signal of actor has connections.
 188  *         CONSUMED = HOVERED-SIGNAL( HOVER-EVENT )
 189  *       }
 190  *
 191  *       IF ( NOT-CONSUMED )
 192  *       {
 193  *         // If event is not consumed then deliver it to the parent unless we reach the root actor.
 194  *         IF ( ACTOR-PARENT )
 195  *         {
 196  *           EMIT-HOVER-SIGNAL( ACTOR-PARENT )
 197  *         }
 198  *       }
 199  *     }
 200  *     @endcode
 201  *   - If there are several touch points, then the delivery is only to the first touch point's hit
 202  *     actor (and its parents).  There will be NO touch or hover signal delivery for the hit actors of the
 203  *     other touch points.
 204  *   - The local coordinates are from the top-left (0.0f, 0.0f, 0.5f) of the hit actor.
 205  *
 206  * - Leave State
 207  *   - A "Leave" state is set when the first point exits the bounds of the previous first point's
 208  *     hit actor (primary hit actor).
 209  *   - When this happens, the last primary hit actor's touch or hover signal is emitted with a "Leave" state
 210  *     (only if it requires leave signals); see SetLeaveRequired().
 211  *
 212  * - Interrupted State
 213  *   - If a system event occurs which interrupts the touch or hover processing, then the last primary hit
 214  *     actor's touch or hover signals are emitted with an "Interrupted" state.
 215  *   - If the last primary hit actor, or one of its parents, is no longer touchable or hoverable, then its
 216  *     touch or hover signals are also emitted with an "Interrupted" state.
 217  *   - If the consumed actor on touch-down is not the same as the consumed actor on touch-up, then
 218  *     touch signals are also emitted from the touch-down actor with an "Interrupted" state.
 219  *   - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
 220  *     hover signals are also emitted from the hover-started actor with an "Interrupted" state.
 221  *
 222  * <h3>Key Events:</h3>
 223  *
 224  * Key events are received by an actor once set to grab key events, only one actor can be set as focused.
 225  *
 226  * @nosubgrouping
 227  *
 228  * Signals
 229  * | %Signal Name      | Method                       |
 230  * |-------------------|------------------------------|
 231  * | touched           | @ref TouchedSignal()         |
 232  * | hovered           | @ref HoveredSignal()         |
 233  * | wheelEvent        | @ref WheelEventSignal()      |
 234  * | onStage           | @ref OnStageSignal()         |
 235  * | offStage          | @ref OffStageSignal()        |
 236  * | onRelayout        | @ref OnRelayoutSignal()      |
 237  *
 238  * Actions
 239  * | %Action Name      | %Actor method called         |
 240  * |-------------------|------------------------------|
 241  * | show              | %SetVisible( true )          |
 242  * | hide              | %SetVisible( false )         |
 243  * @SINCE_1_0.0
 244  */
 245
 246 class DALI_IMPORT_API Actor : public Handle
 247 {
 248 public:
 249
 250   /**
 251    * @brief An enumeration of properties belonging to the Actor class.
 252    * @SINCE_1_0.0
 253    */
 254   struct Property
 255   {
 256     enum
 257     {
 258       PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "parentOrigin",          type Vector3    (constraint-input) @SINCE_1_0.0
 259       PARENT_ORIGIN_X,                                    ///< name "parentOriginX",         type float      (constraint-input) @SINCE_1_0.0
 260       PARENT_ORIGIN_Y,                                    ///< name "parentOriginY",         type float      (constraint-input) @SINCE_1_0.0
 261       PARENT_ORIGIN_Z,                                    ///< name "parentOriginZ",         type float      (constraint-input) @SINCE_1_0.0
 262       ANCHOR_POINT,                                       ///< name "anchorPoint",           type Vector3    (constraint-input) @SINCE_1_0.0
 263       ANCHOR_POINT_X,                                     ///< name "anchorPointX",          type float      (constraint-input) @SINCE_1_0.0
 264       ANCHOR_POINT_Y,                                     ///< name "anchorPointY",          type float      (constraint-input) @SINCE_1_0.0
 265       ANCHOR_POINT_Z,                                     ///< name "anchorPointZ",          type float      (constraint-input) @SINCE_1_0.0
 266       SIZE,                                               ///< name "size",                  type Vector3    (animatable / constraint-input) @SINCE_1_0.0
 267       SIZE_WIDTH,                                         ///< name "sizeWidth",             type float      (animatable / constraint-input) @SINCE_1_0.0
 268       SIZE_HEIGHT,                                        ///< name "sizeHeight",            type float      (animatable / constraint-input) @SINCE_1_0.0
 269       SIZE_DEPTH,                                         ///< name "sizeDepth",             type float      (animatable / constraint-input) @SINCE_1_0.0
 270       POSITION,                                           ///< name "position",              type Vector3    (animatable / constraint-input) @SINCE_1_0.0
 271       POSITION_X,                                         ///< name "positionX",             type float      (animatable / constraint-input) @SINCE_1_0.0
 272       POSITION_Y,                                         ///< name "positionY",             type float      (animatable / constraint-input) @SINCE_1_0.0
 273       POSITION_Z,                                         ///< name "positionZ",             type float      (animatable / constraint-input) @SINCE_1_0.0
 274       WORLD_POSITION,                                     ///< name "worldPosition",         type Vector3    (read-only / constraint-input) @SINCE_1_0.0
 275       WORLD_POSITION_X,                                   ///< name "worldPositionX",        type float      (read-only / constraint-input) @SINCE_1_0.0
 276       WORLD_POSITION_Y,                                   ///< name "worldPositionY",        type float      (read-only / constraint-input) @SINCE_1_0.0
 277       WORLD_POSITION_Z,                                   ///< name "worldPositionZ",        type float      (read-only / constraint-input) @SINCE_1_0.0
 278       ORIENTATION,                                        ///< name "orientation",           type Quaternion (animatable / constraint-input) @SINCE_1_0.0
 279       WORLD_ORIENTATION,                                  ///< name "worldOrientation",      type Quaternion (read-only / constraint-input) @SINCE_1_0.0
 280       SCALE,                                              ///< name "scale",                 type Vector3    (animatable / constraint-input) @SINCE_1_0.0
 281       SCALE_X,                                            ///< name "scaleX",                type float      (animatable / constraint-input) @SINCE_1_0.0
 282       SCALE_Y,                                            ///< name "scaleY",                type float      (animatable / constraint-input) @SINCE_1_0.0
 283       SCALE_Z,                                            ///< name "scaleZ",                type float      (animatable / constraint-input) @SINCE_1_0.0
 284       WORLD_SCALE,                                        ///< name "worldScale",            type Vector3    (read-only / constraint-input) @SINCE_1_0.0
 285       VISIBLE,                                            ///< name "visible",               type bool       (animatable / constraint-input) @SINCE_1_0.0
 286       COLOR,                                              ///< name "color",                 type Vector4    (animatable / constraint-input) @SINCE_1_0.0
 287       COLOR_RED,                                          ///< name "colorRed",              type float      (animatable / constraint-input) @SINCE_1_0.0
 288       COLOR_GREEN,                                        ///< name "colorGreen",            type float      (animatable / constraint-input) @SINCE_1_0.0
 289       COLOR_BLUE,                                         ///< name "colorBlue",             type float      (animatable / constraint-input) @SINCE_1_0.0
 290       COLOR_ALPHA,                                        ///< name "colorAlpha",            type float      (animatable / constraint-input) @SINCE_1_0.0
 291       WORLD_COLOR,                                        ///< name "worldColor",            type Vector4    (read-only / constraint-input) @SINCE_1_0.0
 292       WORLD_MATRIX,                                       ///< name "worldMatrix",           type Matrix     (read-only / constraint-input) @SINCE_1_0.0
 293       NAME,                                               ///< name "name",                  type std::string @SINCE_1_0.0
 294       SENSITIVE,                                          ///< name "sensitive",             type bool @SINCE_1_0.0
 295       LEAVE_REQUIRED,                                     ///< name "leaveRequired",         type bool @SINCE_1_0.0
 296       INHERIT_ORIENTATION,                                ///< name "inheritOrientation",    type bool @SINCE_1_0.0
 297       INHERIT_SCALE,                                      ///< name "inheritScale",          type bool @SINCE_1_0.0
 298       COLOR_MODE,                                         ///< name "colorMode",             type std::string @SINCE_1_0.0
 299       POSITION_INHERITANCE,                               ///< name "positionInheritance",   type std::string @DEPRECATED_1_1.24 Use INHERIT_POSITION instead
 300       DRAW_MODE,                                          ///< name "drawMode",              type std::string @SINCE_1_0.0
 301       SIZE_MODE_FACTOR,                                   ///< name "sizeModeFactor",        type Vector3 @SINCE_1_0.0
 302       WIDTH_RESIZE_POLICY,                                ///< name "widthResizePolicy",     type String @SINCE_1_0.0
 303       HEIGHT_RESIZE_POLICY,                               ///< name "heightResizePolicy",    type String @SINCE_1_0.0
 304       SIZE_SCALE_POLICY,                                  ///< name "sizeScalePolicy",       type String @SINCE_1_0.0
 305       WIDTH_FOR_HEIGHT,                                   ///< name "widthForHeight",        type Boolean @SINCE_1_0.0
 306       HEIGHT_FOR_WIDTH,                                   ///< name "heightForWidth",        type Boolean @SINCE_1_0.0
 307       PADDING,                                            ///< name "padding",               type Vector4 @SINCE_1_0.0
 308       MINIMUM_SIZE,                                       ///< name "minimumSize",           type Vector2 @SINCE_1_0.0
 309       MAXIMUM_SIZE,                                       ///< name "maximumSize",           type Vector2 @SINCE_1_0.0
 310       INHERIT_POSITION,                                   ///< name "inheritPosition",       type bool @SINCE_1_1.24
 311       BATCH_PARENT,                                       ///< name "batchParent",           type bool @SINCE_1_2.0
 312     };
 313   };
 314
 315   // Typedefs
 316
 317   typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType;        ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
 318   typedef Signal< bool (Actor, const TouchData&) >  TouchDataSignalType;    ///< Touch signal type @SINCE_1_1.37
 319   typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType;        ///< Hover signal type @SINCE_1_0.0
 320   typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type @SINCE_1_0.0
 321   typedef Signal< void (Actor) > OnStageSignalType;                         ///< Stage connection signal type @SINCE_1_0.0
 322   typedef Signal< void (Actor) > OffStageSignalType;                        ///< Stage disconnection signal type @SINCE_1_0.0
 323   typedef Signal< void (Actor) > OnRelayoutSignalType;                      ///< Called when the actor is relaid out @SINCE_1_0.0
 324
 325   // Creation
 326
 327   /**
 328    * @brief Create an uninitialized Actor; this can be initialized with Actor::New().
 329    *
 330    * Calling member functions with an uninitialized Actor handle is not allowed.
 331    * @SINCE_1_0.0
 332    */
 333   Actor();
 334
 335   /**
 336    * @brief Create an initialized Actor.
 337    *
 338    * @SINCE_1_0.0
 339    * @return A handle to a newly allocated Dali resource.
 340    */
 341   static Actor New();
 342
 343   /**
 344    * @brief Downcast a handle to Actor handle.
 345    *
 346    * If handle points to a Actor object the downcast produces valid
 347    * handle. If not the returned handle is left uninitialized.
 348    *
 349    * @SINCE_1_0.0
 350    * @param[in] handle to An object
 351    * @return handle to a Actor object or an uninitialized handle
 352    */
 353   static Actor DownCast( BaseHandle handle );
 354
 355   /**
 356    * @brief Dali::Actor is intended as a base class
 357    *
 358    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 359    * @SINCE_1_0.0
 360    */
 361   ~Actor();
 362
 363   /**
 364    * @brief Copy constructor
 365    *
 366    * @SINCE_1_0.0
 367    * @param [in] copy The actor to copy.
 368    */
 369   Actor(const Actor& copy);
 370
 371   /**
 372    * @brief Assignment operator
 373    *
 374    * @SINCE_1_0.0
 375    * @param [in] rhs The actor to copy.
 376    * @return A reference to this
 377    */
 378   Actor& operator=(const Actor& rhs);
 379
 380   /**
 381    * @brief Retrieve the Actor's name.
 382    *
 383    * @SINCE_1_0.0
 384    * @return The Actor's name.
 385    * @pre The Actor has been initialized.
 386    */
 387   const std::string& GetName() const;
 388
 389   /**
 390    * @brief Sets the Actor's name.
 391    *
 392    * @SINCE_1_0.0
 393    * @param [in] name The new name.
 394    * @pre The Actor has been initialized.
 395    */
 396   void SetName(const std::string& name);
 397
 398   /**
 399    * @brief Retrieve the unique ID of the actor.
 400    *
 401    * @SINCE_1_0.0
 402    * @return The ID.
 403    * @pre The Actor has been initialized.
 404    */
 405   unsigned int GetId() const;
 406
 407   // Containment
 408
 409   /**
 410    * @brief Query whether an actor is the root actor, which is owned by the Stage.
 411    *
 412    * @SINCE_1_0.0
 413    * @return True if the actor is the root actor.
 414    * @pre The Actor has been initialized.
 415    */
 416   bool IsRoot() const;
 417
 418   /**
 419    * @brief Query whether the actor is connected to the Stage.
 420    *
 421    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
 422    * @SINCE_1_0.0
 423    * @return True if the actor is connected to the Stage.
 424    * @pre The Actor has been initialized.
 425    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
 426    */
 427   bool OnStage() const;
 428
 429   /**
 430    * @brief Query whether the actor is of class Dali::Layer.
 431    *
 432    * @SINCE_1_0.0
 433    * @return True if the actor is a layer.
 434    * @pre The Actor has been initialized.
 435    */
 436   bool IsLayer() const;
 437
 438   /**
 439    * @brief Gets the layer in which the actor is present.
 440    *
 441    * @SINCE_1_0.0
 442    * @return The layer, which will be uninitialized if the actor is off-stage.
 443    * @pre The Actor has been initialized.
 444    */
 445   Layer GetLayer();
 446
 447   /**
 448    * @brief Adds a child Actor to this Actor.
 449    *
 450    * @SINCE_1_0.0
 451    * @param [in] child The child.
 452    * @pre This Actor (the parent) has been initialized.
 453    * @pre The child actor has been initialized.
 454    * @pre The child actor is not the same as the parent actor.
 455    * @pre The actor is not the Root actor.
 456    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 457    * even if the handle passed into this method is reset or destroyed.
 458    * @note if the child already has a parent, it will be removed from old parent
 459    * and reparented to this actor. This may change childs position, color,
 460    * scale etc as it now inherits them from this actor.
 461    */
 462   void Add(Actor child);
 463
 464   /**
 465    * @brief Removes a child Actor from this Actor.
 466    *
 467    * If the actor was not a child of this actor, this is a no-op.
 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 is not the same as the parent actor.
 472    */
 473   void Remove(Actor child);
 474
 475   /**
 476    * @brief Removes an actor from its parent.
 477    *
 478    * If the actor has no parent, this method does nothing.
 479    * @SINCE_1_0.0
 480    * @pre The (child) actor has been initialized.
 481    */
 482   void Unparent();
 483
 484   /**
 485    * @brief Retrieve the number of children held by the actor.
 486    *
 487    * @SINCE_1_0.0
 488    * @return The number of children
 489    * @pre The Actor has been initialized.
 490    */
 491   unsigned int GetChildCount() const;
 492
 493   /**
 494    * @brief Retrieve and child actor by index.
 495    *
 496    * @SINCE_1_0.0
 497    * @param[in] index The index of the child to retrieve
 498    * @return The actor for the given index or empty handle if children not initialised
 499    * @pre The Actor has been initialized.
 500    */
 501   Actor GetChildAt(unsigned int index) const;
 502
 503   /**
 504    * @brief Search through this actor's hierarchy for an actor with the given name.
 505    *
 506    * The actor itself is also considered in the search.
 507    * @SINCE_1_0.0
 508    * @param[in] actorName the name of the actor to find
 509    * @return A handle to the actor if found, or an empty handle if not.
 510    * @pre The Actor has been initialized.
 511    */
 512   Actor FindChildByName(const std::string& actorName);
 513
 514   /**
 515    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 516    *
 517    * The actor itself is also considered in the search.
 518    * @SINCE_1_0.0
 519    * @param[in] id the ID of the actor to find
 520    * @return A handle to the actor if found, or an empty handle if not.
 521    * @pre The Actor has been initialized.
 522    */
 523   Actor FindChildById(const unsigned int id);
 524
 525   /**
 526    * @brief Retrieve the actor's parent.
 527    *
 528    * @SINCE_1_0.0
 529    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
 530    * @pre The actor has been initialized.
 531    */
 532   Actor GetParent() const;
 533
 534   // Positioning
 535
 536   /**
 537    * @brief Set the origin of an actor, within its parent's area.
 538    *
 539    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 540    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 541    * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
 542    * An actor position is the distance between this origin, and the actors anchor-point.
 543    * @SINCE_1_0.0
 544    * @param [in] origin The new parent-origin.
 545    * @pre The Actor has been initialized.
 546    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentParentOrigin().
 547    * @see Dali::ParentOrigin for predefined parent origin values
 548    */
 549   void SetParentOrigin(const Vector3& origin);
 550
 551   /**
 552    * @brief Retrieve the parent-origin of an actor.
 553    *
 554    * @SINCE_1_0.0
 555    * @return The current parent-origin.
 556    * @pre The Actor has been initialized.
 557    * @note This property can be animated; the return value may not match the value written with SetParentOrigin().
 558    */
 559   Vector3 GetCurrentParentOrigin() const;
 560
 561   /**
 562    * @brief Set the anchor-point of an actor.
 563    *
 564    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
 565    * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
 566    * bottom-right corner.  The default anchor point is
 567    * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
 568    * An actor position is the distance between its parent-origin, and this anchor-point.
 569    * An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
 570    * @SINCE_1_0.0
 571    * @param [in] anchorPoint The new anchor-point.
 572    * @pre The Actor has been initialized.
 573    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentAnchorPoint().
 574    * @see Dali::AnchorPoint for predefined anchor point values
 575    */
 576   void SetAnchorPoint(const Vector3& anchorPoint);
 577
 578   /**
 579    * @brief Retrieve the anchor-point of an actor.
 580    *
 581    * @SINCE_1_0.0
 582    * @return The current anchor-point.
 583    * @pre The Actor has been initialized.
 584    * @note This property can be animated; the return value may not match the value written with SetAnchorPoint().
 585    */
 586   Vector3 GetCurrentAnchorPoint() const;
 587
 588   /**
 589    * @brief Sets the size of an actor.
 590    *
 591    * Geometry can be scaled to fit within this area.
 592    * This does not interfere with the actors scale factor.
 593    * The actors default depth is the minimum of width & height.
 594    * @SINCE_1_0.0
 595    * @param [in] width  The new width.
 596    * @param [in] height The new height.
 597    * @pre The actor has been initialized.
 598    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 599    */
 600   void SetSize(float width, float height);
 601
 602   /**
 603    * @brief Sets the size of an actor.
 604    *
 605    * Geometry can be scaled to fit within this area.
 606    * This does not interfere with the actors scale factor.
 607    * @SINCE_1_0.0
 608    * @param [in] width  The size of the actor along the x-axis.
 609    * @param [in] height The size of the actor along the y-axis.
 610    * @param [in] depth The size of the actor along the z-axis.
 611    * @pre The actor has been initialized.
 612    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 613    */
 614   void SetSize(float width, float height, float depth);
 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    * The actors default depth is the minimum of width & height.
 622    * @SINCE_1_0.0
 623    * @param [in] size The new size.
 624    * @pre The actor has been initialized.
 625    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 626    */
 627   void SetSize(const Vector2& size);
 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    * @SINCE_1_0.0
 635    * @param [in] size The new size.
 636    * @pre The actor has been initialized.
 637    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 638    */
 639   void SetSize(const Vector3& size);
 640
 641   /**
 642    * @brief Retrieve the actor's size.
 643    *
 644    * @SINCE_1_0.0
 645    * @return The actor's target size.
 646    * @pre The actor has been initialized.
 647    * @note This return is the value that was set using SetSize or the target size of an animation.
 648    */
 649   Vector3 GetTargetSize() const;
 650
 651   /**
 652    * @brief Retrieve the actor's size.
 653    *
 654    * @SINCE_1_0.0
 655    * @return The actor's current size.
 656    * @pre The actor has been initialized.
 657    * @note This property can be animated; the return value may not match the value written with SetSize().
 658    */
 659   Vector3 GetCurrentSize() const;
 660
 661   /**
 662    * @brief Return the natural size of the actor.
 663    *
 664    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 665    *
 666    * @SINCE_1_0.0
 667    * @return The actor's natural size
 668    */
 669   Vector3 GetNaturalSize() const;
 670
 671   /**
 672    * @brief Sets the position of the actor.
 673    *
 674    * The Actor's z position will be set to 0.0f.
 675    * @SINCE_1_0.0
 676    * @param [in] x The new x position
 677    * @param [in] y The new y position
 678    * @pre The Actor has been initialized.
 679    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 680    */
 681   void SetPosition(float x, float y);
 682
 683   /**
 684    * @brief Sets the position of the Actor.
 685    *
 686    * @SINCE_1_0.0
 687    * @param [in] x The new x position
 688    * @param [in] y The new y position
 689    * @param [in] z The new z position
 690    * @pre The Actor has been initialized.
 691    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 692    */
 693   void SetPosition(float x, float y, float z);
 694
 695   /**
 696    * @brief Sets the position of the Actor.
 697    *
 698    * @SINCE_1_0.0
 699    * @param [in] position The new position
 700    * @pre The Actor has been initialized.
 701    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 702    */
 703   void SetPosition(const Vector3& position);
 704
 705   /**
 706    * @brief Set the position of an actor along the X-axis.
 707    *
 708    * @SINCE_1_0.0
 709    * @param [in] x The new x position
 710    * @pre The Actor has been initialized.
 711    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 712    */
 713   void SetX(float x);
 714
 715   /**
 716    * @brief Set the position of an actor along the Y-axis.
 717    *
 718    * @SINCE_1_0.0
 719    * @param [in] y The new y position.
 720    * @pre The Actor has been initialized.
 721    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 722    */
 723   void SetY(float y);
 724
 725   /**
 726    * @brief Set the position of an actor along the Z-axis.
 727    *
 728    * @SINCE_1_0.0
 729    * @param [in] z The new z position
 730    * @pre The Actor has been initialized.
 731    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 732    */
 733   void SetZ(float z);
 734
 735   /**
 736    * @brief Translate an actor relative to its existing position.
 737    *
 738    * @SINCE_1_0.0
 739    * @param[in] distance The actor will move by this distance.
 740    * @pre The actor has been initialized.
 741    */
 742   void TranslateBy(const Vector3& distance);
 743
 744   /**
 745    * @brief Retrieve the position of the Actor.
 746    *
 747    * @SINCE_1_0.0
 748    * @return the Actor's current position.
 749    * @pre The Actor has been initialized.
 750    * @note This property can be animated; the return value may not match the value written with SetPosition().
 751    */
 752   Vector3 GetCurrentPosition() const;
 753
 754   /**
 755    * @brief Retrieve the world-position of the Actor.
 756    *
 757    * @SINCE_1_0.0
 758    * @return The Actor's current position in world coordinates.
 759    * @pre The Actor has been initialized.
 760    * @note The actor will not have a world-position, unless it has previously been added to the stage.
 761    */
 762   Vector3 GetCurrentWorldPosition() const;
 763
 764   /**
 765    * @DEPRECATED_1_1.24 Use SetInheritPosition instead
 766    * @brief Set the actors position inheritance mode.
 767    *
 768    * The default is to inherit.
 769    * Switching this off means that using SetPosition() sets the actor's world position.
 770    * @SINCE_1_0.0
 771    * @param[in] mode to use
 772    * @pre The Actor has been initialized.
 773    * @see PositionInheritanceMode
 774    */
 775   void SetPositionInheritanceMode( PositionInheritanceMode mode );
 776
 777   /**
 778    * @brief Set whether a child actor inherits it's parent's position.
 779    *
 780    * Default is to inherit.
 781    * Switching this off means that using SetPosition() sets the actor's world position3
 782    * @SINCE_1_1.24
 783    * @param[in] inherit - true if the actor should inherit position, false otherwise.
 784    * @pre The Actor has been initialized.
 785    */
 786   inline void SetInheritPosition( bool inherit )
 787   {
 788     SetProperty(Property::INHERIT_POSITION, inherit );
 789   }
 790
 791   /**
 792    * @DEPRECATED_1_1.24 Use IsPositionInherited
 793    * @brief Returns the actors position inheritance mode.
 794    *
 795    * @SINCE_1_0.0
 796    * @return Return the position inheritance mode.
 797    * @pre The Actor has been initialized.
 798    */
 799   PositionInheritanceMode GetPositionInheritanceMode() const;
 800
 801   /**
 802    * @brief Returns whether the actor inherits its parent's position.
 803    *
 804    * @SINCE_1_1.24
 805    * @return True if the actor inherits its parent position, 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 Apply 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 Apply 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 Apply 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 Retreive 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 Set 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 - true if the actor should inherit orientation, 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 True if the actor inherits its parent orientation, false if it uses world orientation.
 909    * @pre The Actor has been initialized.
 910    */
 911   bool IsOrientationInherited() const;
 912
 913   /**
 914    * @brief Retrieve 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 Set 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 Set 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 Set 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 Apply 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 Retrieve 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 Retrieve 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 Set 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 - true if the actor should inherit scale, 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 True if the actor inherits its parent scale, 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 Retrieve 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 Retrieve 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 Retrieve 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 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 Retrieve 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 Set 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    * If DrawMode::STENCIL is used, the actor and its children will be used to stencil-test other actors
1127    * within the Layer. Stencil actors are therefore drawn into the stencil buffer before any other
1128    * actors within the Layer.
1129    *
1130    * @SINCE_1_0.0
1131    * @param[in] drawMode The new draw-mode to use.
1132    * @note Setting STENCIL will override OVERLAY_2D, if that would otherwise have been inherited.
1133    * @note Layers do not inherit the DrawMode from their parents.
1134    */
1135   void SetDrawMode( DrawMode::Type drawMode );
1136
1137   /**
1138    * @brief Query how the actor and its children will be drawn.
1139    *
1140    * @SINCE_1_0.0
1141    * @return Return the draw mode type.
1142    */
1143   DrawMode::Type GetDrawMode() const;
1144
1145   // Input Handling
1146
1147   /**
1148    * @brief Sets whether an actor should emit touch or hover signals.
1149    *
1150    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1151    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1152    * hover event signal will be emitted.
1153    *
1154    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1155    * @code
1156    * actor.SetSensitive(false);
1157    * @endcode
1158    *
1159    * Then, to re-enable the touch or hover event signal emission, the application should call:
1160    * @code
1161    * actor.SetSensitive(true);
1162    * @endcode
1163    *
1164    * @SINCE_1_0.0
1165    * @param[in]  sensitive  true to enable emission of the touch or hover event signals, false otherwise.
1166    * @pre The Actor has been initialized.
1167    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1168    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1169    *       hittable if all of its parents have sensitivity set to true.
1170    * @see @see TouchedSignal() and HoveredSignal().
1171    */
1172   void SetSensitive(bool sensitive);
1173
1174   /**
1175    * @brief Query whether an actor emits touch or hover event signals.
1176    *
1177    * @SINCE_1_0.0
1178    * @return True, if emission of touch or hover event signals is enabled, false otherwise.
1179    * @pre The Actor has been initialized.
1180    * @note If an actor is not sensitive, then it's children will not be hittable either.
1181    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1182    *       hittable if all of its parents have sensitivity set to true.
1183    */
1184   bool IsSensitive() const;
1185
1186   /**
1187    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1188    *
1189    * @SINCE_1_0.0
1190    * @param[out] localX On return, the X-coordinate relative to the actor.
1191    * @param[out] localY On return, the Y-coordinate relative to the actor.
1192    * @param[in] screenX The screen X-coordinate.
1193    * @param[in] screenY The screen Y-coordinate.
1194    * @return True if the conversion succeeded.
1195    * @pre The Actor has been initialized.
1196    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1197    */
1198   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1199
1200   /**
1201    * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1202    * the boundary of the actor.
1203    *
1204    * @SINCE_1_0.0
1205    * @param[in]  required  Should be set to true if a Leave event is required
1206    * @pre The Actor has been initialized.
1207    * @note By default, this is set to false as most actors do not require this.
1208    * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
1209    *
1210    */
1211   void SetLeaveRequired(bool required);
1212
1213   /**
1214    * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1215    * the boundary of the actor.
1216    *
1217    * @SINCE_1_0.0
1218    * @return True if a Leave event is required, false otherwise.
1219    * @pre The Actor has been initialized.
1220    */
1221   bool GetLeaveRequired() const;
1222
1223   /**
1224    * @brief Sets whether the actor should be focusable by keyboard navigation.
1225    *
1226    * The default is false.
1227    * @SINCE_1_0.0
1228    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1229    * false otherwise.
1230    * @pre The Actor has been initialized.
1231    */
1232   void SetKeyboardFocusable( bool focusable );
1233
1234   /**
1235    * @brief Returns whether the actor is focusable by keyboard navigation.
1236    *
1237    * @SINCE_1_0.0
1238    * @return True if the actor is focusable by keyboard navigation, false if not.
1239    * @pre The Actor has been initialized.
1240    */
1241   bool IsKeyboardFocusable() const;
1242
1243   // SIZE NEGOTIATION
1244
1245   /**
1246    * @brief Set the resize policy to be used for the given dimension(s).
1247    *
1248    * @SINCE_1_0.0
1249    * @param[in] policy The resize policy to use
1250    * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions.
1251    */
1252   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1253
1254   /**
1255    * @brief Return the resize policy used for a single dimension.
1256    *
1257    * @SINCE_1_0.0
1258    * @param[in] dimension The dimension to get policy for
1259    * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found.
1260    */
1261   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1262
1263   /**
1264    * @brief Set the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1265    *
1266    * @SINCE_1_0.0
1267    * @param[in] policy The policy to use for when the size is set
1268    */
1269   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1270
1271   /**
1272    * @brief Return the size scale policy in use.
1273    *
1274    * @SINCE_1_0.0
1275    * @return Return the size scale policy.
1276    */
1277   SizeScalePolicy::Type GetSizeScalePolicy() const;
1278
1279   /**
1280    * @brief Sets the relative to parent size factor of the actor.
1281    *
1282    * This factor is only used when ResizePolicy is set to either:
1283    * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1284    * This actor's size is set to the actor's size multipled by or added to this factor,
1285    * depending on ResizePolicy ( See SetResizePolicy() ).
1286    *
1287    * @SINCE_1_0.0
1288    * @param [in] factor A Vector3 representing the relative factor to be applied to each axis.
1289    * @pre The Actor has been initialized.
1290    */
1291   void SetSizeModeFactor( const Vector3& factor );
1292
1293   /**
1294    * @brief Retrieve the relative to parent size factor of the actor.
1295    *
1296    * @SINCE_1_0.0
1297    * @return The Actor's current relative size factor.
1298    * @pre The Actor has been initialized.
1299    */
1300   Vector3 GetSizeModeFactor() const;
1301
1302   /**
1303    * @brief Calculate the height of the actor given a width.
1304    *
1305    * The natural size is used for default calculation.
1306    * size 0 is treated as aspect ratio 1:1.
1307    *
1308    * @SINCE_1_0.0
1309    * @param width Width to use
1310    * @return Return the height based on the width.
1311    */
1312   float GetHeightForWidth( float width );
1313
1314   /**
1315    * @brief Calculate the width of the actor given a height.
1316    *
1317    * The natural size is used for default calculation.
1318    * size 0 is treated as aspect ratio 1:1.
1319    *
1320    * @SINCE_1_0.0
1321    * @param height Height to use
1322    * @return Return the width based on the height.
1323    */
1324   float GetWidthForHeight( float height );
1325
1326   /**
1327    * @brief Return the value of negotiated dimension for the given dimension.
1328    *
1329    * @SINCE_1_0.0
1330    * @param dimension The dimension to retrieve
1331    * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found.
1332    */
1333   float GetRelayoutSize( Dimension::Type dimension ) const;
1334
1335   /**
1336    * @brief Set the padding for use in layout.
1337    *
1338    * @SINCE_1_0.0
1339    * @param[in] padding Padding for the actor
1340    */
1341   void SetPadding( const Padding& padding );
1342
1343   /**
1344    * @brief Return the value of the padding.
1345    *
1346    * @SINCE_1_0.0
1347    * @param paddingOut The returned padding data
1348    */
1349   void GetPadding( Padding& paddingOut ) const;
1350
1351   /**
1352    * @brief Set the minimum size an actor can be assigned in size negotiation.
1353    *
1354    * @SINCE_1_0.0
1355    * @param[in] size The minimum size
1356    */
1357   void SetMinimumSize( const Vector2& size );
1358
1359   /**
1360    * @brief Return the minimum relayout size.
1361    *
1362    * @SINCE_1_0.0
1363    * @return Return the mininmum size.
1364    */
1365   Vector2 GetMinimumSize();
1366
1367   /**
1368    * @brief Set the maximum size an actor can be assigned in size negotiation.
1369    *
1370    * @SINCE_1_0.0
1371    * @param[in] size The maximum size
1372    */
1373   void SetMaximumSize( const Vector2& size );
1374
1375   /**
1376    * @brief Return the maximum relayout size.
1377    *
1378    * @SINCE_1_0.0
1379    * @return Return the maximum size.
1380    */
1381   Vector2 GetMaximumSize();
1382
1383   /**
1384    * @brief Get depth in the hierarchy for the actor.
1385    *
1386    * @SINCE_1_0.0
1387    * @return The current depth in the hierarchy of the actor, or -1 if actor is not in the hierarchy
1388    */
1389   int GetHierarchyDepth();
1390
1391 public: // Renderer
1392
1393   /**
1394    * @brief Add a renderer to this actor.
1395    *
1396    * @SINCE_1_0.0
1397    * @param[in] renderer Renderer to add to the actor
1398    * @return The index of the Renderer that was added
1399    * @pre The renderer must be initialized.
1400    *
1401    */
1402   unsigned int AddRenderer( Renderer& renderer );
1403
1404   /**
1405    * @brief Get the number of renderers on this actor.
1406    *
1407    * @SINCE_1_0.0
1408    * @return the number of renderers on this actor
1409    */
1410   unsigned int GetRendererCount() const;
1411
1412   /**
1413    * @brief Get a Renderer by index.
1414    *
1415    * @SINCE_1_0.0
1416    * @param[in] index The index of the renderer to fetch
1417    * @return The renderer at the specified index
1418    * @pre The index must be between 0 and GetRendererCount()-1
1419    *
1420    */
1421   Renderer GetRendererAt( unsigned int index );
1422
1423   /**
1424    * @brief Remove an renderer from the actor.
1425    *
1426    * @SINCE_1_0.0
1427    * @param[in] renderer Handle to the renderer that is to be removed
1428    */
1429   void RemoveRenderer( Renderer& renderer );
1430
1431   /**
1432    * @brief Remove an renderer from the actor by index.
1433    *
1434    * @SINCE_1_0.0
1435    * @param[in] index Index of the renderer that is to be removed
1436    * @pre The index must be between 0 and GetRendererCount()-1
1437    *
1438    */
1439   void RemoveRenderer( unsigned int index );
1440
1441 public: // Signals
1442
1443   /**
1444    * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1445    * @brief This signal is emitted when touch input is received.
1446    *
1447    * A callback of the following type may be connected:
1448    * @code
1449    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1450    * @endcode
1451    * The return value of True, indicates that the touch event should be consumed.
1452    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1453    * @SINCE_1_0.0
1454    * @return The signal to connect to.
1455    * @pre The Actor has been initialized.
1456    */
1457   TouchSignalType& TouchedSignal();
1458
1459   /**
1460    * @brief This signal is emitted when touch input is received.
1461    *
1462    * A callback of the following type may be connected:
1463    * @code
1464    *   bool YourCallbackName( Actor actor, TouchData& touch );
1465    * @endcode
1466    * The return value of True, indicates that the touch event has been consumed.
1467    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1468    * @SINCE_1_1.37
1469    * @return The signal to connect to.
1470    * @pre The Actor has been initialized.
1471    */
1472   TouchDataSignalType& TouchSignal();
1473
1474   /**
1475    * @brief This signal is emitted when hover input is received.
1476    *
1477    * A callback of the following type may be connected:
1478    * @code
1479    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1480    * @endcode
1481    * The return value of True, indicates that the hover event should be consumed.
1482    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1483    * @SINCE_1_0.0
1484    * @return The signal to connect to.
1485    * @pre The Actor has been initialized.
1486    */
1487   HoverSignalType& HoveredSignal();
1488
1489   /**
1490    * @brief This signal is emitted when wheel event is received.
1491    *
1492    * A callback of the following type may be connected:
1493    * @code
1494    *   bool YourCallbackName(Actor actor, const WheelEvent& event);
1495    * @endcode
1496    * The return value of True, indicates that the wheel event should be consumed.
1497    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1498    * @SINCE_1_0.0
1499    * @return The signal to connect to.
1500    * @pre The Actor has been initialized.
1501    */
1502   WheelEventSignalType& WheelEventSignal();
1503
1504   /**
1505    * @brief This signal is emitted after the actor has been connected to the stage.
1506    *
1507    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1508    * @SINCE_1_0.0
1509    * @return The signal to connect to.
1510    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1511    *
1512    * @note When the parent of a set of actors is connected to the stage, then all of the children
1513    * will received this callback.
1514    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1515    *
1516    * @code
1517    *
1518    *       A (parent)
1519    *      / \
1520    *     B   C
1521    *    / \   \
1522    *   D   E   F
1523    *
1524    * @endcode
1525    */
1526   OnStageSignalType& OnStageSignal();
1527
1528   /**
1529    * @brief This signal is emitted after the actor has been disconnected from the stage.
1530    *
1531    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1532    *
1533    * @SINCE_1_0.0
1534    * @return The signal to connect to.
1535    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1536    * will received this callback, starting with the leaf actors.
1537    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1538    *
1539    * @code
1540    *
1541    *       A (parent)
1542    *      / \
1543    *     B   C
1544    *    / \   \
1545    *   D   E   F
1546    *
1547    * @endcode
1548    *
1549    */
1550   OffStageSignalType& OffStageSignal();
1551
1552   /**
1553    * @brief This signal is emitted after the size has been set on the actor during relayout
1554    *
1555    * @SINCE_1_0.0
1556    * @return The signal
1557    */
1558   OnRelayoutSignalType& OnRelayoutSignal();
1559
1560 public: // Not intended for application developers
1561
1562   /**
1563    * @brief This constructor is used by Actor::New() methods.
1564    *
1565    * @SINCE_1_0.0
1566    * @param [in] actor A pointer to a newly allocated Dali resource
1567    */
1568   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1569 };
1570
1571 /**
1572  * @brief Helper for discarding an actor handle.
1573  *
1574  * If the handle is empty, this method does nothing.  Otherwise
1575  * Actor::Unparent() will be called, followed by Actor::Reset().
1576  * @SINCE_1_0.0
1577  * @param[in,out] actor A handle to an actor, or an empty handle.
1578  */
1579 inline void UnparentAndReset( Actor& actor )
1580 {
1581   if( actor )
1582   {
1583     actor.Unparent();
1584     actor.Reset();
1585   }
1586 }
1587
1588 /**
1589  * @}
1590  */
1591 } // namespace Dali
1592
1593 #endif // __DALI_ACTOR_H__