dali/public-api/actors/actor.h

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