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       WIDTH_RESIZE_POLICY,                                ///< name "width-resize-policy",   type String
 296       HEIGHT_RESIZE_POLICY,                               ///< name "height-resize-policy",  type String
 297       SIZE_SCALE_POLICY,                                  ///< name "size-scale-policy",     type String
 298       WIDTH_FOR_HEIGHT,                                   ///< name "width-for-height",      type Boolean
 299       HEIGHT_FOR_WIDTH,                                   ///< name "height-for-width",      type Boolean
 300       PADDING,                                            ///< name "padding",               type Vector4
 301       MINIMUM_SIZE,                                       ///< name "minimum-size",          type Vector2
 302       MAXIMUM_SIZE,                                       ///< name "maximum-size",          type Vector2
 303     };
 304   };
 305
 306   // Typedefs
 307
 308   typedef Signal< bool (Actor, const TouchEvent&)> TouchSignalType;                 ///< Touch signal type
 309   typedef Signal< bool (Actor, const HoverEvent&)> HoverSignalType;                 ///< Hover signal type
 310   typedef Signal< bool (Actor, const MouseWheelEvent&) > MouseWheelEventSignalType; ///< Mousewheel signal type
 311   typedef Signal< void (Actor) > OnStageSignalType;  ///< Stage connection signal type
 312   typedef Signal< void (Actor) > OffStageSignalType; ///< Stage disconnection signal type
 313   typedef Signal< void (Actor) > OnRelayoutSignalType; ///< Called when the actor is relaid out
 314
 315   // Creation
 316
 317   /**
 318    * @brief Create an uninitialized Actor; this can be initialized with Actor::New().
 319    *
 320    * Calling member functions with an uninitialized Dali::Object is not allowed.
 321    */
 322   Actor();
 323
 324   /**
 325    * @brief Create an initialized Actor.
 326    *
 327    * @return A handle to a newly allocated Dali resource.
 328    */
 329   static Actor New();
 330
 331   /**
 332    * @brief Downcast an Object handle to Actor handle.
 333    *
 334    * If handle points to a Actor object the downcast produces valid
 335    * handle. If not the returned handle is left uninitialized.
 336    *
 337    * @param[in] handle to An object
 338    * @return handle to a Actor object or an uninitialized handle
 339    */
 340   static Actor DownCast( BaseHandle handle );
 341
 342   /**
 343    * @brief Dali::Actor is intended as a base class
 344    *
 345    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 346    */
 347   ~Actor();
 348
 349   /**
 350    * @brief Copy constructor
 351    *
 352    * @param [in] copy The actor to copy.
 353    */
 354   Actor(const Actor& copy);
 355
 356   /**
 357    * @brief Assignment operator
 358    *
 359    * @param [in] rhs The actor to copy.
 360    */
 361   Actor& operator=(const Actor& rhs);
 362
 363   /**
 364    * @brief Retrieve the Actor's name.
 365    *
 366    * @pre The Actor has been initialized.
 367    * @return The Actor's name.
 368    */
 369   const std::string& GetName() const;
 370
 371   /**
 372    * @brief Sets the Actor's name.
 373    *
 374    * @pre The Actor has been initialized.
 375    * @param [in] name The new name.
 376    */
 377   void SetName(const std::string& name);
 378
 379   /**
 380    * @brief Retrieve the unique ID of the actor.
 381    *
 382    * @pre The Actor has been initialized.
 383    * @return The ID.
 384    */
 385   unsigned int GetId() const;
 386
 387   // Containment
 388
 389   /**
 390    * @brief Query whether an actor is the root actor, which is owned by the Stage.
 391    *
 392    * @pre The Actor has been initialized.
 393    * @return True if the actor is the root actor.
 394    */
 395   bool IsRoot() const;
 396
 397   /**
 398    * @brief Query whether the actor is connected to the Stage.
 399    *
 400    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
 401    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
 402    * @pre The Actor has been initialized.
 403    * @return True if the actor is connected to the Stage.
 404    */
 405   bool OnStage() const;
 406
 407   /**
 408    * @brief Query whether the actor is of class Dali::Layer.
 409    *
 410    * @pre The Actor has been initialized.
 411    * @return True if the actor is a layer.
 412    */
 413   bool IsLayer() const;
 414
 415   /**
 416    * @brief Gets the layer in which the actor is present.
 417    *
 418    * @pre The Actor has been initialized.
 419    * @return The layer, which will be uninitialized if the actor is off-stage.
 420    */
 421   Layer GetLayer();
 422
 423   /**
 424    * @brief Adds a child Actor to this Actor.
 425    *
 426    * NOTE! if the child already has a parent, it will be removed from old parent
 427    * and reparented to this actor. This may change childs position, color,
 428    * scale etc as it now inherits them from this actor
 429    * @pre This Actor (the parent) has been initialized.
 430    * @pre The child actor has been initialized.
 431    * @pre The child actor is not the same as the parent actor.
 432    * @pre The actor is not the Root actor
 433    * @param [in] child The child.
 434    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 435    * even if the handle passed into this method is reset or destroyed.
 436    * @post This may invalidate ActorContainer iterators.
 437    */
 438   void Add(Actor child);
 439
 440   /**
 441    * @brief Inserts a child Actor to this actor's list of children at the given index
 442    *
 443    * NOTE! if the child already has a parent, it will be removed from old parent
 444    * and reparented to this actor. This may change childs position, color,
 445    * scale etc as it now inherits them from this actor
 446    * @pre This Actor (the parent) has been initialized.
 447    * @pre The child actor has been initialized.
 448    * @pre The child actor is not the same as the parent actor.
 449    * @pre The actor is not the Root actor
 450    * @param [in] index of actor to insert before
 451    * @param [in] child The child.
 452    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 453    * even if the handle passed into this method is reset or destroyed.
 454    * @post If the index is greater than the current child count, it will be ignored and added at the end.
 455    * @post This may invalidate ActorContainer iterators.
 456    */
 457   void Insert(unsigned int index, Actor child);
 458
 459   /**
 460    * @brief Removes a child Actor from this Actor.
 461    *
 462    * If the actor was not a child of this actor, this is a no-op.
 463    * @pre This Actor (the parent) has been initialized.
 464    * @pre The child actor is not the same as the parent actor.
 465    * @param [in] child The child.
 466    * @post This may invalidate ActorContainer iterators.
 467    */
 468   void Remove(Actor child);
 469
 470   /**
 471    * @brief Removes an actor from its parent.
 472    *
 473    * If the actor has no parent, this method does nothing.
 474    * @pre The (child) actor has been initialized.
 475    * @post This may invalidate ActorContainer iterators.
 476    */
 477   void Unparent();
 478
 479   /**
 480    * @brief Retrieve the number of children held by the actor.
 481    *
 482    * @pre The Actor has been initialized.
 483    * @return The number of children
 484    */
 485   unsigned int GetChildCount() const;
 486
 487   /**
 488    * @brief Retrieve and child actor by index.
 489    *
 490    * @pre The Actor has been initialized.
 491    * @param[in] index The index of the child to retrieve
 492    * @return The actor for the given index or empty handle if children not initialised
 493    */
 494   Actor GetChildAt(unsigned int index) const;
 495
 496   /**
 497    * @brief Search through this actor's hierarchy for an actor with the given name.
 498    *
 499    * The actor itself is also considered in the search
 500    * @pre The Actor has been initialized.
 501    * @param[in] actorName the name of the actor to find
 502    * @return A handle to the actor if found, or an empty handle if not.
 503    */
 504   Actor FindChildByName(const std::string& actorName);
 505
 506   /**
 507    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 508    *
 509    * The actor itself is also considered in the search
 510    * @pre The Actor has been initialized.
 511    * @param[in] id the ID of the actor to find
 512    * @return A handle to the actor if found, or an empty handle if not.
 513    */
 514   Actor FindChildById(const unsigned int id);
 515
 516   /**
 517    * @brief Retrieve the actor's parent.
 518    *
 519    * @pre The actor has been initialized.
 520    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
 521    */
 522   Actor GetParent() const;
 523
 524   // Positioning
 525
 526   /**
 527    * @brief Set the origin of an actor, within its parent's area.
 528    *
 529    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 530    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 531    * The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
 532    * An actor position is the distance between this origin, and the actors anchor-point.
 533    * @see Dali::ParentOrigin for predefined parent origin values
 534    * @pre The Actor has been initialized.
 535    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentParentOrigin().
 536    * @param [in] origin The new parent-origin.
 537    */
 538   void SetParentOrigin(const Vector3& origin);
 539
 540   /**
 541    * @brief Retrieve the parent-origin of an actor.
 542    *
 543    * @pre The Actor has been initialized.
 544    * @note This property can be animated; the return value may not match the value written with SetParentOrigin().
 545    * @return The current parent-origin.
 546    */
 547   Vector3 GetCurrentParentOrigin() const;
 548
 549   /**
 550    * @brief Set the anchor-point of an actor.
 551    *
 552    * This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
 553    * is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
 554    * bottom-right corner.  The default anchor point is
 555    * Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
 556    * An actor position is the distance between its parent-origin, and this anchor-point.
 557    * An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
 558    * @see Dali::AnchorPoint for predefined anchor point values
 559    * @pre The Actor has been initialized.
 560    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentAnchorPoint().
 561    * @param [in] anchorPoint The new anchor-point.
 562    */
 563   void SetAnchorPoint(const Vector3& anchorPoint);
 564
 565   /**
 566    * @brief Retrieve the anchor-point of an actor.
 567    *
 568    * @pre The Actor has been initialized.
 569    * @note This property can be animated; the return value may not match the value written with SetAnchorPoint().
 570    * @return The current anchor-point.
 571    */
 572   Vector3 GetCurrentAnchorPoint() const;
 573
 574   /**
 575    * @brief Sets the size of an actor.
 576    *
 577    * Geometry can be scaled to fit within this area.
 578    * This does not interfere with the actors scale factor.
 579    * The actors default depth is the minimum of width & height.
 580    * @pre The actor has been initialized.
 581    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 582    * @param [in] width  The new width.
 583    * @param [in] height The new height.
 584    */
 585   void SetSize(float width, float height);
 586
 587   /**
 588    * @brief Sets the size of an actor.
 589    *
 590    * Geometry can be scaled to fit within this area.
 591    * This does not interfere with the actors scale factor.
 592    * @pre The actor has been initialized.
 593    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 594    * @param [in] width  The size of the actor along the x-axis.
 595    * @param [in] height The size of the actor along the y-axis.
 596    * @param [in] depth The size of the actor along the z-axis.
 597    */
 598   void SetSize(float width, float height, float depth);
 599
 600   /**
 601    * @brief Sets the size of an actor.
 602    *
 603    * Geometry can be scaled to fit within this area.
 604    * This does not interfere with the actors scale factor.
 605    * The actors default depth is the minimum of width & height.
 606    * @pre The actor has been initialized.
 607    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 608    * @param [in] size The new size.
 609    */
 610   void SetSize(const Vector2& size);
 611
 612   /**
 613    * @brief Sets the size of an actor.
 614    *
 615    * Geometry can be scaled to fit within this area.
 616    * This does not interfere with the actors scale factor.
 617    * @pre The actor has been initialized.
 618    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentSize().
 619    * @param [in] size The new size.
 620    */
 621   void SetSize(const Vector3& size);
 622
 623   /**
 624    * @brief Retrieve the actor's size.
 625    *
 626    * @pre The actor has been initialized.
 627    * @note This return is the value that was set using SetSize or the target size of an animation
 628    * @return The actor's current size.
 629    */
 630   Vector3 GetTargetSize() const;
 631
 632   /**
 633    * @brief Retrieve the actor's size.
 634    *
 635    * @pre The actor has been initialized.
 636    * @note This property can be animated; the return value may not match the value written with SetSize().
 637    * @return The actor's current size.
 638    */
 639   Vector3 GetCurrentSize() const;
 640
 641   /**
 642    * Return the natural size of the actor.
 643    *
 644    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 645    *
 646    * @return The actor's natural size
 647    */
 648   Vector3 GetNaturalSize() const;
 649
 650   /**
 651    * @brief Sets the position of the actor.
 652    *
 653    * The Actor's z position will be set to 0.0f.
 654    * @pre The Actor has been initialized.
 655    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 656    * @param [in] x The new x position
 657    * @param [in] y The new y position
 658    */
 659   void SetPosition(float x, float y);
 660
 661   /**
 662    * @brief Sets the position of the Actor.
 663    *
 664    * @pre The Actor has been initialized.
 665    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 666    * @param [in] x The new x position
 667    * @param [in] y The new y position
 668    * @param [in] z The new z position
 669    */
 670   void SetPosition(float x, float y, float z);
 671
 672   /**
 673    * @brief Sets the position of the Actor.
 674    *
 675    * @pre The Actor has been initialized.
 676    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 677    * @param [in] position The new position
 678    */
 679   void SetPosition(const Vector3& position);
 680
 681   /**
 682    * @brief Set the position of an actor along the X-axis.
 683    *
 684    * @pre The Actor has been initialized.
 685    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 686    * @param [in] x The new x position
 687    */
 688   void SetX(float x);
 689
 690   /**
 691    * @brief Set the position of an actor along the Y-axis.
 692    *
 693    * @pre The Actor has been initialized.
 694    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 695    * @param [in] y The new y position.
 696    */
 697   void SetY(float y);
 698
 699   /**
 700    * @brief Set the position of an actor along the Z-axis.
 701    *
 702    * @pre The Actor has been initialized.
 703    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentPosition().
 704    * @param [in] z The new z position
 705    */
 706   void SetZ(float z);
 707
 708   /**
 709    * @brief Translate an actor relative to its existing position.
 710    *
 711    * @pre The actor has been initialized.
 712    * @param[in] distance The actor will move by this distance.
 713    */
 714   void TranslateBy(const Vector3& distance);
 715
 716   /**
 717    * @brief Retrieve the position of the Actor.
 718    *
 719    * @pre The Actor has been initialized.
 720    * @note This property can be animated; the return value may not match the value written with SetPosition().
 721    * @return the Actor's current position.
 722    */
 723   Vector3 GetCurrentPosition() const;
 724
 725   /**
 726    * @brief Retrieve the world-position of the Actor.
 727    *
 728    * @note The actor will not have a world-position, unless it has previously been added to the stage.
 729    * @pre The Actor has been initialized.
 730    * @return The Actor's current position in world coordinates.
 731    */
 732   Vector3 GetCurrentWorldPosition() const;
 733
 734   /**
 735    * @brief Set the actors position inheritance mode.
 736    *
 737    * The default is to inherit.
 738    * Switching this off means that using SetPosition() sets the actor's world position.
 739    * @see PositionInheritanceMode
 740    * @pre The Actor has been initialized.
 741    * @param[in] mode to use
 742    */
 743   void SetPositionInheritanceMode( PositionInheritanceMode mode );
 744
 745   /**
 746    * @brief Returns the actors position inheritance mode.
 747    *
 748    * @pre The Actor has been initialized.
 749    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 750    */
 751   PositionInheritanceMode GetPositionInheritanceMode() const;
 752
 753   /**
 754    * @brief Sets the orientation of the Actor.
 755    *
 756    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 757    * @pre The Actor has been initialized.
 758    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 759    * @param [in] angle The new orientation angle in degrees.
 760    * @param [in] axis The new axis of orientation.
 761    */
 762   void SetOrientation( const Degree& angle, const Vector3& axis )
 763   {
 764     SetOrientation( Radian( angle ), axis );
 765   }
 766
 767   /**
 768    * @brief Sets the orientation of the Actor.
 769    *
 770    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 771    * @pre The Actor has been initialized.
 772    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 773    * @param [in] angle The new orientation angle in radians.
 774    * @param [in] axis The new axis of orientation.
 775    */
 776   void SetOrientation(const Radian& angle, const Vector3& axis);
 777
 778   /**
 779    * @brief Sets the orientation of the Actor.
 780    *
 781    * An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
 782    * @pre The Actor has been initialized.
 783    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
 784    * @param [in] orientation The new orientation.
 785    */
 786   void SetOrientation(const Quaternion& orientation);
 787
 788   /**
 789    * @brief Apply a relative rotation to an actor.
 790    *
 791    * @pre The actor has been initialized.
 792    * @param[in] angle The angle to the rotation to combine with the existing orientation.
 793    * @param[in] axis The axis of the rotation to combine with the existing orientation.
 794    */
 795   void RotateBy( const Degree& angle, const Vector3& axis )
 796   {
 797     RotateBy( Radian( angle ), axis );
 798   }
 799
 800   /**
 801    * @brief Apply a relative rotation to an actor.
 802    *
 803    * @pre The actor has been initialized.
 804    * @param[in] angle The angle to the rotation to combine with the existing orientation.
 805    * @param[in] axis The axis of the rotation to combine with the existing orientation.
 806    */
 807   void RotateBy(const Radian& angle, const Vector3& axis);
 808
 809   /**
 810    * @brief Apply a relative rotation to an actor.
 811    *
 812    * @pre The actor has been initialized.
 813    * @param[in] relativeRotation The rotation to combine with the existing orientation.
 814    */
 815   void RotateBy(const Quaternion& relativeRotation);
 816
 817   /**
 818    * @brief Retreive the Actor's orientation.
 819    *
 820    * @pre The Actor has been initialized.
 821    * @note This property can be animated; the return value may not match the value written with SetOrientation().
 822    * @return The current orientation.
 823    */
 824   Quaternion GetCurrentOrientation() const;
 825
 826   /**
 827    * @brief Set whether a child actor inherits it's parent's orientation.
 828    *
 829    * Default is to inherit.
 830    * Switching this off means that using SetOrientation() sets the actor's world orientation.
 831    * @pre The Actor has been initialized.
 832    * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
 833    */
 834   void SetInheritOrientation(bool inherit);
 835
 836   /**
 837    * @brief Returns whether the actor inherit's it's parent's orientation.
 838    *
 839    * @pre The Actor has been initialized.
 840    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 841    */
 842   bool IsOrientationInherited() const;
 843
 844   /**
 845    * @brief Retrieve the world-orientation of the Actor.
 846    *
 847    * @note The actor will not have a world-orientation, unless it has previously been added to the stage.
 848    * @pre The Actor has been initialized.
 849    * @return The Actor's current orientation in the world.
 850    */
 851   Quaternion GetCurrentWorldOrientation() const;
 852
 853   /**
 854    * @brief Set the scale factor applied to an actor.
 855    *
 856    * @pre The Actor has been initialized.
 857    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 858    * @param [in] scale The scale factor applied on all axes.
 859    */
 860   void SetScale(float scale);
 861
 862   /**
 863    * @brief Set the scale factor applied to an actor.
 864    *
 865    * @pre The Actor has been initialized.
 866    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 867    * @param [in] scaleX The scale factor applied along the x-axis.
 868    * @param [in] scaleY The scale factor applied along the y-axis.
 869    * @param [in] scaleZ The scale factor applied along the z-axis.
 870    */
 871   void SetScale(float scaleX, float scaleY, float scaleZ);
 872
 873   /**
 874    * @brief Set the scale factor applied to an actor.
 875    *
 876    * @pre The Actor has been initialized.
 877    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
 878    * @param [in] scale A vector representing the scale factor for each axis.
 879    */
 880   void SetScale(const Vector3& scale);
 881
 882   /**
 883    * @brief Apply a relative scale to an actor.
 884    *
 885    * @pre The actor has been initialized.
 886    * @param[in] relativeScale The scale to combine with the actors existing scale.
 887    */
 888   void ScaleBy(const Vector3& relativeScale);
 889
 890   /**
 891    * @brief Retrieve the scale factor applied to an actor.
 892    *
 893    * @pre The Actor has been initialized.
 894    * @note This property can be animated; the return value may not match the value written with SetScale().
 895    * @return A vector representing the scale factor for each axis.
 896    */
 897   Vector3 GetCurrentScale() const;
 898
 899   /**
 900    * @brief Retrieve the world-scale of the Actor.
 901    *
 902    * @note The actor will not have a world-scale, unless it has previously been added to the stage.
 903    * @pre The Actor has been initialized.
 904    * @return The Actor's current scale in the world.
 905    */
 906   Vector3 GetCurrentWorldScale() const;
 907
 908   /**
 909    * @brief Set whether a child actor inherits it's parent's scale.
 910    *
 911    * Default is to inherit.
 912    * Switching this off means that using SetScale() sets the actor's world scale.
 913    * @pre The Actor has been initialized.
 914    * @param[in] inherit - true if the actor should inherit scale, false otherwise.
 915    */
 916   void SetInheritScale( bool inherit );
 917
 918   /**
 919    * @brief Returns whether the actor inherit's it's parent's scale.
 920    *
 921    * @pre The Actor has been initialized.
 922    * @return true if the actor inherit's it's parent scale, false if it uses world scale.
 923    */
 924   bool IsScaleInherited() const;
 925
 926   /**
 927    * @brief Retrieves the world-matrix of the actor.
 928    *
 929    * @note The actor will not have a world-matrix, unless it has previously been added to the stage.
 930    * @pre The Actor has been initialized.
 931    * @return The Actor's current world matrix
 932    */
 933   Matrix GetCurrentWorldMatrix() const;
 934
 935   // Visibility & Color
 936
 937   /**
 938    * @brief Sets the visibility flag of an actor.
 939    *
 940    * @pre The actor has been initialized.
 941    * @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
 942    * @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
 943    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
 944    *       rendered if all of its parents have visibility set to true.
 945    * @param [in] visible The new visibility flag.
 946    */
 947   void SetVisible(bool visible);
 948
 949   /**
 950    * @brief Retrieve the visibility flag of an actor.
 951    *
 952    * @pre The actor has been initialized.
 953    * @note This property can be animated; the return value may not match the value written with SetVisible().
 954    * @note If an actor is not visible, then the actor and its children will not be rendered.
 955    *       This is regardless of the individual visibility values of the children i.e. an actor will only be
 956    *       rendered if all of its parents have visibility set to true.
 957    * @return The visibility flag.
 958    */
 959   bool IsVisible() const;
 960
 961   /**
 962    * @brief Sets the opacity of an actor.
 963    *
 964    * @pre The actor has been initialized.
 965    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
 966    * @param [in] opacity The new opacity.
 967    */
 968   void SetOpacity(float opacity);
 969
 970   /**
 971    * @brief Retrieve the actor's opacity.
 972    *
 973    * @pre The actor has been initialized.
 974    * @note This property can be animated; the return value may not match the value written with SetOpacity().
 975    * @return The actor's opacity.
 976    */
 977   float GetCurrentOpacity() const;
 978
 979   /**
 980    * @brief Sets the actor's color; this is an RGBA value.
 981    *
 982    * The final color of the actor depends on its color mode.
 983    * @pre The Actor has been initialized.
 984    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
 985    * @param [in] color The new color.
 986    */
 987   void SetColor(const Vector4& color);
 988
 989   /**
 990    * @brief Retrieve the actor's color.
 991    *
 992    * Actor's own color is not clamped.
 993    * @pre The Actor has been initialized.
 994    * @note This property can be animated; the return value may not match the value written with SetColor().
 995    * @return The color.
 996    */
 997   Vector4 GetCurrentColor() const;
 998
 999   /**
1000    * @brief Sets the actor's color mode.
1001    *
1002    * This specifies whether the Actor uses its own color, or inherits
1003    * its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
1004    * @pre The Actor has been initialized.
1005    * @param [in] colorMode to use.
1006    */
1007   void SetColorMode( ColorMode colorMode );
1008
1009   /**
1010    * @brief Returns the actor's color mode.
1011    *
1012    * @pre The Actor has been initialized.
1013    * @return currently used colorMode.
1014    */
1015   ColorMode GetColorMode() const;
1016
1017   /**
1018    * @brief Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range.
1019    *
1020    * @note The actor will not have a world-color, unless it has previously been added to the stage.
1021    * @pre The Actor has been initialized.
1022    * @return The Actor's current color in the world.
1023    */
1024   Vector4 GetCurrentWorldColor() const;
1025
1026   /**
1027    * @brief Set how the actor and its children should be drawn.
1028    *
1029    * Not all actors are renderable, but DrawMode can be inherited from any actor.
1030    * By default a renderable actor will be drawn as a 3D object. It will be depth-tested against
1031    * other objects in the world i.e. it may be obscured if other objects are in front.
1032    *
1033    * If DrawMode::OVERLAY is used, the actor and its children will be drawn as a 2D overlay.
1034    * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
1035    * For overlay actors, the drawing order is determined by the hierachy (depth-first search order),
1036    * and depth-testing will not be used.
1037    *
1038    * If DrawMode::STENCIL is used, the actor and its children will be used to stencil-test other actors
1039    * within the Layer. Stencil actors are therefore drawn into the stencil buffer before any other
1040    * actors within the Layer.
1041    *
1042    * @param[in] drawMode The new draw-mode to use.
1043    * @note Setting STENCIL will override OVERLAY, if that would otherwise have been inherited.
1044    * @note Layers do not inherit the DrawMode from their parents.
1045    */
1046   void SetDrawMode( DrawMode::Type drawMode );
1047
1048   /**
1049    * @brief Query how the actor and its children will be drawn.
1050    *
1051    * @return True if the Actor is an overlay.
1052    */
1053   DrawMode::Type GetDrawMode() const;
1054
1055   // Input Handling
1056
1057   /**
1058    * @brief Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover().
1059    *
1060    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
1061    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
1062    * hover event signal will be emitted.
1063    *
1064    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
1065    * @code
1066    * actor.SetSensitive(false);
1067    * @endcode
1068    *
1069    * Then, to re-enable the touch or hover event signal emission, the application should call:
1070    * @code
1071    * actor.SetSensitive(true);
1072    * @endcode
1073    *
1074    * @see @see SignalTouch() and SignalHover().
1075    * @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
1076    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1077    *       hittable if all of its parents have sensitivity set to true.
1078    * @pre The Actor has been initialized.
1079    * @param[in]  sensitive  true to enable emission of the touch or hover event signals, false otherwise.
1080    */
1081   void SetSensitive(bool sensitive);
1082
1083   /**
1084    * @brief Query whether an actor emits touch or hover event signals.
1085    *
1086    * @note If an actor is not sensitive, then it's children will not be hittable either.
1087    *       This is regardless of the individual sensitivity values of the children i.e. an actor will only be
1088    *       hittable if all of its parents have sensitivity set to true.
1089    * @pre The Actor has been initialized.
1090    * @return true, if emission of touch or hover event signals is enabled, false otherwise.
1091    */
1092   bool IsSensitive() const;
1093
1094   /**
1095    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1096    *
1097    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1098    * @pre The Actor has been initialized.
1099    * @param[out] localX On return, the X-coordinate relative to the actor.
1100    * @param[out] localY On return, the Y-coordinate relative to the actor.
1101    * @param[in] screenX The screen X-coordinate.
1102    * @param[in] screenY The screen Y-coordinate.
1103    * @return True if the conversion succeeded.
1104    */
1105   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1106
1107   /**
1108    * @brief Sets whether the actor should receive a notification when touch or hover motion events leave
1109    * the boundary of the actor.
1110    *
1111    * @note By default, this is set to false as most actors do not require this.
1112    * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
1113    *
1114    * @pre The Actor has been initialized.
1115    * @param[in]  required  Should be set to true if a Leave event is required
1116    */
1117   void SetLeaveRequired(bool required);
1118
1119   /**
1120    * @brief This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1121    * the boundary of the actor.
1122    *
1123    * @pre The Actor has been initialized.
1124    * @return true if a Leave event is required, false otherwise.
1125    */
1126   bool GetLeaveRequired() const;
1127
1128   /**
1129    * @brief Sets whether the actor should be focusable by keyboard navigation.
1130    *
1131    * The default is false.
1132    * @pre The Actor has been initialized.
1133    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1134    * false otherwise.
1135    */
1136   void SetKeyboardFocusable( bool focusable );
1137
1138   /**
1139    * @brief Returns whether the actor is focusable by keyboard navigation.
1140    *
1141    * @pre The Actor has been initialized.
1142    * @return true if the actor is focusable by keyboard navigation, false if not.
1143    */
1144   bool IsKeyboardFocusable() const;
1145
1146   // SIZE NEGOTIATION
1147
1148   /**
1149    * Set the resize policy to be used for the given dimension(s)
1150    *
1151    * @param[in] policy The resize policy to use
1152    * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions.
1153    */
1154   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1155
1156   /**
1157    * Return the resize policy used for a single dimension
1158    *
1159    * @param[in] dimension The dimension to get policy for
1160    * @return Return the dimension resize policy
1161    */
1162   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1163
1164   /**
1165    * @brief Set the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
1166    *
1167    * @param[in] policy The policy to use for when the size is set
1168    */
1169   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
1170
1171   /**
1172    * @brief Return the size set policy in use
1173    *
1174    * @return Return the size set policy
1175    */
1176   SizeScalePolicy::Type GetSizeScalePolicy() const;
1177
1178   /**
1179    * @brief Sets the relative to parent size factor of the actor.
1180    *
1181    * This factor is only used when ResizePolicy is set to either:
1182    * ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
1183    * This actor's size is set to the actor's size multipled by or added to this factor,
1184    * depending on ResizePolicy (See SetResizePolicy).
1185    *
1186    * @pre The Actor has been initialized.
1187    * @param [in] factor A Vector3 representing the relative factor to be applied to each axis.
1188    */
1189   void SetSizeModeFactor( const Vector3& factor );
1190
1191   /**
1192    * @brief Retrieve the relative to parent size factor of the actor.
1193    *
1194    * @pre The Actor has been initialized.
1195    * @return The Actor's current relative size factor.
1196    */
1197   Vector3 GetSizeModeFactor() const;
1198
1199   /**
1200    * @brief Calculate the height of the actor given a width
1201    *
1202    * @param width Width to use
1203    * @return Return the height based on the width
1204    */
1205   float GetHeightForWidth( float width );
1206
1207   /**
1208    * @brief Calculate the width of the actor given a height
1209    *
1210    * @param height Height to use
1211    * @return Return the width based on the height
1212    */
1213   float GetWidthForHeight( float height );
1214
1215   /**
1216    * Return the value of negotiated dimension for the given dimension
1217    *
1218    * @param dimension The dimension to retrieve
1219    * @return Return the value of the negotiated dimension
1220    */
1221   float GetRelayoutSize( Dimension::Type dimension ) const;
1222
1223   /**
1224    * @brief Force propagate relayout flags through the tree. This actor and all actors
1225    * dependent on it will have their relayout flags reset.
1226    *
1227    * This is useful for resetting layout flags during the layout process.
1228    */
1229   void PropagateRelayoutFlags();
1230
1231   /**
1232    * @brief Set the padding for use in layout
1233    *
1234    * @param[in] padding Padding for the actor
1235    */
1236   void SetPadding( const Padding& padding );
1237
1238   /**
1239    * Return the value of the padding
1240    *
1241    * @param paddingOut The returned padding data
1242    */
1243   void GetPadding( Padding& paddingOut ) const;
1244
1245   /**
1246    * @brief Set the minimum size an actor can be assigned in size negotiation
1247    *
1248    * @param[in] size The minimum size
1249    */
1250   void SetMinimumSize( const Vector2& size );
1251
1252   /**
1253    * @brief Return the minimum relayout size
1254    *
1255    * @return Return the mininmum size
1256    */
1257   Vector2 GetMinimumSize();
1258
1259   /**
1260    * @brief Set the maximum size an actor can be assigned in size negotiation
1261    *
1262    * @param[in] size The maximum size
1263    */
1264   void SetMaximumSize( const Vector2& size );
1265
1266   /**
1267    * @brief Return the maximum relayout size
1268    *
1269    * @return Return the maximum size
1270    */
1271   Vector2 GetMaximumSize();
1272
1273 public: // Signals
1274
1275   /**
1276    * @brief This signal is emitted when touch input is received.
1277    *
1278    * A callback of the following type may be connected:
1279    * @code
1280    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1281    * @endcode
1282    * The return value of True, indicates that the touch event should be consumed.
1283    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1284    * @pre The Actor has been initialized.
1285    * @return The signal to connect to.
1286    */
1287   TouchSignalType& TouchedSignal();
1288
1289   /**
1290    * @brief This signal is emitted when hover input is received.
1291    *
1292    * A callback of the following type may be connected:
1293    * @code
1294    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1295    * @endcode
1296    * The return value of True, indicates that the hover event should be consumed.
1297    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1298    * @pre The Actor has been initialized.
1299    * @return The signal to connect to.
1300    */
1301   HoverSignalType& HoveredSignal();
1302
1303   /**
1304    * @brief This signal is emitted when mouse wheel event is received.
1305    *
1306    * A callback of the following type may be connected:
1307    * @code
1308    *   bool YourCallbackName(Actor actor, const MouseWheelEvent& event);
1309    * @endcode
1310    * The return value of True, indicates that the mouse wheel event should be consumed.
1311    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1312    * @pre The Actor has been initialized.
1313    * @return The signal to connect to.
1314    */
1315   MouseWheelEventSignalType& MouseWheelEventSignal();
1316
1317   /**
1318    * @brief This signal is emitted after the actor has been connected to the stage.
1319    *
1320    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1321    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1322    *
1323    * @note When the parent of a set of actors is connected to the stage, then all of the children
1324    * will received this callback.
1325    *
1326    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1327    *
1328    *       A (parent)
1329    *      / \
1330    *     B   C
1331    *    / \   \
1332    *   D   E   F
1333    *
1334    * @return The signal
1335    */
1336   OnStageSignalType& OnStageSignal();
1337
1338   /**
1339    * @brief This signal is emitted after the actor has been disconnected from the stage.
1340    *
1341    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1342    *
1343    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1344    * will received this callback, starting with the leaf actors.
1345    *
1346    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1347    *
1348    *       A (parent)
1349    *      / \
1350    *     B   C
1351    *    / \   \
1352    *   D   E   F
1353    *
1354    * @return The signal
1355    */
1356   OffStageSignalType& OffStageSignal();
1357
1358   /**
1359    * @brief This signal is emitted after the size has been set on the actor during relayout
1360    *
1361    * @return Return the signal
1362    */
1363   OnRelayoutSignalType& OnRelayoutSignal();
1364
1365 public: // Not intended for application developers
1366
1367   /**
1368    * @brief This constructor is used by Dali New() methods.
1369    *
1370    * @param [in] actor A pointer to a newly allocated Dali resource
1371    */
1372   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1373 };
1374
1375 /**
1376  * @brief Helper for discarding an actor handle.
1377  *
1378  * If the handle is empty, this method does nothing.  Otherwise
1379  * actor.Unparent() will be called, followed by actor.Reset().
1380  * @param[in,out] actor A handle to an actor, or an empty handle.
1381  */
1382  DALI_IMPORT_API void UnparentAndReset( Actor& actor );
1383
1384 } // namespace Dali
1385
1386 #endif // __DALI_ACTOR_H__