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   int GetHierarchyDepth() const
 747   {
 748     if( mIsOnStage )
 749     {
 750       return static_cast<int>(mDepth);
 751     }
 752
 753     return -1;
 754   }
 755
 756 public:
 757
 758   // Size negotiation virtual functions
 759
 760   /**
 761    * @brief Called after the size negotiation has been finished for this control.
 762    *
 763    * The control is expected to assign this given size to itself/its children.
 764    *
 765    * Should be overridden by derived classes if they need to layout
 766    * actors differently after certain operations like add or remove
 767    * actors, resize or after changing specific properties.
 768    *
 769    * Note! As this function is called from inside the size negotiation algorithm, you cannot
 770    * call RequestRelayout (the call would just be ignored)
 771    *
 772    * @param[in]      size       The allocated size.
 773    * @param[in,out]  container  The control should add actors to this container that it is not able
 774    *                            to allocate a size for.
 775    */
 776   virtual void OnRelayout( const Vector2& size, RelayoutContainer& container )
 777   {
 778   }
 779
 780   /**
 781    * @brief Notification for deriving classes when the resize policy is set
 782    *
 783    * @param[in] policy The policy being set
 784    * @param[in] dimension The dimension the policy is being set for
 785    */
 786   virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) {}
 787
 788   /**
 789    * @brief Virtual method to notify deriving classes that relayout dependencies have been
 790    * met and the size for this object is about to be calculated for the given dimension
 791    *
 792    * @param dimension The dimension that is about to be calculated
 793    */
 794   virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
 795
 796   /**
 797    * @brief Virtual method to notify deriving classes that the size for a dimension
 798    * has just been negotiated
 799    *
 800    * @param[in] size The new size for the given dimension
 801    * @param[in] dimension The dimension that was just negotiated
 802    */
 803   virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
 804
 805   /**
 806    * @brief Determine if this actor is dependent on it's children for relayout
 807    *
 808    * @param dimension The dimension(s) to check for
 809    * @return Return if the actor is dependent on it's children
 810    */
 811   virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 812
 813   /**
 814    * @brief Determine if this actor is dependent on it's children for relayout.
 815    *
 816    * Called from deriving classes
 817    *
 818    * @param dimension The dimension(s) to check for
 819    * @return Return if the actor is dependent on it's children
 820    */
 821   virtual bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 822
 823   /**
 824    * @brief Calculate the size for a child
 825    *
 826    * @param[in] child The child actor to calculate the size for
 827    * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
 828    * @return Return the calculated size for the given dimension
 829    */
 830   virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
 831
 832   /**
 833    * @brief This method is called during size negotiation when a height is required for a given width.
 834    *
 835    * Derived classes should override this if they wish to customize the height returned.
 836    *
 837    * @param width to use.
 838    * @return the height based on the width.
 839    */
 840   virtual float GetHeightForWidth( float width );
 841
 842   /**
 843    * @brief This method is called during size negotiation when a width is required for a given height.
 844    *
 845    * Derived classes should override this if they wish to customize the width returned.
 846    *
 847    * @param height to use.
 848    * @return the width based on the width.
 849    */
 850   virtual float GetWidthForHeight( float height );
 851
 852 public:
 853
 854   // Size negotiation
 855
 856   /**
 857    * @brief Called by the RelayoutController to negotiate the size of an actor.
 858    *
 859    * The size allocated by the the algorithm is passed in which the
 860    * actor must adhere to.  A container is passed in as well which
 861    * the actor should populate with actors it has not / or does not
 862    * need to handle in its size negotiation.
 863    *
 864    * @param[in]      size       The allocated size.
 865    * @param[in,out]  container  The container that holds actors that are fed back into the
 866    *                            RelayoutController algorithm.
 867    */
 868   void NegotiateSize( const Vector2& size, RelayoutContainer& container );
 869
 870   /**
 871    * @brief Set whether size negotiation should use the assigned size of the actor
 872    * during relayout for the given dimension(s)
 873    *
 874    * @param[in] use Whether the assigned size of the actor should be used
 875    * @param[in] dimension The dimension(s) to set. Can be a bitfield of multiple dimensions
 876    */
 877   void SetUseAssignedSize( bool use, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 878
 879   /**
 880    * @brief Returns whether size negotiation should use the assigned size of the actor
 881    * during relayout for a single dimension
 882    *
 883    * @param[in] dimension The dimension to get
 884    * @return Return whether the assigned size of the actor should be used. If more than one dimension is requested, just return the first one found
 885    */
 886   bool GetUseAssignedSize( Dimension::Type dimension ) const;
 887
 888   /**
 889    * @copydoc Dali::Actor::SetResizePolicy()
 890    */
 891   void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 892
 893   /**
 894    * @copydoc Dali::Actor::GetResizePolicy()
 895    */
 896   ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
 897
 898   /**
 899    * @copydoc Dali::Actor::SetSizeScalePolicy()
 900    */
 901   void SetSizeScalePolicy( SizeScalePolicy::Type policy );
 902
 903   /**
 904    * @copydoc Dali::Actor::GetSizeScalePolicy()
 905    */
 906   SizeScalePolicy::Type GetSizeScalePolicy() const;
 907
 908   /**
 909    * @copydoc Dali::Actor::SetDimensionDependency()
 910    */
 911   void SetDimensionDependency( Dimension::Type dimension, Dimension::Type dependency );
 912
 913   /**
 914    * @copydoc Dali::Actor::GetDimensionDependency()
 915    */
 916   Dimension::Type GetDimensionDependency( Dimension::Type dimension ) const;
 917
 918   /**
 919    * @brief Set the size negotiation relayout enabled on this actor
 920    *
 921    * @param[in] relayoutEnabled Boolean to enable or disable relayout
 922    */
 923   void SetRelayoutEnabled( bool relayoutEnabled );
 924
 925   /**
 926    * @brief Return if relayout is enabled
 927    *
 928    * @return Return if relayout is enabled or not for this actor
 929    */
 930   bool IsRelayoutEnabled() const;
 931
 932   /**
 933    * @brief Mark an actor as having it's layout dirty
 934    *
 935    * @param dirty Whether to mark actor as dirty or not
 936    * @param dimension The dimension(s) to mark as dirty
 937    */
 938   void SetLayoutDirty( bool dirty, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 939
 940   /**
 941    * @brief Return if any of an actor's dimensions are marked as dirty
 942    *
 943    * @param dimension The dimension(s) to check
 944    * @return Return if any of the requested dimensions are dirty
 945    */
 946   bool IsLayoutDirty( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
 947
 948   /**
 949    * @brief Returns if relayout is enabled and the actor is not dirty
 950    *
 951    * @return Return if it is possible to relayout the actor
 952    */
 953   bool RelayoutPossible( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
 954
 955   /**
 956    * @brief Returns if relayout is enabled and the actor is dirty
 957    *
 958    * @return Return if it is required to relayout the actor
 959    */
 960   bool RelayoutRequired( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
 961
 962   /**
 963    * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene)
 964    *
 965    * This method is automatically called from OnStageConnection(), OnChildAdd(),
 966    * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize().
 967    *
 968    * This method can also be called from a derived class every time it needs a different size.
 969    * At the end of event processing, the relayout process starts and
 970    * all controls which requested Relayout will have their sizes (re)negotiated.
 971    *
 972    * @note RelayoutRequest() can be called multiple times; the size negotiation is still
 973    * only performed once, i.e. there is no need to keep track of this in the calling side.
 974    */
 975   void RelayoutRequest( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 976
 977   /**
 978    * @brief Determine if this actor is dependent on it's parent for relayout
 979    *
 980    * @param dimension The dimension(s) to check for
 981    * @return Return if the actor is dependent on it's parent
 982    */
 983   bool RelayoutDependentOnParent( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 984
 985   /**
 986    * @brief Determine if this actor has another dimension depedent on the specified one
 987    *
 988    * @param dimension The dimension to check for
 989    * @param dependentDimension The dimension to check for dependency with
 990    * @return Return if the actor is dependent on this dimension
 991    */
 992   bool RelayoutDependentOnDimension( Dimension::Type dimension, Dimension::Type dependentDimension );
 993
 994   /**
 995    * Negotiate sizes for a control in all dimensions
 996    *
 997    * @param[in] allocatedSize The size constraint that the control must respect
 998    */
 999   void NegotiateDimensions( const Vector2& allocatedSize );
1000
1001   /**
1002    * Negotiate size for a specific dimension
1003    *
1004    * The algorithm adopts a recursive dependency checking approach. Meaning, that wherever dependencies
1005    * are found, e.g. an actor dependent on its parent, the dependency will be calculated first with NegotiatedDimension and
1006    * LayoutDimensionNegotiated flags being filled in on the actor.
1007    *
1008    * @post All actors that exist in the dependency chain connected to the given actor will have had their NegotiatedDimensions
1009    * calculated and set as well as the LayoutDimensionNegotiated flags.
1010    *
1011    * @param[in] dimension The dimension to negotiate on
1012    * @param[in] allocatedSize The size constraint that the actor must respect
1013    */
1014   void NegotiateDimension( Dimension::Type dimension, const Vector2& allocatedSize, ActorDimensionStack& recursionStack );
1015
1016   /**
1017    * @brief Calculate the size of a dimension
1018    *
1019    * @param[in] dimension The dimension to calculate the size for
1020    * @param[in] maximumSize The upper bounds on the size
1021    * @return Return the calculated size for the dimension
1022    */
1023   float CalculateSize( Dimension::Type dimension, const Vector2& maximumSize );
1024
1025   /**
1026    * @brief Clamp a dimension given the relayout constraints on this actor
1027    *
1028    * @param[in] size The size to constrain
1029    * @param[in] dimension The dimension the size exists in
1030    * @return Return the clamped size
1031    */
1032   float ClampDimension( float size, Dimension::Type dimension );
1033
1034   /**
1035    * Negotiate a dimension based on the size of the parent
1036    *
1037    * @param[in] dimension The dimension to negotiate on
1038    * @return Return the negotiated size
1039    */
1040   float NegotiateFromParent( Dimension::Type dimension );
1041
1042   /**
1043    * Negotiate a dimension based on the size of the parent. Fitting inside.
1044    *
1045    * @param[in] dimension The dimension to negotiate on
1046    * @return Return the negotiated size
1047    */
1048   float NegotiateFromParentFit( Dimension::Type dimension );
1049
1050   /**
1051    * Negotiate a dimension based on the size of the parent. Flooding the whole space.
1052    *
1053    * @param[in] dimension The dimension to negotiate on
1054    * @return Return the negotiated size
1055    */
1056   float NegotiateFromParentFlood( Dimension::Type dimension );
1057
1058   /**
1059    * @brief Negotiate a dimension based on the size of the children
1060    *
1061    * @param[in] dimension The dimension to negotiate on
1062    * @return Return the negotiated size
1063    */
1064   float NegotiateFromChildren( Dimension::Type dimension );
1065
1066   /**
1067    * Set the negotiated dimension value for the given dimension(s)
1068    *
1069    * @param negotiatedDimension The value to set
1070    * @param dimension The dimension(s) to set the value for
1071    */
1072   void SetNegotiatedDimension( float negotiatedDimension, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1073
1074   /**
1075    * Return the value of negotiated dimension for the given dimension
1076    *
1077    * @param dimension The dimension to retrieve
1078    * @return Return the value of the negotiated dimension
1079    */
1080   float GetNegotiatedDimension( Dimension::Type dimension ) const;
1081
1082   /**
1083    * @brief Set the padding for a dimension
1084    *
1085    * @param[in] padding Padding for the dimension. X = start (e.g. left, bottom), y = end (e.g. right, top)
1086    * @param[in] dimension The dimension to set
1087    */
1088   void SetPadding( const Vector2& padding, Dimension::Type dimension );
1089
1090   /**
1091    * Return the value of padding for the given dimension
1092    *
1093    * @param dimension The dimension to retrieve
1094    * @return Return the value of padding for the dimension
1095    */
1096   Vector2 GetPadding( Dimension::Type dimension ) const;
1097
1098   /**
1099    * Return the actor size for a given dimension
1100    *
1101    * @param[in] dimension The dimension to retrieve the size for
1102    * @return Return the size for the given dimension
1103    */
1104   float GetSize( Dimension::Type dimension ) const;
1105
1106   /**
1107    * Return the natural size of the actor for a given dimension
1108    *
1109    * @param[in] dimension The dimension to retrieve the size for
1110    * @return Return the natural size for the given dimension
1111    */
1112   float GetNaturalSize( Dimension::Type dimension ) const;
1113
1114   /**
1115    * @brief Return the amount of size allocated for relayout
1116    *
1117    * May include padding
1118    *
1119    * @param[in] dimension The dimension to retrieve
1120    * @return Return the size
1121    */
1122   float GetRelayoutSize( Dimension::Type dimension ) const;
1123
1124   /**
1125    * @brief If the size has been negotiated return that else return normal size
1126    *
1127    * @param[in] dimension The dimension to retrieve
1128    * @return Return the size
1129    */
1130   float GetLatestSize( Dimension::Type dimension ) const;
1131
1132   /**
1133    * Apply the negotiated size to the actor
1134    *
1135    * @param[in] container The container to fill with actors that require further relayout
1136    */
1137   void SetNegotiatedSize( RelayoutContainer& container );
1138
1139   /**
1140    * @brief Flag the actor as having it's layout dimension negotiated.
1141    *
1142    * @param[in] negotiated The status of the flag to set.
1143    * @param[in] dimension The dimension to set the flag for
1144    */
1145   void SetLayoutNegotiated( bool negotiated, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1146
1147   /**
1148    * @brief Test whether the layout dimension for this actor has been negotiated or not.
1149    *
1150    * @param[in] dimension The dimension to determine the value of the flag for
1151    * @return Return if the layout dimension is negotiated or not.
1152    */
1153   bool IsLayoutNegotiated( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
1154
1155   /**
1156    * @brief provides the Actor implementation of GetHeightForWidth
1157    * @param width to use.
1158    * @return the height based on the width.
1159    */
1160   float GetHeightForWidthBase( float width );
1161
1162   /**
1163    * @brief provides the Actor implementation of GetWidthForHeight
1164    * @param height to use.
1165    * @return the width based on the height.
1166    */
1167   float GetWidthForHeightBase( float height );
1168
1169   /**
1170    * @brief Calculate the size for a child
1171    *
1172    * @param[in] child The child actor to calculate the size for
1173    * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
1174    * @return Return the calculated size for the given dimension
1175    */
1176   float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
1177
1178   /**
1179    * @brief Set the preferred size for size negotiation
1180    *
1181    * @param[in] size The preferred size to set
1182    */
1183   void SetPreferredSize( const Vector2& size );
1184
1185   /**
1186    * @brief Return the preferred size used for size negotiation
1187    *
1188    * @return Return the preferred size
1189    */
1190   Vector2 GetPreferredSize() const;
1191
1192   /**
1193    * @copydoc Dali::Actor::SetMinimumSize
1194    */
1195   void SetMinimumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1196
1197   /**
1198    * @copydoc Dali::Actor::GetMinimumSize
1199    */
1200   float GetMinimumSize( Dimension::Type dimension ) const;
1201
1202   /**
1203    * @copydoc Dali::Actor::SetMaximumSize
1204    */
1205   void SetMaximumSize( float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
1206
1207   /**
1208    * @copydoc Dali::Actor::GetMaximumSize
1209    */
1210   float GetMaximumSize( Dimension::Type dimension ) const;
1211
1212   /**
1213    * @copydoc Dali::Actor::AddRenderer()
1214    */
1215   unsigned int AddRenderer( Renderer& renderer );
1216
1217   /**
1218    * @copydoc Dali::Actor::GetRendererCount()
1219    */
1220   unsigned int GetRendererCount() const;
1221
1222   /**
1223    * @copydoc Dali::Actor::GetRendererAt()
1224    */
1225   RendererPtr GetRendererAt( unsigned int index );
1226
1227   /**
1228    * @copydoc Dali::Actor::RemoveRenderer()
1229    */
1230   void RemoveRenderer( Renderer& renderer );
1231
1232   /**
1233    * @copydoc Dali::Actor::RemoveRenderer()
1234    */
1235   void RemoveRenderer( unsigned int index );
1236
1237 public:
1238
1239   /**
1240    * Converts screen coordinates into the actor's coordinate system.
1241    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1242    * @param[out] localX On return, the X-coordinate relative to the actor.
1243    * @param[out] localY On return, the Y-coordinate relative to the actor.
1244    * @param[in] screenX The screen X-coordinate.
1245    * @param[in] screenY The screen Y-coordinate.
1246    * @return True if the conversion succeeded.
1247    */
1248   bool ScreenToLocal( float& localX, float& localY, float screenX, float screenY ) const;
1249
1250   /**
1251    * Converts screen coordinates into the actor's coordinate system.
1252    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1253    * @param[in] renderTask The render-task used to display the actor.
1254    * @param[out] localX On return, the X-coordinate relative to the actor.
1255    * @param[out] localY On return, the Y-coordinate relative to the actor.
1256    * @param[in] screenX The screen X-coordinate.
1257    * @param[in] screenY The screen Y-coordinate.
1258    * @return True if the conversion succeeded.
1259    */
1260   bool ScreenToLocal( const RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY ) const;
1261
1262   /**
1263    * Converts from the actor's coordinate system to screen coordinates.
1264    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1265    * @param[in] viewMatrix The view-matrix
1266    * @param[in] projectionMatrix The projection-matrix
1267    * @param[in] viewport The view-port
1268    * @param[out] localX On return, the X-coordinate relative to the actor.
1269    * @param[out] localY On return, the Y-coordinate relative to the actor.
1270    * @param[in] screenX The screen X-coordinate.
1271    * @param[in] screenY The screen Y-coordinate.
1272    * @return True if the conversion succeeded.
1273    */
1274   bool ScreenToLocal( const Matrix& viewMatrix,
1275                       const Matrix& projectionMatrix,
1276                       const Viewport& viewport,
1277                       float& localX,
1278                       float& localY,
1279                       float screenX,
1280                       float screenY ) const;
1281
1282   /**
1283    * Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere.
1284    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1285    * @param[in] rayOrigin The ray origin in the world's reference system.
1286    * @param[in] rayDir The ray director vector in the world's reference system.
1287    * @return True if the ray intersects the actor's bounding sphere.
1288    */
1289   bool RaySphereTest( const Vector4& rayOrigin, const Vector4& rayDir ) const;
1290
1291   /**
1292    * Performs a ray-actor test with the given pick-ray and the actor's geometry.
1293    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1294    * @param[in] rayOrigin The ray origin in the world's reference system.
1295    * @param[in] rayDir The ray director vector in the world's reference system.
1296    * @param[out] hitPointLocal The hit point in the Actor's local reference system.
1297    * @param[out] distance The distance from the hit point to the camera.
1298    * @return True if the ray intersects the actor's geometry.
1299    */
1300   bool RayActorTest( const Vector4& rayOrigin,
1301                      const Vector4& rayDir,
1302                      Vector2& hitPointLocal,
1303                      float& distance ) const;
1304
1305   /**
1306    * Sets whether the actor should receive a notification when touch or hover motion events leave
1307    * the boundary of the actor.
1308    *
1309    * @note By default, this is set to false as most actors do not require this.
1310    * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
1311    *
1312    * @param[in]  required  Should be set to true if a Leave event is required
1313    */
1314   void SetLeaveRequired( bool required );
1315
1316   /**
1317    * This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1318    * the boundary of the actor.
1319    * @return true if a Leave event is required, false otherwise.
1320    */
1321   bool GetLeaveRequired() const;
1322
1323   /**
1324    * @copydoc Dali::Actor::SetKeyboardFocusable()
1325    */
1326   void SetKeyboardFocusable( bool focusable );
1327
1328   /**
1329    * @copydoc Dali::Actor::IsKeyboardFocusable()
1330    */
1331   bool IsKeyboardFocusable() const;
1332
1333   /**
1334    * Query whether the application or derived actor type requires touch events.
1335    * @return True if touch events are required.
1336    */
1337   bool GetTouchRequired() const;
1338
1339   /**
1340    * Query whether the application or derived actor type requires hover events.
1341    * @return True if hover events are required.
1342    */
1343   bool GetHoverRequired() const;
1344
1345   /**
1346    * Query whether the application or derived actor type requires wheel events.
1347    * @return True if wheel events are required.
1348    */
1349   bool GetWheelEventRequired() const;
1350
1351   /**
1352    * Query whether the actor is actually hittable.  This method checks whether the actor is
1353    * sensitive, has the visibility flag set to true and is not fully transparent.
1354    * @return true, if it can be hit, false otherwise.
1355    */
1356   bool IsHittable() const;
1357
1358   // Gestures
1359
1360   /**
1361    * Retrieve the gesture data associated with this actor. The first call to this method will
1362    * allocate space for the ActorGestureData so this should only be called if an actor really does
1363    * require gestures.
1364    * @return Reference to the ActorGestureData for this actor.
1365    * @note Once the gesture-data is created for an actor it is likely that gestures are required
1366    * throughout the actor's lifetime so it will only be deleted when the actor is destroyed.
1367    */
1368   ActorGestureData& GetGestureData();
1369
1370   /**
1371    * Queries whether the actor requires the gesture type.
1372    * @param[in] type The gesture type.
1373    */
1374   bool IsGestureRequred( Gesture::Type type ) const;
1375
1376   // Signals
1377
1378   /**
1379    * Used by the EventProcessor to emit touch event signals.
1380    * @param[in] event The touch event (Old API).
1381    * @param[in] touch The touch data.
1382    * @return True if the event was consumed.
1383    */
1384   bool EmitTouchEventSignal( const TouchEvent& event, const Dali::TouchData& touch );
1385
1386   /**
1387    * Used by the EventProcessor to emit hover event signals.
1388    * @param[in] event The hover event.
1389    * @return True if the event was consumed.
1390    */
1391   bool EmitHoverEventSignal( const HoverEvent& event );
1392
1393   /**
1394    * Used by the EventProcessor to emit wheel event signals.
1395    * @param[in] event The wheel event.
1396    * @return True if the event was consumed.
1397    */
1398   bool EmitWheelEventSignal( const WheelEvent& event );
1399
1400   /**
1401    * @copydoc Dali::Actor::TouchedSignal()
1402    */
1403   Dali::Actor::TouchSignalType& TouchedSignal();
1404
1405   /**
1406    * @copydoc Dali::Actor::TouchEventSignal()
1407    */
1408   Dali::Actor::TouchDataSignalType& TouchSignal();
1409
1410   /**
1411    * @copydoc Dali::Actor::HoveredSignal()
1412    */
1413   Dali::Actor::HoverSignalType& HoveredSignal();
1414
1415   /**
1416    * @copydoc Dali::Actor::WheelEventSignal()
1417    */
1418   Dali::Actor::WheelEventSignalType& WheelEventSignal();
1419
1420   /**
1421    * @copydoc Dali::Actor::OnStageSignal()
1422    */
1423   Dali::Actor::OnStageSignalType& OnStageSignal();
1424
1425   /**
1426    * @copydoc Dali::Actor::OffStageSignal()
1427    */
1428   Dali::Actor::OffStageSignalType& OffStageSignal();
1429
1430   /**
1431    * @copydoc Dali::Actor::OnRelayoutSignal()
1432    */
1433   Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal();
1434
1435   /**
1436    * Connects a callback function with the object's signals.
1437    * @param[in] object The object providing the signal.
1438    * @param[in] tracker Used to disconnect the signal.
1439    * @param[in] signalName The signal to connect to.
1440    * @param[in] functor A newly allocated FunctorDelegate.
1441    * @return True if the signal was connected.
1442    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
1443    */
1444   static bool DoConnectSignal( BaseObject* object,
1445                                ConnectionTrackerInterface* tracker,
1446                                const std::string& signalName,
1447                                FunctorDelegate* functor );
1448
1449   /**
1450    * Performs actions as requested using the action name.
1451    * @param[in] object The object on which to perform the action.
1452    * @param[in] actionName The action to perform.
1453    * @param[in] attributes The attributes with which to perfrom this action.
1454    * @return true if the action was done.
1455    */
1456   static bool DoAction( BaseObject* object,
1457                         const std::string& actionName,
1458                         const Property::Map& attributes );
1459
1460 public:
1461   // For Animation
1462
1463   /**
1464    * This should only be called by Animation, when the actors SIZE property is animated.
1465    *
1466    * @param[in] animation The animation that resized the actor
1467    * @param[in] targetSize The new target size of the actor
1468    */
1469   void NotifySizeAnimation( Animation& animation, const Vector3& targetSize );
1470
1471   /**
1472    * This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT or SIZE_DEPTH property is animated.
1473    *
1474    * @param[in] animation The animation that resized the actor
1475    * @param[in] targetSize The new target size of the actor
1476    * @param[in] property The index of the property being animated
1477    */
1478   void NotifySizeAnimation( Animation& animation, float targetSize, Property::Index property );
1479
1480   /**
1481    * For use in derived classes.
1482    * This should only be called by Animation, when the actor is resized using Animation::Resize().
1483    */
1484   virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize )
1485   {
1486   }
1487
1488   /**
1489    * This should only be called by Animation, when the actors POSITION property is animated.
1490    *
1491    * @param[in] animation The animation that repositioned the actor
1492    * @param[in] targetPosition The new target position of the actor
1493    */
1494   void NotifyPositionAnimation( Animation& animation, const Vector3& targetPosition );
1495
1496   /**
1497    * This should only be called by Animation, when the actors POSITION_X or POSITION_Y or POSITION_Z property is animated.
1498    *
1499    * @param[in] animation The animation that repositioned the actor
1500    * @param[in] targetPosition The new target position of the actor
1501    * @param[in] property The index of the property being animated
1502    */
1503   void NotifyPositionAnimation( Animation& animation, float targetPosition, Property::Index property );
1504
1505 protected:
1506
1507   enum DerivedType
1508   {
1509     BASIC, LAYER, ROOT_LAYER
1510   };
1511
1512   /**
1513    * Protected Constructor.  See Actor::New().
1514    * The second-phase construction Initialize() member should be called immediately after this.
1515    * @param[in] derivedType The derived type of actor (if any).
1516    */
1517   Actor( DerivedType derivedType );
1518
1519   /**
1520    * Second-phase constructor. Must be called immediately after creating a new Actor;
1521    */
1522   void Initialize( void );
1523
1524   /**
1525    * A reference counted object may only be deleted by calling Unreference()
1526    */
1527   virtual ~Actor();
1528
1529   /**
1530    * Called on a child during Add() when the parent actor is connected to the Stage.
1531    * @param[in] parentDepth The depth of the parent in the hierarchy.
1532    */
1533   void ConnectToStage( unsigned int parentDepth );
1534
1535   /**
1536    * Helper for ConnectToStage, to recursively connect a tree of actors.
1537    * This is atomic i.e. not interrupted by user callbacks.
1538    * @param[in]  depth The depth in the hierarchy of the actor
1539    * @param[out] connectionList On return, the list of connected actors which require notification.
1540    */
1541   void RecursiveConnectToStage( ActorContainer& connectionList, unsigned int depth );
1542
1543   /**
1544    * Connect the Node associated with this Actor to the scene-graph.
1545    */
1546   void ConnectToSceneGraph();
1547
1548   /**
1549    * Helper for ConnectToStage, to notify a connected actor through the public API.
1550    */
1551   void NotifyStageConnection();
1552
1553   /**
1554    * Called on a child during Remove() when the actor was previously on the Stage.
1555    */
1556   void DisconnectFromStage();
1557
1558   /**
1559    * Helper for DisconnectFromStage, to recursively disconnect a tree of actors.
1560    * This is atomic i.e. not interrupted by user callbacks.
1561    * @param[out] disconnectionList On return, the list of disconnected actors which require notification.
1562    */
1563   void RecursiveDisconnectFromStage( ActorContainer& disconnectionList );
1564
1565   /**
1566    * Disconnect the Node associated with this Actor from the scene-graph.
1567    */
1568   void DisconnectFromSceneGraph();
1569
1570   /**
1571    * Helper for DisconnectFromStage, to notify a disconnected actor through the public API.
1572    */
1573   void NotifyStageDisconnection();
1574
1575   /**
1576    * When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph.
1577    * @return True if the Actor is OnStage & has a Node connected to the scene graph.
1578    */
1579   bool IsNodeConnected() const;
1580
1581 public:
1582
1583   // Default property extensions from Object
1584
1585   /**
1586    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
1587    */
1588   virtual unsigned int GetDefaultPropertyCount() const;
1589
1590   /**
1591    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
1592    */
1593   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
1594
1595   /**
1596    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
1597    */
1598   virtual const char* GetDefaultPropertyName( Property::Index index ) const;
1599
1600   /**
1601    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
1602    */
1603   virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const;
1604
1605   /**
1606    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
1607    */
1608   virtual bool IsDefaultPropertyWritable( Property::Index index ) const;
1609
1610   /**
1611    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
1612    */
1613   virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const;
1614
1615   /**
1616    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
1617    */
1618   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
1619
1620   /**
1621    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
1622    */
1623   virtual Property::Type GetDefaultPropertyType( Property::Index index ) const;
1624
1625   /**
1626    * @copydoc Dali::Internal::Object::SetDefaultProperty()
1627    */
1628   virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
1629
1630   /**
1631    * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
1632    */
1633   virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
1634
1635   /**
1636    * @copydoc Dali::Internal::Object::GetDefaultProperty()
1637    */
1638   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
1639
1640   /**
1641    * @copydoc Dali::Internal::Object::GetPropertyOwner()
1642    */
1643   virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
1644
1645   /**
1646    * @copydoc Dali::Internal::Object::GetSceneObject()
1647    */
1648   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
1649
1650   /**
1651    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
1652    */
1653   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
1654
1655   /**
1656    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
1657    */
1658   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
1659
1660   /**
1661    * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
1662    */
1663   virtual int GetPropertyComponentIndex( Property::Index index ) const;
1664
1665 private:
1666
1667   // Undefined
1668   Actor();
1669
1670   // Undefined
1671   Actor( const Actor& );
1672
1673   // Undefined
1674   Actor& operator=( const Actor& rhs );
1675
1676   /**
1677    * Set the actors parent.
1678    * @param[in] parent The new parent.
1679    */
1680   void SetParent( Actor* parent );
1681
1682   /**
1683    * Helper to create a Node for this Actor.
1684    * To be overriden in derived classes.
1685    * @return A newly allocated node.
1686    */
1687   virtual SceneGraph::Node* CreateNode() const;
1688
1689   /**
1690    * For use in derived classes, called after Initialize()
1691    */
1692   virtual void OnInitialize()
1693   {
1694   }
1695
1696   /**
1697    * For use in internal derived classes.
1698    * This is called during ConnectToStage(), after the actor has finished adding its node to the scene-graph.
1699    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1700    */
1701   virtual void OnStageConnectionInternal()
1702   {
1703   }
1704
1705   /**
1706    * For use in internal derived classes.
1707    * This is called during DisconnectFromStage(), before the actor removes its node from the scene-graph.
1708    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1709    */
1710   virtual void OnStageDisconnectionInternal()
1711   {
1712   }
1713
1714   /**
1715    * For use in external (CustomActor) derived classes.
1716    * This is called after the atomic ConnectToStage() traversal has been completed.
1717    */
1718   virtual void OnStageConnectionExternal( int depth )
1719   {
1720   }
1721
1722   /**
1723    * For use in external (CustomActor) derived classes.
1724    * This is called after the atomic DisconnectFromStage() traversal has been completed.
1725    */
1726   virtual void OnStageDisconnectionExternal()
1727   {
1728   }
1729
1730   /**
1731    * For use in derived classes; this is called after Add() has added a child.
1732    * @param[in] child The child that was added.
1733    */
1734   virtual void OnChildAdd( Actor& child )
1735   {
1736   }
1737
1738   /**
1739    * For use in derived classes; this is called after Remove() has attempted to remove a child( regardless of whether it succeeded or not ).
1740    * @param[in] child The child that was removed.
1741    */
1742   virtual void OnChildRemove( Actor& child )
1743   {
1744   }
1745
1746   /**
1747    * For use in derived classes.
1748    * This is called after SizeSet() has been called.
1749    */
1750   virtual void OnSizeSet( const Vector3& targetSize )
1751   {
1752   }
1753
1754   /**
1755    * For use in derived classes.
1756    * This is only called if mDerivedRequiresTouch is true, and the touch-signal was not consumed.
1757    * @param[in] event The touch event.
1758    * @return True if the event should be consumed.
1759    */
1760   virtual bool OnTouchEvent( const TouchEvent& event )
1761   {
1762     return false;
1763   }
1764
1765   /**
1766    * For use in derived classes.
1767    * This is only called if mDerivedRequiresHover is true, and the hover-signal was not consumed.
1768    * @param[in] event The hover event.
1769    * @return True if the event should be consumed.
1770    */
1771   virtual bool OnHoverEvent( const HoverEvent& event )
1772   {
1773     return false;
1774   }
1775
1776   /**
1777    * For use in derived classes.
1778    * This is only called if the wheel signal was not consumed.
1779    * @param[in] event The wheel event.
1780    * @return True if the event should be consumed.
1781    */
1782   virtual bool OnWheelEvent( const WheelEvent& event )
1783   {
1784     return false;
1785   }
1786
1787   /**
1788    * @brief Ensure the relayout data is allocated
1789    */
1790   void EnsureRelayoutData();
1791
1792   /**
1793    * @brief Apply the size set policy to the input size
1794    *
1795    * @param[in] size The size to apply the policy to
1796    * @return Return the adjusted size
1797    */
1798   Vector2 ApplySizeSetPolicy( const Vector2 size );
1799
1800   /**
1801    * Retrieve the parent object of an Actor.
1802    * @return The parent object, or NULL if the Actor does not have a parent.
1803    */
1804   virtual Object* GetParentObject() const;
1805
1806 protected:
1807
1808   Actor* mParent;                 ///< Each actor (except the root) can have one parent
1809   ActorContainer* mChildren;      ///< Container of referenced actors
1810   RendererContainer* mRenderers;   ///< Renderer container
1811
1812   const SceneGraph::Node* mNode;  ///< Not owned
1813   Vector3* mParentOrigin;         ///< NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable
1814   Vector3* mAnchorPoint;          ///< NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable
1815
1816   struct RelayoutData;
1817   RelayoutData* mRelayoutData; ///< Struct to hold optional collection of relayout variables
1818
1819   ActorGestureData* mGestureData;   ///< Optional Gesture data. Only created when actor requires gestures
1820
1821   // Signals
1822   Dali::Actor::TouchSignalType             mTouchedSignal;
1823   Dali::Actor::TouchDataSignalType         mTouchSignal;
1824   Dali::Actor::HoverSignalType             mHoveredSignal;
1825   Dali::Actor::WheelEventSignalType        mWheelEventSignal;
1826   Dali::Actor::OnStageSignalType           mOnStageSignal;
1827   Dali::Actor::OffStageSignalType          mOffStageSignal;
1828   Dali::Actor::OnRelayoutSignalType        mOnRelayoutSignal;
1829
1830   Vector3         mTargetSize;       ///< Event-side storage for size (not a pointer as most actors will have a size)
1831   Vector3         mTargetPosition;   ///< Event-side storage for position (not a pointer as most actors will have a position)
1832
1833   std::string     mName;      ///< Name of the actor
1834   unsigned int    mId;        ///< A unique ID to identify the actor starting from 1, and 0 is reserved
1835
1836   uint16_t mDepth;            ///< The depth in the hierarchy of the actor. Only 4096 levels of depth are supported
1837   uint16_t mSiblingOrder;     ///< The sibling order of the actor
1838
1839   const bool mIsRoot                               : 1; ///< Flag to identify the root actor
1840   const bool mIsLayer                              : 1; ///< Flag to identify that this is a layer
1841   bool mIsOnStage                                  : 1; ///< Flag to identify whether the actor is on-stage
1842   bool mSensitive                                  : 1; ///< Whether the actor emits touch event signals
1843   bool mLeaveRequired                              : 1; ///< Whether a touch event signal is emitted when the a touch leaves the actor's bounds
1844   bool mKeyboardFocusable                          : 1; ///< Whether the actor should be focusable by keyboard navigation
1845   bool mDerivedRequiresTouch                       : 1; ///< Whether the derived actor type requires touch event signals
1846   bool mDerivedRequiresHover                       : 1; ///< Whether the derived actor type requires hover event signals
1847   bool mDerivedRequiresWheelEvent                  : 1; ///< Whether the derived actor type requires wheel event signals
1848   bool mOnStageSignalled                           : 1; ///< Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection
1849   bool mInsideOnSizeSet                            : 1; ///< Whether we are inside OnSizeSet
1850   bool mInheritPosition                            : 1; ///< Cached: Whether the parent's position should be inherited.
1851   bool mInheritOrientation                         : 1; ///< Cached: Whether the parent's orientation should be inherited.
1852   bool mInheritScale                               : 1; ///< Cached: Whether the parent's scale should be inherited.
1853   DrawMode::Type mDrawMode                         : 2; ///< Cached: How the actor and its children should be drawn
1854   PositionInheritanceMode mPositionInheritanceMode : 2; ///< Cached: Determines how position is inherited
1855   ColorMode mColorMode                             : 2; ///< Cached: Determines whether mWorldColor is inherited
1856   ClippingMode::Type mClippingMode                 : 2; ///< Cached: Determines which clipping mode (if any) to use.
1857
1858 private:
1859
1860   static ActorContainer mNullChildren;  ///< Empty container (shared by all actors, returned by GetChildren() const)
1861   static unsigned int mActorCounter;    ///< A counter to track the actor instance creation
1862
1863 };
1864
1865 } // namespace Internal
1866
1867 // Helpers for public-api forwarding methods
1868
1869 inline Internal::Actor& GetImplementation( Dali::Actor& actor )
1870 {
1871   DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1872
1873   BaseObject& handle = actor.GetBaseObject();
1874
1875   return static_cast< Internal::Actor& >( handle );
1876 }
1877
1878 inline const Internal::Actor& GetImplementation( const Dali::Actor& actor )
1879 {
1880   DALI_ASSERT_ALWAYS( actor && "Actor handle is empty" );
1881
1882   const BaseObject& handle = actor.GetBaseObject();
1883
1884   return static_cast< const Internal::Actor& >( handle );
1885 }
1886
1887 } // namespace Dali
1888
1889 #endif // DALI_INTERNAL_ACTOR_H