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 Inserts a child Actor to this actor's list of children at the given index
 421    *
 422    * NOTE! if the child already has a parent, it will be removed from old parent
 423    * and reparented to this actor. This may change childs position, color,
 424    * scale etc as it now inherits them from this actor
 425    * @pre This Actor (the parent) has been initialized.
 426    * @pre The child actor has been initialized.
 427    * @pre The child actor is not the same as the parent actor.
 428    * @pre The actor is not the Root actor
 429    * @param [in] index of actor to insert before
 430    * @param [in] child The child.
 431    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 432    * even if the handle passed into this method is reset or destroyed.
 433    * @post If the index is greater than the current child count, it will be ignored and added at the end.
 434    * @post This may invalidate ActorContainer iterators.
 435    */
 436   void Insert(unsigned int index, Actor child);
 437
 438   /**
 439    * @brief Removes a child Actor from this Actor.
 440    *
 441    * If the actor was not a child of this actor, this is a no-op.
 442    * @pre This Actor (the parent) has been initialized.
 443    * @pre The child actor is not the same as the parent actor.
 444    * @param [in] child The child.
 445    * @post This may invalidate ActorContainer iterators.
 446    */
 447   void Remove(Actor child);
 448
 449   /**
 450    * @brief Removes an actor from its parent.
 451    *
 452    * If the actor has no parent, this method does nothing.
 453    * @pre The (child) actor has been initialized.
 454    * @post This may invalidate ActorContainer iterators.
 455    */
 456   void Unparent();
 457
 458   /**
 459    * @brief Retrieve the number of children held by the actor.
 460    *
 461    * @pre The Actor has been initialized.
 462    * @return The number of children
 463    */
 464   unsigned int GetChildCount() const;
 465
 466   /**
 467    * @brief Retrieve and child actor by index.
 468    *
 469    * @pre The Actor has been initialized.
 470    * @param[in] index The index of the child to retrieve
 471    * @return The actor for the given index or empty handle if children not initialised
 472    */
 473   Actor GetChildAt(unsigned int index) const;
 474
 475   /**
 476    * @brief Search through this actor's hierarchy for an actor with the given name.
 477    *
 478    * The actor itself is also considered in the search
 479    * @pre The Actor has been initialized.
 480    * @param[in] actorName the name of the actor to find
 481    * @return A handle to the actor if found, or an empty handle if not.
 482    */
 483   Actor FindChildByName(const std::string& actorName);
 484
 485   /**
 486    * @brief Search through this actor's hierarchy for an actor with the given name or alias.
 487    *
 488    * Actors can customize this function to provide actors with preferred alias'
 489    * For example 'previous' could return the last selected child.
 490    * If no aliased actor is found then FindChildByName() is called.
 491    * @pre The Actor has been initialized.
 492    * @param[in] actorAlias the name of the actor to find
 493    * @return A handle to the actor if found, or an empty handle if not.
 494    */
 495   Actor FindChildByAlias(const std::string& actorAlias);
 496
 497   /**
 498    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 499    *
 500    * The actor itself is also considered in the search
 501    * @pre The Actor has been initialized.
 502    * @param[in] id the ID of the actor to find
 503    * @return A handle to the actor if found, or an empty handle if not.
 504    */
 505   Actor FindChildById(const unsigned int id);
 506
 507   /**
 508    * @brief Retrieve the actor's parent.
 509    *
 510    * @pre The actor has been initialized.
 511    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
 512    */
 513   Actor GetParent() const;
 514
 515   // Positioning
 516
 517   /**
 518    * @brief Set the origin of an actor, within its parent's area.
 519    *
 520    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 521    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 522    * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
 523    * An actor position is the distance between this origin, and the actors anchor-point.
 524    * @see Dali::ParentOrigin for predefined parent origin values
 525    * @pre The Actor has been initialized.
 526    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentParentOrigin().
 527    * @param [in] origin The new parent-origin.
 528    */
 529   void SetParentOrigin(const Vector3& origin);
 530
 531   /**
 532    * @brief Retrieve the parent-origin of an actor.
 533    *
 534    * @pre The Actor has been initialized.
 535    * @note This property can be animated; the return value may not match the value written with SetParentOrigin().
 536    * @return The current parent-origin.
 537    */
 538   Vector3 GetCurrentParentOrigin() const;
 539
 540   /**
 541    * @brief Set the anchor-point of an actor.
 542    *
 543    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
 544    * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
 545    * bottom-right corner.  The default anchor point is
 546    * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
 547    * An actor position is the distance between its parent-origin, and this anchor-point.
 548    * An actor's rotation is centered around its anchor-point.
 549    * @see Dali::AnchorPoint for predefined anchor point values
 550    * @pre The Actor has been initialized.
 551    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentAnchorPoint().
 552    * @param [in] anchorPoint The new anchor-point.
 553    */
 554   void SetAnchorPoint(const Vector3& anchorPoint);
 555
 556   /**
 557    * @brief Retrieve the anchor-point of an actor.
 558    *
 559    * @pre The Actor has been initialized.
 560    * @note This property can be animated; the return value may not match the value written with SetAnchorPoint().
 561    * @return The current anchor-point.
 562    */
 563   Vector3 GetCurrentAnchorPoint() const;
 564
 565   /**
 566    * @brief Sets the size of an actor.
 567    *
 568    * Geometry can be scaled to fit within this area.
 569    * This does not interfere with the actors scale factor.
 570    * The actors default depth is the minimum of width & height.
 571    * @pre The actor has been initialized.
 572    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 573    * @param [in] width  The new width.
 574    * @param [in] height The new height.
 575    */
 576   void SetSize(float width, float height);
 577
 578   /**
 579    * @brief Sets the size of an actor.
 580    *
 581    * Geometry can be scaled to fit within this area.
 582    * This does not interfere with the actors scale factor.
 583    * @pre The actor has been initialized.
 584    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 585    * @param [in] width  The size of the actor along the x-axis.
 586    * @param [in] height The size of the actor along the y-axis.
 587    * @param [in] depth The size of the actor along the z-axis.
 588    */
 589   void SetSize(float width, float height, float depth);
 590
 591   /**
 592    * @brief Sets the size of an actor.
 593    *
 594    * Geometry can be scaled to fit within this area.
 595    * This does not interfere with the actors scale factor.
 596    * The actors default depth is the minimum of width & height.
 597    * @pre The actor has been initialized.
 598    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 599    * @param [in] size The new size.
 600    */
 601   void SetSize(const Vector2& size);
 602
 603   /**
 604    * @brief Sets the size of an actor.
 605    *
 606    * Geometry can be scaled to fit within this area.
 607    * This does not interfere with the actors scale factor.
 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 Vector3& size);
 613
 614   /**
 615    * @brief Retrieve the actor's size.
 616    *
 617    * @pre The actor has been initialized.
 618    * @note This property can be animated; the return value may not match the value written with SetSize().
 619    * @return The actor's current size.
 620    */
 621   Vector3 GetCurrentSize() const;
 622
 623   /**
 624    * @brief Sets the position of the actor.
 625    *
 626    * The Actor's z position will be set to 0.0f.
 627    * @pre The Actor has been initialized.
 628    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 629    * @param [in] x The new x position
 630    * @param [in] y The new y position
 631    */
 632   void SetPosition(float x, float y);
 633
 634   /**
 635    * @brief Sets the position of the Actor.
 636    *
 637    * @pre The Actor has been initialized.
 638    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 639    * @param [in] x The new x position
 640    * @param [in] y The new y position
 641    * @param [in] z The new z position
 642    */
 643   void SetPosition(float x, float y, float z);
 644
 645   /**
 646    * @brief Sets the position of the Actor.
 647    *
 648    * @pre The Actor has been initialized.
 649    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 650    * @param [in] position The new position
 651    */
 652   void SetPosition(const Vector3& position);
 653
 654   /**
 655    * @brief Set the position of an actor along the X-axis.
 656    *
 657    * @pre The Actor has been initialized.
 658    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 659    * @param [in] x The new x position
 660    */
 661   void SetX(float x);
 662
 663   /**
 664    * @brief Set the position of an actor along the Y-axis.
 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] y The new y position.
 669    */
 670   void SetY(float y);
 671
 672   /**
 673    * @brief Set the position of an actor along the Z-axis.
 674    *
 675    * @pre The Actor has been initialized.
 676    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 677    * @param [in] z The new z position
 678    */
 679   void SetZ(float z);
 680
 681   /**
 682    * @brief Move an actor relative to its existing position.
 683    *
 684    * @pre The actor has been initialized.
 685    * @param[in] distance The actor will move by this distance.
 686    */
 687   void MoveBy(const Vector3& distance);
 688
 689   /**
 690    * @brief Retrieve the position of the Actor.
 691    *
 692    * @pre The Actor has been initialized.
 693    * @note This property can be animated; the return value may not match the value written with SetPosition().
 694    * @return the Actor's current position.
 695    */
 696   Vector3 GetCurrentPosition() const;
 697
 698   /**
 699    * @brief Retrieve the world-position of the Actor.
 700    *
 701    * @note The actor will not have a world-position, unless it has previously been added to the stage.
 702    * @pre The Actor has been initialized.
 703    * @return The Actor's current position in world coordinates.
 704    */
 705   Vector3 GetCurrentWorldPosition() const;
 706
 707   /**
 708    * @brief Set the actors position inheritance mode.
 709    *
 710    * The default is to inherit.
 711    * Switching this off means that using SetPosition() sets the actor's world position.
 712    * @see PositionInheritanceMode
 713    * @pre The Actor has been initialized.
 714    * @param[in] mode to use
 715    */
 716   void SetPositionInheritanceMode( PositionInheritanceMode mode );
 717
 718   /**
 719    * @brief Returns the actors position inheritance mode.
 720    *
 721    * @pre The Actor has been initialized.
 722    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 723    */
 724   PositionInheritanceMode GetPositionInheritanceMode() const;
 725
 726   /**
 727    * @brief Sets the rotation of the Actor.
 728    *
 729    * An actor's rotation is centered around its anchor point.
 730    * @pre The Actor has been initialized.
 731    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentRotation().
 732    * @param [in] angle The new rotation angle in degrees.
 733    * @param [in] axis The new axis of rotation.
 734    */
 735   void SetRotation(const Degree& angle, const Vector3& axis);
 736
 737   /**
 738    * @brief Sets the rotation of the Actor.
 739    *
 740    * An actor's rotation is centered around its anchor point.
 741    * @pre The Actor has been initialized.
 742    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentRotation().
 743    * @param [in] angle The new rotation angle in radians.
 744    * @param [in] axis The new axis of rotation.
 745    */
 746   void SetRotation(const Radian& angle, const Vector3& axis);
 747
 748   /**
 749    * @brief Sets the rotation of the Actor.
 750    *
 751    * @pre The Actor has been initialized.
 752    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentRotation().
 753    * @param [in] rotation The new rotation.
 754    */
 755   void SetRotation(const Quaternion& rotation);
 756
 757   /**
 758    * @brief Apply a relative rotation to an actor.
 759    *
 760    * @pre The actor has been initialized.
 761    * @param[in] angle The angle to the rotation to combine with the existing rotation.
 762    * @param[in] axis The axis of the rotation to combine with the existing rotation.
 763    */
 764   void RotateBy(const Degree& angle, const Vector3& axis);
 765
 766   /**
 767    * @brief Apply a relative rotation to an actor.
 768    *
 769    * @pre The actor has been initialized.
 770    * @param[in] angle The angle to the rotation to combine with the existing rotation.
 771    * @param[in] axis The axis of the rotation to combine with the existing rotation.
 772    */
 773   void RotateBy(const Radian& angle, const Vector3& axis);
 774
 775   /**
 776    * @brief Apply a relative rotation to an actor.
 777    *
 778    * @pre The actor has been initialized.
 779    * @param[in] relativeRotation The rotation to combine with the existing rotation.
 780    */
 781   void RotateBy(const Quaternion& relativeRotation);
 782
 783   /**
 784    * @brief Retreive the Actor's rotation.
 785    *
 786    * @pre The Actor has been initialized.
 787    * @note This property can be animated; the return value may not match the value written with SetRotation().
 788    * @return The current rotation.
 789    */
 790   Quaternion GetCurrentRotation() const;
 791
 792   /**
 793    * @brief Set whether a child actor inherits it's parent's orientation.
 794    *
 795    * Default is to inherit.
 796    * Switching this off means that using SetRotation() sets the actor's world orientation.
 797    * @pre The Actor has been initialized.
 798    * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
 799    */
 800   void SetInheritRotation(bool inherit);
 801
 802   /**
 803    * @brief Returns whether the actor inherit's it's parent's orientation.
 804    *
 805    * @pre The Actor has been initialized.
 806    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 807    */
 808   bool IsRotationInherited() const;
 809
 810   /**
 811    * @brief Retrieve the world-rotation of the Actor.
 812    *
 813    * @note The actor will not have a world-rotation, unless it has previously been added to the stage.
 814    * @pre The Actor has been initialized.
 815    * @return The Actor's current rotation in the world.
 816    */
 817   Quaternion GetCurrentWorldRotation() const;
 818
 819   /**
 820    * @brief Set the scale factor applied to an actor.
 821    *
 822    * @pre The Actor has been initialized.
 823    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 824    * @param [in] scale The scale factor applied on all axes.
 825    */
 826   void SetScale(float scale);
 827
 828   /**
 829    * @brief Set the scale factor applied to an actor.
 830    *
 831    * @pre The Actor has been initialized.
 832    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 833    * @param [in] scaleX The scale factor applied along the x-axis.
 834    * @param [in] scaleY The scale factor applied along the y-axis.
 835    * @param [in] scaleZ The scale factor applied along the z-axis.
 836    */
 837   void SetScale(float scaleX, float scaleY, float scaleZ);
 838
 839   /**
 840    * @brief Set the scale factor applied to an actor.
 841    *
 842    * @pre The Actor has been initialized.
 843    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 844    * @param [in] scale A vector representing the scale factor for each axis.
 845    */
 846   void SetScale(const Vector3& scale);
 847
 848   /**
 849    * @brief Apply a relative scale to an actor.
 850    *
 851    * @pre The actor has been initialized.
 852    * @param[in] relativeScale The scale to combine with the actors existing scale.
 853    */
 854   void ScaleBy(const Vector3& relativeScale);
 855
 856   /**
 857    * @brief Retrieve the scale factor applied to an actor.
 858    *
 859    * @pre The Actor has been initialized.
 860    * @note This property can be animated; the return value may not match the value written with SetScale().
 861    * @return A vector representing the scale factor for each axis.
 862    */
 863   Vector3 GetCurrentScale() const;
 864
 865   /**
 866    * @brief Retrieve the world-scale of the Actor.
 867    *
 868    * @note The actor will not have a world-scale, unless it has previously been added to the stage.
 869    * @pre The Actor has been initialized.
 870    * @return The Actor's current scale in the world.
 871    */
 872   Vector3 GetCurrentWorldScale() const;
 873
 874   /**
 875    * @brief Set whether a child actor inherits it's parent's scale.
 876    *
 877    * Default is to inherit.
 878    * Switching this off means that using SetScale() sets the actor's world scale.
 879    * @pre The Actor has been initialized.
 880    * @param[in] inherit - true if the actor should inherit scale, false otherwise.
 881    */
 882   void SetInheritScale( bool inherit );
 883
 884   /**
 885    * @brief Returns whether the actor inherit's it's parent's scale.
 886    *
 887    * @pre The Actor has been initialized.
 888    * @return true if the actor inherit's it's parent scale, false if it uses world scale.
 889    */
 890   bool IsScaleInherited() const;
 891
 892   /**
 893    * @brief Retrieves the world-matrix of the actor.
 894    *
 895    * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
 896    * @pre The Actor has been initialized.
 897    * @return The Actor's current world matrix
 898    */
 899   Matrix GetCurrentWorldMatrix() const;
 900
 901   // Visibility & Color
 902
 903   /**
 904    * @brief Sets the visibility flag of an actor.
 905    *
 906    * @pre The actor has been initialized.
 907    * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
 908    * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
 909    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
 910    *       rendered if all of its parents have visibility set to true.
 911    * @param [in] visible The new visibility flag.
 912    */
 913   void SetVisible(bool visible);
 914
 915   /**
 916    * @brief Retrieve the visibility flag of an actor.
 917    *
 918    * @pre The actor has been initialized.
 919    * @note This property can be animated; the return value may not match the value written with SetVisible().
 920    * @note If an actor is not visible, then the actor and its children will not be rendered.
 921    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
 922    *       rendered if all of its parents have visibility set to true.
 923    * @return The visibility flag.
 924    */
 925   bool IsVisible() const;
 926
 927   /**
 928    * @brief Sets the opacity of an actor.
 929    *
 930    * @pre The actor has been initialized.
 931    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
 932    * @param [in] opacity The new opacity.
 933    */
 934   void SetOpacity(float opacity);
 935
 936   /**
 937    * @brief Apply a relative opacity change to an actor.
 938    *
 939    * @pre The actor has been initialized.
 940    * @param[in] relativeOpacity The opacity to combine with the actors existing opacity.
 941    */
 942   void OpacityBy(float relativeOpacity);
 943
 944   /**
 945    * @brief Retrieve the actor's opacity.
 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 SetOpacity().
 949    * @return The actor's opacity.
 950    */
 951   float GetCurrentOpacity() const;
 952
 953   /**
 954    * @brief Sets the actor's color; this is an RGBA value.
 955    *
 956    * The final color of the actor depends on its color mode.
 957    * @pre The Actor has been initialized.
 958    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
 959    * @param [in] color The new color.
 960    */
 961   void SetColor(const Vector4& color);
 962
 963   /**
 964    * @brief Apply a relative color change to an actor.
 965    *
 966    * @pre The actor has been initialized.
 967    * @param[in] relativeColor The color to combine with the actors existing color.
 968    */
 969   void ColorBy(const Vector4& relativeColor);
 970
 971   /**
 972    * @brief Retrieve the actor's color.
 973    *
 974    * Actor's own color is not clamped.
 975    * @pre The Actor has been initialized.
 976    * @note This property can be animated; the return value may not match the value written with SetColor().
 977    * @return The color.
 978    */
 979   Vector4 GetCurrentColor() const;
 980
 981   /**
 982    * @brief Sets the actor's color mode.
 983    *
 984    * This specifies whether the Actor uses its own color, or inherits
 985    * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
 986    * @pre The Actor has been initialized.
 987    * @param [in] colorMode to use.
 988    */
 989   void SetColorMode( ColorMode colorMode );
 990
 991   /**
 992    * @brief Returns the actor's color mode.
 993    *
 994    * @pre The Actor has been initialized.
 995    * @return currently used colorMode.
 996    */
 997   ColorMode GetColorMode() const;
 998
 999   /**
1000    * @brief Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range.
1001    *
1002    * @note The actor will not have a world-color, unless it has previously been added to the stage.
1003    * @pre The Actor has been initialized.
1004    * @return The Actor's current color in the world.
1005    */
1006   Vector4 GetCurrentWorldColor() const;
1007
1008   /**
1009    * @brief Set how the actor and its children should be drawn.
1010    *
1011    * Not all actors are renderable, but DrawMode can be inherited from any actor.
1012    * By default a renderable actor will be drawn as a 3D object. It will be depth-tested against
1013    * other objects in the world i.e. it may be obscured if other objects are in front.
1014    *
1015    * If DrawMode::OVERLAY is used, the actor and its children will be drawn as a 2D overlay.
1016    * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1017    * For overlay actors, the drawing order is determined by the hierachy (depth-first search order),
1018    * and depth-testing will not be used.
1019    *
1020    * If DrawMode::STENCIL is used, the actor and its children will be used to stencil-test other actors
1021    * within the Layer. Stencil actors are therefore drawn into the stencil buffer before any other
1022    * actors within the Layer.
1023    *
1024    * @param[in] drawMode The new draw-mode to use.
1025    * @note Setting STENCIL will override OVERLAY, if that would otherwise have been inherited.
1026    * @note Layers do not inherit the DrawMode from their parents.
1027    */
1028   void SetDrawMode( DrawMode::Type drawMode );
1029
1030   /**
1031    * @brief Query how the actor and its children will be drawn.
1032    *
1033    * @return True if the Actor is an overlay.
1034    */
1035   DrawMode::Type GetDrawMode() const;
1036
1037   // Input Handling
1038
1039   /**
1040    * @brief Sets whether an actor should emit touch event signals; @see SignalTouched().
1041    *
1042    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouched(),
1043    * the touch event signal will be emitted.
1044    *
1045    * If the application wishes to temporarily disable the touch event signal emission, then they can do so by calling:
1046    * @code
1047    * actor.SetSensitive(false);
1048    * @endcode
1049    *
1050    * Then, to re-enable the touch event signal emission, the application should call:
1051    * @code
1052    * actor.SetSensitive(true);
1053    * @endcode
1054    *
1055    * @see SignalTouched().
1056    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1057    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1058    *       hittable if all of its parents have sensitivity set to true.
1059    * @pre The Actor has been initialized.
1060    * @param[in]  sensitive  true to enable emission of the touch event signals, false otherwise.
1061    */
1062   void SetSensitive(bool sensitive);
1063
1064   /**
1065    * @brief Query whether an actor emits touch event signals.
1066    *
1067    * @note If an actor is not sensitive, then it's children will not be hittable either.
1068    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1069    *       hittable if all of its parents have sensitivity set to true.
1070    * @pre The Actor has been initialized.
1071    * @return true, if emission of touch event signals is enabled, false otherwise.
1072    */
1073   bool IsSensitive() const;
1074
1075   /**
1076    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1077    *
1078    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1079    * @pre The Actor has been initialized.
1080    * @param[out] localX On return, the X-coordinate relative to the actor.
1081    * @param[out] localY On return, the Y-coordinate relative to the actor.
1082    * @param[in] screenX The screen X-coordinate.
1083    * @param[in] screenY The screen Y-coordinate.
1084    * @return True if the conversion succeeded.
1085    */
1086   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1087
1088   /**
1089    * @brief Sets whether the actor should receive a notification when touch motion events leave
1090    * the boundary of the actor.
1091    *
1092    * @note By default, this is set to false as most actors do not require this.
1093    * @note Need to connect to the SignalTouch to actually receive this event.
1094    *
1095    * @pre The Actor has been initialized.
1096    * @param[in]  required  Should be set to true if a Leave event is required
1097    */
1098   void SetLeaveRequired(bool required);
1099
1100   /**
1101    * @brief This returns whether the actor requires touch events whenever touch motion events leave
1102    * the boundary of the actor.
1103    *
1104    * @pre The Actor has been initialized.
1105    * @return true if a Leave event is required, false otherwise.
1106    */
1107   bool GetLeaveRequired() const;
1108
1109   /**
1110    * @brief Sets whether the actor should be focusable by keyboard navigation.
1111    *
1112    * The default is true.
1113    * @pre The Actor has been initialized.
1114    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1115    * false otherwise.
1116    */
1117   void SetKeyboardFocusable( bool focusable );
1118
1119   /**
1120    * @brief Returns whether the actor is focusable by keyboard navigation.
1121    *
1122    * @pre The Actor has been initialized.
1123    * @return true if the actor is focusable by keyboard navigation, false if not.
1124    */
1125   bool IsKeyboardFocusable() const;
1126
1127 public: // Signals
1128
1129   /**
1130    * @brief This signal is emitted when touch input is received.
1131    *
1132    * A callback of the following type may be connected:
1133    * @code
1134    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1135    * @endcode
1136    * The return value of True, indicates that the touch event should be consumed.
1137    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1138    * @pre The Actor has been initialized.
1139    * @return The signal to connect to.
1140    */
1141   TouchSignalV2& TouchedSignal();
1142
1143   /**
1144    * @brief This signal is emitted when mouse wheel event is received.
1145    *
1146    * A callback of the following type may be connected:
1147    * @code
1148    *   bool YourCallbackName(Actor actor, const MouseWheelEvent& event);
1149    * @endcode
1150    * The return value of True, indicates that the mouse wheel event should be consumed.
1151    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1152    * @pre The Actor has been initialized.
1153    * @return The signal to connect to.
1154    */
1155   MouseWheelEventSignalV2& MouseWheelEventSignal();
1156
1157   /**
1158    * @brief Signal to indicate when the actor's size is set by application code.
1159    *
1160    * This signal is emitted when actors size is being <b>set</b> by application code.
1161    * This signal is <b>not</b> emitted when size is animated
1162    * Note! GetCurrentSize might not return this same size as the set size message may still be queued
1163    * A callback of the following type may be connected:
1164    * @code
1165    *   void YourCallback(Actor actor, const Vector3& newSize);
1166    * @endcode
1167    * @pre The Actor has been initialized.
1168    * @return The signal to connect to.
1169    */
1170   SetSizeSignalV2& SetSizeSignal();
1171
1172   /**
1173    * @brief This signal is emitted after the actor has been connected to the stage.
1174    *
1175    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1176    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1177    *
1178    * @note When the parent of a set of actors is connected to the stage, then all of the children
1179    * will received this callback.
1180    *
1181    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1182    *
1183    *       A (parent)
1184    *      / \
1185    *     B   C
1186    *    / \   \
1187    *   D   E   F
1188    *
1189    * @return The signal
1190    */
1191   OnStageSignalV2& OnStageSignal();
1192
1193   /**
1194    * @brief This signal is emitted after the actor has been disconnected from the stage.
1195    *
1196    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1197    *
1198    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1199    * will received this callback, starting with the leaf actors.
1200    *
1201    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1202    *
1203    *       A (parent)
1204    *      / \
1205    *     B   C
1206    *    / \   \
1207    *   D   E   F
1208    *
1209    * @return The signal
1210    */
1211   OffStageSignalV2& OffStageSignal();
1212
1213 public: // Dynamics
1214
1215   /**
1216    * @brief Enable dynamics for this actor.
1217    *
1218    * The actor will behave as a rigid/soft body in the simulation
1219    * @pre The actor is not already acting as a DynamicsBody and IsDynamicsRoot() returns false
1220    *
1221    * @param [in] bodyConfig The DynamicsBodyConfig specifying the dynamics properties for this actor in the dynamics world.
1222    * @return The DynamicsBody
1223    */
1224   DynamicsBody EnableDynamics(DynamicsBodyConfig bodyConfig);
1225
1226   /**
1227    * @brief Add a joint constraint to this actor.
1228    *
1229    * @param[in] attachedActor The other actor in the joint
1230    * @param[in] offset        The offset (relative to this actor) of the origin of the joint
1231    * @return                  The new joint
1232    * @pre Both actors are dynamics enabled actors (IE Actor::EnableDynamics()) has been invoked for both actors).
1233    * @post If the two actors are already connected by a joint, The existing joint is returned
1234    *       and offset is ignored.
1235    */
1236   DynamicsJoint AddDynamicsJoint( Actor attachedActor, const Vector3& offset );
1237
1238   /**
1239    * @brief Add a joint constraint to this actor.
1240    *
1241    * @param[in] attachedActor The other actor in the joint
1242    * @param[in] offsetA       The offset (relative to this actor) of the origin of the joint
1243    * @param[in] offsetB       The offset (relative to attachedActor) of the origin of the joint
1244    * @return                  The new joint
1245    * @pre Both actors are dynamics enabled actors (IE Actor::EnableDynamics()) has been invoked for both actors).
1246    * @post If the two actors are already connected by a joint, The existing joint is returned
1247    *       and offset is ignored.
1248    */
1249   DynamicsJoint AddDynamicsJoint( Actor attachedActor, const Vector3& offsetA, const Vector3& offsetB );
1250
1251   /**
1252    * @brief Get the number of DynamicsJoint objects added to this actor.
1253    *
1254    * @return The number of DynamicsJoint objects added to this actor
1255    */
1256   const int GetNumberOfJoints() const;
1257
1258   /**
1259    * @brief Get a joint by index.
1260    *
1261    * @param[in] index The index of the joint.
1262    *                  Use GetNumberOfJoints to get the valid range of indices.
1263    * @return The joint.
1264    */
1265   DynamicsJoint GetDynamicsJointByIndex( const int index );
1266
1267   /**
1268    * @brief Get the joint between this actor and attachedActor.
1269    *
1270    * @param[in] attachedActor The other actor in the joint
1271    * @return The joint.
1272    */
1273   DynamicsJoint GetDynamicsJoint( Actor attachedActor );
1274
1275   /**
1276    * @brief Remove a joint from this actor
1277    *
1278    * @param[in] joint The joint to be removed
1279    */
1280   void RemoveDynamicsJoint( DynamicsJoint joint );
1281
1282   /**
1283    * @brief Disable dynamics for this actor.
1284    *
1285    * The actor will be detached from the DynamicsBody/DynamicsJoint associated with it through EnableDynamics
1286    */
1287   void DisableDynamics();
1288
1289   /**
1290    * @brief Get the associated DynamicsBody.
1291    *
1292    * @return A DynamicsBody
1293    */
1294   DynamicsBody GetDynamicsBody();
1295
1296 public: // Not intended for application developers
1297
1298   /**
1299    * @brief This constructor is used by Dali New() methods.
1300    *
1301    * @param [in] actor A pointer to a newly allocated Dali resource
1302    */
1303   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1304 };
1305
1306 /**
1307  * @brief Helper for discarding an actor handle.
1308  *
1309  * If the handle is empty, this method does nothing.  Otherwise
1310  * actor.Unparent() will be called, followed by actor.Reset().
1311  * @param[in,out] actor A handle to an actor, or an empty handle.
1312  */
1313 void UnparentAndReset( Actor& actor );
1314
1315 } // namespace Dali
1316
1317 #endif // __DALI_ACTOR_H__