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