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