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