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