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