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