dali/public-api/actors/actor.h

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