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     };
 312   };
 313
 314   // Typedefs
 315
 316   typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType;        ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
 317   typedef Signal< bool (Actor, const TouchData&) >  TouchDataSignalType;    ///< Touch signal type @SINCE_1_1.37
 318   typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType;        ///< Hover signal type @SINCE_1_0.0
 319   typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type @SINCE_1_0.0
 320   typedef Signal< void (Actor) > OnStageSignalType;                         ///< Stage connection signal type @SINCE_1_0.0
 321   typedef Signal< void (Actor) > OffStageSignalType;                        ///< Stage disconnection signal type @SINCE_1_0.0
 322   typedef Signal< void (Actor) > OnRelayoutSignalType;                      ///< Called when the actor is relaid out @SINCE_1_0.0
 323
 324   // Creation
 325
 326   /**
 327    * @brief Create an uninitialized Actor; this can be initialized with Actor::New().
 328    *
 329    * Calling member functions with an uninitialized Actor handle is not allowed.
 330    * @SINCE_1_0.0
 331    */
 332   Actor();
 333
 334   /**
 335    * @brief Create an initialized Actor.
 336    *
 337    * @SINCE_1_0.0
 338    * @return A handle to a newly allocated Dali resource.
 339    */
 340   static Actor New();
 341
 342   /**
 343    * @brief Downcast a handle to Actor handle.
 344    *
 345    * If handle points to a Actor object the downcast produces valid
 346    * handle. If not the returned handle is left uninitialized.
 347    *
 348    * @SINCE_1_0.0
 349    * @param[in] handle to An object
 350    * @return handle to a Actor object or an uninitialized handle
 351    */
 352   static Actor DownCast( BaseHandle handle );
 353
 354   /**
 355    * @brief Dali::Actor is intended as a base class
 356    *
 357    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 358    * @SINCE_1_0.0
 359    */
 360   ~Actor();
 361
 362   /**
 363    * @brief Copy constructor
 364    *
 365    * @SINCE_1_0.0
 366    * @param [in] copy The actor to copy.
 367    */
 368   Actor(const Actor& copy);
 369
 370   /**
 371    * @brief Assignment operator
 372    *
 373    * @SINCE_1_0.0
 374    * @param [in] rhs The actor to copy.
 375    * @return A reference to this
 376    */
 377   Actor& operator=(const Actor& rhs);
 378
 379   /**
 380    * @brief Retrieve the Actor's name.
 381    *
 382    * @SINCE_1_0.0
 383    * @return The Actor's name.
 384    * @pre The Actor has been initialized.
 385    */
 386   const std::string& GetName() const;
 387
 388   /**
 389    * @brief Sets the Actor's name.
 390    *
 391    * @SINCE_1_0.0
 392    * @param [in] name The new name.
 393    * @pre The Actor has been initialized.
 394    */
 395   void SetName(const std::string& name);
 396
 397   /**
 398    * @brief Retrieve the unique ID of the actor.
 399    *
 400    * @SINCE_1_0.0
 401    * @return The ID.
 402    * @pre The Actor has been initialized.
 403    */
 404   unsigned int GetId() const;
 405
 406   // Containment
 407
 408   /**
 409    * @brief Query whether an actor is the root actor, which is owned by the Stage.
 410    *
 411    * @SINCE_1_0.0
 412    * @return True if the actor is the root actor.
 413    * @pre The Actor has been initialized.
 414    */
 415   bool IsRoot() const;
 416
 417   /**
 418    * @brief Query whether the actor is connected to the Stage.
 419    *
 420    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
 421    * @SINCE_1_0.0
 422    * @return True if the actor is connected to the Stage.
 423    * @pre The Actor has been initialized.
 424    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
 425    */
 426   bool OnStage() const;
 427
 428   /**
 429    * @brief Query whether the actor is of class Dali::Layer.
 430    *
 431    * @SINCE_1_0.0
 432    * @return True if the actor is a layer.
 433    * @pre The Actor has been initialized.
 434    */
 435   bool IsLayer() const;
 436
 437   /**
 438    * @brief Gets the layer in which the actor is present.
 439    *
 440    * @SINCE_1_0.0
 441    * @return The layer, which will be uninitialized if the actor is off-stage.
 442    * @pre The Actor has been initialized.
 443    */
 444   Layer GetLayer();
 445
 446   /**
 447    * @brief Adds a child Actor to this Actor.
 448    *
 449    * @SINCE_1_0.0
 450    * @param [in] child The child.
 451    * @pre This Actor (the parent) has been initialized.
 452    * @pre The child actor has been initialized.
 453    * @pre The child actor is not the same as the parent actor.
 454    * @pre The actor is not the Root actor.
 455    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 456    * even if the handle passed into this method is reset or destroyed.
 457    * @note if the child already has a parent, it will be removed from old parent
 458    * and reparented to this actor. This may change childs position, color,
 459    * scale etc as it now inherits them from this actor.
 460    */
 461   void Add(Actor child);
 462
 463   /**
 464    * @brief Removes a child Actor from this Actor.
 465    *
 466    * If the actor was not a child of this actor, this is a no-op.
 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 is not the same as the parent actor.
 471    */
 472   void Remove(Actor child);
 473
 474   /**
 475    * @brief Removes an actor from its parent.
 476    *
 477    * If the actor has no parent, this method does nothing.
 478    * @SINCE_1_0.0
 479    * @pre The (child) actor has been initialized.
 480    */
 481   void Unparent();
 482
 483   /**
 484    * @brief Retrieve the number of children held by the actor.
 485    *
 486    * @SINCE_1_0.0
 487    * @return The number of children
 488    * @pre The Actor has been initialized.
 489    */
 490   unsigned int GetChildCount() const;
 491
 492   /**
 493    * @brief Retrieve and child actor by index.
 494    *
 495    * @SINCE_1_0.0
 496    * @param[in] index The index of the child to retrieve
 497    * @return The actor for the given index or empty handle if children not initialised
 498    * @pre The Actor has been initialized.
 499    */
 500   Actor GetChildAt(unsigned int index) const;
 501
 502   /**
 503    * @brief Search through this actor's hierarchy for an actor with the given name.
 504    *
 505    * The actor itself is also considered in the search.
 506    * @SINCE_1_0.0
 507    * @param[in] actorName the name of the actor to find
 508    * @return A handle to the actor if found, or an empty handle if not.
 509    * @pre The Actor has been initialized.
 510    */
 511   Actor FindChildByName(const std::string& actorName);
 512
 513   /**
 514    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 515    *
 516    * The actor itself is also considered in the search.
 517    * @SINCE_1_0.0
 518    * @param[in] id the ID of the actor to find
 519    * @return A handle to the actor if found, or an empty handle if not.
 520    * @pre The Actor has been initialized.
 521    */
 522   Actor FindChildById(const unsigned int id);
 523
 524   /**
 525    * @brief Retrieve the actor's parent.
 526    *
 527    * @SINCE_1_0.0
 528    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
 529    * @pre The actor has been initialized.
 530    */
 531   Actor GetParent() const;
 532
 533   // Positioning
 534
 535   /**
 536    * @brief Set the origin of an actor, within its parent's area.
 537    *
 538    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 539    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 540    * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
 541    * An actor position is the distance between this origin, and the actors anchor-point.
 542    * @SINCE_1_0.0
 543    * @param [in] origin The new parent-origin.
 544    * @pre The Actor has been initialized.
 545    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentParentOrigin().
 546    * @see Dali::ParentOrigin for predefined parent origin values
 547    */
 548   void SetParentOrigin(const Vector3& origin);
 549
 550   /**
 551    * @brief Retrieve the parent-origin of an actor.
 552    *
 553    * @SINCE_1_0.0
 554    * @return The current parent-origin.
 555    * @pre The Actor has been initialized.
 556    * @note This property can be animated; the return value may not match the value written with SetParentOrigin().
 557    */
 558   Vector3 GetCurrentParentOrigin() const;
 559
 560   /**
 561    * @brief Set the anchor-point of an actor.
 562    *
 563    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
 564    * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
 565    * bottom-right corner.  The default anchor point is
 566    * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
 567    * An actor position is the distance between its parent-origin, and this anchor-point.
 568    * An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
 569    * @SINCE_1_0.0
 570    * @param [in] anchorPoint The new anchor-point.
 571    * @pre The Actor has been initialized.
 572    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentAnchorPoint().
 573    * @see Dali::AnchorPoint for predefined anchor point values
 574    */
 575   void SetAnchorPoint(const Vector3& anchorPoint);
 576
 577   /**
 578    * @brief Retrieve the anchor-point of an actor.
 579    *
 580    * @SINCE_1_0.0
 581    * @return The current anchor-point.
 582    * @pre The Actor has been initialized.
 583    * @note This property can be animated; the return value may not match the value written with SetAnchorPoint().
 584    */
 585   Vector3 GetCurrentAnchorPoint() const;
 586
 587   /**
 588    * @brief Sets the size of an actor.
 589    *
 590    * Geometry can be scaled to fit within this area.
 591    * This does not interfere with the actors scale factor.
 592    * The actors default depth is the minimum of width & height.
 593    * @SINCE_1_0.0
 594    * @param [in] width  The new width.
 595    * @param [in] height The new height.
 596    * @pre The actor has been initialized.
 597    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 598    */
 599   void SetSize(float width, float height);
 600
 601   /**
 602    * @brief Sets the size of an actor.
 603    *
 604    * Geometry can be scaled to fit within this area.
 605    * This does not interfere with the actors scale factor.
 606    * @SINCE_1_0.0
 607    * @param [in] width  The size of the actor along the x-axis.
 608    * @param [in] height The size of the actor along the y-axis.
 609    * @param [in] depth The size of the actor along the z-axis.
 610    * @pre The actor has been initialized.
 611    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 612    */
 613   void SetSize(float width, float height, float depth);
 614
 615   /**
 616    * @brief Sets the size of an actor.
 617    *
 618    * Geometry can be scaled to fit within this area.
 619    * This does not interfere with the actors scale factor.
 620    * The actors default depth is the minimum of width & height.
 621    * @SINCE_1_0.0
 622    * @param [in] size The new size.
 623    * @pre The actor has been initialized.
 624    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 625    */
 626   void SetSize(const Vector2& size);
 627
 628   /**
 629    * @brief Sets the size of an actor.
 630    *
 631    * Geometry can be scaled to fit within this area.
 632    * This does not interfere with the actors scale factor.
 633    * @SINCE_1_0.0
 634    * @param [in] size The new size.
 635    * @pre The actor has been initialized.
 636    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 637    */
 638   void SetSize(const Vector3& size);
 639
 640   /**
 641    * @brief Retrieve the actor's size.
 642    *
 643    * @SINCE_1_0.0
 644    * @return The actor's target size.
 645    * @pre The actor has been initialized.
 646    * @note This return is the value that was set using SetSize or the target size of an animation.
 647    */
 648   Vector3 GetTargetSize() const;
 649
 650   /**
 651    * @brief Retrieve the actor's size.
 652    *
 653    * @SINCE_1_0.0
 654    * @return The actor's current size.
 655    * @pre The actor has been initialized.
 656    * @note This property can be animated; the return value may not match the value written with SetSize().
 657    */
 658   Vector3 GetCurrentSize() const;
 659
 660   /**
 661    * @brief Return the natural size of the actor.
 662    *
 663    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 664    *
 665    * @SINCE_1_0.0
 666    * @return The actor's natural size
 667    */
 668   Vector3 GetNaturalSize() const;
 669
 670   /**
 671    * @brief Sets the position of the actor.
 672    *
 673    * The Actor's z position will be set to 0.0f.
 674    * @SINCE_1_0.0
 675    * @param [in] x The new x position
 676    * @param [in] y The new y position
 677    * @pre The Actor has been initialized.
 678    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 679    */
 680   void SetPosition(float x, float y);
 681
 682   /**
 683    * @brief Sets the position of the Actor.
 684    *
 685    * @SINCE_1_0.0
 686    * @param [in] x The new x position
 687    * @param [in] y The new y position
 688    * @param [in] z The new z position
 689    * @pre The Actor has been initialized.
 690    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 691    */
 692   void SetPosition(float x, float y, float z);
 693
 694   /**
 695    * @brief Sets the position of the Actor.
 696    *
 697    * @SINCE_1_0.0
 698    * @param [in] position The new position
 699    * @pre The Actor has been initialized.
 700    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 701    */
 702   void SetPosition(const Vector3& position);
 703
 704   /**
 705    * @brief Set the position of an actor along the X-axis.
 706    *
 707    * @SINCE_1_0.0
 708    * @param [in] x The new x position
 709    * @pre The Actor has been initialized.
 710    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 711    */
 712   void SetX(float x);
 713
 714   /**
 715    * @brief Set the position of an actor along the Y-axis.
 716    *
 717    * @SINCE_1_0.0
 718    * @param [in] y The new y position.
 719    * @pre The Actor has been initialized.
 720    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 721    */
 722   void SetY(float y);
 723
 724   /**
 725    * @brief Set the position of an actor along the Z-axis.
 726    *
 727    * @SINCE_1_0.0
 728    * @param [in] z The new z position
 729    * @pre The Actor has been initialized.
 730    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 731    */
 732   void SetZ(float z);
 733
 734   /**
 735    * @brief Translate an actor relative to its existing position.
 736    *
 737    * @SINCE_1_0.0
 738    * @param[in] distance The actor will move by this distance.
 739    * @pre The actor has been initialized.
 740    */
 741   void TranslateBy(const Vector3& distance);
 742
 743   /**
 744    * @brief Retrieve the position of the Actor.
 745    *
 746    * @SINCE_1_0.0
 747    * @return the Actor's current position.
 748    * @pre The Actor has been initialized.
 749    * @note This property can be animated; the return value may not match the value written with SetPosition().
 750    */
 751   Vector3 GetCurrentPosition() const;
 752
 753   /**
 754    * @brief Retrieve the world-position of the Actor.
 755    *
 756    * @SINCE_1_0.0
 757    * @return The Actor's current position in world coordinates.
 758    * @pre The Actor has been initialized.
 759    * @note The actor will not have a world-position, unless it has previously been added to the stage.
 760    */
 761   Vector3 GetCurrentWorldPosition() const;
 762
 763   /**
 764    * @DEPRECATED_1_1.24 Use SetInheritPosition instead
 765    * @brief Set the actors position inheritance mode.
 766    *
 767    * The default is to inherit.
 768    * Switching this off means that using SetPosition() sets the actor's world position.
 769    * @SINCE_1_0.0
 770    * @param[in] mode to use
 771    * @pre The Actor has been initialized.
 772    * @see PositionInheritanceMode
 773    */
 774   void SetPositionInheritanceMode( PositionInheritanceMode mode );
 775
 776   /**
 777    * @brief Set whether a child actor inherits it's parent's position.
 778    *
 779    * Default is to inherit.
 780    * Switching this off means that using SetPosition() sets the actor's world position3
 781    * @SINCE_1_1.24
 782    * @param[in] inherit - true if the actor should inherit position, false otherwise.
 783    * @pre The Actor has been initialized.
 784    */
 785   inline void SetInheritPosition( bool inherit )
 786   {
 787     SetProperty(Property::INHERIT_POSITION, inherit );
 788   }
 789
 790   /**
 791    * @DEPRECATED_1_1.24 Use IsPositionInherited
 792    * @brief Returns the actors position inheritance mode.
 793    *
 794    * @SINCE_1_0.0
 795    * @return Return the position inheritance mode.
 796    * @pre The Actor has been initialized.
 797    */
 798   PositionInheritanceMode GetPositionInheritanceMode() const;
 799
 800   /**
 801    * @brief Returns whether the actor inherits its parent's position.
 802    *
 803    * @SINCE_1_1.24
 804    * @return True if the actor inherits its parent position, 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 Apply 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 Apply 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 Apply 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 Retreive 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 Set 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 - true if the actor should inherit orientation, 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 True if the actor inherits its parent orientation, false if it uses world orientation.
 908    * @pre The Actor has been initialized.
 909    */
 910   bool IsOrientationInherited() const;
 911
 912   /**
 913    * @brief Retrieve 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 Set 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 Set 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 Set 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 Apply 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 Retrieve 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 Retrieve 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 Set 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 - true if the actor should inherit scale, 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 True if the actor inherits its parent scale, 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 Retrieve 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 Retrieve 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 Retrieve 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 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 Retrieve 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 Set 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    * If DrawMode::STENCIL is used, the actor and its children will be used to stencil-test other actors
1126    * within the Layer. Stencil actors are therefore drawn into the stencil buffer before any other
1127    * actors within the Layer.
1128    *
1129    * @SINCE_1_0.0
1130    * @param[in] drawMode The new draw-mode to use.
1131    * @note Setting STENCIL will override OVERLAY_2D, if that would otherwise have been inherited.
1132    * @note Layers do not inherit the DrawMode from their parents.
1133    */
1134   void SetDrawMode( DrawMode::Type drawMode );
1135
1136   /**
1137    * @brief Query how the actor and its children will be drawn.
1138    *
1139    * @SINCE_1_0.0
1140    * @return Return the draw mode type.
1141    */
1142   DrawMode::Type GetDrawMode() const;
1143
1144   // Input Handling
1145
1146   /**
1147    * @brief Sets whether an actor should emit touch or hover signals.
1148    *
1149    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1150    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1151    * hover event signal will be emitted.
1152    *
1153    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1154    * @code
1155    * actor.SetSensitive(false);
1156    * @endcode
1157    *
1158    * Then, to re-enable the touch or hover event signal emission, the application should call:
1159    * @code
1160    * actor.SetSensitive(true);
1161    * @endcode
1162    *
1163    * @SINCE_1_0.0
1164    * @param[in]  sensitive  true to enable emission of the touch or hover event signals, false otherwise.
1165    * @pre The Actor has been initialized.
1166    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1167    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1168    *       hittable if all of its parents have sensitivity set to true.
1169    * @see @see TouchedSignal() and HoveredSignal().
1170    */
1171   void SetSensitive(bool sensitive);
1172
1173   /**
1174    * @brief Query whether an actor emits touch or hover event signals.
1175    *
1176    * @SINCE_1_0.0
1177    * @return True, if emission of touch or hover event signals is enabled, false otherwise.
1178    * @pre The Actor has been initialized.
1179    * @note If an actor is not sensitive, then it's children will not be hittable either.
1180    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1181    *       hittable if all of its parents have sensitivity set to true.
1182    */
1183   bool IsSensitive() const;
1184
1185   /**
1186    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1187    *
1188    * @SINCE_1_0.0
1189    * @param[out] localX On return, the X-coordinate relative to the actor.
1190    * @param[out] localY On return, the Y-coordinate relative to the actor.
1191    * @param[in] screenX The screen X-coordinate.
1192    * @param[in] screenY The screen Y-coordinate.
1193    * @return True if the conversion succeeded.
1194    * @pre The Actor has been initialized.
1195    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1196    */
1197   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1198
1199   /**
1200    * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1201    * the boundary of the actor.
1202    *
1203    * @SINCE_1_0.0
1204    * @param[in]  required  Should be set to true if a Leave event is required
1205    * @pre The Actor has been initialized.
1206    * @note By default, this is set to false as most actors do not require this.
1207    * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
1208    *
1209    */
1210   void SetLeaveRequired(bool required);
1211
1212   /**
1213    * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1214    * the boundary of the actor.
1215    *
1216    * @SINCE_1_0.0
1217    * @return True if a Leave event is required, false otherwise.
1218    * @pre The Actor has been initialized.
1219    */
1220   bool GetLeaveRequired() const;
1221
1222   /**
1223    * @brief Sets whether the actor should be focusable by keyboard navigation.
1224    *
1225    * The default is false.
1226    * @SINCE_1_0.0
1227    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1228    * false otherwise.
1229    * @pre The Actor has been initialized.
1230    */
1231   void SetKeyboardFocusable( bool focusable );
1232
1233   /**
1234    * @brief Returns whether the actor is focusable by keyboard navigation.
1235    *
1236    * @SINCE_1_0.0
1237    * @return True if the actor is focusable by keyboard navigation, false if not.
1238    * @pre The Actor has been initialized.
1239    */
1240   bool IsKeyboardFocusable() const;
1241
1242   // SIZE NEGOTIATION
1243
1244   /**
1245    * @brief Set the resize policy to be used for the given dimension(s).
1246    *
1247    * @SINCE_1_0.0
1248    * @param[in] policy The resize policy to use
1249    * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions.
1250    */
1251   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1252
1253   /**
1254    * @brief Return the resize policy used for a single dimension.
1255    *
1256    * @SINCE_1_0.0
1257    * @param[in] dimension The dimension to get policy for
1258    * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found.
1259    */
1260   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1261
1262   /**
1263    * @brief Set the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1264    *
1265    * @SINCE_1_0.0
1266    * @param[in] policy The policy to use for when the size is set
1267    */
1268   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1269
1270   /**
1271    * @brief Return the size scale policy in use.
1272    *
1273    * @SINCE_1_0.0
1274    * @return Return the size scale policy.
1275    */
1276   SizeScalePolicy::Type GetSizeScalePolicy() const;
1277
1278   /**
1279    * @brief Sets the relative to parent size factor of the actor.
1280    *
1281    * This factor is only used when ResizePolicy is set to either:
1282    * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1283    * This actor's size is set to the actor's size multipled by or added to this factor,
1284    * depending on ResizePolicy ( See SetResizePolicy() ).
1285    *
1286    * @SINCE_1_0.0
1287    * @param [in] factor A Vector3 representing the relative factor to be applied to each axis.
1288    * @pre The Actor has been initialized.
1289    */
1290   void SetSizeModeFactor( const Vector3& factor );
1291
1292   /**
1293    * @brief Retrieve the relative to parent size factor of the actor.
1294    *
1295    * @SINCE_1_0.0
1296    * @return The Actor's current relative size factor.
1297    * @pre The Actor has been initialized.
1298    */
1299   Vector3 GetSizeModeFactor() const;
1300
1301   /**
1302    * @brief Calculate the height of the actor given a width.
1303    *
1304    * The natural size is used for default calculation.
1305    * size 0 is treated as aspect ratio 1:1.
1306    *
1307    * @SINCE_1_0.0
1308    * @param width Width to use
1309    * @return Return the height based on the width.
1310    */
1311   float GetHeightForWidth( float width );
1312
1313   /**
1314    * @brief Calculate the width of the actor given a height.
1315    *
1316    * The natural size is used for default calculation.
1317    * size 0 is treated as aspect ratio 1:1.
1318    *
1319    * @SINCE_1_0.0
1320    * @param height Height to use
1321    * @return Return the width based on the height.
1322    */
1323   float GetWidthForHeight( float height );
1324
1325   /**
1326    * @brief Return the value of negotiated dimension for the given dimension.
1327    *
1328    * @SINCE_1_0.0
1329    * @param dimension The dimension to retrieve
1330    * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found.
1331    */
1332   float GetRelayoutSize( Dimension::Type dimension ) const;
1333
1334   /**
1335    * @brief Set the padding for use in layout.
1336    *
1337    * @SINCE_1_0.0
1338    * @param[in] padding Padding for the actor
1339    */
1340   void SetPadding( const Padding& padding );
1341
1342   /**
1343    * @brief Return the value of the padding.
1344    *
1345    * @SINCE_1_0.0
1346    * @param paddingOut The returned padding data
1347    */
1348   void GetPadding( Padding& paddingOut ) const;
1349
1350   /**
1351    * @brief Set the minimum size an actor can be assigned in size negotiation.
1352    *
1353    * @SINCE_1_0.0
1354    * @param[in] size The minimum size
1355    */
1356   void SetMinimumSize( const Vector2& size );
1357
1358   /**
1359    * @brief Return the minimum relayout size.
1360    *
1361    * @SINCE_1_0.0
1362    * @return Return the mininmum size.
1363    */
1364   Vector2 GetMinimumSize();
1365
1366   /**
1367    * @brief Set the maximum size an actor can be assigned in size negotiation.
1368    *
1369    * @SINCE_1_0.0
1370    * @param[in] size The maximum size
1371    */
1372   void SetMaximumSize( const Vector2& size );
1373
1374   /**
1375    * @brief Return the maximum relayout size.
1376    *
1377    * @SINCE_1_0.0
1378    * @return Return the maximum size.
1379    */
1380   Vector2 GetMaximumSize();
1381
1382   /**
1383    * @brief Get depth in the hierarchy for the actor.
1384    *
1385    * @SINCE_1_0.0
1386    * @return The current depth in the hierarchy of the actor, or -1 if actor is not in the hierarchy
1387    */
1388   int GetHierarchyDepth();
1389
1390 public: // Renderer
1391
1392   /**
1393    * @brief Add a renderer to this actor.
1394    *
1395    * @SINCE_1_0.0
1396    * @param[in] renderer Renderer to add to the actor
1397    * @return The index of the Renderer that was added
1398    * @pre The renderer must be initialized.
1399    *
1400    */
1401   unsigned int AddRenderer( Renderer& renderer );
1402
1403   /**
1404    * @brief Get the number of renderers on this actor.
1405    *
1406    * @SINCE_1_0.0
1407    * @return the number of renderers on this actor
1408    */
1409   unsigned int GetRendererCount() const;
1410
1411   /**
1412    * @brief Get a Renderer by index.
1413    *
1414    * @SINCE_1_0.0
1415    * @param[in] index The index of the renderer to fetch
1416    * @return The renderer at the specified index
1417    * @pre The index must be between 0 and GetRendererCount()-1
1418    *
1419    */
1420   Renderer GetRendererAt( unsigned int index );
1421
1422   /**
1423    * @brief Remove an renderer from the actor.
1424    *
1425    * @SINCE_1_0.0
1426    * @param[in] renderer Handle to the renderer that is to be removed
1427    */
1428   void RemoveRenderer( Renderer& renderer );
1429
1430   /**
1431    * @brief Remove an renderer from the actor by index.
1432    *
1433    * @SINCE_1_0.0
1434    * @param[in] index Index of the renderer that is to be removed
1435    * @pre The index must be between 0 and GetRendererCount()-1
1436    *
1437    */
1438   void RemoveRenderer( unsigned int index );
1439
1440 public: // Signals
1441
1442   /**
1443    * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1444    * @brief This signal is emitted when touch input is received.
1445    *
1446    * A callback of the following type may be connected:
1447    * @code
1448    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1449    * @endcode
1450    * The return value of True, indicates that the touch event should be consumed.
1451    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1452    * @SINCE_1_0.0
1453    * @return The signal to connect to.
1454    * @pre The Actor has been initialized.
1455    */
1456   TouchSignalType& TouchedSignal();
1457
1458   /**
1459    * @brief This signal is emitted when touch input is received.
1460    *
1461    * A callback of the following type may be connected:
1462    * @code
1463    *   bool YourCallbackName( Actor actor, TouchData& touch );
1464    * @endcode
1465    * The return value of True, indicates that the touch event has been consumed.
1466    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1467    * @SINCE_1_1.37
1468    * @return The signal to connect to.
1469    * @pre The Actor has been initialized.
1470    */
1471   TouchDataSignalType& TouchSignal();
1472
1473   /**
1474    * @brief This signal is emitted when hover input is received.
1475    *
1476    * A callback of the following type may be connected:
1477    * @code
1478    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1479    * @endcode
1480    * The return value of True, indicates that the hover event should be consumed.
1481    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1482    * @SINCE_1_0.0
1483    * @return The signal to connect to.
1484    * @pre The Actor has been initialized.
1485    */
1486   HoverSignalType& HoveredSignal();
1487
1488   /**
1489    * @brief This signal is emitted when wheel event is received.
1490    *
1491    * A callback of the following type may be connected:
1492    * @code
1493    *   bool YourCallbackName(Actor actor, const WheelEvent& event);
1494    * @endcode
1495    * The return value of True, indicates that the wheel event should be consumed.
1496    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1497    * @SINCE_1_0.0
1498    * @return The signal to connect to.
1499    * @pre The Actor has been initialized.
1500    */
1501   WheelEventSignalType& WheelEventSignal();
1502
1503   /**
1504    * @brief This signal is emitted after the actor has been connected to the stage.
1505    *
1506    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1507    * @SINCE_1_0.0
1508    * @return The signal to connect to.
1509    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1510    *
1511    * @note When the parent of a set of actors is connected to the stage, then all of the children
1512    * will received this callback.
1513    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1514    *
1515    * @code
1516    *
1517    *       A (parent)
1518    *      / \
1519    *     B   C
1520    *    / \   \
1521    *   D   E   F
1522    *
1523    * @endcode
1524    */
1525   OnStageSignalType& OnStageSignal();
1526
1527   /**
1528    * @brief This signal is emitted after the actor has been disconnected from the stage.
1529    *
1530    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1531    *
1532    * @SINCE_1_0.0
1533    * @return The signal to connect to.
1534    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1535    * will received this callback, starting with the leaf actors.
1536    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1537    *
1538    * @code
1539    *
1540    *       A (parent)
1541    *      / \
1542    *     B   C
1543    *    / \   \
1544    *   D   E   F
1545    *
1546    * @endcode
1547    *
1548    */
1549   OffStageSignalType& OffStageSignal();
1550
1551   /**
1552    * @brief This signal is emitted after the size has been set on the actor during relayout
1553    *
1554    * @SINCE_1_0.0
1555    * @return The signal
1556    */
1557   OnRelayoutSignalType& OnRelayoutSignal();
1558
1559 public: // Not intended for application developers
1560
1561   /**
1562    * @brief This constructor is used by Actor::New() methods.
1563    *
1564    * @SINCE_1_0.0
1565    * @param [in] actor A pointer to a newly allocated Dali resource
1566    */
1567   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1568 };
1569
1570 /**
1571  * @brief Helper for discarding an actor handle.
1572  *
1573  * If the handle is empty, this method does nothing.  Otherwise
1574  * Actor::Unparent() will be called, followed by Actor::Reset().
1575  * @SINCE_1_0.0
1576  * @param[in,out] actor A handle to an actor, or an empty handle.
1577  */
1578 inline void UnparentAndReset( Actor& actor )
1579 {
1580   if( actor )
1581   {
1582     actor.Unparent();
1583     actor.Reset();
1584   }
1585 }
1586
1587 /**
1588  * @}
1589  */
1590 } // namespace Dali
1591
1592 #endif // __DALI_ACTOR_H__