dali/public-api/actors/actor.h

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