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

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