dali/public-api/actors/actor.h

   1 #ifndef __DALI_ACTOR_H__
   2 #define __DALI_ACTOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 <boost/function.hpp>
  23 #include <string>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/common/vector-wrapper.h>
  27 #include <dali/public-api/animation/active-constraint-declarations.h>
  28 #include <dali/public-api/actors/actor-enumerations.h>
  29 #include <dali/public-api/actors/draw-mode.h>
  30 #include <dali/public-api/object/constrainable.h>
  31 #include <dali/public-api/signals/dali-signal.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 class Actor;
  39 }
  40
  41 class Actor;
  42 class Animation;
  43 class Constraint;
  44 struct Degree;
  45 class DynamicsBody;
  46 class DynamicsBodyConfig;
  47 class DynamicsJoint;
  48 class Quaternion;
  49 class Layer;
  50 struct Radian;
  51 struct KeyEvent;
  52 struct TouchEvent;
  53 struct HoverEvent;
  54 struct MouseWheelEvent;
  55 struct Vector2;
  56 struct Vector3;
  57 struct Vector4;
  58
  59 /**
  60  * @brief Actor container.
  61  */
  62 typedef std::vector<Actor> ActorContainer;
  63 typedef ActorContainer::iterator ActorIter; ///< Iterator for Dali::ActorContainer
  64 typedef ActorContainer::const_iterator ActorConstIter; ///< Const iterator for Dali::ActorContainer
  65
  66
  67
  68 /**
  69  * @brief Actor is the primary object with which Dali applications interact.
  70  *
  71  * UI controls can be built by combining multiple actors.
  72  *
  73  * <h3>Multi-Touch Events:</h3>
  74  *
  75  * Touch or hover events are received via signals; see Actor::TouchedSignal() and Actor::HoveredSignal() for more details.
  76  *
  77  * <i>Hit Testing Rules Summary:</i>
  78  *
  79  * - An actor is only hittable if the actor's touch or hover signal has a connection.
  80  * - An actor is only hittable when it is between the camera's near and far planes.
  81  * - If an actor is made insensitive, then the actor and its children are not hittable; see IsSensitive()
  82  * - If an actor's visibility flag is unset, then none of its children are hittable either; see IsVisible()
  83  * - To be hittable, an actor must have a non-zero size.
  84  * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor()
  85  *
  86  * <i>Hit Test Algorithm:</i>
  87  *
  88  * - RenderTasks
  89  *   - Hit testing is dependent on the camera used, which is specific to each RenderTask.
  90  *
  91  * - Layers
  92  *   - For each RenderTask, hit testing starts from the top-most layer and we go through all the
  93  *     layers until we have a hit or there are none left.
  94  *   - Before we perform a hit test within a layer, we check if all the layer's parents are visible
  95  *     and sensitive.
  96  *   - If they are not, we skip hit testing the actors in that layer altogether.
  97  *   - If a layer is set to consume all touch, then we do not check any layers behind this layer.
  98  *
  99  * - Actors
 100  *   - The final part of hit testing is performed by walking through the actor tree within a layer.
 101  *   - The following pseudocode shows the algorithm used:
 102  *     @code
 103  *     HIT-TEST-WITHIN-LAYER( ACTOR )
 104  *     {
 105  *       // Only hit-test the actor and its children if it is sensitive and visible
 106  *       IF ( ACTOR-IS-SENSITIVE &&
 107  *            ACTOR-IS-VISIBLE )
 108  *       {
 109  *         // Depth-first traversal within current layer, visiting parent first
 110  *
 111  *         // Check whether current actor should be hit-tested
 112  *         IF ( ( TOUCH-SIGNAL-NOT-EMPTY || HOVER-SIGNAL-NOT-EMPTY ) &&
 113  *              ACTOR-HAS-NON-ZERO-SIZE &&
 114  *              ACTOR-WORLD-COLOR-IS-NOT-TRANSPARENT )
 115  *         {
 116  *           // Hit-test current actor
 117  *           IF ( ACTOR-HIT )
 118  *           {
 119  *             IF ( ACTOR-IS-OVERLAY || ( DISTANCE-TO-ACTOR < DISTANCE-TO-LAST-HIT-ACTOR ) )
 120  *             {
 121  *               // The current actor is the closest actor that was underneath the touch
 122  *               LAST-HIT-ACTOR = CURRENT-ACTOR
 123  *             }
 124  *           }
 125  *         }
 126  *
 127  *         // Keep checking children, in case we hit something closer
 128  *         FOR-EACH CHILD (in order)
 129  *         {
 130  *           IF ( CHILD-IS-NOT-A-LAYER )
 131  *           {
 132  *             // Continue traversal for this child's sub-tree
 133  *             HIT-TEST-WITHIN-LAYER ( CHILD )
 134  *           }
 135  *           // else we skip hit-testing the child's sub-tree altogether
 136  *         }
 137  *       }
 138  *     }
 139  *     @endcode
 140  *   - Overlays always take priority (i.e. they're considered closer) regardless of distance.
 141  *     The overlay children take priority over their parents, and overlay siblings take priority
 142  *     over their previous siblings (i.e. reverse of rendering order):
 143  *     @code
 144  *           1
 145  *          / \
 146  *         /   \
 147  *        2     5
 148  *       / \     \
 149  *      /   \     \
 150  *     3     4     6
 151  *
 152  *     Hit Priority of above Actor tree (all overlays): 1 - Lowest. 6 - Highest.
 153  *     @endcode
 154  *   - Stencil Actors can be used to influence the result of hits on renderable actors within a layer.
 155  *     If a Stencil Actor exists on a layer and that Actor is marked visible then a successful
 156  *     hit on a renderable actor can only take place in the area that the stencil Actor marks as visible.
 157  *     The hit can be in any Stencil Actor in that layer, but must be in the region of one of them.
 158  *     Stencil Actor inheritance behaves as with rendering in that any child of a Stencil Actor will
 159  *     also be considered a Stencil Actor.
 160  *     Non-renderable actors can be hit regardless of whether a stencil actor is hit or not.
 161  *
 162  * <i>Touch or hover Event Delivery:</i>
 163  *
 164  * - Delivery
 165  *   - The hit actor's touch or hover signal is emitted first; if it is not consumed by any of the listeners,
 166  *     the parent's touch or hover signal is emitted, and so on.
 167  *   - The following pseudocode shows the delivery mechanism:
 168  *     @code
 169  *     EMIT-TOUCH-SIGNAL( ACTOR )
 170  *     {
 171  *       IF ( TOUCH-SIGNAL-NOT-EMPTY )
 172  *       {
 173  *         // Only do the emission if touch signal of actor has connections.
 174  *         CONSUMED = TOUCHED-SIGNAL( TOUCH-EVENT )
 175  *       }
 176  *
 177  *       IF ( NOT-CONSUMED )
 178  *       {
 179  *         // If event is not consumed then deliver it to the parent unless we reach the root actor
 180  *         IF ( ACTOR-PARENT )
 181  *         {
 182  *           EMIT-TOUCH-SIGNAL( ACTOR-PARENT )
 183  *         }
 184  *       }
 185  *     }
 186  *
 187  *     EMIT-HOVER-SIGNAL( ACTOR )
 188  *     {
 189  *       IF ( HOVER-SIGNAL-NOT-EMPTY )
 190  *       {
 191  *         // Only do the emission if hover signal of actor has connections.
 192  *         CONSUMED = HOVERED-SIGNAL( HOVER-EVENT )
 193  *       }
 194  *
 195  *       IF ( NOT-CONSUMED )
 196  *       {
 197  *         // If event is not consumed then deliver it to the parent unless we reach the root actor
 198  *         IF ( ACTOR-PARENT )
 199  *         {
 200  *           EMIT-HOVER-SIGNAL( ACTOR-PARENT )
 201  *         }
 202  *       }
 203  *     }
 204  *     @endcode
 205  *   - If there are several touch points, then the delivery is only to the first touch point's hit
 206  *     actor (and its parents).  There will be NO touch or hover signal delivery for the hit actors of the
 207  *     other touch points.
 208  *   - The local coordinates are from the top-left (0.0f, 0.0f, 0.5f) of the hit actor.
 209  *
 210  * - Leave State
 211  *   - A "Leave" state is set when the first point exits the bounds of the previous first point's
 212  *     hit actor (primary hit actor).
 213  *   - When this happens, the last primary hit actor's touch or hover signal is emitted with a "Leave" state
 214  *     (only if it requires leave signals); see SetLeaveRequired().
 215  *
 216  * - Interrupted State
 217  *   - If a system event occurs which interrupts the touch or hover processing, then the last primary hit
 218  *     actor's touch or hover signals are emitted with an "Interrupted" state.
 219  *   - If the last primary hit actor, or one of its parents, is no longer touchable or hoverable, then its
 220  *     touch or hover signals are also emitted with an "Interrupted" state.
 221  *   - If the consumed actor on touch-down is not the same as the consumed actor on touch-up, then
 222  *     touch signals are also emitted from the touch-down actor with an "Interrupted" state.
 223  *   - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
 224  *     hover signals are also emitted from the hover-started actor with an "Interrupted" state.
 225  * <h3>Key Events:</h3>
 226  *
 227  * Key events are received by an actor once set to grab key events, only one actor can be set as focused.
 228  *
 229  * @nosubgrouping
 230  */
 231 class DALI_IMPORT_API Actor : public Constrainable
 232 {
 233 public:
 234
 235   // Typedefs
 236
 237   typedef Signal< bool (Actor, const TouchEvent&)> TouchSignalType;                ///< Touch signal type
 238   typedef Signal< bool (Actor, const HoverEvent&)> HoverSignalType;                ///< Hover signal type
 239   typedef Signal< bool (Actor, const MouseWheelEvent&) > MouseWheelEventSignalType;///< Mousewheel signal type
 240   typedef Signal< void (Actor) > OnStageSignalType;  ///< Stage connection signal type
 241   typedef Signal< void (Actor) > OffStageSignalType; ///< Stage disconnection signal type
 242
 243   /// @name Properties
 244   /** @{ */
 245   static const Property::Index PARENT_ORIGIN;         ///< name "parent-origin",         type VECTOR3
 246   static const Property::Index PARENT_ORIGIN_X;       ///< name "parent-origin-x",       type FLOAT
 247   static const Property::Index PARENT_ORIGIN_Y;       ///< name "parent-origin-y",       type FLOAT
 248   static const Property::Index PARENT_ORIGIN_Z;       ///< name "parent-origin-z",       type FLOAT
 249   static const Property::Index ANCHOR_POINT;          ///< name "anchor-point",          type VECTOR3
 250   static const Property::Index ANCHOR_POINT_X;        ///< name "anchor-point-x",        type FLOAT
 251   static const Property::Index ANCHOR_POINT_Y;        ///< name "anchor-point-y",        type FLOAT
 252   static const Property::Index ANCHOR_POINT_Z;        ///< name "anchor-point-z",        type FLOAT
 253   static const Property::Index SIZE;                  ///< name "size",                  type VECTOR3
 254   static const Property::Index SIZE_WIDTH;            ///< name "size-width",            type FLOAT
 255   static const Property::Index SIZE_HEIGHT;           ///< name "size-height",           type FLOAT
 256   static const Property::Index SIZE_DEPTH;            ///< name "size-depth",            type FLOAT
 257   static const Property::Index POSITION;              ///< name "position",              type VECTOR3
 258   static const Property::Index POSITION_X;            ///< name "position-x",            type FLOAT
 259   static const Property::Index POSITION_Y;            ///< name "position-y",            type FLOAT
 260   static const Property::Index POSITION_Z;            ///< name "position-z",            type FLOAT
 261   static const Property::Index WORLD_POSITION;        ///< name "world-position",        type VECTOR3 (read-only)
 262   static const Property::Index WORLD_POSITION_X;      ///< name "world-position-x",      type FLOAT (read-only)
 263   static const Property::Index WORLD_POSITION_Y;      ///< name "world-position-y",      type FLOAT (read-only)
 264   static const Property::Index WORLD_POSITION_Z;      ///< name "world-position-z",      type FLOAT (read-only)
 265   static const Property::Index ROTATION;              ///< name "rotation",              type ROTATION
 266   static const Property::Index WORLD_ROTATION;        ///< name "world-rotation",        type ROTATION (read-only)
 267   static const Property::Index SCALE;                 ///< name "scale",                 type VECTOR3
 268   static const Property::Index SCALE_X;               ///< name "scale-x",               type FLOAT
 269   static const Property::Index SCALE_Y;               ///< name "scale-y",               type FLOAT
 270   static const Property::Index SCALE_Z;               ///< name "scale-z",               type FLOAT
 271   static const Property::Index WORLD_SCALE;           ///< name "world-scale",           type VECTOR3 (read-only)
 272   static const Property::Index VISIBLE;               ///< name "visible",               type BOOLEAN
 273   static const Property::Index COLOR;                 ///< name "color",                 type VECTOR4
 274   static const Property::Index COLOR_RED;             ///< name "color-red",             type FLOAT
 275   static const Property::Index COLOR_GREEN;           ///< name "color-green",           type FLOAT
 276   static const Property::Index COLOR_BLUE;            ///< name "color-blue",            type FLOAT
 277   static const Property::Index COLOR_ALPHA;           ///< name "color-alpha",           type FLOAT
 278   static const Property::Index WORLD_COLOR;           ///< name "world-color",           type VECTOR4 (read-only)
 279   static const Property::Index WORLD_MATRIX;          ///< name "world-matrix",          type MATRIX (read-only)
 280   static const Property::Index NAME;                  ///< name "name",                  type STRING
 281   static const Property::Index SENSITIVE;             ///< name "sensitive",             type BOOLEAN
 282   static const Property::Index LEAVE_REQUIRED;        ///< name "leave-required",        type BOOLEAN
 283   static const Property::Index INHERIT_ROTATION;      ///< name "inherit-rotation",      type BOOLEAN
 284   static const Property::Index INHERIT_SCALE;         ///< name "inherit-scale",         type BOOLEAN
 285   static const Property::Index COLOR_MODE;            ///< name "color-mode",            type STRING
 286   static const Property::Index POSITION_INHERITANCE;  ///< name "position-inheritance",  type STRING
 287   static const Property::Index DRAW_MODE;             ///< name "draw-mode",             type STRING
 288   /** @} */
 289
 290   /// @name Signals
 291   /** @{ */
 292   static const char* const SIGNAL_TOUCHED;            ///< name "touched",           @see TouchedSignal()
 293   static const char* const SIGNAL_HOVERED;            ///< name "hovered",           @see HoveredSignal()
 294   static const char* const SIGNAL_MOUSE_WHEEL_EVENT;  ///< name "mouse-wheel-event", @see MouseWheelEventSignal()
 295   static const char* const SIGNAL_ON_STAGE;           ///< name "on-stage",          @see OnStageSignal()
 296   static const char* const SIGNAL_OFF_STAGE;          ///< name "off-stage",         @see OffStageSignal()
 297   /** @} */
 298
 299   /// @name Actions
 300   /** @{ */
 301   static const char* const ACTION_SHOW;               ///< name "show",   @see SetVisible()
 302   static const char* const ACTION_HIDE;               ///< name "hide",   @see SetVisible()
 303   /** @} */
 304
 305   // Creation
 306
 307   /**
 308    * @brief Create an uninitialized Actor; this can be initialized with Actor::New().
 309    *
 310    * Calling member functions with an uninitialized Dali::Object is not allowed.
 311    */
 312   Actor();
 313
 314   /**
 315    * @brief Create an initialized Actor.
 316    *
 317    * @return A handle to a newly allocated Dali resource.
 318    */
 319   static Actor New();
 320
 321   /**
 322    * @brief Downcast an Object handle to Actor handle.
 323    *
 324    * If handle points to a Actor object the downcast produces valid
 325    * handle. If not the returned handle is left uninitialized.
 326    *
 327    * @param[in] handle to An object
 328    * @return handle to a Actor object or an uninitialized handle
 329    */
 330   static Actor DownCast( BaseHandle handle );
 331
 332   /**
 333    * @brief Dali::Actor is intended as a base class
 334    *
 335    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 336    */
 337   ~Actor();
 338
 339   /**
 340    * @brief Copy constructor
 341    *
 342    * @param [in] copy The actor to copy.
 343    */
 344   Actor(const Actor& copy);
 345
 346   /**
 347    * @brief Assignment operator
 348    *
 349    * @param [in] rhs The actor to copy.
 350    */
 351   Actor& operator=(const Actor& rhs);
 352
 353   /**
 354    * @brief Retrieve the Actor's name.
 355    *
 356    * @pre The Actor has been initialized.
 357    * @return The Actor's name.
 358    */
 359   const std::string& GetName() const;
 360
 361   /**
 362    * @brief Sets the Actor's name.
 363    *
 364    * @pre The Actor has been initialized.
 365    * @param [in] name The new name.
 366    */
 367   void SetName(const std::string& name);
 368
 369   /**
 370    * @brief Retrieve the unique ID of the actor.
 371    *
 372    * @pre The Actor has been initialized.
 373    * @return The ID.
 374    */
 375   unsigned int GetId() const;
 376
 377   // Containment
 378
 379   /**
 380    * @brief Query whether an actor is the root actor, which is owned by the Stage.
 381    *
 382    * @pre The Actor has been initialized.
 383    * @return True if the actor is the root actor.
 384    */
 385   bool IsRoot() const;
 386
 387   /**
 388    * @brief Query whether the actor is connected to the Stage.
 389    *
 390    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
 391    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
 392    * @pre The Actor has been initialized.
 393    * @return True if the actor is connected to the Stage.
 394    */
 395   bool OnStage() const;
 396
 397   /**
 398    * @brief Query whether the actor is of class Dali::Layer.
 399    *
 400    * @pre The Actor has been initialized.
 401    * @return True if the actor is a layer.
 402    */
 403   bool IsLayer() const;
 404
 405   /**
 406    * @brief Gets the layer in which the actor is present.
 407    *
 408    * @pre The Actor has been initialized.
 409    * @return The layer, which will be uninitialized if the actor is off-stage.
 410    */
 411   Layer GetLayer();
 412
 413   /**
 414    * @brief Adds a child Actor to this Actor.
 415    *
 416    * NOTE! if the child already has a parent, it will be removed from old parent
 417    * and reparented to this actor. This may change childs position, color,
 418    * scale etc as it now inherits them from this actor
 419    * @pre This Actor (the parent) has been initialized.
 420    * @pre The child actor has been initialized.
 421    * @pre The child actor is not the same as the parent actor.
 422    * @pre The actor is not the Root actor
 423    * @param [in] child The child.
 424    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 425    * even if the handle passed into this method is reset or destroyed.
 426    * @post This may invalidate ActorContainer iterators.
 427    */
 428   void Add(Actor child);
 429
 430   /**
 431    * @brief Inserts a child Actor to this actor's list of children at the given index
 432    *
 433    * NOTE! if the child already has a parent, it will be removed from old parent
 434    * and reparented to this actor. This may change childs position, color,
 435    * scale etc as it now inherits them from this actor
 436    * @pre This Actor (the parent) has been initialized.
 437    * @pre The child actor has been initialized.
 438    * @pre The child actor is not the same as the parent actor.
 439    * @pre The actor is not the Root actor
 440    * @param [in] index of actor to insert before
 441    * @param [in] child The child.
 442    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 443    * even if the handle passed into this method is reset or destroyed.
 444    * @post If the index is greater than the current child count, it will be ignored and added at the end.
 445    * @post This may invalidate ActorContainer iterators.
 446    */
 447   void Insert(unsigned int index, Actor child);
 448
 449   /**
 450    * @brief Removes a child Actor from this Actor.
 451    *
 452    * If the actor was not a child of this actor, this is a no-op.
 453    * @pre This Actor (the parent) has been initialized.
 454    * @pre The child actor is not the same as the parent actor.
 455    * @param [in] child The child.
 456    * @post This may invalidate ActorContainer iterators.
 457    */
 458   void Remove(Actor child);
 459
 460   /**
 461    * @brief Removes an actor from its parent.
 462    *
 463    * If the actor has no parent, this method does nothing.
 464    * @pre The (child) actor has been initialized.
 465    * @post This may invalidate ActorContainer iterators.
 466    */
 467   void Unparent();
 468
 469   /**
 470    * @brief Retrieve the number of children held by the actor.
 471    *
 472    * @pre The Actor has been initialized.
 473    * @return The number of children
 474    */
 475   unsigned int GetChildCount() const;
 476
 477   /**
 478    * @brief Retrieve and child actor by index.
 479    *
 480    * @pre The Actor has been initialized.
 481    * @param[in] index The index of the child to retrieve
 482    * @return The actor for the given index or empty handle if children not initialised
 483    */
 484   Actor GetChildAt(unsigned int index) const;
 485
 486   /**
 487    * @brief Search through this actor's hierarchy for an actor with the given name.
 488    *
 489    * The actor itself is also considered in the search
 490    * @pre The Actor has been initialized.
 491    * @param[in] actorName the name of the actor to find
 492    * @return A handle to the actor if found, or an empty handle if not.
 493    */
 494   Actor FindChildByName(const std::string& actorName);
 495
 496   /**
 497    * @brief Search through this actor's hierarchy for an actor with the given name or alias.
 498    *
 499    * Actors can customize this function to provide actors with preferred alias'
 500    * For example 'previous' could return the last selected child.
 501    * If no aliased actor is found then FindChildByName() is called.
 502    * @pre The Actor has been initialized.
 503    * @param[in] actorAlias the name of the actor to find
 504    * @return A handle to the actor if found, or an empty handle if not.
 505    */
 506   Actor FindChildByAlias(const std::string& actorAlias);
 507
 508   /**
 509    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 510    *
 511    * The actor itself is also considered in the search
 512    * @pre The Actor has been initialized.
 513    * @param[in] id the ID of the actor to find
 514    * @return A handle to the actor if found, or an empty handle if not.
 515    */
 516   Actor FindChildById(const unsigned int id);
 517
 518   /**
 519    * @brief Retrieve the actor's parent.
 520    *
 521    * @pre The actor has been initialized.
 522    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
 523    */
 524   Actor GetParent() const;
 525
 526   // Positioning
 527
 528   /**
 529    * @brief Set the origin of an actor, within its parent's area.
 530    *
 531    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 532    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 533    * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
 534    * An actor position is the distance between this origin, and the actors anchor-point.
 535    * @see Dali::ParentOrigin for predefined parent origin values
 536    * @pre The Actor has been initialized.
 537    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentParentOrigin().
 538    * @param [in] origin The new parent-origin.
 539    */
 540   void SetParentOrigin(const Vector3& origin);
 541
 542   /**
 543    * @brief Retrieve the parent-origin of an actor.
 544    *
 545    * @pre The Actor has been initialized.
 546    * @note This property can be animated; the return value may not match the value written with SetParentOrigin().
 547    * @return The current parent-origin.
 548    */
 549   Vector3 GetCurrentParentOrigin() const;
 550
 551   /**
 552    * @brief Set the anchor-point of an actor.
 553    *
 554    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
 555    * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
 556    * bottom-right corner.  The default anchor point is
 557    * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
 558    * An actor position is the distance between its parent-origin, and this anchor-point.
 559    * An actor's rotation is centered around its anchor-point.
 560    * @see Dali::AnchorPoint for predefined anchor point values
 561    * @pre The Actor has been initialized.
 562    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentAnchorPoint().
 563    * @param [in] anchorPoint The new anchor-point.
 564    */
 565   void SetAnchorPoint(const Vector3& anchorPoint);
 566
 567   /**
 568    * @brief Retrieve the anchor-point of an actor.
 569    *
 570    * @pre The Actor has been initialized.
 571    * @note This property can be animated; the return value may not match the value written with SetAnchorPoint().
 572    * @return The current anchor-point.
 573    */
 574   Vector3 GetCurrentAnchorPoint() const;
 575
 576   /**
 577    * @brief Sets the size of an actor.
 578    *
 579    * Geometry can be scaled to fit within this area.
 580    * This does not interfere with the actors scale factor.
 581    * The actors default depth is the minimum of width & height.
 582    * @pre The actor has been initialized.
 583    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 584    * @param [in] width  The new width.
 585    * @param [in] height The new height.
 586    */
 587   void SetSize(float width, float height);
 588
 589   /**
 590    * @brief Sets the size of an actor.
 591    *
 592    * Geometry can be scaled to fit within this area.
 593    * This does not interfere with the actors scale factor.
 594    * @pre The actor has been initialized.
 595    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 596    * @param [in] width  The size of the actor along the x-axis.
 597    * @param [in] height The size of the actor along the y-axis.
 598    * @param [in] depth The size of the actor along the z-axis.
 599    */
 600   void SetSize(float width, float height, float depth);
 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    * @pre The actor has been initialized.
 609    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 610    * @param [in] size The new size.
 611    */
 612   void SetSize(const Vector2& size);
 613
 614   /**
 615    * @brief Sets the size of an actor.
 616    *
 617    * Geometry can be scaled to fit within this area.
 618    * This does not interfere with the actors scale factor.
 619    * @pre The actor has been initialized.
 620    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 621    * @param [in] size The new size.
 622    */
 623   void SetSize(const Vector3& size);
 624
 625   /**
 626    * @brief Retrieve the actor's size.
 627    *
 628    * @pre The actor has been initialized.
 629    * @note This return is the value that was set using SetSize or the target size of an animation
 630    * @return The actor's current size.
 631    */
 632   Vector3 GetSize() const;
 633
 634   /**
 635    * @brief Retrieve the actor's size.
 636    *
 637    * @pre The actor has been initialized.
 638    * @note This property can be animated; the return value may not match the value written with SetSize().
 639    * @return The actor's current size.
 640    */
 641   Vector3 GetCurrentSize() const;
 642
 643   /**
 644    * Return the natural size of the actor.
 645    *
 646    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 647    *
 648    * @return The actor's natural size
 649    */
 650   Vector3 GetNaturalSize() const;
 651
 652   /**
 653    * @brief Sets the position of the actor.
 654    *
 655    * The Actor's z position will be set to 0.0f.
 656    * @pre The Actor has been initialized.
 657    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 658    * @param [in] x The new x position
 659    * @param [in] y The new y position
 660    */
 661   void SetPosition(float x, float y);
 662
 663   /**
 664    * @brief Sets the position of the Actor.
 665    *
 666    * @pre The Actor has been initialized.
 667    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 668    * @param [in] x The new x position
 669    * @param [in] y The new y position
 670    * @param [in] z The new z position
 671    */
 672   void SetPosition(float x, float y, float z);
 673
 674   /**
 675    * @brief Sets the position of the Actor.
 676    *
 677    * @pre The Actor has been initialized.
 678    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 679    * @param [in] position The new position
 680    */
 681   void SetPosition(const Vector3& position);
 682
 683   /**
 684    * @brief Set the position of an actor along the X-axis.
 685    *
 686    * @pre The Actor has been initialized.
 687    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 688    * @param [in] x The new x position
 689    */
 690   void SetX(float x);
 691
 692   /**
 693    * @brief Set the position of an actor along the Y-axis.
 694    *
 695    * @pre The Actor has been initialized.
 696    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 697    * @param [in] y The new y position.
 698    */
 699   void SetY(float y);
 700
 701   /**
 702    * @brief Set the position of an actor along the Z-axis.
 703    *
 704    * @pre The Actor has been initialized.
 705    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 706    * @param [in] z The new z position
 707    */
 708   void SetZ(float z);
 709
 710   /**
 711    * @brief Move an actor relative to its existing position.
 712    *
 713    * @pre The actor has been initialized.
 714    * @param[in] distance The actor will move by this distance.
 715    */
 716   void MoveBy(const Vector3& distance);
 717
 718   /**
 719    * @brief Retrieve the position of the Actor.
 720    *
 721    * @pre The Actor has been initialized.
 722    * @note This property can be animated; the return value may not match the value written with SetPosition().
 723    * @return the Actor's current position.
 724    */
 725   Vector3 GetCurrentPosition() const;
 726
 727   /**
 728    * @brief Retrieve the world-position of the Actor.
 729    *
 730    * @note The actor will not have a world-position, unless it has previously been added to the stage.
 731    * @pre The Actor has been initialized.
 732    * @return The Actor's current position in world coordinates.
 733    */
 734   Vector3 GetCurrentWorldPosition() const;
 735
 736   /**
 737    * @brief Set the actors position inheritance mode.
 738    *
 739    * The default is to inherit.
 740    * Switching this off means that using SetPosition() sets the actor's world position.
 741    * @see PositionInheritanceMode
 742    * @pre The Actor has been initialized.
 743    * @param[in] mode to use
 744    */
 745   void SetPositionInheritanceMode( PositionInheritanceMode mode );
 746
 747   /**
 748    * @brief Returns the actors position inheritance mode.
 749    *
 750    * @pre The Actor has been initialized.
 751    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 752    */
 753   PositionInheritanceMode GetPositionInheritanceMode() const;
 754
 755   /**
 756    * @brief Sets the rotation of the Actor.
 757    *
 758    * An actor's rotation is centered around its anchor point.
 759    * @pre The Actor has been initialized.
 760    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentRotation().
 761    * @param [in] angle The new rotation angle in degrees.
 762    * @param [in] axis The new axis of rotation.
 763    */
 764   void SetRotation(const Degree& angle, const Vector3& axis);
 765
 766   /**
 767    * @brief Sets the rotation of the Actor.
 768    *
 769    * An actor's rotation is centered around its anchor point.
 770    * @pre The Actor has been initialized.
 771    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentRotation().
 772    * @param [in] angle The new rotation angle in radians.
 773    * @param [in] axis The new axis of rotation.
 774    */
 775   void SetRotation(const Radian& angle, const Vector3& axis);
 776
 777   /**
 778    * @brief Sets the rotation of the Actor.
 779    *
 780    * @pre The Actor has been initialized.
 781    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentRotation().
 782    * @param [in] rotation The new rotation.
 783    */
 784   void SetRotation(const Quaternion& rotation);
 785
 786   /**
 787    * @brief Apply a relative rotation to an actor.
 788    *
 789    * @pre The actor has been initialized.
 790    * @param[in] angle The angle to the rotation to combine with the existing rotation.
 791    * @param[in] axis The axis of the rotation to combine with the existing rotation.
 792    */
 793   void RotateBy(const Degree& angle, const Vector3& axis);
 794
 795   /**
 796    * @brief Apply a relative rotation to an actor.
 797    *
 798    * @pre The actor has been initialized.
 799    * @param[in] angle The angle to the rotation to combine with the existing rotation.
 800    * @param[in] axis The axis of the rotation to combine with the existing rotation.
 801    */
 802   void RotateBy(const Radian& angle, const Vector3& axis);
 803
 804   /**
 805    * @brief Apply a relative rotation to an actor.
 806    *
 807    * @pre The actor has been initialized.
 808    * @param[in] relativeRotation The rotation to combine with the existing rotation.
 809    */
 810   void RotateBy(const Quaternion& relativeRotation);
 811
 812   /**
 813    * @brief Retreive the Actor's rotation.
 814    *
 815    * @pre The Actor has been initialized.
 816    * @note This property can be animated; the return value may not match the value written with SetRotation().
 817    * @return The current rotation.
 818    */
 819   Quaternion GetCurrentRotation() const;
 820
 821   /**
 822    * @brief Set whether a child actor inherits it's parent's orientation.
 823    *
 824    * Default is to inherit.
 825    * Switching this off means that using SetRotation() sets the actor's world orientation.
 826    * @pre The Actor has been initialized.
 827    * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
 828    */
 829   void SetInheritRotation(bool inherit);
 830
 831   /**
 832    * @brief Returns whether the actor inherit's it's parent's orientation.
 833    *
 834    * @pre The Actor has been initialized.
 835    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 836    */
 837   bool IsRotationInherited() const;
 838
 839   /**
 840    * @brief Retrieve the world-rotation of the Actor.
 841    *
 842    * @note The actor will not have a world-rotation, unless it has previously been added to the stage.
 843    * @pre The Actor has been initialized.
 844    * @return The Actor's current rotation in the world.
 845    */
 846   Quaternion GetCurrentWorldRotation() const;
 847
 848   /**
 849    * @brief Set the scale factor applied to an actor.
 850    *
 851    * @pre The Actor has been initialized.
 852    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 853    * @param [in] scale The scale factor applied on all axes.
 854    */
 855   void SetScale(float scale);
 856
 857   /**
 858    * @brief Set the scale factor applied to an actor.
 859    *
 860    * @pre The Actor has been initialized.
 861    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 862    * @param [in] scaleX The scale factor applied along the x-axis.
 863    * @param [in] scaleY The scale factor applied along the y-axis.
 864    * @param [in] scaleZ The scale factor applied along the z-axis.
 865    */
 866   void SetScale(float scaleX, float scaleY, float scaleZ);
 867
 868   /**
 869    * @brief Set the scale factor applied to an actor.
 870    *
 871    * @pre The Actor has been initialized.
 872    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 873    * @param [in] scale A vector representing the scale factor for each axis.
 874    */
 875   void SetScale(const Vector3& scale);
 876
 877   /**
 878    * @brief Apply a relative scale to an actor.
 879    *
 880    * @pre The actor has been initialized.
 881    * @param[in] relativeScale The scale to combine with the actors existing scale.
 882    */
 883   void ScaleBy(const Vector3& relativeScale);
 884
 885   /**
 886    * @brief Retrieve the scale factor applied to an actor.
 887    *
 888    * @pre The Actor has been initialized.
 889    * @note This property can be animated; the return value may not match the value written with SetScale().
 890    * @return A vector representing the scale factor for each axis.
 891    */
 892   Vector3 GetCurrentScale() const;
 893
 894   /**
 895    * @brief Retrieve the world-scale of the Actor.
 896    *
 897    * @note The actor will not have a world-scale, unless it has previously been added to the stage.
 898    * @pre The Actor has been initialized.
 899    * @return The Actor's current scale in the world.
 900    */
 901   Vector3 GetCurrentWorldScale() const;
 902
 903   /**
 904    * @brief Set whether a child actor inherits it's parent's scale.
 905    *
 906    * Default is to inherit.
 907    * Switching this off means that using SetScale() sets the actor's world scale.
 908    * @pre The Actor has been initialized.
 909    * @param[in] inherit - true if the actor should inherit scale, false otherwise.
 910    */
 911   void SetInheritScale( bool inherit );
 912
 913   /**
 914    * @brief Returns whether the actor inherit's it's parent's scale.
 915    *
 916    * @pre The Actor has been initialized.
 917    * @return true if the actor inherit's it's parent scale, false if it uses world scale.
 918    */
 919   bool IsScaleInherited() const;
 920
 921   /**
 922    * @brief Retrieves the world-matrix of the actor.
 923    *
 924    * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
 925    * @pre The Actor has been initialized.
 926    * @return The Actor's current world matrix
 927    */
 928   Matrix GetCurrentWorldMatrix() const;
 929
 930   // Visibility & Color
 931
 932   /**
 933    * @brief Sets the visibility flag of an actor.
 934    *
 935    * @pre The actor has been initialized.
 936    * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
 937    * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
 938    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
 939    *       rendered if all of its parents have visibility set to true.
 940    * @param [in] visible The new visibility flag.
 941    */
 942   void SetVisible(bool visible);
 943
 944   /**
 945    * @brief Retrieve the visibility flag of an actor.
 946    *
 947    * @pre The actor has been initialized.
 948    * @note This property can be animated; the return value may not match the value written with SetVisible().
 949    * @note If an actor is not visible, then the actor and its children will not be rendered.
 950    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
 951    *       rendered if all of its parents have visibility set to true.
 952    * @return The visibility flag.
 953    */
 954   bool IsVisible() const;
 955
 956   /**
 957    * @brief Sets the opacity of an actor.
 958    *
 959    * @pre The actor has been initialized.
 960    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
 961    * @param [in] opacity The new opacity.
 962    */
 963   void SetOpacity(float opacity);
 964
 965   /**
 966    * @brief Apply a relative opacity change to an actor.
 967    *
 968    * @pre The actor has been initialized.
 969    * @param[in] relativeOpacity The opacity to combine with the actors existing opacity.
 970    */
 971   void OpacityBy(float relativeOpacity);
 972
 973   /**
 974    * @brief Retrieve the actor's opacity.
 975    *
 976    * @pre The actor has been initialized.
 977    * @note This property can be animated; the return value may not match the value written with SetOpacity().
 978    * @return The actor's opacity.
 979    */
 980   float GetCurrentOpacity() const;
 981
 982   /**
 983    * @brief Sets the actor's color; this is an RGBA value.
 984    *
 985    * The final color of the actor depends on its color mode.
 986    * @pre The Actor has been initialized.
 987    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
 988    * @param [in] color The new color.
 989    */
 990   void SetColor(const Vector4& color);
 991
 992   /**
 993    * @brief Apply a relative color change to an actor.
 994    *
 995    * @pre The actor has been initialized.
 996    * @param[in] relativeColor The color to combine with the actors existing color.
 997    */
 998   void ColorBy(const Vector4& relativeColor);
 999
1000   /**
1001    * @brief Retrieve the actor's color.
1002    *
1003    * Actor's own color is not clamped.
1004    * @pre The Actor has been initialized.
1005    * @note This property can be animated; the return value may not match the value written with SetColor().
1006    * @return The color.
1007    */
1008   Vector4 GetCurrentColor() const;
1009
1010   /**
1011    * @brief Sets the actor's color mode.
1012    *
1013    * This specifies whether the Actor uses its own color, or inherits
1014    * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
1015    * @pre The Actor has been initialized.
1016    * @param [in] colorMode to use.
1017    */
1018   void SetColorMode( ColorMode colorMode );
1019
1020   /**
1021    * @brief Returns the actor's color mode.
1022    *
1023    * @pre The Actor has been initialized.
1024    * @return currently used colorMode.
1025    */
1026   ColorMode GetColorMode() const;
1027
1028   /**
1029    * @brief Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range.
1030    *
1031    * @note The actor will not have a world-color, unless it has previously been added to the stage.
1032    * @pre The Actor has been initialized.
1033    * @return The Actor's current color in the world.
1034    */
1035   Vector4 GetCurrentWorldColor() const;
1036
1037   /**
1038    * @brief Set how the actor and its children should be drawn.
1039    *
1040    * Not all actors are renderable, but DrawMode can be inherited from any actor.
1041    * By default a renderable actor will be drawn as a 3D object. It will be depth-tested against
1042    * other objects in the world i.e. it may be obscured if other objects are in front.
1043    *
1044    * If DrawMode::OVERLAY is used, the actor and its children will be drawn as a 2D overlay.
1045    * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1046    * For overlay actors, the drawing order is determined by the hierachy (depth-first search order),
1047    * and depth-testing will not be used.
1048    *
1049    * If DrawMode::STENCIL is used, the actor and its children will be used to stencil-test other actors
1050    * within the Layer. Stencil actors are therefore drawn into the stencil buffer before any other
1051    * actors within the Layer.
1052    *
1053    * @param[in] drawMode The new draw-mode to use.
1054    * @note Setting STENCIL will override OVERLAY, if that would otherwise have been inherited.
1055    * @note Layers do not inherit the DrawMode from their parents.
1056    */
1057   void SetDrawMode( DrawMode::Type drawMode );
1058
1059   /**
1060    * @brief Query how the actor and its children will be drawn.
1061    *
1062    * @return True if the Actor is an overlay.
1063    */
1064   DrawMode::Type GetDrawMode() const;
1065
1066   // Input Handling
1067
1068   /**
1069    * @brief Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover().
1070    *
1071    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1072    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1073    * hover event signal will be emitted.
1074    *
1075    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1076    * @code
1077    * actor.SetSensitive(false);
1078    * @endcode
1079    *
1080    * Then, to re-enable the touch or hover event signal emission, the application should call:
1081    * @code
1082    * actor.SetSensitive(true);
1083    * @endcode
1084    *
1085    * @see @see SignalTouch() and SignalHover().
1086    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1087    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1088    *       hittable if all of its parents have sensitivity set to true.
1089    * @pre The Actor has been initialized.
1090    * @param[in]  sensitive  true to enable emission of the touch or hover event signals, false otherwise.
1091    */
1092   void SetSensitive(bool sensitive);
1093
1094   /**
1095    * @brief Query whether an actor emits touch or hover event signals.
1096    *
1097    * @note If an actor is not sensitive, then it's children will not be hittable either.
1098    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1099    *       hittable if all of its parents have sensitivity set to true.
1100    * @pre The Actor has been initialized.
1101    * @return true, if emission of touch or hover event signals is enabled, false otherwise.
1102    */
1103   bool IsSensitive() const;
1104
1105   /**
1106    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1107    *
1108    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1109    * @pre The Actor has been initialized.
1110    * @param[out] localX On return, the X-coordinate relative to the actor.
1111    * @param[out] localY On return, the Y-coordinate relative to the actor.
1112    * @param[in] screenX The screen X-coordinate.
1113    * @param[in] screenY The screen Y-coordinate.
1114    * @return True if the conversion succeeded.
1115    */
1116   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1117
1118   /**
1119    * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1120    * the boundary of the actor.
1121    *
1122    * @note By default, this is set to false as most actors do not require this.
1123    * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
1124    *
1125    * @pre The Actor has been initialized.
1126    * @param[in]  required  Should be set to true if a Leave event is required
1127    */
1128   void SetLeaveRequired(bool required);
1129
1130   /**
1131    * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1132    * the boundary of the actor.
1133    *
1134    * @pre The Actor has been initialized.
1135    * @return true if a Leave event is required, false otherwise.
1136    */
1137   bool GetLeaveRequired() const;
1138
1139   /**
1140    * @brief Sets whether the actor should be focusable by keyboard navigation.
1141    *
1142    * The default is true.
1143    * @pre The Actor has been initialized.
1144    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1145    * false otherwise.
1146    */
1147   void SetKeyboardFocusable( bool focusable );
1148
1149   /**
1150    * @brief Returns whether the actor is focusable by keyboard navigation.
1151    *
1152    * @pre The Actor has been initialized.
1153    * @return true if the actor is focusable by keyboard navigation, false if not.
1154    */
1155   bool IsKeyboardFocusable() const;
1156
1157 public: // Signals
1158
1159   /**
1160    * @brief This signal is emitted when touch input is received.
1161    *
1162    * A callback of the following type may be connected:
1163    * @code
1164    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1165    * @endcode
1166    * The return value of True, indicates that the touch event should be consumed.
1167    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1168    * @pre The Actor has been initialized.
1169    * @return The signal to connect to.
1170    */
1171   TouchSignalType& TouchedSignal();
1172
1173   /**
1174    * @brief This signal is emitted when hover input is received.
1175    *
1176    * A callback of the following type may be connected:
1177    * @code
1178    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1179    * @endcode
1180    * The return value of True, indicates that the hover event should be consumed.
1181    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1182    * @pre The Actor has been initialized.
1183    * @return The signal to connect to.
1184    */
1185   HoverSignalType& HoveredSignal();
1186
1187   /**
1188    * @brief This signal is emitted when mouse wheel event is received.
1189    *
1190    * A callback of the following type may be connected:
1191    * @code
1192    *   bool YourCallbackName(Actor actor, const MouseWheelEvent& event);
1193    * @endcode
1194    * The return value of True, indicates that the mouse wheel event should be consumed.
1195    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1196    * @pre The Actor has been initialized.
1197    * @return The signal to connect to.
1198    */
1199   MouseWheelEventSignalType& MouseWheelEventSignal();
1200
1201   /**
1202    * @brief This signal is emitted after the actor has been connected to the stage.
1203    *
1204    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1205    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1206    *
1207    * @note When the parent of a set of actors is connected to the stage, then all of the children
1208    * will received this callback.
1209    *
1210    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1211    *
1212    *       A (parent)
1213    *      / \
1214    *     B   C
1215    *    / \   \
1216    *   D   E   F
1217    *
1218    * @return The signal
1219    */
1220   OnStageSignalType& OnStageSignal();
1221
1222   /**
1223    * @brief This signal is emitted after the actor has been disconnected from the stage.
1224    *
1225    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1226    *
1227    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1228    * will received this callback, starting with the leaf actors.
1229    *
1230    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1231    *
1232    *       A (parent)
1233    *      / \
1234    *     B   C
1235    *    / \   \
1236    *   D   E   F
1237    *
1238    * @return The signal
1239    */
1240   OffStageSignalType& OffStageSignal();
1241
1242 public: // Dynamics
1243
1244   /**
1245    * @brief Enable dynamics for this actor.
1246    *
1247    * The actor will behave as a rigid/soft body in the simulation
1248    * @pre The actor is not already acting as a DynamicsBody and IsDynamicsRoot() returns false
1249    *
1250    * @param [in] bodyConfig The DynamicsBodyConfig specifying the dynamics properties for this actor in the dynamics world.
1251    * @return The DynamicsBody
1252    */
1253   DynamicsBody EnableDynamics(DynamicsBodyConfig bodyConfig);
1254
1255   /**
1256    * @brief Add a joint constraint to this actor.
1257    *
1258    * @param[in] attachedActor The other actor in the joint
1259    * @param[in] offset        The offset (relative to this actor) of the origin of the joint
1260    * @return                  The new joint
1261    * @pre Both actors are dynamics enabled actors (IE Actor::EnableDynamics()) has been invoked for both actors).
1262    * @post If the two actors are already connected by a joint, The existing joint is returned
1263    *       and offset is ignored.
1264    */
1265   DynamicsJoint AddDynamicsJoint( Actor attachedActor, const Vector3& offset );
1266
1267   /**
1268    * @brief Add a joint constraint to this actor.
1269    *
1270    * @param[in] attachedActor The other actor in the joint
1271    * @param[in] offsetA       The offset (relative to this actor) of the origin of the joint
1272    * @param[in] offsetB       The offset (relative to attachedActor) of the origin of the joint
1273    * @return                  The new joint
1274    * @pre Both actors are dynamics enabled actors (IE Actor::EnableDynamics()) has been invoked for both actors).
1275    * @post If the two actors are already connected by a joint, The existing joint is returned
1276    *       and offset is ignored.
1277    */
1278   DynamicsJoint AddDynamicsJoint( Actor attachedActor, const Vector3& offsetA, const Vector3& offsetB );
1279
1280   /**
1281    * @brief Get the number of DynamicsJoint objects added to this actor.
1282    *
1283    * @return The number of DynamicsJoint objects added to this actor
1284    */
1285   int GetNumberOfJoints() const;
1286
1287   /**
1288    * @brief Get a joint by index.
1289    *
1290    * @param[in] index The index of the joint.
1291    *                  Use GetNumberOfJoints to get the valid range of indices.
1292    * @return The joint.
1293    */
1294   DynamicsJoint GetDynamicsJointByIndex( const int index );
1295
1296   /**
1297    * @brief Get the joint between this actor and attachedActor.
1298    *
1299    * @param[in] attachedActor The other actor in the joint
1300    * @return The joint.
1301    */
1302   DynamicsJoint GetDynamicsJoint( Actor attachedActor );
1303
1304   /**
1305    * @brief Remove a joint from this actor
1306    *
1307    * @param[in] joint The joint to be removed
1308    */
1309   void RemoveDynamicsJoint( DynamicsJoint joint );
1310
1311   /**
1312    * @brief Disable dynamics for this actor.
1313    *
1314    * The actor will be detached from the DynamicsBody/DynamicsJoint associated with it through EnableDynamics
1315    */
1316   void DisableDynamics();
1317
1318   /**
1319    * @brief Get the associated DynamicsBody.
1320    *
1321    * @return A DynamicsBody
1322    */
1323   DynamicsBody GetDynamicsBody();
1324
1325 public: // Not intended for application developers
1326
1327   /**
1328    * @brief This constructor is used by Dali New() methods.
1329    *
1330    * @param [in] actor A pointer to a newly allocated Dali resource
1331    */
1332   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1333 };
1334
1335 /**
1336  * @brief Helper for discarding an actor handle.
1337  *
1338  * If the handle is empty, this method does nothing.  Otherwise
1339  * actor.Unparent() will be called, followed by actor.Reset().
1340  * @param[in,out] actor A handle to an actor, or an empty handle.
1341  */
1342  DALI_IMPORT_API void UnparentAndReset( Actor& actor );
1343
1344 } // namespace Dali
1345
1346 #endif // __DALI_ACTOR_H__