dali/public-api/actors/actor.h

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