dali/public-api/actors/actor.h

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