dali/public-api/actors/actor.h

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