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 Property::DRAW_MODE.
 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        */
 413       ORIENTATION,
 414
 415       /**
 416        * @brief The world orientation of an actor.
 417        * @details Name "worldOrientation", type Property::ROTATION, read-only / constraint-input
 418        * @SINCE_1_0.0
 419        */
 420       WORLD_ORIENTATION,
 421
 422       /**
 423        * @brief The scale factor applied to an actor.
 424        * @details Name "scale", type Property::VECTOR3, animatable / constraint-input
 425        * @SINCE_1_0.0
 426        * @see Actor::SetScale()
 427        */
 428       SCALE,
 429
 430       /**
 431        * @brief The x scale factor applied to an actor.
 432        * @details Name "scaleX", type Property::FLOAT, animatable / constraint-input
 433        * @SINCE_1_0.0
 434        * @see Actor::SetScale()
 435        */
 436       SCALE_X,
 437
 438       /**
 439        * @brief The y scale factor applied to an actor.
 440        * @details Name "scaleY", type Property::FLOAT, animatable / constraint-input
 441        * @SINCE_1_0.0
 442        * @see Actor::SetScale()
 443        */
 444       SCALE_Y,
 445
 446       /**
 447        * @brief The x scale factor applied to an actor.
 448        * @details Name "scaleZ", type Property::FLOAT, animatable / constraint-input
 449        * @SINCE_1_0.0
 450        * @see Actor::SetScale()
 451        */
 452       SCALE_Z,
 453
 454       /**
 455        * @brief The world scale factor applied to an actor.
 456        * @details Name "worldScale", type Property::VECTOR3, read-only / constraint-input
 457        * @SINCE_1_0.0
 458        */
 459       WORLD_SCALE,
 460
 461       /**
 462        * @brief The visibility flag of an actor.
 463        * @details Name "visible", type Property::BOOL, animatable / constraint-input
 464        * @SINCE_1_0.0
 465        */
 466       VISIBLE,
 467
 468       /**
 469        * @brief The color of an actor.
 470        * @details Name "color", type Property::VECTOR4 or Property::VECTOR3, animatable / constraint-input
 471        * @note The alpha value will be 1.0f if a Vector3 type value is set.
 472        * @SINCE_1_0.0
 473        */
 474       COLOR,
 475
 476       /**
 477        * @brief The red component of an actor's color.
 478        * @details Name "colorRed", type Property::FLOAT, animatable / constraint-input
 479        * @SINCE_1_0.0
 480        */
 481       COLOR_RED,
 482
 483       /**
 484        * @brief The green component of an actor's color.
 485        * @details Name "colorGreen", type Property::FLOAT, animatable / constraint-input
 486        * @SINCE_1_0.0
 487        */
 488       COLOR_GREEN,
 489
 490       /**
 491        * @brief The blue component of an actor's color.
 492        * @details Name "colorBlue", type Property::FLOAT, animatable / constraint-input
 493        * @SINCE_1_0.0
 494        */
 495       COLOR_BLUE,
 496
 497       /**
 498        * @brief The alpha component of an actor's color.
 499        * @details Name "colorAlpha", type Property::FLOAT, animatable / constraint-input
 500        * @SINCE_1_0.0
 501        */
 502       COLOR_ALPHA,
 503
 504       /**
 505        * @brief The world color of an actor.
 506        * @details Name "worldColor", type Property::VECTOR4, read-only / constraint-input
 507        * @SINCE_1_0.0
 508        */
 509       WORLD_COLOR,
 510
 511       /**
 512        * @brief The world matrix of an actor.
 513        * @details Name "worldMatrix", type Property::MATRIX, read-only / constraint-input
 514        * @SINCE_1_0.0
 515        */
 516       WORLD_MATRIX,
 517
 518       /**
 519        * @brief The name of an actor.
 520        * @details Name "name", type Property::STRING
 521        * @SINCE_1_0.0
 522        */
 523       NAME,
 524
 525       /**
 526        * @brief The flag whether an actor should emit touch or hover signals.
 527        * @details Name "sensitive", type Property::BOOLEAN
 528        * @SINCE_1_0.0
 529        */
 530       SENSITIVE,
 531
 532       /**
 533        * @brief The flag whether an actor should receive a notification when touch or hover motion events leave.
 534        * @details Name "leaveRequired", type Property::BOOLEAN
 535        * @SINCE_1_0.0
 536        */
 537       LEAVE_REQUIRED,
 538
 539       /**
 540        * @brief The flag whether a child actor inherits it's parent's orientation.
 541        * @details Name "inheritOrientation", type Property::BOOLEAN
 542        * @SINCE_1_0.0
 543        */
 544       INHERIT_ORIENTATION,
 545
 546       /**
 547        * @brief The flag whether a child actor inherits it's parent's scale.
 548        * @details Name "inheritScale", type Property::BOOLEAN
 549        * @SINCE_1_0.0
 550        */
 551       INHERIT_SCALE,
 552
 553       /**
 554        * @brief The color mode of an actor.
 555        * @details Name "colorMode", type ColorMode (Property::INTEGER) or Property::STRING.
 556        * @SINCE_1_0.0
 557        */
 558       COLOR_MODE,
 559
 560       /**
 561        * @brief This property is removed because it's deprecated.
 562        */
 563       RESERVED_PROPERTY_01,
 564
 565       /**
 566        * @brief The draw mode of an actor.
 567        * @details Name "drawMode", type DrawMode::Type (Property::INTEGER) or Property::STRING.
 568        * @SINCE_1_0.0
 569        */
 570       DRAW_MODE,
 571
 572       /**
 573        * @brief The size mode factor of an actor.
 574        * @details Name "sizeModeFactor", type Property::VECTOR3.
 575        * @SINCE_1_0.0
 576        * @see Actor::SetSizeModeFactor()
 577        */
 578       SIZE_MODE_FACTOR,
 579
 580       /**
 581        * @brief The resize policy for the width of an actor.
 582        * @details Name "widthResizePolicy", type ResizePolicy::Type (Property::INTEGER) or Property::STRING.
 583        * @SINCE_1_0.0
 584        * @see Actor::SetResizePolicy()
 585        */
 586       WIDTH_RESIZE_POLICY,
 587
 588       /**
 589        * @brief The resize policy for the height of an actor.
 590        * @details Name "heightResizePolicy", type ResizePolicy::Type (Property::INTEGER) or Property::STRING.
 591        * @SINCE_1_0.0
 592        * @see Actor::SetResizePolicy()
 593        */
 594       HEIGHT_RESIZE_POLICY,
 595
 596       /**
 597        * @brief The size scale policy of an actor.
 598        * @details Name "sizeScalePolicy", type SizeScalePolicy::Type (Property::INTEGER) or Property::STRING.
 599        * @SINCE_1_0.0
 600        */
 601       SIZE_SCALE_POLICY,
 602
 603       /**
 604        * @brief The flag to determine the width dependent on the height.
 605        * @details Name "widthForHeight", type Property::BOOLEAN.
 606        * @SINCE_1_0.0
 607        * @see Actor::SetResizePolicy()
 608        */
 609       WIDTH_FOR_HEIGHT,
 610
 611       /**
 612        * @brief The flag to determine the height dependent on the width.
 613        * @details Name "heightForWidth", type Property::BOOLEAN.
 614        * @SINCE_1_0.0
 615        * @see Actor::SetResizePolicy()
 616        */
 617       HEIGHT_FOR_WIDTH,
 618
 619       /**
 620        * @brief The padding of an actor for use in layout.
 621        * @details Name "padding", type Property::VECTOR4.
 622        * @SINCE_1_0.0
 623        */
 624       PADDING,
 625
 626       /**
 627        * @brief The minimum size an actor can be assigned in size negotiation.
 628        * @details Name "minimumSize", type Property::VECTOR2.
 629        * @SINCE_1_0.0
 630        */
 631       MINIMUM_SIZE,
 632
 633       /**
 634        * @brief The maximum size an actor can be assigned in size negotiation.
 635        * @details Name "maximumSize", type Property::VECTOR2.
 636        * @SINCE_1_0.0
 637        */
 638       MAXIMUM_SIZE,
 639
 640       /**
 641        * @brief The flag whether a child actor inherits it's parent's position.
 642        * @details Name "inheritPosition", type Property::BOOLEAN.
 643        * @SINCE_1_1.24
 644        */
 645       INHERIT_POSITION,
 646
 647       /**
 648        * @brief The clipping mode of an actor.
 649        * @details Name "clippingMode", type ClippingMode::Type (Property::INTEGER) or Property::STRING.
 650        * @SINCE_1_2_5
 651        * @see ClippingMode::Type for supported values.
 652        */
 653       CLIPPING_MODE,
 654
 655       /**
 656        * @brief The direction of the layout.
 657        * @details Name "layoutDirection", type LayoutDirection::Type (Property::INTEGER) or Property::STRING.
 658        * @SINCE_1_2.60
 659        * @see LayoutDirection::Type for supported values.
 660        */
 661       LAYOUT_DIRECTION,
 662
 663       /**
 664        * @brief Determines whether child actors inherit the layout direction from a parent.
 665        * @details Name "layoutDirectionInheritance", type Property::BOOLEAN.
 666        * @SINCE_1_2.60
 667        */
 668       INHERIT_LAYOUT_DIRECTION,
 669     };
 670   };
 671
 672   // Typedefs
 673
 674   typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType;        ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
 675   typedef Signal< bool (Actor, const TouchData&) >  TouchDataSignalType;    ///< Touch signal type @SINCE_1_1.37
 676   typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType;        ///< Hover signal type @SINCE_1_0.0
 677   typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type @SINCE_1_0.0
 678   typedef Signal< void (Actor) > OnStageSignalType;                         ///< Stage connection signal type @SINCE_1_0.0
 679   typedef Signal< void (Actor) > OffStageSignalType;                        ///< Stage disconnection signal type @SINCE_1_0.0
 680   typedef Signal< void (Actor) > OnRelayoutSignalType;                      ///< Called when the actor is relaid out @SINCE_1_0.0
 681   typedef Signal< void ( Actor, LayoutDirection::Type ) > LayoutDirectionChangedSignalType; ///< Layout direction changes signal type. @SINCE_1_2.60
 682
 683   // Creation
 684
 685   /**
 686    * @brief Creates an uninitialized Actor; this can be initialized with Actor::New().
 687    *
 688    * Calling member functions with an uninitialized Actor handle is not allowed.
 689    * @SINCE_1_0.0
 690    */
 691   Actor();
 692
 693   /**
 694    * @brief Creates an initialized Actor.
 695    *
 696    * @SINCE_1_0.0
 697    * @return A handle to a newly allocated Dali resource
 698    */
 699   static Actor New();
 700
 701   /**
 702    * @brief Downcasts a handle to Actor handle.
 703    *
 704    * If handle points to an Actor object, the downcast produces valid handle.
 705    * If not, the returned handle is left uninitialized.
 706    *
 707    * @SINCE_1_0.0
 708    * @param[in] handle to An object
 709    * @return handle to a Actor object or an uninitialized handle
 710    */
 711   static Actor DownCast( BaseHandle handle );
 712
 713   /**
 714    * @brief Dali::Actor is intended as a base class.
 715    *
 716    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 717    * @SINCE_1_0.0
 718    */
 719   ~Actor();
 720
 721   /**
 722    * @brief Copy constructor.
 723    *
 724    * @SINCE_1_0.0
 725    * @param[in] copy The actor to copy
 726    */
 727   Actor(const Actor& copy);
 728
 729   /**
 730    * @brief Assignment operator
 731    *
 732    * @SINCE_1_0.0
 733    * @param[in] rhs The actor to copy
 734    * @return A reference to this
 735    */
 736   Actor& operator=(const Actor& rhs);
 737
 738   /**
 739    * @brief Retrieves the unique ID of the actor.
 740    *
 741    * @SINCE_1_0.0
 742    * @return The ID
 743    * @pre The Actor has been initialized.
 744    */
 745   uint32_t GetId() const;
 746
 747   // Containment
 748
 749   /**
 750    * @brief Queries whether an actor is the root actor, which is owned by the Stage.
 751    *
 752    * @SINCE_1_0.0
 753    * @return True if the actor is the root actor
 754    * @pre The Actor has been initialized.
 755    */
 756   bool IsRoot() const;
 757
 758   /**
 759    * @brief Queries whether the actor is connected to the Stage.
 760    *
 761    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
 762    * @SINCE_1_0.0
 763    * @return True if the actor is connected to the Stage
 764    * @pre The Actor has been initialized.
 765    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
 766    */
 767   bool OnStage() const;
 768
 769   /**
 770    * @brief Queries whether the actor is of class Dali::Layer.
 771    *
 772    * @SINCE_1_0.0
 773    * @return True if the actor is a layer
 774    * @pre The Actor has been initialized.
 775    */
 776   bool IsLayer() const;
 777
 778   /**
 779    * @brief Gets the layer in which the actor is present.
 780    *
 781    * @SINCE_1_0.0
 782    * @return The layer, which will be uninitialized if the actor is off-stage
 783    * @pre The Actor has been initialized.
 784    */
 785   Layer GetLayer();
 786
 787   /**
 788    * @brief Adds a child Actor to this Actor.
 789    *
 790    * @SINCE_1_0.0
 791    * @param[in] child The child
 792    * @pre This Actor (the parent) has been initialized.
 793    * @pre The child actor has been initialized.
 794    * @pre The child actor is not the same as the parent actor.
 795    * @pre The actor is not the Root actor.
 796    * @post The child will be referenced by its parent. This means that the child will be kept alive,
 797    * even if the handle passed into this method is reset or destroyed.
 798    * @note If the child already has a parent, it will be removed from old parent
 799    * and reparented to this actor. This may change child's position, color,
 800    * scale etc as it now inherits them from this actor.
 801    */
 802   void Add(Actor child);
 803
 804   /**
 805    * @brief Removes a child Actor from this Actor.
 806    *
 807    * If the actor was not a child of this actor, this is a no-op.
 808    * @SINCE_1_0.0
 809    * @param[in] child The child
 810    * @pre This Actor (the parent) has been initialized.
 811    * @pre The child actor is not the same as the parent actor.
 812    */
 813   void Remove(Actor child);
 814
 815   /**
 816    * @brief Removes an actor from its parent.
 817    *
 818    * If the actor has no parent, this method does nothing.
 819    * @SINCE_1_0.0
 820    * @pre The (child) actor has been initialized.
 821    */
 822   void Unparent();
 823
 824   /**
 825    * @brief Retrieves the number of children held by the actor.
 826    *
 827    * @SINCE_1_0.0
 828    * @return The number of children
 829    * @pre The Actor has been initialized.
 830    */
 831   uint32_t GetChildCount() const;
 832
 833   /**
 834    * @brief Retrieve and child actor by index.
 835    *
 836    * @SINCE_1_0.0
 837    * @param[in] index The index of the child to retrieve
 838    * @return The actor for the given index or empty handle if children not initialized
 839    * @pre The Actor has been initialized.
 840    */
 841   Actor GetChildAt( uint32_t index ) const;
 842
 843   /**
 844    * @brief Search through this actor's hierarchy for an actor with the given name.
 845    *
 846    * The actor itself is also considered in the search.
 847    * @SINCE_1_0.0
 848    * @param[in] actorName The name of the actor to find
 849    * @return A handle to the actor if found, or an empty handle if not
 850    * @pre The Actor has been initialized.
 851    */
 852   Actor FindChildByName(const std::string& actorName);
 853
 854   /**
 855    * @brief Search through this actor's hierarchy for an actor with the given unique ID.
 856    *
 857    * The actor itself is also considered in the search.
 858    * @SINCE_1_0.0
 859    * @param[in] id The ID of the actor to find
 860    * @return A handle to the actor if found, or an empty handle if not
 861    * @pre The Actor has been initialized.
 862    */
 863   Actor FindChildById( const uint32_t id );
 864
 865   /**
 866    * @brief Retrieves the actor's parent.
 867    *
 868    * @SINCE_1_0.0
 869    * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid
 870    * @pre The actor has been initialized.
 871    */
 872   Actor GetParent() const;
 873
 874   // Positioning
 875
 876   /**
 877    * @brief Sets the size of an actor.
 878    *
 879    * Geometry can be scaled to fit within this area.
 880    * This does not interfere with the actors scale factor.
 881    * The actors default depth is the minimum of width & height.
 882    * @SINCE_1_0.0
 883    * @param [in] width The new width
 884    * @param [in] height The new height
 885    * @pre The actor has been initialized.
 886    */
 887   void SetSize(float width, float height);
 888
 889   /**
 890    * @brief Sets the size of an actor.
 891    *
 892    * Geometry can be scaled to fit within this area.
 893    * This does not interfere with the actors scale factor.
 894    * @SINCE_1_0.0
 895    * @param[in] width The size of the actor along the x-axis
 896    * @param[in] height The size of the actor along the y-axis
 897    * @param[in] depth The size of the actor along the z-axis
 898    * @pre The actor has been initialized.
 899    */
 900   void SetSize(float width, float height, float depth);
 901
 902   /**
 903    * @brief Sets the size of an actor.
 904    *
 905    * Geometry can be scaled to fit within this area.
 906    * This does not interfere with the actors scale factor.
 907    * The actors default depth is the minimum of width & height.
 908    * @SINCE_1_0.0
 909    * @param[in] size The new size
 910    * @pre The actor has been initialized.
 911    */
 912   void SetSize(const Vector2& size);
 913
 914   /**
 915    * @brief Sets the size of an actor.
 916    *
 917    * Geometry can be scaled to fit within this area.
 918    * This does not interfere with the actors scale factor.
 919    * @SINCE_1_0.0
 920    * @param [in] size The new size
 921    * @pre The actor has been initialized.
 922    */
 923   void SetSize(const Vector3& size);
 924
 925   /**
 926    * @brief Retrieves the actor's size.
 927    *
 928    * @SINCE_1_0.0
 929    * @return The actor's target size
 930    * @pre The actor has been initialized.
 931    * @note This return is the value that was set using SetSize or the target size of an animation.
 932    *       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.
 933    */
 934   Vector3 GetTargetSize() const;
 935
 936   /**
 937    * @brief Returns the natural size of the actor.
 938    *
 939    * Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
 940    *
 941    * @SINCE_1_0.0
 942    * @return The actor's natural size
 943    */
 944   Vector3 GetNaturalSize() const;
 945
 946   /**
 947    * @brief Sets the position of the Actor.
 948    *
 949    * By default, sets the position vector between the parent origin and anchor point (default).
 950    *
 951    * If Position inheritance if disabled, sets the world position. @see Actor::Property::INHERIT_POSITION
 952    *
 953    * @image html actor-position.png
 954    * The Actor's z position will be set to 0.0f.
 955    * @SINCE_1_0.0
 956    * @param[in] x The new x position
 957    * @param[in] y The new y position
 958    * @pre The Actor has been initialized.
 959    */
 960   void SetPosition(float x, float y);
 961
 962   /**
 963    * @brief Sets the position of the Actor.
 964    *
 965    * By default, sets the position vector between the parent origin and anchor point (default).
 966    *
 967    * If Position inheritance if disabled, sets the world position. @see Actor::Property::INHERIT_POSITION
 968    *
 969    * @image html actor-position.png
 970    * @SINCE_1_0.0
 971    * @param[in] x The new x position
 972    * @param[in] y The new y position
 973    * @param[in] z The new z position
 974    * @pre The Actor has been initialized.
 975    */
 976   void SetPosition(float x, float y, float z);
 977
 978   /**
 979    * @brief Sets the position of the Actor.
 980    *
 981    * By default, sets the position vector between the parent origin and anchor point (default).
 982    *
 983    * If Position inheritance if disabled, sets the world position. @see Actor::Property::INHERIT_POSITION
 984    *
 985    * @image html actor-position.png
 986    * @SINCE_1_0.0
 987    * @param[in] position The new position
 988    * @pre The Actor has been initialized.
 989    */
 990   void SetPosition(const Vector3& position);
 991
 992   /**
 993    * @brief Sets the position of an actor along the X-axis.
 994    *
 995    * @SINCE_1_0.0
 996    * @param[in] x The new x position
 997    * @pre The Actor has been initialized.
 998    */
 999   void SetX(float x);
1000
1001   /**
1002    * @brief Sets the position of an actor along the Y-axis.
1003    *
1004    * @SINCE_1_0.0
1005    * @param[in] y The new y position
1006    * @pre The Actor has been initialized.
1007    */
1008   void SetY(float y);
1009
1010   /**
1011    * @brief Sets the position of an actor along the Z-axis.
1012    *
1013    * @SINCE_1_0.0
1014    * @param[in] z The new z position
1015    * @pre The Actor has been initialized.
1016    */
1017   void SetZ(float z);
1018
1019   /**
1020    * @brief Translates an actor relative to its existing position.
1021    *
1022    * @SINCE_1_0.0
1023    * @param[in] distance The actor will move by this distance
1024    * @pre The actor has been initialized.
1025    */
1026   void TranslateBy(const Vector3& distance);
1027
1028   /**
1029    * @brief Applies a relative rotation to an actor.
1030    *
1031    * @SINCE_1_0.0
1032    * @param[in] angle The angle to the rotation to combine with the existing orientation
1033    * @param[in] axis The axis of the rotation to combine with the existing orientation
1034    * @pre The actor has been initialized.
1035    */
1036   void RotateBy( const Degree& angle, const Vector3& axis )
1037   {
1038     RotateBy( Radian( angle ), axis );
1039   }
1040
1041   /**
1042    * @brief Applies a relative rotation to an actor.
1043    *
1044    * @SINCE_1_0.0
1045    * @param[in] angle The angle to the rotation to combine with the existing orientation
1046    * @param[in] axis The axis of the rotation to combine with the existing orientation
1047    * @pre The actor has been initialized.
1048    */
1049   void RotateBy(const Radian& angle, const Vector3& axis);
1050
1051   /**
1052    * @brief Applies a relative rotation to an actor.
1053    *
1054    * @SINCE_1_0.0
1055    * @param[in] relativeRotation The rotation to combine with the existing orientation
1056    * @pre The actor has been initialized.
1057    */
1058   void RotateBy(const Quaternion& relativeRotation);
1059
1060   /**
1061    * @brief Sets the scale factor applied to an actor.
1062    *
1063    * @SINCE_1_0.0
1064    * @param[in] scale The scale factor applied on all axes
1065    * @pre The Actor has been initialized.
1066    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
1067    */
1068   void SetScale(float scale);
1069
1070   /**
1071    * @brief Sets the scale factor applied to an actor.
1072    *
1073    * @SINCE_1_0.0
1074    * @param[in] scaleX The scale factor applied along the x-axis
1075    * @param[in] scaleY The scale factor applied along the y-axis
1076    * @param[in] scaleZ The scale factor applied along the z-axis
1077    * @pre The Actor has been initialized.
1078    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
1079    */
1080   void SetScale(float scaleX, float scaleY, float scaleZ);
1081
1082   /**
1083    * @brief Sets the scale factor applied to an actor.
1084    *
1085    * @SINCE_1_0.0
1086    * @param[in] scale A vector representing the scale factor for each axis
1087    * @pre The Actor has been initialized.
1088    * @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
1089    */
1090   void SetScale(const Vector3& scale);
1091
1092   /**
1093    * @brief Applies a relative scale to an actor.
1094    *
1095    * @SINCE_1_0.0
1096    * @param[in] relativeScale The scale to combine with the actor's existing scale
1097    * @pre The actor has been initialized.
1098    */
1099   void ScaleBy(const Vector3& relativeScale);
1100
1101   // Input Handling
1102
1103   /**
1104    * @brief Converts screen coordinates into the actor's coordinate system using the default camera.
1105    *
1106    * @SINCE_1_0.0
1107    * @param[out] localX On return, the X-coordinate relative to the actor
1108    * @param[out] localY On return, the Y-coordinate relative to the actor
1109    * @param[in] screenX The screen X-coordinate
1110    * @param[in] screenY The screen Y-coordinate
1111    * @return True if the conversion succeeded
1112    * @pre The Actor has been initialized.
1113    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1114    */
1115   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1116
1117   /**
1118    * @brief Sets whether the actor should be focusable by keyboard navigation.
1119    *
1120    * The default is false.
1121    * @SINCE_1_0.0
1122    * @param[in] focusable - true if the actor should be focusable by keyboard navigation,
1123    * false otherwise
1124    * @pre The Actor has been initialized.
1125    */
1126   void SetKeyboardFocusable( bool focusable );
1127
1128   /**
1129    * @brief Returns whether the actor is focusable by keyboard navigation.
1130    *
1131    * @SINCE_1_0.0
1132    * @return @c true if the actor is focusable by keyboard navigation, @c false if not
1133    * @pre The Actor has been initialized.
1134    */
1135   bool IsKeyboardFocusable() const;
1136
1137   /**
1138    * @brief Raise actor above the next sibling actor.
1139    *
1140    * @SINCE_1_2.60
1141    * @pre The Actor has been initialized.
1142    * @pre The Actor has been parented.
1143    */
1144   void Raise();
1145
1146   /**
1147    * @brief Lower the actor below the previous sibling actor.
1148    *
1149    * @SINCE_1_2.60
1150    * @pre The Actor has been initialized.
1151    * @pre The Actor has been parented.
1152    */
1153   void Lower();
1154
1155   /**
1156    * @brief Raise actor above all other sibling actors.
1157    *
1158    * @SINCE_1_2.60
1159    * @pre The Actor has been initialized.
1160    * @pre The Actor has been parented.
1161    */
1162   void RaiseToTop();
1163
1164   /**
1165    * @brief Lower actor to the bottom of all other sibling actors.
1166    *
1167    * @SINCE_1_2.60
1168    * @pre The Actor has been initialized.
1169    * @pre The Actor has been parented.
1170    */
1171   void LowerToBottom();
1172
1173   /**
1174    * @brief Raises the actor above the target actor.
1175    *
1176    * @SINCE_1_2.60
1177    * @param[in] target The target actor
1178    * @pre The Actor has been initialized.
1179    * @pre The Actor has been parented.
1180    * @pre The target actor is a sibling.
1181    */
1182   void RaiseAbove( Actor target );
1183
1184   /**
1185    * @brief Lower the actor to below the target actor.
1186    *
1187    * @SINCE_1_2.60
1188    * @param[in] target The target actor
1189    * @pre The Actor has been initialized.
1190    * @pre The Actor has been parented.
1191    * @pre The target actor is a sibling.
1192    */
1193   void LowerBelow( Actor target );
1194
1195   // SIZE NEGOTIATION
1196
1197   /**
1198    * @brief Sets the resize policy to be used for the given dimension(s).
1199    *
1200    * @SINCE_1_0.0
1201    * @param[in] policy The resize policy to use
1202    * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions
1203    */
1204   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
1205
1206   /**
1207    * @brief Returns the resize policy used for a single dimension.
1208    *
1209    * @SINCE_1_0.0
1210    * @param[in] dimension The dimension to get policy for
1211    * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found
1212    */
1213   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
1214
1215   /**
1216    * @brief Calculates the height of the actor given a width.
1217    *
1218    * The natural size is used for default calculation.
1219    * size 0 is treated as aspect ratio 1:1.
1220    *
1221    * @SINCE_1_0.0
1222    * @param[in] width Width to use
1223    * @return Return the height based on the width
1224    */
1225   float GetHeightForWidth( float width );
1226
1227   /**
1228    * @brief Calculates the width of the actor given a height.
1229    *
1230    * The natural size is used for default calculation.
1231    * size 0 is treated as aspect ratio 1:1.
1232    *
1233    * @SINCE_1_0.0
1234    * @param[in] height Height to use
1235    * @return Return the width based on the height
1236    */
1237   float GetWidthForHeight( float height );
1238
1239   /**
1240    * @brief Returns the value of negotiated dimension for the given dimension.
1241    *
1242    * @SINCE_1_0.0
1243    * @param[in] dimension The dimension to retrieve
1244    * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found
1245    */
1246   float GetRelayoutSize( Dimension::Type dimension ) const;
1247
1248   /**
1249    * @brief Gets depth in the hierarchy for the actor.
1250    *
1251    * @SINCE_1_0.0
1252    * @return The current depth in the hierarchy of the actor, or @c -1 if actor is not in the hierarchy
1253    */
1254   int32_t GetHierarchyDepth();
1255
1256 public: // Renderer
1257
1258   /**
1259    * @brief Adds a renderer to this actor.
1260    *
1261    * @SINCE_1_0.0
1262    * @param[in] renderer Renderer to add to the actor
1263    * @return The index of the Renderer that was added
1264    * @pre The renderer must be initialized.
1265    *
1266    */
1267   uint32_t AddRenderer( Renderer& renderer );
1268
1269   /**
1270    * @brief Gets the number of renderers on this actor.
1271    *
1272    * @SINCE_1_0.0
1273    * @return The number of renderers on this actor
1274    */
1275   uint32_t GetRendererCount() const;
1276
1277   /**
1278    * @brief Gets a Renderer by index.
1279    *
1280    * @SINCE_1_0.0
1281    * @param[in] index The index of the renderer to fetch
1282    * @return The renderer at the specified index
1283    * @pre The index must be between 0 and GetRendererCount()-1
1284    *
1285    */
1286   Renderer GetRendererAt( uint32_t index );
1287
1288   /**
1289    * @brief Removes a renderer from the actor.
1290    *
1291    * @SINCE_1_0.0
1292    * @param[in] renderer Handle to the renderer that is to be removed
1293    */
1294   void RemoveRenderer( Renderer& renderer );
1295
1296   /**
1297    * @brief Removes a renderer from the actor by index.
1298    *
1299    * @SINCE_1_0.0
1300    * @param[in] index Index of the renderer that is to be removed
1301    * @pre The index must be between 0 and GetRendererCount()-1
1302    *
1303    */
1304   void RemoveRenderer( uint32_t index );
1305
1306 public: // Signals
1307
1308   /**
1309    * @DEPRECATED_1_1.37 Use TouchSignal() instead.
1310    * @brief This signal is emitted when touch input is received.
1311    *
1312    * A callback of the following type may be connected:
1313    * @code
1314    *   bool YourCallbackName(Actor actor, const TouchEvent& event);
1315    * @endcode
1316    * The return value of True, indicates that the touch event should be consumed.
1317    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1318    * @SINCE_1_0.0
1319    * @return The signal to connect to
1320    * @pre The Actor has been initialized.
1321    */
1322   TouchSignalType& TouchedSignal() DALI_DEPRECATED_API;
1323
1324   /**
1325    * @brief This signal is emitted when touch input is received.
1326    *
1327    * A callback of the following type may be connected:
1328    * @code
1329    *   bool YourCallbackName( Actor actor, TouchData& touch );
1330    * @endcode
1331    * The return value of True, indicates that the touch event has been consumed.
1332    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1333    * @SINCE_1_1.37
1334    * @return The signal to connect to
1335    * @pre The Actor has been initialized.
1336    */
1337   TouchDataSignalType& TouchSignal();
1338
1339   /**
1340    * @brief This signal is emitted when hover input is received.
1341    *
1342    * A callback of the following type may be connected:
1343    * @code
1344    *   bool YourCallbackName(Actor actor, const HoverEvent& event);
1345    * @endcode
1346    * The return value of True, indicates that the hover event should be consumed.
1347    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1348    * @SINCE_1_0.0
1349    * @return The signal to connect to
1350    * @pre The Actor has been initialized.
1351    */
1352   HoverSignalType& HoveredSignal();
1353
1354   /**
1355    * @brief This signal is emitted when wheel event is received.
1356    *
1357    * A callback of the following type may be connected:
1358    * @code
1359    *   bool YourCallbackName(Actor actor, const WheelEvent& event);
1360    * @endcode
1361    * The return value of True, indicates that the wheel event should be consumed.
1362    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
1363    * @SINCE_1_0.0
1364    * @return The signal to connect to
1365    * @pre The Actor has been initialized.
1366    */
1367   WheelEventSignalType& WheelEventSignal();
1368
1369   /**
1370    * @brief This signal is emitted after the actor has been connected to the stage.
1371    *
1372    * When an actor is connected, it will be directly or indirectly parented to the root Actor.
1373    * @SINCE_1_0.0
1374    * @return The signal to connect to
1375    * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
1376    *
1377    * @note When the parent of a set of actors is connected to the stage, then all of the children
1378    * will received this callback.
1379    * For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
1380    *
1381    * @code
1382    *
1383    *       A (parent)
1384    *      / \
1385    *     B   C
1386    *    / \   \
1387    *   D   E   F
1388    *
1389    * @endcode
1390    */
1391   OnStageSignalType& OnStageSignal();
1392
1393   /**
1394    * @brief This signal is emitted after the actor has been disconnected from the stage.
1395    *
1396    * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
1397    *
1398    * @SINCE_1_0.0
1399    * @return The signal to connect to
1400    * @note When the parent of a set of actors is disconnected to the stage, then all of the children
1401    * will received this callback, starting with the leaf actors.
1402    * For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
1403    *
1404    * @code
1405    *
1406    *       A (parent)
1407    *      / \
1408    *     B   C
1409    *    / \   \
1410    *   D   E   F
1411    *
1412    * @endcode
1413    *
1414    */
1415   OffStageSignalType& OffStageSignal();
1416
1417   /**
1418    * @brief This signal is emitted after the size has been set on the actor during relayout
1419    *
1420    * @SINCE_1_0.0
1421    * @return The signal
1422    */
1423   OnRelayoutSignalType& OnRelayoutSignal();
1424
1425   /**
1426    * @brief This signal is emitted when the layout direction property of this or a parent actor is changed.
1427    *
1428    * A callback of the following type may be connected:
1429    * @code
1430    *   void YourCallbackName( Actor actor, LayoutDirection::Type type );
1431    * @endcode
1432    * actor: The actor, or child of actor, whose layout direction has changed
1433    * type: Whether the actor's layout direction property has changed or a parent's.
1434    *
1435    * @SINCE_1_2.60
1436    * @return The signal to connect to
1437    * @pre The Actor has been initialized.
1438    */
1439   LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal();
1440
1441 public: // Not intended for application developers
1442
1443   /// @cond internal
1444   /**
1445    * @brief This constructor is used by Actor::New() methods.
1446    *
1447    * @SINCE_1_0.0
1448    * @param [in] actor A pointer to a newly allocated Dali resource
1449    */
1450   explicit DALI_INTERNAL Actor(Internal::Actor* actor);
1451   /// @endcond
1452 };
1453
1454 /**
1455  * @brief Helper for discarding an actor handle.
1456  *
1457  * If the handle is empty, this method does nothing.  Otherwise
1458  * Actor::Unparent() will be called, followed by Actor::Reset().
1459  * @SINCE_1_0.0
1460  * @param[in,out] actor A handle to an actor, or an empty handle
1461  */
1462 inline void UnparentAndReset( Actor& actor )
1463 {
1464   if( actor )
1465   {
1466     actor.Unparent();
1467     actor.Reset();
1468   }
1469 }
1470
1471 /**
1472  * @}
1473  */
1474 } // namespace Dali
1475
1476 #endif // DALI_ACTOR_H