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    */
 659   Vector3 GetTargetSize() const;
 660
 661   /**
 662    * @brief Retrieves the actor's size.
 663    *
 664    * @SINCE_1_0.0
 665    * @return The actor's current size
 666    * @pre The actor has been initialized.
 667    * @note This property can be animated; the return value may not match the value written with SetSize().
 668    */
 669   Vector3 GetCurrentSize() const;
 670
 671   /**
 672    * @brief Returns the natural size of the actor.
 673    *
 674    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 675    *
 676    * @SINCE_1_0.0
 677    * @return The actor's natural size
 678    */
 679   Vector3 GetNaturalSize() const;
 680
 681   /**
 682    * @brief Sets the position of the Actor.
 683    *
 684    * By default, sets the position vector between the parent origin and anchor point (default).
 685    *
 686    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 687    *
 688    * @image html actor-position.png
 689    * The Actor's z position will be set to 0.0f.
 690    * @SINCE_1_0.0
 691    * @param[in] x The new x position
 692    * @param[in] y The new y position
 693    * @pre The Actor has been initialized.
 694    */
 695   void SetPosition(float x, float y);
 696
 697   /**
 698    * @brief Sets the position of the Actor.
 699    *
 700    * By default, sets the position vector between the parent origin and anchor point (default).
 701    *
 702    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 703    *
 704    * @image html actor-position.png
 705    * @SINCE_1_0.0
 706    * @param[in] x The new x position
 707    * @param[in] y The new y position
 708    * @param[in] z The new z position
 709    * @pre The Actor has been initialized.
 710    */
 711   void SetPosition(float x, float y, float z);
 712
 713   /**
 714    * @brief Sets the position of the Actor.
 715    *
 716    * By default, sets the position vector between the parent origin and anchor point (default).
 717    *
 718    * If Position inheritance if disabled, sets the world position. @see SetInheritPosition
 719    *
 720    * @image html actor-position.png
 721    * @SINCE_1_0.0
 722    * @param[in] position The new position
 723    * @pre The Actor has been initialized.
 724    */
 725   void SetPosition(const Vector3& position);
 726
 727   /**
 728    * @brief Sets the position of an actor along the X-axis.
 729    *
 730    * @SINCE_1_0.0
 731    * @param[in] x The new x position
 732    * @pre The Actor has been initialized.
 733    */
 734   void SetX(float x);
 735
 736   /**
 737    * @brief Sets the position of an actor along the Y-axis.
 738    *
 739    * @SINCE_1_0.0
 740    * @param[in] y The new y position
 741    * @pre The Actor has been initialized.
 742    */
 743   void SetY(float y);
 744
 745   /**
 746    * @brief Sets the position of an actor along the Z-axis.
 747    *
 748    * @SINCE_1_0.0
 749    * @param[in] z The new z position
 750    * @pre The Actor has been initialized.
 751    */
 752   void SetZ(float z);
 753
 754   /**
 755    * @brief Translates an actor relative to its existing position.
 756    *
 757    * @SINCE_1_0.0
 758    * @param[in] distance The actor will move by this distance
 759    * @pre The actor has been initialized.
 760    */
 761   void TranslateBy(const Vector3& distance);
 762
 763   /**
 764    * @brief Retrieves the position of the Actor.
 765    *
 766    * @SINCE_1_0.0
 767    * @return The Actor's current position
 768    * @pre The Actor has been initialized.
 769    * @note This property can be animated; the return value may not match the value written with SetPosition().
 770    */
 771   Vector3 GetCurrentPosition() const;
 772
 773   /**
 774    * @brief Retrieves the world-position of the Actor.
 775    *
 776    * @SINCE_1_0.0
 777    * @return The Actor's current position in world coordinates
 778    * @pre The Actor has been initialized.
 779    * @note The actor may not have a world-position unless it has been added to the stage.
 780    */
 781   Vector3 GetCurrentWorldPosition() const;
 782
 783   /**
 784    * @DEPRECATED_1_1.24 Use SetInheritPosition instead
 785    * @brief Sets the actors position inheritance mode.
 786    *
 787    * The default is to inherit.
 788    * Switching this off means that using SetPosition() sets the actor's world position.
 789    * @SINCE_1_0.0
 790    * @param[in] mode to use
 791    * @pre The Actor has been initialized.
 792    * @see PositionInheritanceMode
 793    */
 794   void SetPositionInheritanceMode( PositionInheritanceMode mode ) DALI_DEPRECATED_API;
 795
 796   /**
 797    * @brief Sets whether a child actor inherits it's parent's position.
 798    *
 799    * Default is to inherit.
 800    * Switching this off means that using SetPosition() sets the actor's world position, i.e. translates from
 801    * the world origin (0,0,0) to the anchor point of the actor.
 802    * @SINCE_1_1.24
 803    * @param[in] inherit - @c true if the actor should inherit position, @c false otherwise
 804    * @pre The Actor has been initialized.
 805    */
 806   inline void SetInheritPosition( bool inherit )
 807   {
 808     SetProperty(Property::INHERIT_POSITION, inherit );
 809   }
 810
 811   /**
 812    * @DEPRECATED_1_1.24 Use IsPositionInherited
 813    * @brief Returns the actors position inheritance mode.
 814    *
 815    * @SINCE_1_0.0
 816    * @return Return the position inheritance mode
 817    * @pre The Actor has been initialized.
 818    */
 819   PositionInheritanceMode GetPositionInheritanceMode() const DALI_DEPRECATED_API;
 820
 821   /**
 822    * @brief Returns whether the actor inherits its parent's position.
 823    *
 824    * @SINCE_1_1.24
 825    * @return @c true if the actor inherits its parent position, @c false if it uses world position
 826    * @pre The Actor has been initialized.
 827    */
 828   inline bool IsPositionInherited() const
 829   {
 830     return GetProperty(Property::INHERIT_POSITION ).Get<bool>();
 831   }
 832
 833   /**
 834    * @brief Sets the orientation of the Actor.
 835    *
 836    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 837    * @SINCE_1_0.0
 838    * @param[in] angle The new orientation angle in degrees
 839    * @param[in] axis The new axis of orientation
 840    * @pre The Actor has been initialized.
 841    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 842    */
 843   void SetOrientation( const Degree& angle, const Vector3& axis )
 844   {
 845     SetOrientation( Radian( angle ), axis );
 846   }
 847
 848   /**
 849    * @brief Sets the orientation of the Actor.
 850    *
 851    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 852    * @SINCE_1_0.0
 853    * @param[in] angle The new orientation angle in radians
 854    * @param[in] axis The new axis of orientation
 855    * @pre The Actor has been initialized.
 856    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 857    */
 858   void SetOrientation(const Radian& angle, const Vector3& axis);
 859
 860   /**
 861    * @brief Sets the orientation of the Actor.
 862    *
 863    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 864    * @SINCE_1_0.0
 865    * @param[in] orientation The new orientation
 866    * @pre The Actor has been initialized.
 867    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 868    */
 869   void SetOrientation(const Quaternion& orientation);
 870
 871   /**
 872    * @brief Applies a relative rotation to an actor.
 873    *
 874    * @SINCE_1_0.0
 875    * @param[in] angle The angle to the rotation to combine with the existing orientation
 876    * @param[in] axis The axis of the rotation to combine with the existing orientation
 877    * @pre The actor has been initialized.
 878    */
 879   void RotateBy( const Degree& angle, const Vector3& axis )
 880   {
 881     RotateBy( Radian( angle ), axis );
 882   }
 883
 884   /**
 885    * @brief Applies a relative rotation to an actor.
 886    *
 887    * @SINCE_1_0.0
 888    * @param[in] angle The angle to the rotation to combine with the existing orientation
 889    * @param[in] axis The axis of the rotation to combine with the existing orientation
 890    * @pre The actor has been initialized.
 891    */
 892   void RotateBy(const Radian& angle, const Vector3& axis);
 893
 894   /**
 895    * @brief Applies a relative rotation to an actor.
 896    *
 897    * @SINCE_1_0.0
 898    * @param[in] relativeRotation The rotation to combine with the existing orientation
 899    * @pre The actor has been initialized.
 900    */
 901   void RotateBy(const Quaternion& relativeRotation);
 902
 903   /**
 904    * @brief Retrieves the Actor's orientation.
 905    *
 906    * @SINCE_1_0.0
 907    * @return The current orientation
 908    * @pre The Actor has been initialized.
 909    * @note This property can be animated; the return value may not match the value written with SetOrientation().
 910    */
 911   Quaternion GetCurrentOrientation() const;
 912
 913   /**
 914    * @brief Sets whether a child actor inherits it's parent's orientation.
 915    *
 916    * Default is to inherit.
 917    * Switching this off means that using SetOrientation() sets the actor's world orientation.
 918    * @SINCE_1_0.0
 919    * @param[in] inherit - @c true if the actor should inherit orientation, @c false otherwise
 920    * @pre The Actor has been initialized.
 921    */
 922   void SetInheritOrientation(bool inherit);
 923
 924   /**
 925    * @brief Returns whether the actor inherits its parent's orientation.
 926    *
 927    * @SINCE_1_0.0
 928    * @return @c true if the actor inherits its parent orientation, @c false if it uses world orientation
 929    * @pre The Actor has been initialized.
 930    */
 931   bool IsOrientationInherited() const;
 932
 933   /**
 934    * @brief Retrieves the world-orientation of the Actor.
 935    *
 936    * @SINCE_1_0.0
 937    * @return The Actor's current orientation in the world
 938    * @pre The Actor has been initialized.
 939    * @note The actor will not have a world-orientation, unless it has previously been added to the stage.
 940    */
 941   Quaternion GetCurrentWorldOrientation() const;
 942
 943   /**
 944    * @brief Sets the scale factor applied to an actor.
 945    *
 946    * @SINCE_1_0.0
 947    * @param[in] scale The scale factor applied on all axes
 948    * @pre The Actor has been initialized.
 949    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 950    */
 951   void SetScale(float scale);
 952
 953   /**
 954    * @brief Sets the scale factor applied to an actor.
 955    *
 956    * @SINCE_1_0.0
 957    * @param[in] scaleX The scale factor applied along the x-axis
 958    * @param[in] scaleY The scale factor applied along the y-axis
 959    * @param[in] scaleZ The scale factor applied along the z-axis
 960    * @pre The Actor has been initialized.
 961    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 962    */
 963   void SetScale(float scaleX, float scaleY, float scaleZ);
 964
 965   /**
 966    * @brief Sets the scale factor applied to an actor.
 967    *
 968    * @SINCE_1_0.0
 969    * @param[in] scale A vector representing the scale factor for each axis
 970    * @pre The Actor has been initialized.
 971    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 972    */
 973   void SetScale(const Vector3& scale);
 974
 975   /**
 976    * @brief Applies a relative scale to an actor.
 977    *
 978    * @SINCE_1_0.0
 979    * @param[in] relativeScale The scale to combine with the actor's existing scale
 980    * @pre The actor has been initialized.
 981    */
 982   void ScaleBy(const Vector3& relativeScale);
 983
 984   /**
 985    * @brief Retrieves the scale factor applied to an actor.
 986    *
 987    * @SINCE_1_0.0
 988    * @return A vector representing the scale factor for each axis
 989    * @pre The Actor has been initialized.
 990    * @note This property can be animated; the return value may not match the value written with SetScale().
 991    */
 992   Vector3 GetCurrentScale() const;
 993
 994   /**
 995    * @brief Retrieves the world-scale of the Actor.
 996    *
 997    * @SINCE_1_0.0
 998    * @return The Actor's current scale in the world
 999    * @pre The Actor has been initialized.
1000    * @note The actor will not have a world-scale, unless it has previously been added to the stage.
1001    */
1002   Vector3 GetCurrentWorldScale() const;
1003
1004   /**
1005    * @brief Sets whether a child actor inherits it's parent's scale.
1006    *
1007    * Default is to inherit.
1008    * Switching this off means that using SetScale() sets the actor's world scale.
1009    * @SINCE_1_0.0
1010    * @param[in] inherit - @c true if the actor should inherit scale, @c false otherwise
1011    * @pre The Actor has been initialized.
1012    */
1013   void SetInheritScale( bool inherit );
1014
1015   /**
1016    * @brief Returns whether the actor inherits its parent's scale.
1017    *
1018    * @SINCE_1_0.0
1019    * @return @c true if the actor inherits its parent scale, @c false if it uses world scale
1020    * @pre The Actor has been initialized.
1021    */
1022   bool IsScaleInherited() const;
1023
1024   /**
1025    * @brief Retrieves the world-matrix of the actor.
1026    *
1027    * @SINCE_1_0.0
1028    * @return The Actor's current world matrix
1029    * @pre The Actor has been initialized.
1030    * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
1031    */
1032   Matrix GetCurrentWorldMatrix() const;
1033
1034   // Visibility & Color
1035
1036   /**
1037    * @brief Sets the visibility flag of an actor.
1038    *
1039    * @SINCE_1_0.0
1040    * @param[in] visible The new visibility flag
1041    * @pre The actor has been initialized.
1042    * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
1043    * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
1044    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
1045    *       rendered if all of its parents have visibility set to true.
1046    */
1047   void SetVisible(bool visible);
1048
1049   /**
1050    * @brief Retrieves the visibility flag of an actor.
1051    *
1052    * @SINCE_1_0.0
1053    * @return The visibility flag
1054    * @pre The actor has been initialized.
1055    * @note This property can be animated; the return value may not match the value written with SetVisible().
1056    * @note If an actor is not visible, then the actor and its children will not be rendered.
1057    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
1058    *       rendered if all of its parents have visibility set to true.
1059    */
1060   bool IsVisible() const;
1061
1062   /**
1063    * @brief Sets the opacity of an actor.
1064    *
1065    * @SINCE_1_0.0
1066    * @param[in] opacity The new opacity
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 GetCurrentOpacity().
1069    */
1070   void SetOpacity(float opacity);
1071
1072   /**
1073    * @brief Retrieves the actor's opacity.
1074    *
1075    * @SINCE_1_0.0
1076    * @return The actor's opacity
1077    * @pre The actor has been initialized.
1078    * @note This property can be animated; the return value may not match the value written with SetOpacity().
1079    */
1080   float GetCurrentOpacity() const;
1081
1082   /**
1083    * @brief Sets the actor's color; this is an RGBA value.
1084    *
1085    * The final color of the actor depends on its color mode.
1086    * @SINCE_1_0.0
1087    * @param[in] color The new color
1088    * @pre The Actor has been initialized.
1089    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
1090    */
1091   void SetColor(const Vector4& color);
1092
1093   /**
1094    * @brief Retrieves the actor's color.
1095    *
1096    * Actor's own color is not clamped.
1097    * @SINCE_1_0.0
1098    * @return The color
1099    * @pre The Actor has been initialized.
1100    * @note This property can be animated; the return value may not match the value written with SetColor().
1101    */
1102   Vector4 GetCurrentColor() const;
1103
1104   /**
1105    * @brief Sets the actor's color mode.
1106    *
1107    * This specifies whether the Actor uses its own color, or inherits
1108    * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
1109    * @SINCE_1_0.0
1110    * @param[in] colorMode ColorMode to use
1111    * @pre The Actor has been initialized.
1112    */
1113   void SetColorMode( ColorMode colorMode );
1114
1115   /**
1116    * @brief Returns the actor's color mode.
1117    *
1118    * @SINCE_1_0.0
1119    * @return Currently used colorMode
1120    * @pre The Actor has been initialized.
1121    */
1122   ColorMode GetColorMode() const;
1123
1124   /**
1125    * @brief Retrieves the world-color of the Actor, where each component is clamped within the 0->1 range.
1126    *
1127    * @SINCE_1_0.0
1128    * @return The Actor's current color in the world
1129    * @pre The Actor has been initialized.
1130    * @note The actor will not have a world-color, unless it has previously been added to the stage.
1131    */
1132   Vector4 GetCurrentWorldColor() const;
1133
1134   /**
1135    * @brief Sets how the actor and its children should be drawn.
1136    *
1137    * Not all actors are renderable, but DrawMode can be inherited from any actor.
1138    * If an object is in a 3D layer, it will be depth-tested against
1139    * other objects in the world i.e. it may be obscured if other objects are in front.
1140    *
1141    * If DrawMode::OVERLAY_2D is used, the actor and its children will be drawn as a 2D overlay.
1142    * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1143    * For overlay actors, the drawing order is with respect to tree levels of Actors,
1144    * and depth-testing will not be used.
1145
1146    * @SINCE_1_0.0
1147    * @param[in] drawMode The new draw-mode to use
1148    * @note Layers do not inherit the DrawMode from their parents.
1149    */
1150   void SetDrawMode( DrawMode::Type drawMode );
1151
1152   /**
1153    * @brief Queries how the actor and its children will be drawn.
1154    *
1155    * @SINCE_1_0.0
1156    * @return Return the draw mode type
1157    */
1158   DrawMode::Type GetDrawMode() const;
1159
1160   // Input Handling
1161
1162   /**
1163    * @brief Sets whether an actor should emit touch or hover signals.
1164    *
1165    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1166    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1167    * hover event signal will be emitted.
1168    *
1169    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1170    * @code
1171    * actor.SetSensitive(false);
1172    * @endcode
1173    *
1174    * Then, to re-enable the touch or hover event signal emission, the application should call:
1175    * @code
1176    * actor.SetSensitive(true);
1177    * @endcode
1178    *
1179    * @SINCE_1_0.0
1180    * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise
1181    * @pre The Actor has been initialized.
1182    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1183    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1184    *       hittable if all of its parents have sensitivity set to true.
1185    * @see @see TouchedSignal() and HoveredSignal().
1186    */
1187   void SetSensitive(bool sensitive);
1188
1189   /**
1190    * @brief Queries whether an actor emits touch or hover event signals.
1191    *
1192    * @SINCE_1_0.0
1193    * @return @c true, if emission of touch or hover event signals is enabled, @c false otherwise
1194    * @pre The Actor has been initialized.
1195    * @note If an actor is not sensitive, then it's children will not be hittable either.
1196    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1197    *       hittable if all of its parents have sensitivity set to true.
1198    */
1199   bool IsSensitive() const;
1200
1201   /**
1202    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1203    *
1204    * @SINCE_1_0.0
1205    * @param[out] localX On return, the X-coordinate relative to the actor
1206    * @param[out] localY On return, the Y-coordinate relative to the actor
1207    * @param[in] screenX The screen X-coordinate
1208    * @param[in] screenY The screen Y-coordinate
1209    * @return True if the conversion succeeded
1210    * @pre The Actor has been initialized.
1211    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1212    */
1213   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1214
1215   /**
1216    * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1217    * the boundary of the actor.
1218    *
1219    * @SINCE_1_0.0
1220    * @param[in] required Should be set to true if a Leave event is required
1221    * @pre The Actor has been initialized.
1222    * @note By default, this is set to false as most actors do not require this.
1223    * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
1224    *
1225    */
1226   void SetLeaveRequired(bool required);
1227
1228   /**
1229    * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1230    * the boundary of the actor.
1231    *
1232    * @SINCE_1_0.0
1233    * @return @c true if a Leave event is required, @c false otherwise
1234    * @pre The Actor has been initialized.
1235    */
1236   bool GetLeaveRequired() const;
1237
1238   /**
1239    * @brief Sets whether the actor should be focusable by keyboard navigation.
1240    *
1241    * The default is false.
1242    * @SINCE_1_0.0
1243    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1244    * false otherwise
1245    * @pre The Actor has been initialized.
1246    */
1247   void SetKeyboardFocusable( bool focusable );
1248
1249   /**
1250    * @brief Returns whether the actor is focusable by keyboard navigation.
1251    *
1252    * @SINCE_1_0.0
1253    * @return @c true if the actor is focusable by keyboard navigation, @c false if not
1254    * @pre The Actor has been initialized.
1255    */
1256   bool IsKeyboardFocusable() const;
1257
1258   /**
1259    * @brief Raise actor above the next sibling actor.
1260    *
1261    * @SINCE_1_2.60
1262    * @pre The Actor has been initialized.
1263    * @pre The Actor has been parented.
1264    */
1265   void Raise();
1266
1267   /**
1268    * @brief Lower the actor below the previous sibling actor.
1269    *
1270    * @SINCE_1_2.60
1271    * @pre The Actor has been initialized.
1272    * @pre The Actor has been parented.
1273    */
1274   void Lower();
1275
1276   /**
1277    * @brief Raise actor above all other sibling actors.
1278    *
1279    * @SINCE_1_2.60
1280    * @pre The Actor has been initialized.
1281    * @pre The Actor has been parented.
1282    */
1283   void RaiseToTop();
1284
1285   /**
1286    * @brief Lower actor to the bottom of all other sibling actors.
1287    *
1288    * @SINCE_1_2.60
1289    * @pre The Actor has been initialized.
1290    * @pre The Actor has been parented.
1291    */
1292   void LowerToBottom();
1293
1294   /**
1295    * @brief Raises the actor above the target actor.
1296    *
1297    * @SINCE_1_2.60
1298    * @param[in] target The target actor
1299    * @pre The Actor has been initialized.
1300    * @pre The Actor has been parented.
1301    * @pre The target actor is a sibling.
1302    */
1303   void RaiseAbove( Actor target );
1304
1305   /**
1306    * @brief Lower the actor to below the target actor.
1307    *
1308    * @SINCE_1_2.60
1309    * @param[in] target The target actor
1310    * @pre The Actor has been initialized.
1311    * @pre The Actor has been parented.
1312    * @pre The target actor is a sibling.
1313    */
1314   void LowerBelow( Actor target );
1315
1316   // SIZE NEGOTIATION
1317
1318   /**
1319    * @brief Sets the resize policy to be used for the given dimension(s).
1320    *
1321    * @SINCE_1_0.0
1322    * @param[in] policy The resize policy to use
1323    * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions
1324    */
1325   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1326
1327   /**
1328    * @brief Returns the resize policy used for a single dimension.
1329    *
1330    * @SINCE_1_0.0
1331    * @param[in] dimension The dimension to get policy for
1332    * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found
1333    */
1334   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1335
1336   /**
1337    * @brief Sets the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1338    *
1339    * @SINCE_1_0.0
1340    * @param[in] policy The policy to use for when the size is set
1341    */
1342   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1343
1344   /**
1345    * @brief Returns the size scale policy in use.
1346    *
1347    * @SINCE_1_0.0
1348    * @return Return the size scale policy
1349    */
1350   SizeScalePolicy::Type GetSizeScalePolicy() const;
1351
1352   /**
1353    * @brief Sets the relative to parent size factor of the actor.
1354    *
1355    * This factor is only used when ResizePolicy is set to either:
1356    * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1357    * This actor's size is set to the actor's size multiplied by or added to this factor,
1358    * depending on ResizePolicy ( See SetResizePolicy() ).
1359    *
1360    * @SINCE_1_0.0
1361    * @param[in] factor A Vector3 representing the relative factor to be applied to each axis
1362    * @pre The Actor has been initialized.
1363    */
1364   void SetSizeModeFactor( const Vector3& factor );
1365
1366   /**
1367    * @brief Retrieves the relative to parent size factor of the actor.
1368    *
1369    * @SINCE_1_0.0
1370    * @return The Actor's current relative size factor
1371    * @pre The Actor has been initialized.
1372    */
1373   Vector3 GetSizeModeFactor() const;
1374
1375   /**
1376    * @brief Calculates the height of the actor given a width.
1377    *
1378    * The natural size is used for default calculation.
1379    * size 0 is treated as aspect ratio 1:1.
1380    *
1381    * @SINCE_1_0.0
1382    * @param[in] width Width to use
1383    * @return Return the height based on the width
1384    */
1385   float GetHeightForWidth( float width );
1386
1387   /**
1388    * @brief Calculates the width of the actor given a height.
1389    *
1390    * The natural size is used for default calculation.
1391    * size 0 is treated as aspect ratio 1:1.
1392    *
1393    * @SINCE_1_0.0
1394    * @param[in] height Height to use
1395    * @return Return the width based on the height
1396    */
1397   float GetWidthForHeight( float height );
1398
1399   /**
1400    * @brief Returns the value of negotiated dimension for the given dimension.
1401    *
1402    * @SINCE_1_0.0
1403    * @param[in] dimension The dimension to retrieve
1404    * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found
1405    */
1406   float GetRelayoutSize( Dimension::Type dimension ) const;
1407
1408   /**
1409    * @brief Sets the padding for use in layout.
1410    *
1411    * @SINCE_1_0.0
1412    * @param[in] padding Padding for the actor
1413    */
1414   void SetPadding( const Padding& padding );
1415
1416   /**
1417    * @brief Returns the value of the padding.
1418    *
1419    * @SINCE_1_0.0
1420    * @param[in] paddingOut The returned padding data
1421    */
1422   void GetPadding( Padding& paddingOut ) const;
1423
1424   /**
1425    * @brief Sets the minimum size an actor can be assigned in size negotiation.
1426    *
1427    * @SINCE_1_0.0
1428    * @param[in] size The minimum size
1429    */
1430   void SetMinimumSize( const Vector2& size );
1431
1432   /**
1433    * @brief Returns the minimum relayout size.
1434    *
1435    * @SINCE_1_0.0
1436    * @return Return the minimum size
1437    */
1438   Vector2 GetMinimumSize();
1439
1440   /**
1441    * @brief Sets the maximum size an actor can be assigned in size negotiation.
1442    *
1443    * @SINCE_1_0.0
1444    * @param[in] size The maximum size
1445    */
1446   void SetMaximumSize( const Vector2& size );
1447
1448   /**
1449    * @brief Returns the maximum relayout size.
1450    *
1451    * @SINCE_1_0.0
1452    * @return Return the maximum size
1453    */
1454   Vector2 GetMaximumSize();
1455
1456   /**
1457    * @brief Gets depth in the hierarchy for the actor.
1458    *
1459    * @SINCE_1_0.0
1460    * @return The current depth in the hierarchy of the actor, or @c -1 if actor is not in the hierarchy
1461    */
1462   int32_t GetHierarchyDepth();
1463
1464 public: // Renderer
1465
1466   /**
1467    * @brief Adds a renderer to this actor.
1468    *
1469    * @SINCE_1_0.0
1470    * @param[in] renderer Renderer to add to the actor
1471    * @return The index of the Renderer that was added
1472    * @pre The renderer must be initialized.
1473    *
1474    */
1475   uint32_t AddRenderer( Renderer& renderer );
1476
1477   /**
1478    * @brief Gets the number of renderers on this actor.
1479    *
1480    * @SINCE_1_0.0
1481    * @return The number of renderers on this actor
1482    */
1483   uint32_t GetRendererCount() const;
1484
1485   /**
1486    * @brief Gets a Renderer by index.
1487    *
1488    * @SINCE_1_0.0
1489    * @param[in] index The index of the renderer to fetch
1490    * @return The renderer at the specified index
1491    * @pre The index must be between 0 and GetRendererCount()-1
1492    *
1493    */
1494   Renderer GetRendererAt( uint32_t index );
1495
1496   /**
1497    * @brief Removes a renderer from the actor.
1498    *
1499    * @SINCE_1_0.0
1500    * @param[in] renderer Handle to the renderer that is to be removed
1501    */
1502   void RemoveRenderer( Renderer& renderer );
1503
1504   /**
1505    * @brief Removes a renderer from the actor by index.
1506    *
1507    * @SINCE_1_0.0
1508    * @param[in] index Index of the renderer that is to be removed
1509    * @pre The index must be between 0 and GetRendererCount()-1
1510    *
1511    */
1512   void RemoveRenderer( uint32_t index );
1513
1514 public: // Signals
1515
1516   /**
1517    * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1518    * @brief This signal is emitted when touch input is received.
1519    *
1520    * A callback of the following type may be connected:
1521    * @code
1522    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1523    * @endcode
1524    * The return value of True, indicates that the touch event should be consumed.
1525    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1526    * @SINCE_1_0.0
1527    * @return The signal to connect to
1528    * @pre The Actor has been initialized.
1529    */
1530   TouchSignalType& TouchedSignal() DALI_DEPRECATED_API;
1531
1532   /**
1533    * @brief This signal is emitted when touch input is received.
1534    *
1535    * A callback of the following type may be connected:
1536    * @code
1537    *   bool YourCallbackName( Actor actor, TouchData& touch );
1538    * @endcode
1539    * The return value of True, indicates that the touch event has been consumed.
1540    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1541    * @SINCE_1_1.37
1542    * @return The signal to connect to
1543    * @pre The Actor has been initialized.
1544    */
1545   TouchDataSignalType& TouchSignal();
1546
1547   /**
1548    * @brief This signal is emitted when hover input is received.
1549    *
1550    * A callback of the following type may be connected:
1551    * @code
1552    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1553    * @endcode
1554    * The return value of True, indicates that the hover event should be consumed.
1555    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1556    * @SINCE_1_0.0
1557    * @return The signal to connect to
1558    * @pre The Actor has been initialized.
1559    */
1560   HoverSignalType& HoveredSignal();
1561
1562   /**
1563    * @brief This signal is emitted when wheel event is received.
1564    *
1565    * A callback of the following type may be connected:
1566    * @code
1567    *   bool YourCallbackName(Actor actor, const WheelEvent& event);
1568    * @endcode
1569    * The return value of True, indicates that the wheel event should be consumed.
1570    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1571    * @SINCE_1_0.0
1572    * @return The signal to connect to
1573    * @pre The Actor has been initialized.
1574    */
1575   WheelEventSignalType& WheelEventSignal();
1576
1577   /**
1578    * @brief This signal is emitted after the actor has been connected to the stage.
1579    *
1580    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1581    * @SINCE_1_0.0
1582    * @return The signal to connect to
1583    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1584    *
1585    * @note When the parent of a set of actors is connected to the stage, then all of the children
1586    * will received this callback.
1587    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1588    *
1589    * @code
1590    *
1591    *       A (parent)
1592    *      / \
1593    *     B   C
1594    *    / \   \
1595    *   D   E   F
1596    *
1597    * @endcode
1598    */
1599   OnStageSignalType& OnStageSignal();
1600
1601   /**
1602    * @brief This signal is emitted after the actor has been disconnected from the stage.
1603    *
1604    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1605    *
1606    * @SINCE_1_0.0
1607    * @return The signal to connect to
1608    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1609    * will received this callback, starting with the leaf actors.
1610    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1611    *
1612    * @code
1613    *
1614    *       A (parent)
1615    *      / \
1616    *     B   C
1617    *    / \   \
1618    *   D   E   F
1619    *
1620    * @endcode
1621    *
1622    */
1623   OffStageSignalType& OffStageSignal();
1624
1625   /**
1626    * @brief This signal is emitted after the size has been set on the actor during relayout
1627    *
1628    * @SINCE_1_0.0
1629    * @return The signal
1630    */
1631   OnRelayoutSignalType& OnRelayoutSignal();
1632
1633   /**
1634    * @brief This signal is emitted when the layout direction property of this or a parent actor is changed.
1635    *
1636    * A callback of the following type may be connected:
1637    * @code
1638    *   void YourCallbackName( Actor actor, LayoutDirection::Type type );
1639    * @endcode
1640    * actor: The actor, or child of actor, whose layout direction has changed
1641    * type: Whether the actor's layout direction property has changed or a parent's.
1642    *
1643    * @SINCE_1_2.60
1644    * @return The signal to connect to
1645    * @pre The Actor has been initialized.
1646    */
1647   LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal();
1648
1649 public: // Not intended for application developers
1650
1651   /// @cond internal
1652   /**
1653    * @brief This constructor is used by Actor::New() methods.
1654    *
1655    * @SINCE_1_0.0
1656    * @param [in] actor A pointer to a newly allocated Dali resource
1657    */
1658   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1659   /// @endcond
1660 };
1661
1662 /**
1663  * @brief Helper for discarding an actor handle.
1664  *
1665  * If the handle is empty, this method does nothing.  Otherwise
1666  * Actor::Unparent() will be called, followed by Actor::Reset().
1667  * @SINCE_1_0.0
1668  * @param[in,out] actor A handle to an actor, or an empty handle
1669  */
1670 inline void UnparentAndReset( Actor& actor )
1671 {
1672   if( actor )
1673   {
1674     actor.Unparent();
1675     actor.Reset();
1676   }
1677 }
1678
1679 /**
1680  * @}
1681  */
1682 } // namespace Dali
1683
1684 #endif // DALI_ACTOR_H