dali/public-api/actors/actor.h

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