dali/public-api/actors/actor.h

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