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