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