dali/public-api/actors/actor.h

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