dali/internal/event/actors/actor-impl.h

   1 #ifndef __DALI_INTERNAL_ACTOR_H__
   2 #define __DALI_INTERNAL_ACTOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/common/vector-wrapper.h>
  26 #include <dali/public-api/object/ref-object.h>
  27 #include <dali/public-api/actors/actor.h>
  28 #include <dali/public-api/common/dali-common.h>
  29 #include <dali/public-api/events/gesture.h>
  30 #include <dali/public-api/math/viewport.h>
  31 #include <dali/internal/event/common/object-impl.h>
  32 #include <dali/public-api/size-negotiation/relayout-container.h>
  33 #include <dali/internal/event/common/stage-def.h>
  34 #include <dali/internal/event/actors/actor-declarations.h>
  35 #include <dali/internal/event/actor-attachments/actor-attachment-declarations.h>
  36 #include <dali/internal/update/nodes/node-declarations.h>
  37
  38 #ifdef DYNAMICS_SUPPORT
  39 #include <dali/internal/event/dynamics/dynamics-declarations.h>
  40 #endif
  41
  42 namespace Dali
  43 {
  44
  45 struct KeyEvent;
  46 struct TouchEvent;
  47 struct HoverEvent;
  48 struct MouseWheelEvent;
  49
  50 namespace Internal
  51 {
  52
  53 class Actor;
  54 class ActorGestureData;
  55 class Animation;
  56 class RenderTask;
  57 struct DynamicsData;
  58
  59 typedef IntrusivePtr< Actor > ActorPtr;
  60 typedef std::vector< Dali::Actor > ActorContainer; // Store handles to return via public-api
  61 typedef ActorContainer::iterator ActorIter;
  62 typedef ActorContainer::const_iterator ActorConstIter;
  63
  64 /**
  65  * Actor is the primary object which Dali applications interact with.
  66  * UI controls can be built by combining multiple actors.
  67  * Multi-Touch events are received through signals emitted by the actor tree.
  68  *
  69  * An Actor is a proxy for a Node in the scene graph.
  70  * When an Actor is added to the Stage, it creates a node and attaches it to the scene graph.
  71  * The scene-graph can be updated in a separate thread, so the attachment is done using an asynchronous message.
  72  * When a tree of Actors is detached from the Stage, a message is sent to destroy the associated nodes.
  73  */
  74 class Actor : public Object
  75 {
  76 public:
  77
  78   /**
  79    * @brief Struct to hold an actor and a dimension
  80    */
  81   struct ActorDimensionPair
  82   {
  83     /**
  84      * @brief Constructor
  85      *
  86      * @param[in] newActor The actor to assign
  87      * @param[in] newDimension The dimension to assign
  88      */
  89     ActorDimensionPair( Actor* newActor, Dimension::Type newDimension )
  90     : actor( newActor ),
  91       dimension( newDimension )
  92     {
  93     }
  94
  95     /**
  96      * @brief Equality operator
  97      *
  98      * @param[in] lhs The left hand side argument
  99      * @param[in] rhs The right hand side argument
 100      */
 101     bool operator== ( const ActorDimensionPair& rhs )
 102     {
 103       return ( actor == rhs.actor ) && ( dimension == rhs.dimension );
 104     }
 105
 106     Actor* actor;           ///< The actor to hold
 107     Dimension::Type dimension;    ///< The dimension to hold
 108   };
 109
 110   typedef std::vector< ActorDimensionPair > ActorDimensionStack;
 111
 112 public:
 113
 114   /**
 115    * Create a new actor.
 116    * @return A smart-pointer to the newly allocated Actor.
 117    */
 118   static ActorPtr New();
 119
 120   /**
 121    * Retrieve the name of the actor.
 122    * @return The name.
 123    */
 124   const std::string& GetName() const;
 125
 126   /**
 127    * Set the name of the actor.
 128    * @param[in] name The new name.
 129    */
 130   void SetName( const std::string& name );
 131
 132   /**
 133    * @copydoc Dali::Actor::GetId
 134    */
 135   unsigned int GetId() const;
 136
 137   // Attachments
 138
 139   /**
 140    * Attach an object to an actor.
 141    * @pre The actor does not already have an attachment.
 142    * @param[in] attachment The object to attach.
 143    */
 144   void Attach( ActorAttachment& attachment );
 145
 146   /**
 147    * Retreive the object attached to an actor.
 148    * @return The attachment.
 149    */
 150   ActorAttachmentPtr GetAttachment();
 151
 152   // Containment
 153
 154   /**
 155    * Query whether an actor is the root actor, which is owned by the Stage.
 156    * @return True if the actor is a root actor.
 157    */
 158   bool IsRoot() const
 159   {
 160     return mIsRoot;
 161   }
 162
 163   /**
 164    * Query whether the actor is connected to the Stage.
 165    */
 166   bool OnStage() const;
 167
 168   /**
 169    * Query whether the actor is a RenderableActor derived type.
 170    * @return True if the actor is renderable.
 171    */
 172   bool IsRenderable() const
 173   {
 174     // inlined as this is called a lot in hit testing
 175     return mIsRenderable;
 176   }
 177
 178   /**
 179    * Query whether the actor is of class Dali::Layer
 180    * @return True if the actor is a layer.
 181    */
 182   bool IsLayer() const
 183   {
 184     // inlined as this is called a lot in hit testing
 185     return mIsLayer;
 186   }
 187
 188   /**
 189    * Gets the layer in which the actor is present
 190    * @return The layer, which will be uninitialized if the actor is off-stage.
 191    */
 192   Dali::Layer GetLayer();
 193
 194   /**
 195    * Adds a child Actor to this Actor.
 196    * @pre The child actor is not the same as the parent actor.
 197    * @pre The child actor does not already have a parent.
 198    * @param [in] child The child.
 199    * @post The child will be referenced by its parent.
 200    */
 201   void Add( Actor& child );
 202
 203   /**
 204    * Inserts a child Actor to this Actor's child list
 205    * @pre The child actor is not the same as the parent actor.
 206    * @pre The child actor does not already have a parent.
 207    * @param [in] index in childlist to insert child at
 208    * @param [in] child The child.
 209    * @post The child will be referenced by its parent.
 210    */
 211   void Insert( unsigned int index, Actor& child );
 212
 213   /**
 214    * Removes a child Actor from this Actor.
 215    * @param [in] child The child.
 216    * @post The child will be unreferenced.
 217    */
 218   void Remove( Actor& child );
 219
 220   /**
 221    * @copydoc Dali::Actor::Unparent
 222    */
 223   void Unparent();
 224
 225   /**
 226    * Retrieve the number of children held by the actor.
 227    * @return The number of children
 228    */
 229   unsigned int GetChildCount() const;
 230
 231   /**
 232    * @copydoc Dali::Actor::GetChildAt
 233    */
 234   Dali::Actor GetChildAt( unsigned int index ) const;
 235
 236   /**
 237    * Retrieve a reference to Actor's children.
 238    * @note Not for public use.
 239    * @return A reference to the container of children.
 240    */
 241   ActorContainer& GetChildrenInternal()
 242   {
 243     return *mChildren;
 244   }
 245
 246   /**
 247    * @copydoc Dali::Actor::FindChildByName
 248    */
 249   ActorPtr FindChildByName( const std::string& actorName );
 250
 251   /**
 252    * @copydoc Dali::Actor::FindChildById
 253    */
 254   ActorPtr FindChildById( const unsigned int id );
 255
 256   /**
 257    * Retrieve the parent of an Actor.
 258    * @return The parent actor, or NULL if the Actor does not have a parent.
 259    */
 260   Actor* GetParent() const
 261   {
 262     return mParent;
 263   }
 264
 265   /**
 266    * Sets the size of an actor.
 267    * ActorAttachments attached to the actor, can be scaled to fit within this area.
 268    * This does not interfere with the actors scale factor.
 269    * @param [in] width  The new width.
 270    * @param [in] height The new height.
 271    */
 272   void SetSize( float width, float height );
 273
 274   /**
 275    * Sets the size of an actor.
 276    * ActorAttachments attached to the actor, can be scaled to fit within this area.
 277    * This does not interfere with the actors scale factor.
 278    * @param [in] width The size of the actor along the x-axis.
 279    * @param [in] height The size of the actor along the y-axis.
 280    * @param [in] depth The size of the actor along the z-axis.
 281    */
 282   void SetSize( float width, float height, float depth );
 283
 284   /**
 285    * Sets the size of an actor.
 286    * ActorAttachments attached to the actor, can be scaled to fit within this area.
 287    * This does not interfere with the actors scale factor.
 288    * @param [in] size The new size.
 289    */
 290   void SetSize( const Vector2& size );
 291
 292   /**
 293    * Sets the update size for an actor.
 294    *
 295    * @param[in] size The size to set.
 296    */
 297   void SetSizeInternal( const Vector2& size );
 298
 299   /**
 300    * Sets the size of an actor.
 301    * ActorAttachments attached to the actor, can be scaled to fit within this area.
 302    * This does not interfere with the actors scale factor.
 303    * @param [in] size The new size.
 304    */
 305   void SetSize( const Vector3& size );
 306
 307   /**
 308    * Sets the update size for an actor.
 309    *
 310    * @param[in] size The size to set.
 311    */
 312   void SetSizeInternal( const Vector3& size );
 313
 314   /**
 315    * Set the width component of the Actor's size.
 316    * @param [in] width The new width component.
 317    */
 318   void SetWidth( float width );
 319
 320   /**
 321    * Set the height component of the Actor's size.
 322    * @param [in] height The new height component.
 323    */
 324   void SetHeight( float height );
 325
 326   /**
 327    * Set the depth component of the Actor's size.
 328    * @param [in] depth The new depth component.
 329    */
 330   void SetDepth( float depth );
 331
 332   /**
 333    * Retrieve the Actor's size from event side.
 334    * This size will be the size set or if animating then the target size.
 335    * @return The Actor's size.
 336    */
 337   const Vector3& GetTargetSize() const;
 338
 339   /**
 340    * Retrieve the Actor's size from update side.
 341    * This size will be the size set or animating but will be a frame behind.
 342    * @return The Actor's size.
 343    */
 344   const Vector3& GetCurrentSize() const;
 345
 346   /**
 347    * Return the natural size of the actor
 348    *
 349    * @return The actor's natural size
 350    */
 351   virtual Vector3 GetNaturalSize() const;
 352
 353   /**
 354    * Set the origin of an actor, within its parent's area.
 355    * This is expressed in 2D unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 356    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 357    * The default parent-origin is top-left (0.0, 0.0, 0.5).
 358    * An actor position is the distance between this origin, and the actors anchor-point.
 359    * @param [in] origin The new parent-origin.
 360    */
 361   void SetParentOrigin( const Vector3& origin );
 362
 363   /**
 364    * Set the x component of the parent-origin
 365    * @param [in] x The new x value.
 366    */
 367   void SetParentOriginX( float x );
 368
 369   /**
 370    * Set the y component of the parent-origin
 371    * @param [in] y The new y value.
 372    */
 373   void SetParentOriginY( float y );
 374
 375   /**
 376    * Set the z component of the parent-origin
 377    * @param [in] z The new z value.
 378    */
 379   void SetParentOriginZ( float z );
 380
 381   /**
 382    * Retrieve the parent-origin of an actor.
 383    * @return The parent-origin.
 384    */
 385   const Vector3& GetCurrentParentOrigin() const;
 386
 387   /**
 388    * Set the anchor-point of an actor. This is expressed in 2D unit coordinates, such that
 389    * (0.0, 0.0, 0.5) is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the bottom-right corner.
 390    * The default anchor point is top-left (0.0, 0.0, 0.5).
 391    * An actor position is the distance between its parent-origin, and this anchor-point.
 392    * An actor's rotation is centered around its anchor-point.
 393    * @param [in] anchorPoint The new anchor-point.
 394    */
 395   void SetAnchorPoint( const Vector3& anchorPoint );
 396
 397   /**
 398    * Set the x component of the anchor-point.
 399    * @param [in] x The new x value.
 400    */
 401   void SetAnchorPointX( float x );
 402
 403   /**
 404    * Set the y component of the anchor-point.
 405    * @param [in] y The new y value.
 406    */
 407   void SetAnchorPointY( float y );
 408
 409   /**
 410    * Set the z component of the anchor-point.
 411    * @param [in] z The new z value.
 412    */
 413   void SetAnchorPointZ( float z );
 414
 415   /**
 416    * Retrieve the anchor-point of an actor.
 417    * @return The anchor-point.
 418    */
 419   const Vector3& GetCurrentAnchorPoint() const;
 420
 421   /**
 422    * Sets the position of the Actor.
 423    * The coordinates are relative to the Actor's parent.
 424    * The Actor's z position will be set to 0.0f.
 425    * @param [in] x The new x position
 426    * @param [in] y The new y position
 427    */
 428   void SetPosition( float x, float y );
 429
 430   /**
 431    * Sets the position of the Actor.
 432    * The coordinates are relative to the Actor's parent.
 433    * @param [in] x The new x position
 434    * @param [in] y The new y position
 435    * @param [in] z The new z position
 436    */
 437   void SetPosition( float x, float y, float z );
 438
 439   /**
 440    * Sets the position of the Actor.
 441    * The coordinates are relative to the Actor's parent.
 442    * @param [in] position The new position.
 443    */
 444   void SetPosition( const Vector3& position );
 445
 446   /**
 447    * Set the position of an actor along the X-axis.
 448    * @param [in] x The new x position
 449    */
 450   void SetX( float x );
 451
 452   /**
 453    * Set the position of an actor along the Y-axis.
 454    * @param [in] y The new y position.
 455    */
 456   void SetY( float y );
 457
 458   /**
 459    * Set the position of an actor along the Z-axis.
 460    * @param [in] z The new z position
 461    */
 462   void SetZ( float z );
 463
 464   /**
 465    * Translate an actor relative to its existing position.
 466    * @param[in] distance The actor will move by this distance.
 467    */
 468   void TranslateBy( const Vector3& distance );
 469
 470   /**
 471    * Retrieve the position of the Actor.
 472    * The coordinates are relative to the Actor's parent.
 473    * @return the Actor's position.
 474    */
 475   const Vector3& GetCurrentPosition() const;
 476
 477   /**
 478    * Retrieve the target position of the Actor.
 479    * The coordinates are relative to the Actor's parent.
 480    * @return the Actor's position.
 481    */
 482   const Vector3& GetTargetPosition() const;
 483
 484   /**
 485    * @copydoc Dali::Actor::GetCurrentWorldPosition()
 486    */
 487   const Vector3& GetCurrentWorldPosition() const;
 488
 489   /**
 490    * @copydoc Dali::Actor::SetPositionInheritanceMode()
 491    */
 492   void SetPositionInheritanceMode( PositionInheritanceMode mode );
 493
 494   /**
 495    * @copydoc Dali::Actor::GetPositionInheritanceMode()
 496    */
 497   PositionInheritanceMode GetPositionInheritanceMode() const;
 498
 499   /**
 500    * Sets the orientation of the Actor.
 501    * @param [in] angleRadians The new orientation angle in radians.
 502    * @param [in] axis The new axis of orientation.
 503    */
 504   void SetOrientation( const Radian& angleRadians, const Vector3& axis );
 505
 506   /**
 507    * Sets the orientation of the Actor.
 508    * @param [in] orientation The new orientation.
 509    */
 510   void SetOrientation( const Quaternion& orientation );
 511
 512   /**
 513    * Rotate an actor around its existing rotation axis.
 514    * @param[in] angleRadians The angle to the rotation to combine with the existing rotation.
 515    * @param[in] axis The axis of the rotation to combine with the existing rotation.
 516    */
 517   void RotateBy( const Radian& angleRadians, const Vector3& axis );
 518
 519   /**
 520    * Apply a relative rotation to an actor.
 521    * @param[in] relativeRotation The rotation to combine with the actors existing rotation.
 522    */
 523   void RotateBy( const Quaternion& relativeRotation );
 524
 525   /**
 526    * Retreive the Actor's orientation.
 527    * @return the orientation.
 528    */
 529   const Quaternion& GetCurrentOrientation() const;
 530
 531   /**
 532    * Set whether a child actor inherits it's parent's orientation. Default is to inherit.
 533    * Switching this off means that using SetOrientation() sets the actor's world orientation.
 534    * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
 535    */
 536   void SetInheritOrientation( bool inherit );
 537
 538   /**
 539    * Returns whether the actor inherit's it's parent's orientation.
 540    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 541    */
 542   bool IsOrientationInherited() const;
 543
 544   /**
 545    * Sets the factor of the parents size used for the child actor.
 546    * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
 547    * @param[in] factor The vector to multiply the parents size by to get the childs size.
 548    */
 549   void SetSizeModeFactor( const Vector3& factor );
 550
 551   /**
 552    * Gets the factor of the parents size used for the child actor.
 553    * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
 554    * @return The vector being used to multiply the parents size by to get the childs size.
 555    */
 556   const Vector3& GetSizeModeFactor() const;
 557
 558   /**
 559    * @copydoc Dali::Actor::GetCurrentWorldOrientation()
 560    */
 561   const Quaternion& GetCurrentWorldOrientation() const;
 562
 563   /**
 564    * Sets a scale factor applied to an actor.
 565    * @param [in] scale The scale factor applied on all axes.
 566    */
 567   void SetScale( float scale );
 568
 569   /**
 570    * Sets a scale factor applied to an actor.
 571    * @param [in] scaleX The scale factor applied along the x-axis.
 572    * @param [in] scaleY The scale factor applied along the y-axis.
 573    * @param [in] scaleZ The scale factor applied along the z-axis.
 574    */
 575   void SetScale( float scaleX, float scaleY, float scaleZ );
 576
 577   /**
 578    * Sets a scale factor applied to an actor.
 579    * @param [in] scale A vector representing the scale factor for each axis.
 580    */
 581   void SetScale( const Vector3& scale );
 582
 583   /**
 584    * Set the x component of the scale factor.
 585    * @param [in] x The new x value.
 586    */
 587   void SetScaleX( float x );
 588
 589   /**
 590    * Set the y component of the scale factor.
 591    * @param [in] y The new y value.
 592    */
 593   void SetScaleY( float y );
 594
 595   /**
 596    * Set the z component of the scale factor.
 597    * @param [in] z The new z value.
 598    */
 599   void SetScaleZ( float z );
 600
 601   /**
 602    * Apply a relative scale to an actor.
 603    * @param[in] relativeScale The scale to combine with the actors existing scale.
 604    */
 605   void ScaleBy( const Vector3& relativeScale );
 606
 607   /**
 608    * Retrieve the scale factor applied to an actor.
 609    * @return A vector representing the scale factor for each axis.
 610    */
 611   const Vector3& GetCurrentScale() const;
 612
 613   /**
 614    * @copydoc Dali::Actor::GetCurrentWorldScale()
 615    */
 616   const Vector3& GetCurrentWorldScale() const;
 617
 618   /**
 619    * @copydoc Dali::Actor::SetInheritScale()
 620    */
 621   void SetInheritScale( bool inherit );
 622
 623   /**
 624    * @copydoc Dali::Actor::IsScaleInherited()
 625    */
 626   bool IsScaleInherited() const;
 627
 628   /**
 629    * @copydoc Dali::Actor::GetCurrentWorldMatrix()
 630    */
 631   Matrix GetCurrentWorldMatrix() const;
 632
 633   // Visibility
 634
 635   /**
 636    * Sets the visibility flag of an actor.
 637    * @param [in] visible The new visibility flag.
 638    */
 639   void SetVisible( bool visible );
 640
 641   /**
 642    * Retrieve the visibility flag of an actor.
 643    * @return The visibility flag.
 644    */
 645   bool IsVisible() const;
 646
 647   /**
 648    * Sets the opacity of an actor.
 649    * @param [in] opacity The new opacity.
 650    */
 651   void SetOpacity( float opacity );
 652
 653   /**
 654    * Retrieve the actor's opacity.
 655    * @return The actor's opacity.
 656    */
 657   float GetCurrentOpacity() const;
 658
 659   /**
 660    * Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover().
 661    * An actor is sensitive by default, which means that as soon as an application connects to the SignalTouch(),
 662    * the touch event signal will be emitted, and as soon as an application connects to the SignalHover(), the
 663    * hover event signal will be emitted.
 664    *
 665    * If the application wishes to temporarily disable the touch or hover event signal emission, then they can do so by calling:
 666    * @code
 667    * actor.SetSensitive(false);
 668    * @endcode
 669    *
 670    * Then, to re-enable the touch or hover event signal emission, the application should call:
 671    * @code
 672    * actor.SetSensitive(true);
 673    * @endcode
 674    *
 675    * @see SignalTouch() and SignalHover().
 676    * @note If an actor's sensitivity is set to false, then it's children will not emit a touch or hover event signal either.
 677    * @param[in]  sensitive  true to enable emission of the touch or hover event signals, false otherwise.
 678    */
 679   void SetSensitive( bool sensitive )
 680   {
 681     mSensitive = sensitive;
 682   }
 683
 684   /**
 685    * Query whether an actor emits touch or hover event signals.
 686    * @see SetSensitive(bool)
 687    * @return true, if emission of touch or hover event signals is enabled, false otherwise.
 688    */
 689   bool IsSensitive() const
 690   {
 691     return mSensitive;
 692   }
 693
 694   /**
 695    * @copydoc Dali::Actor::SetDrawMode
 696    */
 697   void SetDrawMode( DrawMode::Type drawMode );
 698
 699   /**
 700    * @copydoc Dali::Actor::GetDrawMode
 701    */
 702   DrawMode::Type GetDrawMode() const;
 703
 704   /**
 705    * @copydoc Dali::Actor::SetOverlay
 706    */
 707   void SetOverlay( bool enable );
 708
 709   /**
 710    * @copydoc Dali::Actor::IsOverlay
 711    */
 712   bool IsOverlay() const;
 713
 714   /**
 715    * Sets whether an actor transmits geometry scaling to it's children.
 716    * The default value is for it not to transmit scaling.
 717    * @param[in] transmitGeometryScaling True to transmit scaling.
 718    */
 719   void SetTransmitGeometryScaling( bool transmitGeometryScaling );
 720
 721   /**
 722    * Get the TransmitGeometryScaling property for this actor.
 723    * @return True if geometry scaling is applied to the inherited scale.
 724    */
 725   bool GetTransmitGeometryScaling() const;
 726
 727   /**
 728    * Sets the initial volume of the actor. Used for scaling the
 729    * actor appropriately as the actor is sized when transmitGeometryScaling
 730    * is set to true.
 731    *
 732    * @param[in] volume the volume of the model and it's children
 733    */
 734   void SetInitialVolume( const Vector3& volume );
 735
 736   /**
 737    * Sets the actor's color.  The final color of actor depends on its color mode.
 738    * This final color is applied to the drawable elements of an actor.
 739    * @param [in] color The new color.
 740    */
 741   void SetColor( const Vector4& color );
 742
 743   /**
 744    * Set the red component of the color.
 745    * @param [in] red The new red component.
 746    */
 747   void SetColorRed( float red );
 748
 749   /**
 750    * Set the green component of the color.
 751    * @param [in] green The new green component.
 752    */
 753   void SetColorGreen( float green );
 754
 755   /**
 756    * Set the blue component of the scale factor.
 757    * @param [in] blue The new blue value.
 758    */
 759   void SetColorBlue( float blue );
 760
 761   /**
 762    * Retrieve the actor's color.
 763    * @return The color.
 764    */
 765   const Vector4& GetCurrentColor() const;
 766
 767   /**
 768    * Sets the actor's color mode.
 769    * Color mode specifies whether Actor uses its own color or inherits its parent color
 770    * @param [in] colorMode to use.
 771    */
 772   void SetColorMode( ColorMode colorMode );
 773
 774   /**
 775    * Returns the actor's color mode.
 776    * @return currently used colorMode.
 777    */
 778   ColorMode GetColorMode() const;
 779
 780   /**
 781    * @copydoc Dali::Actor::GetCurrentWorldColor()
 782    */
 783   const Vector4& GetCurrentWorldColor() const;
 784
 785 public:
 786
 787   // Size negotiation virtual functions
 788
 789   /**
 790    * @brief Called after the size negotiation has been finished for this control.
 791    *
 792    * The control is expected to assign this given size to itself/its children.
 793    *
 794    * Should be overridden by derived classes if they need to layout
 795    * actors differently after certain operations like add or remove
 796    * actors, resize or after changing specific properties.
 797    *
 798    * Note! As this function is called from inside the size negotiation algorithm, you cannot
 799    * call RequestRelayout (the call would just be ignored)
 800    *
 801    * @param[in]      size       The allocated size.
 802    * @param[in,out]  container  The control should add actors to this container that it is not able
 803    *                            to allocate a size for.
 804    */
 805   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container )
 806   {
 807   }
 808
 809   /**
 810    * @brief Notification for deriving classes when the resize policy is set
 811    *
 812    * @param[in] policy The policy being set
 813    * @param[in] dimension The dimension the policy is being set for
 814    */
 815   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) {}
 816
 817   /**
 818    * @brief Virtual method to notify deriving classes that relayout dependencies have been
 819    * met and the size for this object is about to be calculated for the given dimension
 820    *
 821    * @param dimension The dimension that is about to be calculated
 822    */
 823   virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
 824
 825   /**
 826    * @brief Virtual method to notify deriving classes that the size for a dimension
 827    * has just been negotiated
 828    *
 829    * @param[in] size The new size for the given dimension
 830    * @param[in] dimension The dimension that was just negotiated
 831    */
 832   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
 833
 834   /**
 835    * @brief Determine if this actor is dependent on it's children for relayout
 836    *
 837    * @param dimension The dimension(s) to check for
 838    * @return Return if the actor is dependent on it's children
 839    */
 840   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 841
 842   /**
 843    * @brief Determine if this actor is dependent on it's children for relayout.
 844    *
 845    * Called from deriving classes
 846    *
 847    * @param dimension The dimension(s) to check for
 848    * @return Return if the actor is dependent on it's children
 849    */
 850   virtual bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 851
 852   /**
 853    * @brief Calculate the size for a child
 854    *
 855    * @param[in] child The child actor to calculate the size for
 856    * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
 857    * @return Return the calculated size for the given dimension
 858    */
 859   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
 860
 861   /**
 862    * @brief This method is called during size negotiation when a height is required for a given width.
 863    *
 864    * Derived classes should override this if they wish to customize the height returned.
 865    *
 866    * @param width to use.
 867    * @return the height based on the width.
 868    */
 869   virtual float GetHeightForWidth( float width );
 870
 871   /**
 872    * @brief This method is called during size negotiation when a width is required for a given height.
 873    *
 874    * Derived classes should override this if they wish to customize the width returned.
 875    *
 876    * @param height to use.
 877    * @return the width based on the width.
 878    */
 879   virtual float GetWidthForHeight( float height );
 880
 881 public:
 882
 883   // Size negotiation
 884
 885   /**
 886    * @brief Called by the RelayoutController to negotiate the size of an actor.
 887    *
 888    * The size allocated by the the algorithm is passed in which the
 889    * actor must adhere to.  A container is passed in as well which
 890    * the actor should populate with actors it has not / or does not
 891    * need to handle in its size negotiation.
 892    *
 893    * @param[in]      size       The allocated size.
 894    * @param[in,out]  container  The container that holds actors that are fed back into the
 895    *                            RelayoutController algorithm.
 896    */
 897   void NegotiateSize( const Vector2& size, RelayoutContainer& container );
 898
 899   /**
 900    * @copydoc Dali::Actor::SetResizePolicy()
 901    */
 902   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 903
 904   /**
 905    * @copydoc Dali::Actor::GetResizePolicy()
 906    */
 907   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
 908
 909   /**
 910    * @copydoc Dali::Actor::SetSizeScalePolicy()
 911    */
 912   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
 913
 914   /**
 915    * @copydoc Dali::Actor::GetSizeScalePolicy()
 916    */
 917   SizeScalePolicy::Type GetSizeScalePolicy() const;
 918
 919   /**
 920    * @copydoc Dali::Actor::SetDimensionDependency()
 921    */
 922   void SetDimensionDependency( Dimension::Type dimension, Dimension::Type dependency );
 923
 924   /**
 925    * @copydoc Dali::Actor::GetDimensionDependency()
 926    */
 927   Dimension::Type GetDimensionDependency( Dimension::Type dimension ) const;
 928
 929   /**
 930    * @brief Set the size negotiation relayout enabled on this actor
 931    *
 932    * @param[in] relayoutEnabled Boolean to enable or disable relayout
 933    */
 934   void SetRelayoutEnabled( bool relayoutEnabled );
 935
 936   /**
 937    * @brief Return if relayout is enabled
 938    *
 939    * @return Return if relayout is enabled or not for this actor
 940    */
 941   bool IsRelayoutEnabled() const;
 942
 943   /**
 944    * @brief Mark an actor as having it's layout dirty
 945    *
 946    * @param dirty Whether to mark actor as dirty or not
 947    * @param dimension The dimension(s) to mark as dirty
 948    */
 949   void SetLayoutDirty( bool dirty, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 950
 951   /**
 952    * @brief Return if any of an actor's dimensions are marked as dirty
 953    *
 954    * @param dimension The dimension(s) to check
 955    * @return Return if any of the requested dimensions are dirty
 956    */
 957   bool IsLayoutDirty( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
 958
 959   /**
 960    * @brief Returns if relayout is enabled and the actor is not dirty
 961    *
 962    * @return Return if it is possible to relayout the actor
 963    */
 964   bool RelayoutPossible( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
 965
 966   /**
 967    * @brief Returns if relayout is enabled and the actor is dirty
 968    *
 969    * @return Return if it is required to relayout the actor
 970    */
 971   bool RelayoutRequired( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
 972
 973   /**
 974    * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene)
 975    *
 976    * This method is automatically called from OnStageConnection(), OnChildAdd(),
 977    * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize().
 978    *
 979    * This method can also be called from a derived class every time it needs a different size.
 980    * At the end of event processing, the relayout process starts and
 981    * all controls which requested Relayout will have their sizes (re)negotiated.
 982    *
 983    * @note RelayoutRequest() can be called multiple times; the size negotiation is still
 984    * only performed once, i.e. there is no need to keep track of this in the calling side.
 985    */
 986   void RelayoutRequest( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 987
 988   /*
 989    * @copydoc Dali::Actor::PropagateRelayoutFlags
 990    */
 991   void PropagateRelayoutFlags();
 992
 993   /**
 994    * @brief Determine if this actor is dependent on it's parent for relayout
 995    *
 996    * @param dimension The dimension(s) to check for
 997    * @return Return if the actor is dependent on it's parent
 998    */
 999   bool RelayoutDependentOnParent( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1000
1001   /**
1002    * @brief Determine if this actor has another dimension depedent on the specified one
1003    *
1004    * @param dimension The dimension to check for
1005    * @param dependentDimension The dimension to check for dependency with
1006    * @return Return if the actor is dependent on this dimension
1007    */
1008   bool RelayoutDependentOnDimension( Dimension::Type dimension, Dimension::Type dependentDimension );
1009
1010   /**
1011    * Negotiate sizes for a control in all dimensions
1012    *
1013    * @param[in] allocatedSize The size constraint that the control must respect
1014    */
1015   void NegotiateDimensions( const Vector2& allocatedSize );
1016
1017   /**
1018    * Negotiate size for a specific dimension
1019    *
1020    * The algorithm adopts a recursive dependency checking approach. Meaning, that wherever dependencies
1021    * are found, e.g. an actor dependent on its parent, the dependency will be calculated first with NegotiatedDimension and
1022    * LayoutDimensionNegotiated flags being filled in on the actor.
1023    *
1024    * @post All actors that exist in the dependency chain connected to the given actor will have had their NegotiatedDimensions
1025    * calculated and set as well as the LayoutDimensionNegotiated flags.
1026    *
1027    * @param[in] dimension The dimension to negotiate on
1028    * @param[in] allocatedSize The size constraint that the actor must respect
1029    */
1030   void NegotiateDimension( Dimension::Type dimension, const Vector2& allocatedSize, ActorDimensionStack& recursionStack );
1031
1032   /**
1033    * @brief Calculate the size of a dimension
1034    *
1035    * @param[in] dimension The dimension to calculate the size for
1036    * @param[in] maximumSize The upper bounds on the size
1037    * @return Return the calculated size for the dimension
1038    */
1039   float CalculateSize( Dimension::Type dimension, const Vector2& maximumSize );
1040
1041   /**
1042    * @brief Clamp a dimension given the relayout constraints on this actor
1043    *
1044    * @param[in] size The size to constrain
1045    * @param[in] dimension The dimension the size exists in
1046    * @return Return the clamped size
1047    */
1048   float ClampDimension( float size, Dimension::Type dimension );
1049
1050   /**
1051    * Negotiate a dimension based on the size of the parent
1052    *
1053    * @param[in] dimension The dimension to negotiate on
1054    * @return Return the negotiated size
1055    */
1056   float NegotiateFromParent( Dimension::Type dimension );
1057
1058   /**
1059    * Negotiate a dimension based on the size of the parent. Fitting inside.
1060    *
1061    * @param[in] dimension The dimension to negotiate on
1062    * @return Return the negotiated size
1063    */
1064   float NegotiateFromParentFit( Dimension::Type dimension );
1065
1066   /**
1067    * Negotiate a dimension based on the size of the parent. Flooding the whole space.
1068    *
1069    * @param[in] dimension The dimension to negotiate on
1070    * @return Return the negotiated size
1071    */
1072   float NegotiateFromParentFlood( Dimension::Type dimension );
1073
1074   /**
1075    * @brief Negotiate a dimension based on the size of the children
1076    *
1077    * @param[in] dimension The dimension to negotiate on
1078    * @return Return the negotiated size
1079    */
1080   float NegotiateFromChildren( Dimension::Type dimension );
1081
1082   /**
1083    * Set the negotiated dimension value for the given dimension(s)
1084    *
1085    * @param negotiatedDimension The value to set
1086    * @param dimension The dimension(s) to set the value for
1087    */
1088   void SetNegotiatedDimension( float negotiatedDimension, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1089
1090   /**
1091    * Return the value of negotiated dimension for the given dimension
1092    *
1093    * @param dimension The dimension to retrieve
1094    * @return Return the value of the negotiated dimension
1095    */
1096   float GetNegotiatedDimension( Dimension::Type dimension ) const;
1097
1098   /**
1099    * @brief Set the padding for a dimension
1100    *
1101    * @param[in] padding Padding for the dimension. X = start (e.g. left, bottom), y = end (e.g. right, top)
1102    * @param[in] dimension The dimension to set
1103    */
1104   void SetPadding( const Vector2& padding, Dimension::Type dimension );
1105
1106   /**
1107    * Return the value of padding for the given dimension
1108    *
1109    * @param dimension The dimension to retrieve
1110    * @return Return the value of padding for the dimension
1111    */
1112   Vector2 GetPadding( Dimension::Type dimension ) const;
1113
1114   /**
1115    * Return the actor size for a given dimension
1116    *
1117    * @param[in] dimension The dimension to retrieve the size for
1118    * @return Return the size for the given dimension
1119    */
1120   float GetSize( Dimension::Type dimension ) const;
1121
1122   /**
1123    * Return the natural size of the actor for a given dimension
1124    *
1125    * @param[in] dimension The dimension to retrieve the size for
1126    * @return Return the natural size for the given dimension
1127    */
1128   float GetNaturalSize( Dimension::Type dimension ) const;
1129
1130   /**
1131    * @brief Return the amount of size allocated for relayout
1132    *
1133    * May include padding
1134    *
1135    * @param[in] dimension The dimension to retrieve
1136    * @return Return the size
1137    */
1138   float GetRelayoutSize( Dimension::Type dimension ) const;
1139
1140   /**
1141    * @brief If the size has been negotiated return that else return normal size
1142    *
1143    * @param[in] dimension The dimension to retrieve
1144    * @return Return the size
1145    */
1146   float GetLatestSize( Dimension::Type dimension ) const;
1147
1148   /**
1149    * Apply the negotiated size to the actor
1150    *
1151    * @param[in] container The container to fill with actors that require further relayout
1152    */
1153   void SetNegotiatedSize( RelayoutContainer& container );
1154
1155   /**
1156    * @brief Flag the actor as having it's layout dimension negotiated.
1157    *
1158    * @param[in] negotiated The status of the flag to set.
1159    * @param[in] dimension The dimension to set the flag for
1160    */
1161   void SetLayoutNegotiated( bool negotiated, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1162
1163   /**
1164    * @brief Test whether the layout dimension for this actor has been negotiated or not.
1165    *
1166    * @param[in] dimension The dimension to determine the value of the flag for
1167    * @return Return if the layout dimension is negotiated or not.
1168    */
1169   bool IsLayoutNegotiated( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
1170
1171   /**
1172    * @brief Calculate the size for a child
1173    *
1174    * @param[in] child The child actor to calculate the size for
1175    * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
1176    * @return Return the calculated size for the given dimension
1177    */
1178   float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
1179
1180   /**
1181    * @brief Set the preferred size for size negotiation
1182    *
1183    * @param[in] size The preferred size to set
1184    */
1185   void SetPreferredSize( const Vector2& size );
1186
1187   /**
1188    * @brief Return the preferred size used for size negotiation
1189    *
1190    * @return Return the preferred size
1191    */
1192   Vector2 GetPreferredSize() const;
1193
1194   /**
1195    * @copydoc Dali::Actor::SetMinimumSize
1196    */
1197   void SetMinimumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1198
1199   /**
1200    * @copydoc Dali::Actor::GetMinimumSize
1201    */
1202   float GetMinimumSize( Dimension::Type dimension ) const;
1203
1204   /**
1205    * @copydoc Dali::Actor::SetMaximumSize
1206    */
1207   void SetMaximumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1208
1209   /**
1210    * @copydoc Dali::Actor::GetMaximumSize
1211    */
1212   float GetMaximumSize( Dimension::Type dimension ) const;
1213
1214 #ifdef DYNAMICS_SUPPORT
1215
1216   // Dynamics
1217
1218   /// @copydoc Dali::Actor::DisableDynamics
1219   void DisableDynamics();
1220
1221   /// @copydoc Dali::Actor::EnableDynamics(Dali::DynamicsBodyConfig)
1222   DynamicsBodyPtr EnableDynamics(DynamicsBodyConfigPtr bodyConfig);
1223
1224   /// @copydoc Dali::Actor::GetDynamicsBody
1225   DynamicsBodyPtr GetDynamicsBody() const;
1226
1227   /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&)
1228   DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offset );
1229
1230   /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&,const Vector3&)
1231   DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offsetA, const Vector3& offsetB );
1232
1233   /// @copydoc Dali::Actor::GetNumberOfJoints
1234   const int GetNumberOfJoints() const;
1235
1236   /// @copydoc Dali::Actor::GetDynamicsJointByIndex
1237   DynamicsJointPtr GetDynamicsJointByIndex( const int index ) const;
1238
1239   /// @copydoc Dali::Actor::GetDynamicsJoint
1240   DynamicsJointPtr GetDynamicsJoint( ActorPtr attachedActor ) const;
1241
1242   /// @copydoc Dali::Actor::RemoveDynamicsJoint
1243   void RemoveDynamicsJoint( DynamicsJointPtr joint );
1244
1245   /**
1246    * Hold a reference to a DynamicsJoint
1247    * @param[in] joint The joint
1248    */
1249   void ReferenceJoint( DynamicsJointPtr joint );
1250
1251   /**
1252    * Release a reference to a DynamicsJoint
1253    * @param[in] joint The joint
1254    */
1255   void ReleaseJoint( DynamicsJointPtr joint );
1256
1257   /**
1258    * Set this actor to be the root actor in the dynamics simulation
1259    * All children of the actor are added/removed from the simulation.
1260    * @param[in] flag  When true sets this actor to be the simulation world root actor and
1261    *                  if OnStage() all dynamics enabled child actors are added to the simulation,
1262    *                  when false stops this actor being the simulation root and if OnStage() all
1263    *                  dynamics enabled child actors are removed from the simulation.
1264    */
1265   void SetDynamicsRoot(bool flag);
1266
1267 private:
1268   /**
1269    * Check if this actor is the root actor in the dynamics simulation
1270    * @return true if this is the dynamics root actor.
1271    */
1272   bool IsDynamicsRoot() const;
1273
1274   /**
1275    * Add actor to the dynamics simulation
1276    * Invoked when the actor is staged, or it's parent becomes the simulation root
1277    */
1278   void ConnectDynamics();
1279
1280   /**
1281    * Remove actor from the dynamics simulation
1282    * Invoked when the actor is unstaged, or it's parent stops being the the simulation root
1283    */
1284   void DisconnectDynamics();
1285
1286   /**
1287    * An actor in a DynamicsJoint relationship has been staged
1288    * @param[in] actor The actor passed into AddDynamicsJoint()
1289    */
1290   void AttachedActorOnStage( Dali::Actor actor );
1291
1292   /**
1293    * An actor in a DynamicsJoint relationship has been unstaged
1294    * @param[in] actor The actor passed into AddDynamicsJoint()
1295    */
1296   void AttachedActorOffStage( Dali::Actor actor );
1297
1298 #endif // DYNAMICS_SUPPORT
1299
1300 public:
1301   /**
1302    * Converts screen coordinates into the actor's coordinate system.
1303    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1304    * @param[out] localX On return, the X-coordinate relative to the actor.
1305    * @param[out] localY On return, the Y-coordinate relative to the actor.
1306    * @param[in] screenX The screen X-coordinate.
1307    * @param[in] screenY The screen Y-coordinate.
1308    * @return True if the conversion succeeded.
1309    */
1310   bool ScreenToLocal( float& localX, float& localY, float screenX, float screenY ) const;
1311
1312   /**
1313    * Converts screen coordinates into the actor's coordinate system.
1314    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1315    * @param[in] renderTask The render-task used to display the actor.
1316    * @param[out] localX On return, the X-coordinate relative to the actor.
1317    * @param[out] localY On return, the Y-coordinate relative to the actor.
1318    * @param[in] screenX The screen X-coordinate.
1319    * @param[in] screenY The screen Y-coordinate.
1320    * @return True if the conversion succeeded.
1321    */
1322   bool ScreenToLocal( RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY ) const;
1323
1324   /**
1325    * Converts from the actor's coordinate system to screen coordinates.
1326    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1327    * @param[in] viewMatrix The view-matrix
1328    * @param[in] projectionMatrix The projection-matrix
1329    * @param[in] viewport The view-port
1330    * @param[out] localX On return, the X-coordinate relative to the actor.
1331    * @param[out] localY On return, the Y-coordinate relative to the actor.
1332    * @param[in] screenX The screen X-coordinate.
1333    * @param[in] screenY The screen Y-coordinate.
1334    * @return True if the conversion succeeded.
1335    */
1336   bool ScreenToLocal( const Matrix& viewMatrix,
1337                       const Matrix& projectionMatrix,
1338                       const Viewport& viewport,
1339                       float& localX,
1340                       float& localY,
1341                       float screenX,
1342                       float screenY ) const;
1343
1344   /**
1345    * Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere.
1346    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1347    * @param[in] rayOrigin The ray origin in the world's reference system.
1348    * @param[in] rayDir The ray director vector in the world's reference system.
1349    * @return True if the ray intersects the actor's bounding sphere.
1350    */
1351   bool RaySphereTest( const Vector4& rayOrigin, const Vector4& rayDir ) const;
1352
1353   /**
1354    * Performs a ray-actor test with the given pick-ray and the actor's geometry.
1355    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1356    * @param[in] rayOrigin The ray origin in the world's reference system.
1357    * @param[in] rayDir The ray director vector in the world's reference system.
1358    * @param[out] hitPointLocal The hit point in the Actor's local reference system.
1359    * @param[out] distance The distance from the hit point to the camera.
1360    * @return True if the ray intersects the actor's geometry.
1361    */
1362   bool RayActorTest( const Vector4& rayOrigin,
1363                      const Vector4& rayDir,
1364                      Vector4& hitPointLocal,
1365                      float& distance ) const;
1366
1367   /**
1368    * Sets whether the actor should receive a notification when touch or hover motion events leave
1369    * the boundary of the actor.
1370    *
1371    * @note By default, this is set to false as most actors do not require this.
1372    * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
1373    *
1374    * @param[in]  required  Should be set to true if a Leave event is required
1375    */
1376   void SetLeaveRequired( bool required );
1377
1378   /**
1379    * This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1380    * the boundary of the actor.
1381    * @return true if a Leave event is required, false otherwise.
1382    */
1383   bool GetLeaveRequired() const;
1384
1385   /**
1386    * @copydoc Dali::Actor::SetKeyboardFocusable()
1387    */
1388   void SetKeyboardFocusable( bool focusable );
1389
1390   /**
1391    * @copydoc Dali::Actor::IsKeyboardFocusable()
1392    */
1393   bool IsKeyboardFocusable() const;
1394
1395   /**
1396    * Query whether the application or derived actor type requires touch events.
1397    * @return True if touch events are required.
1398    */
1399   bool GetTouchRequired() const;
1400
1401   /**
1402    * Query whether the application or derived actor type requires hover events.
1403    * @return True if hover events are required.
1404    */
1405   bool GetHoverRequired() const;
1406
1407   /**
1408    * Query whether the application or derived actor type requires mouse wheel events.
1409    * @return True if mouse wheel events are required.
1410    */
1411   bool GetMouseWheelEventRequired() const;
1412
1413   /**
1414    * Query whether the actor is actually hittable.  This method checks whether the actor is
1415    * sensitive, has the visibility flag set to true and is not fully transparent.
1416    * @return true, if it can be hit, false otherwise.
1417    */
1418   bool IsHittable() const;
1419
1420   // Gestures
1421
1422   /**
1423    * Retrieve the gesture data associated with this actor. The first call to this method will
1424    * allocate space for the ActorGestureData so this should only be called if an actor really does
1425    * require gestures.
1426    * @return Reference to the ActorGestureData for this actor.
1427    * @note Once the gesture-data is created for an actor it is likely that gestures are required
1428    * throughout the actor's lifetime so it will only be deleted when the actor is destroyed.
1429    */
1430   ActorGestureData& GetGestureData();
1431
1432   /**
1433    * Queries whether the actor requires the gesture type.
1434    * @param[in] type The gesture type.
1435    */
1436   bool IsGestureRequred( Gesture::Type type ) const;
1437
1438   // Signals
1439
1440   /**
1441    * Used by the EventProcessor to emit touch event signals.
1442    * @param[in] event The touch event.
1443    * @return True if the event was consumed.
1444    */
1445   bool EmitTouchEventSignal( const TouchEvent& event );
1446
1447   /**
1448    * Used by the EventProcessor to emit hover event signals.
1449    * @param[in] event The hover event.
1450    * @return True if the event was consumed.
1451    */
1452   bool EmitHoverEventSignal( const HoverEvent& event );
1453
1454   /**
1455    * Used by the EventProcessor to emit mouse wheel event signals.
1456    * @param[in] event The mouse wheel event.
1457    * @return True if the event was consumed.
1458    */
1459   bool EmitMouseWheelEventSignal( const MouseWheelEvent& event );
1460
1461   /**
1462    * @copydoc Dali::Actor::TouchedSignal()
1463    */
1464   Dali::Actor::TouchSignalType& TouchedSignal();
1465
1466   /**
1467    * @copydoc Dali::Actor::HoveredSignal()
1468    */
1469   Dali::Actor::HoverSignalType& HoveredSignal();
1470
1471   /**
1472    * @copydoc Dali::Actor::MouseWheelEventSignal()
1473    */
1474   Dali::Actor::MouseWheelEventSignalType& MouseWheelEventSignal();
1475
1476   /**
1477    * @copydoc Dali::Actor::OnStageSignal()
1478    */
1479   Dali::Actor::OnStageSignalType& OnStageSignal();
1480
1481   /**
1482    * @copydoc Dali::Actor::OffStageSignal()
1483    */
1484   Dali::Actor::OffStageSignalType& OffStageSignal();
1485
1486   /**
1487    * @copydoc Dali::Actor::OnRelayoutSignal()
1488    */
1489   Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal();
1490
1491   /**
1492    * Connects a callback function with the object's signals.
1493    * @param[in] object The object providing the signal.
1494    * @param[in] tracker Used to disconnect the signal.
1495    * @param[in] signalName The signal to connect to.
1496    * @param[in] functor A newly allocated FunctorDelegate.
1497    * @return True if the signal was connected.
1498    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
1499    */
1500   static bool DoConnectSignal( BaseObject* object,
1501                                ConnectionTrackerInterface* tracker,
1502                                const std::string& signalName,
1503                                FunctorDelegate* functor );
1504
1505   /**
1506    * Performs actions as requested using the action name.
1507    * @param[in] object The object on which to perform the action.
1508    * @param[in] actionName The action to perform.
1509    * @param[in] attributes The attributes with which to perfrom this action.
1510    * @return true if the action was done.
1511    */
1512   static bool DoAction( BaseObject* object,
1513                         const std::string& actionName,
1514                         const std::vector< Property::Value >& attributes );
1515
1516 public:
1517   // For Animation
1518
1519   /**
1520    * This should only be called by Animation, when the actor is resized using Animation::Resize().
1521    *
1522    * @param[in] animation The animation that resized the actor
1523    * @param[in] targetSize The new target size of the actor
1524    */
1525   void NotifySizeAnimation( Animation& animation, const Vector3& targetSize );
1526
1527   /**
1528    * For use in derived classes.
1529    * This should only be called by Animation, when the actor is resized using Animation::Resize().
1530    */
1531   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize )
1532   {
1533   }
1534
1535 protected:
1536
1537   enum DerivedType
1538   {
1539     BASIC, RENDERABLE, LAYER, ROOT_LAYER
1540   };
1541
1542   /**
1543    * Protected Constructor.  See Actor::New().
1544    * The second-phase construction Initialize() member should be called immediately after this.
1545    * @param[in] derivedType The derived type of actor (if any).
1546    */
1547   Actor( DerivedType derivedType );
1548
1549   /**
1550    * Second-phase constructor. Must be called immediately after creating a new Actor;
1551    */
1552   void Initialize( void );
1553
1554   /**
1555    * A reference counted object may only be deleted by calling Unreference()
1556    */
1557   virtual ~Actor();
1558
1559   /**
1560    * Called on a child during Add() when the parent actor is connected to the Stage.
1561    * @param[in] stage The stage.
1562    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1563    */
1564   void ConnectToStage( int index = -1 );
1565
1566   /**
1567    * Helper for ConnectToStage, to recursively connect a tree of actors.
1568    * This is atomic i.e. not interrupted by user callbacks.
1569    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1570    * @param[out] connectionList On return, the list of connected actors which require notification.
1571    */
1572   void RecursiveConnectToStage( ActorContainer& connectionList, int index = -1 );
1573
1574   /**
1575    * Connect the Node associated with this Actor to the scene-graph.
1576    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1577    */
1578   void ConnectToSceneGraph( int index = -1 );
1579
1580   /**
1581    * Helper for ConnectToStage, to notify a connected actor through the public API.
1582    */
1583   void NotifyStageConnection();
1584
1585   /**
1586    * Called on a child during Remove() when the actor was previously on the Stage.
1587    */
1588   void DisconnectFromStage();
1589
1590   /**
1591    * Helper for DisconnectFromStage, to recursively disconnect a tree of actors.
1592    * This is atomic i.e. not interrupted by user callbacks.
1593    * @param[out] disconnectionList On return, the list of disconnected actors which require notification.
1594    */
1595   void RecursiveDisconnectFromStage( ActorContainer& disconnectionList );
1596
1597   /**
1598    * Disconnect the Node associated with this Actor from the scene-graph.
1599    */
1600   void DisconnectFromSceneGraph();
1601
1602   /**
1603    * Helper for DisconnectFromStage, to notify a disconnected actor through the public API.
1604    */
1605   void NotifyStageDisconnection();
1606
1607   /**
1608    * When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph.
1609    * @return True if the Actor is OnStage & has a Node connected to the scene graph.
1610    */
1611   bool IsNodeConnected() const;
1612
1613   /**
1614    * Calculate the size of the z dimension for a 2D size
1615    *
1616    * @param[in] size The 2D size (X, Y) to calculate Z from
1617    *
1618    * @return Return the Z dimension for this size
1619    */
1620   float CalculateSizeZ( const Vector2& size ) const;
1621
1622 public:
1623   // Default property extensions from Object
1624
1625   /**
1626    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
1627    */
1628   virtual unsigned int GetDefaultPropertyCount() const;
1629
1630   /**
1631    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
1632    */
1633   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
1634
1635   /**
1636    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
1637    */
1638   virtual const char* GetDefaultPropertyName( Property::Index index ) const;
1639
1640   /**
1641    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
1642    */
1643   virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const;
1644
1645   /**
1646    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
1647    */
1648   virtual bool IsDefaultPropertyWritable( Property::Index index ) const;
1649
1650   /**
1651    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
1652    */
1653   virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const;
1654
1655   /**
1656    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
1657    */
1658   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
1659
1660   /**
1661    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
1662    */
1663   virtual Property::Type GetDefaultPropertyType( Property::Index index ) const;
1664
1665   /**
1666    * @copydoc Dali::Internal::Object::SetDefaultProperty()
1667    */
1668   virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
1669
1670   /**
1671    * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
1672    */
1673   virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
1674
1675   /**
1676    * @copydoc Dali::Internal::Object::GetDefaultProperty()
1677    */
1678   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
1679
1680   /**
1681    * @copydoc Dali::Internal::Object::GetPropertyOwner()
1682    */
1683   virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
1684
1685   /**
1686    * @copydoc Dali::Internal::Object::GetSceneObject()
1687    */
1688   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
1689
1690   /**
1691    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
1692    */
1693   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
1694
1695   /**
1696    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
1697    */
1698   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
1699
1700   /**
1701    * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
1702    */
1703   virtual int GetPropertyComponentIndex( Property::Index index ) const;
1704
1705 private:
1706
1707   // Undefined
1708   Actor();
1709
1710   // Undefined
1711   Actor( const Actor& );
1712
1713   // Undefined
1714   Actor& operator=( const Actor& rhs );
1715
1716   /**
1717    * Set the actors parent.
1718    * @param[in] parent The new parent.
1719    * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
1720    */
1721   void SetParent( Actor* parent, int index = -1 );
1722
1723   /**
1724    * Helper to create a Node for this Actor.
1725    * To be overriden in derived classes.
1726    * @return A newly allocated node.
1727    */
1728   virtual SceneGraph::Node* CreateNode() const;
1729
1730   /**
1731    * For use in derived classes, called after Initialize()
1732    */
1733   virtual void OnInitialize()
1734   {
1735   }
1736
1737   /**
1738    * For use in internal derived classes.
1739    * This is called during ConnectToStage(), after the actor has finished adding its node to the scene-graph.
1740    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1741    */
1742   virtual void OnStageConnectionInternal()
1743   {
1744   }
1745
1746   /**
1747    * For use in internal derived classes.
1748    * This is called during DisconnectFromStage(), before the actor removes its node from the scene-graph.
1749    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1750    */
1751   virtual void OnStageDisconnectionInternal()
1752   {
1753   }
1754
1755   /**
1756    * For use in external (CustomActor) derived classes.
1757    * This is called after the atomic ConnectToStage() traversal has been completed.
1758    */
1759   virtual void OnStageConnectionExternal()
1760   {
1761   }
1762
1763   /**
1764    * For use in external (CustomActor) derived classes.
1765    * This is called after the atomic DisconnectFromStage() traversal has been completed.
1766    */
1767   virtual void OnStageDisconnectionExternal()
1768   {
1769   }
1770
1771   /**
1772    * For use in derived classes; this is called after Add() has added a child.
1773    * @param[in] child The child that was added.
1774    */
1775   virtual void OnChildAdd( Actor& child )
1776   {
1777   }
1778
1779   /**
1780    * For use in derived classes; this is called after Remove() has removed a child.
1781    * @param[in] child The child that was removed.
1782    */
1783   virtual void OnChildRemove( Actor& child )
1784   {
1785   }
1786
1787   /**
1788    * For use in derived classes.
1789    * This is called after SizeSet() has been called.
1790    */
1791   virtual void OnSizeSet( const Vector3& targetSize )
1792   {
1793   }
1794
1795   /**
1796    * For use in derived classes.
1797    * This is only called if mDerivedRequiresTouch is true, and the touch-signal was not consumed.
1798    * @param[in] event The touch event.
1799    * @return True if the event should be consumed.
1800    */
1801   virtual bool OnTouchEvent( const TouchEvent& event )
1802   {
1803     return false;
1804   }
1805
1806   /**
1807    * For use in derived classes.
1808    * This is only called if mDerivedRequiresHover is true, and the hover-signal was not consumed.
1809    * @param[in] event The hover event.
1810    * @return True if the event should be consumed.
1811    */
1812   virtual bool OnHoverEvent( const HoverEvent& event )
1813   {
1814     return false;
1815   }
1816
1817   /**
1818    * For use in derived classes.
1819    * This is only called if the mouse wheel signal was not consumed.
1820    * @param[in] event The mouse event.
1821    * @return True if the event should be consumed.
1822    */
1823   virtual bool OnMouseWheelEvent( const MouseWheelEvent& event )
1824   {
1825     return false;
1826   }
1827
1828   /**
1829    * @brief Ensure the relayout data is allocated
1830    */
1831   void EnsureRelayoutData() const;
1832
1833   /**
1834    * @brief Apply the size set policy to the input size
1835    *
1836    * @param[in] size The size to apply the policy to
1837    * @return Return the adjusted size
1838    */
1839   Vector2 ApplySizeSetPolicy( const Vector2 size );
1840
1841 protected:
1842
1843   StagePtr mStage;                ///< Used to send messages to Node; valid until Core destruction
1844   Actor* mParent;                 ///< Each actor (except the root) can have one parent
1845   ActorContainer* mChildren;      ///< Container of referenced actors
1846   const SceneGraph::Node* mNode;  ///< Not owned
1847   Vector3* mParentOrigin;         ///< NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable
1848   Vector3* mAnchorPoint;          ///< NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable
1849
1850   struct RelayoutData;
1851   mutable RelayoutData* mRelayoutData; ///< Struct to hold optional collection of relayout variables
1852
1853 #ifdef DYNAMICS_SUPPORT
1854   DynamicsData* mDynamicsData; ///< optional physics data
1855 #endif
1856
1857   ActorGestureData* mGestureData;   ///< Optional Gesture data. Only created when actor requires gestures
1858
1859   ActorAttachmentPtr mAttachment;   ///< Optional referenced attachment
1860
1861   // Signals
1862   Dali::Actor::TouchSignalType             mTouchedSignal;
1863   Dali::Actor::HoverSignalType             mHoveredSignal;
1864   Dali::Actor::MouseWheelEventSignalType   mMouseWheelEventSignal;
1865   Dali::Actor::OnStageSignalType           mOnStageSignal;
1866   Dali::Actor::OffStageSignalType          mOffStageSignal;
1867   Dali::Actor::OnRelayoutSignalType        mOnRelayoutSignal;
1868
1869   Vector3         mTargetSize;       ///< Event-side storage for size (not a pointer as most actors will have a size)
1870   Vector3         mTargetPosition;   ///< Event-side storage for position (not a pointer as most actors will have a position)
1871
1872   std::string     mName;      ///< Name of the actor
1873   unsigned int    mId;        ///< A unique ID to identify the actor starting from 1, and 0 is reserved
1874
1875   const bool mIsRoot                               : 1; ///< Flag to identify the root actor
1876   const bool mIsRenderable                         : 1; ///< Flag to identify that this is a renderable actor
1877   const bool mIsLayer                              : 1; ///< Flag to identify that this is a layer
1878   bool mIsOnStage                                  : 1; ///< Flag to identify whether the actor is on-stage
1879   bool mIsDynamicsRoot                             : 1; ///< Flag to identify if this is the dynamics world root
1880   bool mSensitive                                  : 1; ///< Whether the actor emits touch event signals
1881   bool mLeaveRequired                              : 1; ///< Whether a touch event signal is emitted when the a touch leaves the actor's bounds
1882   bool mKeyboardFocusable                          : 1; ///< Whether the actor should be focusable by keyboard navigation
1883   bool mDerivedRequiresTouch                       : 1; ///< Whether the derived actor type requires touch event signals
1884   bool mDerivedRequiresHover                       : 1; ///< Whether the derived actor type requires hover event signals
1885   bool mDerivedRequiresMouseWheelEvent             : 1; ///< Whether the derived actor type requires mouse wheel event signals
1886   bool mOnStageSignalled                           : 1; ///< Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection
1887   bool mInheritOrientation                         : 1; ///< Cached: Whether the parent's orientation should be inherited.
1888   bool mInheritScale                               : 1; ///< Cached: Whether the parent's scale should be inherited.
1889   DrawMode::Type mDrawMode                         : 2; ///< Cached: How the actor and its children should be drawn
1890   PositionInheritanceMode mPositionInheritanceMode : 2; ///< Cached: Determines how position is inherited
1891   ColorMode mColorMode                             : 2; ///< Cached: Determines whether mWorldColor is inherited
1892
1893 private:
1894
1895   static ActorContainer mNullChildren;  ///< Empty container (shared by all actors, returned by GetChildren() const)
1896   static unsigned int mActorCounter;    ///< A counter to track the actor instance creation
1897
1898 };
1899
1900 } // namespace Internal
1901
1902 // Helpers for public-api forwarding methods
1903
1904 inline Internal::Actor& GetImplementation( Dali::Actor& actor )
1905 {
1906   DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1907
1908   BaseObject& handle = actor.GetBaseObject();
1909
1910   return static_cast< Internal::Actor& >( handle );
1911 }
1912
1913 inline const Internal::Actor& GetImplementation( const Dali::Actor& actor )
1914 {
1915   DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1916
1917   const BaseObject& handle = actor.GetBaseObject();
1918
1919   return static_cast< const Internal::Actor& >( handle );
1920 }
1921
1922 } // namespace Dali
1923
1924 #endif // __DALI_INTERNAL_ACTOR_H__