dali/public-api/actors/actor.h

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