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