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

   1 #ifndef DALI_INTERNAL_ACTOR_H
   2 #define DALI_INTERNAL_ACTOR_H
   3
   4 /*
   5  * Copyright (c) 2021 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/devel-api/actors/actor-devel.h>
  26 #include <dali/devel-api/rendering/renderer-devel.h>
  27 #include <dali/internal/common/const-string.h>
  28 #include <dali/internal/common/internal-constants.h>
  29 #include <dali/internal/common/memory-pool-object-allocator.h>
  30 #include <dali/internal/event/actors/actor-declarations.h>
  31 #include <dali/internal/event/actors/actor-parent-impl.h>
  32 #include <dali/internal/event/actors/actor-parent.h>
  33 #include <dali/internal/event/actors/actor-renderer-container.h>
  34 #include <dali/internal/event/common/object-impl.h>
  35 #include <dali/internal/event/common/stage-def.h>
  36 #include <dali/internal/update/nodes/node-declarations.h>
  37 #include <dali/public-api/actors/actor.h>
  38 #include <dali/public-api/common/dali-common.h>
  39 #include <dali/public-api/common/vector-wrapper.h>
  40 #include <dali/public-api/events/gesture.h>
  41 #include <dali/public-api/math/viewport.h>
  42 #include <dali/public-api/object/ref-object.h>
  43 #include <dali/public-api/size-negotiation/relayout-container.h>
  44
  45 namespace Dali
  46 {
  47 class KeyEvent;
  48 class TouchData;
  49 class TouchEvent;
  50 class WheelEvent;
  51
  52 namespace Internal
  53 {
  54 class Actor;
  55 class ActorGestureData;
  56 class Animation;
  57 class RenderTask;
  58 class Renderer;
  59 class Scene;
  60
  61 class ActorDepthTreeNode;
  62 using DepthNodeMemoryPool = Dali::Internal::MemoryPoolObjectAllocator<ActorDepthTreeNode>;
  63
  64 /**
  65  * Actor is the primary object with which Dali applications interact.
  66  * UI controls can be built by combining multiple actors.
  67  * Multi-Touch events are received through signals emitted by the actor tree.
  68  *
  69  * An Actor is a proxy for a Node in the scene graph.
  70  * When an Actor is added to the Stage, it creates a node and connects it to the scene graph.
  71  * The scene-graph can be updated in a separate thread, so the connection is done using an asynchronous message.
  72  * When a tree of Actors is detached from the Stage, a message is sent to destroy the associated nodes.
  73  */
  74 class Actor : public Object, public ActorParent
  75 {
  76 public:
  77   /**
  78    * @brief Struct to hold an actor and a dimension
  79    */
  80   struct ActorDimensionPair
  81   {
  82     /**
  83      * @brief Constructor
  84      *
  85      * @param[in] newActor The actor to assign
  86      * @param[in] newDimension The dimension to assign
  87      */
  88     ActorDimensionPair(Actor* newActor, Dimension::Type newDimension)
  89     : actor(newActor),
  90       dimension(newDimension)
  91     {
  92     }
  93
  94     /**
  95      * @brief Equality operator
  96      *
  97      * @param[in] lhs The left hand side argument
  98      * @param[in] rhs The right hand side argument
  99      */
 100     bool operator==(const ActorDimensionPair& rhs)
 101     {
 102       return (actor == rhs.actor) && (dimension == rhs.dimension);
 103     }
 104
 105     Actor*          actor;     ///< The actor to hold
 106     Dimension::Type dimension; ///< The dimension to hold
 107   };
 108
 109   using ActorDimensionStack = std::vector<ActorDimensionPair>;
 110
 111 public:
 112   /**
 113    * Create a new actor.
 114    * @return A smart-pointer to the newly allocated Actor.
 115    */
 116   static ActorPtr New();
 117
 118   /**
 119    * Helper to create node for derived classes who don't have their own node type
 120    * @return pointer to newly created unique node
 121    */
 122   static const SceneGraph::Node* CreateNode();
 123
 124   /**
 125    * Retrieve the name of the actor.
 126    * @return The name.
 127    */
 128   std::string_view GetName() const
 129   {
 130     return mName.GetStringView();
 131   }
 132
 133   /**
 134    * Set the name of the actor.
 135    * @param[in] name The new name.
 136    */
 137   void SetName(std::string_view name);
 138
 139   /**
 140    * @copydoc Dali::Actor::GetId
 141    */
 142   uint32_t GetId() const;
 143
 144   // Containment
 145
 146   /**
 147    * Query whether an actor is the root actor, which is owned by the Stage.
 148    * @return True if the actor is a root actor.
 149    */
 150   bool IsRoot() const
 151   {
 152     return mIsRoot;
 153   }
 154
 155   /**
 156    * Query whether the actor is connected to the Scene.
 157    */
 158   bool OnScene() const
 159   {
 160     return mIsOnScene;
 161   }
 162
 163   /**
 164    * Query whether the actor has any renderers.
 165    * @return True if the actor is renderable.
 166    */
 167   bool IsRenderable() const
 168   {
 169     // inlined as this is called a lot in hit testing
 170     return mRenderers && !mRenderers->IsEmpty();
 171   }
 172
 173   /**
 174    * Query whether the actor is of class Dali::Layer
 175    * @return True if the actor is a layer.
 176    */
 177   bool IsLayer() const
 178   {
 179     // inlined as this is called a lot in hit testing
 180     return mIsLayer;
 181   }
 182
 183   /**
 184    * Gets the layer in which the actor is present
 185    * @return The layer, which will be uninitialized if the actor is off-stage.
 186    */
 187   Dali::Layer GetLayer();
 188
 189   /**
 190    * @copydoc Dali::Internal::ActorParent::Add()
 191    */
 192   void Add(Actor& child, bool notify = true) override;
 193
 194   /**
 195    * @copydoc Dali::Internal::ActorParent::Remove()
 196    */
 197   void Remove(Actor& child, bool notify = true) override;
 198
 199   /**
 200    * @copydoc Dali::DevelActor::SwitchParent()
 201    */
 202   void SwitchParent(Actor& newParent);
 203
 204   /**
 205    * @copydoc Dali::Actor::Unparent
 206    */
 207   void Unparent();
 208
 209   /**
 210    * @copydoc Dali::Internal::ActorParent::GetChildCount()
 211    */
 212   uint32_t GetChildCount() const override;
 213
 214   /**
 215    * @copydoc Dali::Internal::ActorParent::GetChildAt
 216    */
 217   ActorPtr GetChildAt(uint32_t index) const override;
 218
 219   /**
 220    * Retrieve a reference to Actor's children.
 221    * @note Not for public use.
 222    * @return A reference to the container of children.
 223    * @note The internal container is lazily initialized so ensure you check the child count before using the value returned by this method.
 224    */
 225   ActorContainer& GetChildrenInternal();
 226
 227   /**
 228    * @copydoc Dali::Internal::ActorParent::FindChildByName
 229    */
 230   ActorPtr FindChildByName(ConstString actorName) override;
 231
 232   /**
 233    * @copydoc Dali::Internal::ActorParent::FindChildById
 234    */
 235   ActorPtr FindChildById(const uint32_t id) override;
 236
 237   /**
 238    * @copydoc Dali::Internal::ActorParent::UnparentChildren
 239    */
 240   void UnparentChildren() override;
 241
 242   /**
 243    * Retrieve the parent of an Actor.
 244    * @return The parent actor, or NULL if the Actor does not have a parent.
 245    */
 246   Actor* GetParent() const
 247   {
 248     return static_cast<Actor*>(mParent);
 249   }
 250
 251   /**
 252    * Calculates screen position and size.
 253    *
 254    * @return pair of two values, position of top-left corner on screen and size respectively.
 255    */
 256   Rect<> CalculateScreenExtents() const;
 257
 258   /**
 259    * @copydoc DevelActor::SetNeedGesturePropagation.
 260    */
 261   void SetNeedGesturePropagation(bool propagation);
 262
 263   /**
 264    * Retrieve need gesture propagation value
 265    * @return The actor's need gesture propagation value.
 266    */
 267   bool NeedGesturePropagation();
 268
 269   /**
 270    * Sets the size of an actor.
 271    * This does not interfere with the actors scale factor.
 272    * @param [in] width  The new width.
 273    * @param [in] height The new height.
 274    */
 275   void SetSize(float width, float height);
 276
 277   /**
 278    * Sets the size of an actor.
 279    * This does not interfere with the actors scale factor.
 280    * @param [in] width The size of the actor along the x-axis.
 281    * @param [in] height The size of the actor along the y-axis.
 282    * @param [in] depth The size of the actor along the z-axis.
 283    */
 284   void SetSize(float width, float height, float depth);
 285
 286   /**
 287    * Sets the size of an actor.
 288    * This does not interfere with the actors scale factor.
 289    * @param [in] size The new size.
 290    */
 291   void SetSize(const Vector2& size);
 292
 293   /**
 294    * Sets the update size for an actor.
 295    *
 296    * @param[in] size The size to set.
 297    */
 298   void SetSizeInternal(const Vector2& size);
 299
 300   /**
 301    * Sets the size of an actor.
 302    * This does not interfere with the actors scale factor.
 303    * @param [in] size The new size.
 304    */
 305   void SetSize(const Vector3& size);
 306
 307   /**
 308    * Sets the update size for an actor.
 309    *
 310    * @param[in] size The size to set.
 311    */
 312   void SetSizeInternal(const Vector3& size);
 313
 314   /**
 315    * Set the width component of the Actor's size.
 316    * @param [in] width The new width component.
 317    */
 318   void SetWidth(float width);
 319
 320   /**
 321    * Set the height component of the Actor's size.
 322    * @param [in] height The new height component.
 323    */
 324   void SetHeight(float height);
 325
 326   /**
 327    * Set the depth component of the Actor's size.
 328    * @param [in] depth The new depth component.
 329    */
 330   void SetDepth(float depth);
 331
 332   /**
 333    * Retrieve the Actor's size from event side.
 334    * This size will be the size set or if animating then the target size.
 335    * @return The Actor's size.
 336    */
 337   Vector3 GetTargetSize() const;
 338
 339   /**
 340    * Retrieve the Actor's size from update side.
 341    * This size will be the size set or animating but will be a frame behind.
 342    * @return The Actor's size.
 343    */
 344   const Vector3& GetCurrentSize() const;
 345
 346   /**
 347    * Return the natural size of the actor
 348    *
 349    * @return The actor's natural size
 350    */
 351   virtual Vector3 GetNaturalSize() const;
 352
 353   /**
 354    * Set the origin of an actor, within its parent's area.
 355    * This is expressed in 2D unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
 356    * and (1.0, 1.0, 0.5) is the bottom-right corner.
 357    * The default parent-origin is top-left (0.0, 0.0, 0.5).
 358    * An actor position is the distance between this origin, and the actors anchor-point.
 359    * @param [in] origin The new parent-origin.
 360    */
 361   void SetParentOrigin(const Vector3& origin);
 362
 363   /**
 364    * Retrieve the parent-origin of an actor.
 365    * @return The parent-origin.
 366    */
 367   const Vector3& GetCurrentParentOrigin() const;
 368
 369   /**
 370    * Set the anchor-point of an actor. This is expressed in 2D unit coordinates, such that
 371    * (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.
 372    * The default anchor point is top-left (0.0, 0.0, 0.5).
 373    * An actor position is the distance between its parent-origin, and this anchor-point.
 374    * An actor's rotation is centered around its anchor-point.
 375    * @param [in] anchorPoint The new anchor-point.
 376    */
 377   void SetAnchorPoint(const Vector3& anchorPoint);
 378
 379   /**
 380    * Retrieve the anchor-point of an actor.
 381    * @return The anchor-point.
 382    */
 383   const Vector3& GetCurrentAnchorPoint() const;
 384
 385   /**
 386    * Sets the position of the Actor.
 387    * The coordinates are relative to the Actor's parent.
 388    * The Actor's z position will be set to 0.0f.
 389    * @param [in] x The new x position
 390    * @param [in] y The new y position
 391    */
 392   void SetPosition(float x, float y);
 393
 394   /**
 395    * Sets the position of the Actor.
 396    * The coordinates are relative to the Actor's parent.
 397    * @param [in] x The new x position
 398    * @param [in] y The new y position
 399    * @param [in] z The new z position
 400    */
 401   void SetPosition(float x, float y, float z);
 402
 403   /**
 404    * Sets the position of the Actor.
 405    * The coordinates are relative to the Actor's parent.
 406    * @param [in] position The new position.
 407    */
 408   void SetPosition(const Vector3& position);
 409
 410   /**
 411    * Set the position of an actor along the X-axis.
 412    * @param [in] x The new x position
 413    */
 414   void SetX(float x);
 415
 416   /**
 417    * Set the position of an actor along the Y-axis.
 418    * @param [in] y The new y position.
 419    */
 420   void SetY(float y);
 421
 422   /**
 423    * Set the position of an actor along the Z-axis.
 424    * @param [in] z The new z position
 425    */
 426   void SetZ(float z);
 427
 428   /**
 429    * Translate an actor relative to its existing position.
 430    * @param[in] distance The actor will move by this distance.
 431    */
 432   void TranslateBy(const Vector3& distance);
 433
 434   /**
 435    * Retrieve the position of the Actor.
 436    * The coordinates are relative to the Actor's parent.
 437    * @return the Actor's position.
 438    */
 439   const Vector3& GetCurrentPosition() const;
 440
 441   /**
 442    * Retrieve the target position of the Actor.
 443    * The coordinates are relative to the Actor's parent.
 444    * @return the Actor's position.
 445    */
 446   const Vector3& GetTargetPosition() const
 447   {
 448     return mTargetPosition;
 449   }
 450
 451   /**
 452    * @copydoc Dali::Actor::GetCurrentWorldPosition()
 453    */
 454   const Vector3& GetCurrentWorldPosition() const;
 455
 456   /**
 457    * @copydoc Dali::Actor::SetInheritPosition()
 458    */
 459   void SetInheritPosition(bool inherit);
 460
 461   /**
 462    * @copydoc Dali::Actor::IsPositionInherited()
 463    */
 464   bool IsPositionInherited() const
 465   {
 466     return mInheritPosition;
 467   }
 468
 469   /**
 470    * Sets the orientation of the Actor.
 471    * @param [in] angleRadians The new orientation angle in radians.
 472    * @param [in] axis The new axis of orientation.
 473    */
 474   void SetOrientation(const Radian& angleRadians, const Vector3& axis);
 475
 476   /**
 477    * Sets the orientation of the Actor.
 478    * @param [in] orientation The new orientation.
 479    */
 480   void SetOrientation(const Quaternion& orientation);
 481
 482   /**
 483    * Rotate an actor around its existing rotation axis.
 484    * @param[in] angleRadians The angle to the rotation to combine with the existing rotation.
 485    * @param[in] axis The axis of the rotation to combine with the existing rotation.
 486    */
 487   void RotateBy(const Radian& angleRadians, const Vector3& axis);
 488
 489   /**
 490    * Apply a relative rotation to an actor.
 491    * @param[in] relativeRotation The rotation to combine with the actors existing rotation.
 492    */
 493   void RotateBy(const Quaternion& relativeRotation);
 494
 495   /**
 496    * Retreive the Actor's orientation.
 497    * @return the orientation.
 498    */
 499   const Quaternion& GetCurrentOrientation() const;
 500
 501   /**
 502    * Set whether a child actor inherits it's parent's orientation. Default is to inherit.
 503    * Switching this off means that using SetOrientation() sets the actor's world orientation.
 504    * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
 505    */
 506   void SetInheritOrientation(bool inherit);
 507
 508   /**
 509    * Returns whether the actor inherit's it's parent's orientation.
 510    * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
 511    */
 512   bool IsOrientationInherited() const
 513   {
 514     return mInheritOrientation;
 515   }
 516
 517   /**
 518    * Sets the factor of the parents size used for the child actor.
 519    * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
 520    * @param[in] factor The vector to multiply the parents size by to get the childs size.
 521    */
 522   void SetSizeModeFactor(const Vector3& factor);
 523
 524   /**
 525    * Gets the factor of the parents size used for the child actor.
 526    * Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
 527    * @return The vector being used to multiply the parents size by to get the childs size.
 528    */
 529   const Vector3& GetSizeModeFactor() const;
 530
 531   /**
 532    * @copydoc Dali::Actor::GetCurrentWorldOrientation()
 533    */
 534   const Quaternion& GetCurrentWorldOrientation() const;
 535
 536   /**
 537    * Sets a scale factor applied to an actor.
 538    * @param [in] scale The scale factor applied on all axes.
 539    */
 540   void SetScale(float scale);
 541
 542   /**
 543    * Sets a scale factor applied to an actor.
 544    * @param [in] scaleX The scale factor applied along the x-axis.
 545    * @param [in] scaleY The scale factor applied along the y-axis.
 546    * @param [in] scaleZ The scale factor applied along the z-axis.
 547    */
 548   void SetScale(float scaleX, float scaleY, float scaleZ);
 549
 550   /**
 551    * Sets a scale factor applied to an actor.
 552    * @param [in] scale A vector representing the scale factor for each axis.
 553    */
 554   void SetScale(const Vector3& scale);
 555
 556   /**
 557    * Set the x component of the scale factor.
 558    * @param [in] x The new x value.
 559    */
 560   void SetScaleX(float x);
 561
 562   /**
 563    * Set the y component of the scale factor.
 564    * @param [in] y The new y value.
 565    */
 566   void SetScaleY(float y);
 567
 568   /**
 569    * Set the z component of the scale factor.
 570    * @param [in] z The new z value.
 571    */
 572   void SetScaleZ(float z);
 573
 574   /**
 575    * Apply a relative scale to an actor.
 576    * @param[in] relativeScale The scale to combine with the actors existing scale.
 577    */
 578   void ScaleBy(const Vector3& relativeScale);
 579
 580   /**
 581    * Retrieve the scale factor applied to an actor.
 582    * @return A vector representing the scale factor for each axis.
 583    */
 584   const Vector3& GetCurrentScale() const;
 585
 586   /**
 587    * @copydoc Dali::Actor::GetCurrentWorldScale()
 588    */
 589   const Vector3& GetCurrentWorldScale() const;
 590
 591   /**
 592    * @copydoc Dali::Actor::SetInheritScale()
 593    */
 594   void SetInheritScale(bool inherit);
 595
 596   /**
 597    * @copydoc Dali::Actor::IsScaleInherited()
 598    */
 599   bool IsScaleInherited() const
 600   {
 601     return mInheritScale;
 602   }
 603
 604   /**
 605    * @copydoc Dali::Actor::GetCurrentWorldMatrix()
 606    */
 607   Matrix GetCurrentWorldMatrix() const;
 608
 609   // Visibility
 610
 611   /**
 612    * Sets the visibility flag of an actor.
 613    * @param[in] visible The new visibility flag.
 614    */
 615   void SetVisible(bool visible);
 616
 617   /**
 618    * Retrieve the visibility flag of an actor.
 619    * @return The visibility flag.
 620    */
 621   bool IsVisible() const;
 622
 623   /**
 624    * Sets the opacity of an actor.
 625    * @param [in] opacity The new opacity.
 626    */
 627   void SetOpacity(float opacity);
 628
 629   /**
 630    * Retrieve the actor's opacity.
 631    * @return The actor's opacity.
 632    */
 633   float GetCurrentOpacity() const;
 634
 635   /**
 636    * Retrieve the actor's clipping mode.
 637    * @return The actor's clipping mode (cached)
 638    */
 639   ClippingMode::Type GetClippingMode() const
 640   {
 641     return mClippingMode;
 642   }
 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     return mDrawMode;
 690   }
 691
 692   /**
 693    * @copydoc Dali::Actor::IsOverlay
 694    */
 695   bool IsOverlay() const
 696   {
 697     return (DrawMode::OVERLAY_2D == mDrawMode);
 698   }
 699
 700   /**
 701    * Sets the actor's color.  The final color of actor depends on its color mode.
 702    * This final color is applied to the drawable elements of an actor.
 703    * @param [in] color The new color.
 704    */
 705   void SetColor(const Vector4& color);
 706
 707   /**
 708    * Set the red component of the color.
 709    * @param [in] red The new red component.
 710    */
 711   void SetColorRed(float red);
 712
 713   /**
 714    * Set the green component of the color.
 715    * @param [in] green The new green component.
 716    */
 717   void SetColorGreen(float green);
 718
 719   /**
 720    * Set the blue component of the scale factor.
 721    * @param [in] blue The new blue value.
 722    */
 723   void SetColorBlue(float blue);
 724
 725   /**
 726    * Retrieve the actor's color.
 727    * @return The color.
 728    */
 729   const Vector4& GetCurrentColor() const;
 730
 731   /**
 732    * Sets the actor's color mode.
 733    * Color mode specifies whether Actor uses its own color or inherits its parent color
 734    * @param [in] colorMode to use.
 735    */
 736   void SetColorMode(ColorMode colorMode);
 737
 738   /**
 739    * Returns the actor's color mode.
 740    * @return currently used colorMode.
 741    */
 742   ColorMode GetColorMode() const
 743   {
 744     return mColorMode;
 745   }
 746
 747   /**
 748    * @copydoc Dali::Actor::GetCurrentWorldColor()
 749    */
 750   const Vector4& GetCurrentWorldColor() const;
 751
 752   /**
 753    * @copydoc Dali::Actor::GetHierarchyDepth()
 754    */
 755   inline int32_t GetHierarchyDepth() const
 756   {
 757     if(mIsOnScene)
 758     {
 759       return mDepth;
 760     }
 761
 762     return -1;
 763   }
 764
 765   /**
 766    * Get the actor's sorting depth
 767    *
 768    * @return The depth used for hit-testing and renderer sorting
 769    */
 770   uint32_t GetSortingDepth()
 771   {
 772     return mSortedDepth;
 773   }
 774
 775 public:
 776   // Size negotiation virtual functions
 777
 778   /**
 779    * @brief Called after the size negotiation has been finished for this control.
 780    *
 781    * The control is expected to assign this given size to itself/its children.
 782    *
 783    * Should be overridden by derived classes if they need to layout
 784    * actors differently after certain operations like add or remove
 785    * actors, resize or after changing specific properties.
 786    *
 787    * Note! As this function is called from inside the size negotiation algorithm, you cannot
 788    * call RequestRelayout (the call would just be ignored)
 789    *
 790    * @param[in]      size       The allocated size.
 791    * @param[in,out]  container  The control should add actors to this container that it is not able
 792    *                            to allocate a size for.
 793    */
 794   virtual void OnRelayout(const Vector2& size, RelayoutContainer& container)
 795   {
 796   }
 797
 798   /**
 799    * @brief Notification for deriving classes when the resize policy is set
 800    *
 801    * @param[in] policy The policy being set
 802    * @param[in] dimension The dimension the policy is being set for
 803    */
 804   virtual void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension)
 805   {
 806   }
 807
 808   /**
 809    * @brief Virtual method to notify deriving classes that relayout dependencies have been
 810    * met and the size for this object is about to be calculated for the given dimension
 811    *
 812    * @param dimension The dimension that is about to be calculated
 813    */
 814   virtual void OnCalculateRelayoutSize(Dimension::Type dimension)
 815   {
 816   }
 817
 818   /**
 819    * @brief Virtual method to notify deriving classes that the size for a dimension
 820    * has just been negotiated
 821    *
 822    * @param[in] size The new size for the given dimension
 823    * @param[in] dimension The dimension that was just negotiated
 824    */
 825   virtual void OnLayoutNegotiated(float size, Dimension::Type dimension)
 826   {
 827   }
 828
 829   /**
 830    * @brief Determine if this actor is dependent on it's children for relayout
 831    *
 832    * @param dimension The dimension(s) to check for
 833    * @return Return if the actor is dependent on it's children
 834    */
 835   virtual bool RelayoutDependentOnChildren(Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
 836
 837   /**
 838    * @brief Determine if this actor is dependent on it's children for relayout.
 839    *
 840    * Called from deriving classes
 841    *
 842    * @param dimension The dimension(s) to check for
 843    * @return Return if the actor is dependent on it's children
 844    */
 845   virtual bool RelayoutDependentOnChildrenBase(Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
 846
 847   /**
 848    * @brief Calculate the size for a child
 849    *
 850    * @param[in] child The child actor to calculate the size for
 851    * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
 852    * @return Return the calculated size for the given dimension
 853    */
 854   virtual float CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension);
 855
 856   /**
 857    * @brief This method is called during size negotiation when a height is required for a given width.
 858    *
 859    * Derived classes should override this if they wish to customize the height returned.
 860    *
 861    * @param width to use.
 862    * @return the height based on the width.
 863    */
 864   virtual float GetHeightForWidth(float width);
 865
 866   /**
 867    * @brief This method is called during size negotiation when a width is required for a given height.
 868    *
 869    * Derived classes should override this if they wish to customize the width returned.
 870    *
 871    * @param height to use.
 872    * @return the width based on the width.
 873    */
 874   virtual float GetWidthForHeight(float height);
 875
 876 public:
 877   // Size negotiation
 878
 879   /**
 880    * @brief Called by the RelayoutController to negotiate the size of an actor.
 881    *
 882    * The size allocated by the the algorithm is passed in which the
 883    * actor must adhere to.  A container is passed in as well which
 884    * the actor should populate with actors it has not / or does not
 885    * need to handle in its size negotiation.
 886    *
 887    * @param[in]      size       The allocated size.
 888    * @param[in,out]  container  The container that holds actors that are fed back into the
 889    *                            RelayoutController algorithm.
 890    */
 891   void NegotiateSize(const Vector2& size, RelayoutContainer& container);
 892
 893   /**
 894    * @brief Set whether size negotiation should use the assigned size of the actor
 895    * during relayout for the given dimension(s)
 896    *
 897    * @param[in] use Whether the assigned size of the actor should be used
 898    * @param[in] dimension The dimension(s) to set. Can be a bitfield of multiple dimensions
 899    */
 900   void SetUseAssignedSize(bool use, Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
 901
 902   /**
 903    * @brief Returns whether size negotiation should use the assigned size of the actor
 904    * during relayout for a single dimension
 905    *
 906    * @param[in] dimension The dimension to get
 907    * @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
 908    */
 909   bool GetUseAssignedSize(Dimension::Type dimension) const;
 910
 911   /**
 912    * @copydoc Dali::Actor::SetResizePolicy()
 913    */
 914   void SetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
 915
 916   /**
 917    * @copydoc Dali::Actor::GetResizePolicy()
 918    */
 919   ResizePolicy::Type GetResizePolicy(Dimension::Type dimension) const;
 920
 921   /**
 922    * @copydoc Dali::Actor::SetSizeScalePolicy()
 923    */
 924   void SetSizeScalePolicy(SizeScalePolicy::Type policy);
 925
 926   /**
 927    * @copydoc Dali::Actor::GetSizeScalePolicy()
 928    */
 929   SizeScalePolicy::Type GetSizeScalePolicy() const;
 930
 931   /**
 932    * @copydoc Dali::Actor::SetDimensionDependency()
 933    */
 934   void SetDimensionDependency(Dimension::Type dimension, Dimension::Type dependency);
 935
 936   /**
 937    * @copydoc Dali::Actor::GetDimensionDependency()
 938    */
 939   Dimension::Type GetDimensionDependency(Dimension::Type dimension) const;
 940
 941   /**
 942    * @brief Set the size negotiation relayout enabled on this actor
 943    *
 944    * @param[in] relayoutEnabled Boolean to enable or disable relayout
 945    */
 946   void SetRelayoutEnabled(bool relayoutEnabled);
 947
 948   /**
 949    * @brief Return if relayout is enabled
 950    *
 951    * @return Return if relayout is enabled or not for this actor
 952    */
 953   bool IsRelayoutEnabled() const;
 954
 955   /**
 956    * @brief Mark an actor as having it's layout dirty
 957    *
 958    * @param dirty Whether to mark actor as dirty or not
 959    * @param dimension The dimension(s) to mark as dirty
 960    */
 961   void SetLayoutDirty(bool dirty, Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
 962
 963   /**
 964    * @brief Return if any of an actor's dimensions are marked as dirty
 965    *
 966    * @param dimension The dimension(s) to check
 967    * @return Return if any of the requested dimensions are dirty
 968    */
 969   bool IsLayoutDirty(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) const;
 970
 971   /**
 972    * @brief Returns if relayout is enabled and the actor is not dirty
 973    *
 974    * @return Return if it is possible to relayout the actor
 975    */
 976   bool RelayoutPossible(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) const;
 977
 978   /**
 979    * @brief Returns if relayout is enabled and the actor is dirty
 980    *
 981    * @return Return if it is required to relayout the actor
 982    */
 983   bool RelayoutRequired(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) const;
 984
 985   /**
 986    * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene)
 987    *
 988    * This method is automatically called from OnSceneConnection(), OnChildAdd(),
 989    * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize().
 990    *
 991    * This method can also be called from a derived class every time it needs a different size.
 992    * At the end of event processing, the relayout process starts and
 993    * all controls which requested Relayout will have their sizes (re)negotiated.
 994    *
 995    * @note RelayoutRequest() can be called multiple times; the size negotiation is still
 996    * only performed once, i.e. there is no need to keep track of this in the calling side.
 997    */
 998   void RelayoutRequest(Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
 999
1000   /**
1001    * @brief Determine if this actor is dependent on it's parent for relayout
1002    *
1003    * @param dimension The dimension(s) to check for
1004    * @return Return if the actor is dependent on it's parent
1005    */
1006   bool RelayoutDependentOnParent(Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
1007
1008   /**
1009    * @brief Determine if this actor has another dimension depedent on the specified one
1010    *
1011    * @param dimension The dimension to check for
1012    * @param dependentDimension The dimension to check for dependency with
1013    * @return Return if the actor is dependent on this dimension
1014    */
1015   bool RelayoutDependentOnDimension(Dimension::Type dimension, Dimension::Type dependentDimension);
1016
1017   /**
1018    * @brief Calculate the size of a dimension
1019    *
1020    * @param[in] dimension The dimension to calculate the size for
1021    * @param[in] maximumSize The upper bounds on the size
1022    * @return Return the calculated size for the dimension
1023    */
1024   float CalculateSize(Dimension::Type dimension, const Vector2& maximumSize);
1025
1026   /**
1027    * Negotiate a dimension based on the size of the parent
1028    *
1029    * @param[in] dimension The dimension to negotiate on
1030    * @return Return the negotiated size
1031    */
1032   float NegotiateFromParent(Dimension::Type dimension);
1033
1034   /**
1035    * Negotiate a dimension based on the size of the parent. Fitting inside.
1036    *
1037    * @param[in] dimension The dimension to negotiate on
1038    * @return Return the negotiated size
1039    */
1040   float NegotiateFromParentFit(Dimension::Type dimension);
1041
1042   /**
1043    * Negotiate a dimension based on the size of the parent. Flooding the whole space.
1044    *
1045    * @param[in] dimension The dimension to negotiate on
1046    * @return Return the negotiated size
1047    */
1048   float NegotiateFromParentFlood(Dimension::Type dimension);
1049
1050   /**
1051    * @brief Negotiate a dimension based on the size of the children
1052    *
1053    * @param[in] dimension The dimension to negotiate on
1054    * @return Return the negotiated size
1055    */
1056   float NegotiateFromChildren(Dimension::Type dimension);
1057
1058   /**
1059    * Set the negotiated dimension value for the given dimension(s)
1060    *
1061    * @param negotiatedDimension The value to set
1062    * @param dimension The dimension(s) to set the value for
1063    */
1064   void SetNegotiatedDimension(float negotiatedDimension, Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
1065
1066   /**
1067    * Return the value of negotiated dimension for the given dimension
1068    *
1069    * @param dimension The dimension to retrieve
1070    * @return Return the value of the negotiated dimension
1071    */
1072   float GetNegotiatedDimension(Dimension::Type dimension) const;
1073
1074   /**
1075    * @brief Set the padding for a dimension
1076    *
1077    * @param[in] padding Padding for the dimension. X = start (e.g. left, bottom), y = end (e.g. right, top)
1078    * @param[in] dimension The dimension to set
1079    */
1080   void SetPadding(const Vector2& padding, Dimension::Type dimension);
1081
1082   /**
1083    * Return the value of padding for the given dimension
1084    *
1085    * @param dimension The dimension to retrieve
1086    * @return Return the value of padding for the dimension
1087    */
1088   Vector2 GetPadding(Dimension::Type dimension) const;
1089
1090   /**
1091    * Return the actor size for a given dimension
1092    *
1093    * @param[in] dimension The dimension to retrieve the size for
1094    * @return Return the size for the given dimension
1095    */
1096   float GetSize(Dimension::Type dimension) const;
1097
1098   /**
1099    * Return the natural size of the actor for a given dimension
1100    *
1101    * @param[in] dimension The dimension to retrieve the size for
1102    * @return Return the natural size for the given dimension
1103    */
1104   float GetNaturalSize(Dimension::Type dimension) const;
1105
1106   /**
1107    * @brief Return the amount of size allocated for relayout
1108    *
1109    * May include padding
1110    *
1111    * @param[in] dimension The dimension to retrieve
1112    * @return Return the size
1113    */
1114   float GetRelayoutSize(Dimension::Type dimension) const;
1115
1116   /**
1117    * @brief If the size has been negotiated return that else return normal size
1118    *
1119    * @param[in] dimension The dimension to retrieve
1120    * @return Return the size
1121    */
1122   float GetLatestSize(Dimension::Type dimension) const;
1123
1124   /**
1125    * Apply the negotiated size to the actor
1126    *
1127    * @param[in] container The container to fill with actors that require further relayout
1128    */
1129   void SetNegotiatedSize(RelayoutContainer& container);
1130
1131   /**
1132    * @brief Flag the actor as having it's layout dimension negotiated.
1133    *
1134    * @param[in] negotiated The status of the flag to set.
1135    * @param[in] dimension The dimension to set the flag for
1136    */
1137   void SetLayoutNegotiated(bool negotiated, Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
1138
1139   /**
1140    * @brief Test whether the layout dimension for this actor has been negotiated or not.
1141    *
1142    * @param[in] dimension The dimension to determine the value of the flag for
1143    * @return Return if the layout dimension is negotiated or not.
1144    */
1145   bool IsLayoutNegotiated(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) const;
1146
1147   /**
1148    * @brief provides the Actor implementation of GetHeightForWidth
1149    * @param width to use.
1150    * @return the height based on the width.
1151    */
1152   float GetHeightForWidthBase(float width);
1153
1154   /**
1155    * @brief provides the Actor implementation of GetWidthForHeight
1156    * @param height to use.
1157    * @return the width based on the height.
1158    */
1159   float GetWidthForHeightBase(float height);
1160
1161   /**
1162    * @brief Calculate the size for a child
1163    *
1164    * @param[in] child The child actor to calculate the size for
1165    * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
1166    * @return Return the calculated size for the given dimension
1167    */
1168   float CalculateChildSizeBase(const Dali::Actor& child, Dimension::Type dimension);
1169
1170   /**
1171    * @brief Set the preferred size for size negotiation
1172    *
1173    * @param[in] size The preferred size to set
1174    */
1175   void SetPreferredSize(const Vector2& size);
1176
1177   /**
1178    * @brief Return the preferred size used for size negotiation
1179    *
1180    * @return Return the preferred size
1181    */
1182   Vector2 GetPreferredSize() const;
1183
1184   /**
1185    * @copydoc Dali::Actor::SetMinimumSize
1186    */
1187   void SetMinimumSize(float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
1188
1189   /**
1190    * @copydoc Dali::Actor::GetMinimumSize
1191    */
1192   float GetMinimumSize(Dimension::Type dimension) const;
1193
1194   /**
1195    * @copydoc Dali::Actor::SetMaximumSize
1196    */
1197   void SetMaximumSize(float size, Dimension::Type dimension = Dimension::ALL_DIMENSIONS);
1198
1199   /**
1200    * @copydoc Dali::Actor::GetMaximumSize
1201    */
1202   float GetMaximumSize(Dimension::Type dimension) const;
1203
1204   /**
1205    * @copydoc Dali::Actor::AddRenderer()
1206    */
1207   uint32_t AddRenderer(Renderer& renderer);
1208
1209   /**
1210    * @copydoc Dali::Actor::GetRendererCount()
1211    */
1212   uint32_t GetRendererCount() const;
1213
1214   /**
1215    * @copydoc Dali::Actor::GetRendererAt()
1216    */
1217   RendererPtr GetRendererAt(uint32_t index);
1218
1219   /**
1220    * @copydoc Dali::Actor::RemoveRenderer()
1221    */
1222   void RemoveRenderer(Renderer& renderer);
1223
1224   /**
1225    * @copydoc Dali::Actor::RemoveRenderer()
1226    */
1227   void RemoveRenderer(uint32_t index);
1228
1229   /**
1230    * @brief Set BlendEquation at each renderer that added on this Actor.
1231    */
1232   void SetBlendEquation(DevelBlendEquation::Type blendEquation);
1233
1234   /**
1235    * @brief Get Blend Equation that applied to this Actor
1236    */
1237   DevelBlendEquation::Type GetBlendEquation() const;
1238
1239   /**
1240    * @brief Set this Actor is transparent or not without any affection on the child Actors.
1241    */
1242   void SetTransparent(bool transparent);
1243
1244   /**
1245    * @brief Get this Actor is transparent or not.
1246    */
1247   bool IsTransparent() const;
1248
1249 public:
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[out] localX On return, the X-coordinate relative to the actor.
1254    * @param[out] localY On return, the Y-coordinate relative to the actor.
1255    * @param[in] screenX The screen X-coordinate.
1256    * @param[in] screenY The screen Y-coordinate.
1257    * @return True if the conversion succeeded.
1258    */
1259   bool ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const;
1260
1261   /**
1262    * Converts screen coordinates into the actor's coordinate system.
1263    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1264    * @param[in] renderTask The render-task used to display the actor.
1265    * @param[out] localX On return, the X-coordinate relative to the actor.
1266    * @param[out] localY On return, the Y-coordinate relative to the actor.
1267    * @param[in] screenX The screen X-coordinate.
1268    * @param[in] screenY The screen Y-coordinate.
1269    * @return True if the conversion succeeded.
1270    */
1271   bool ScreenToLocal(const RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY) const;
1272
1273   /**
1274    * Converts from the actor's coordinate system to screen coordinates.
1275    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
1276    * @param[in] viewMatrix The view-matrix
1277    * @param[in] projectionMatrix The projection-matrix
1278    * @param[in] viewport The view-port
1279    * @param[out] localX On return, the X-coordinate relative to the actor.
1280    * @param[out] localY On return, the Y-coordinate relative to the actor.
1281    * @param[in] screenX The screen X-coordinate.
1282    * @param[in] screenY The screen Y-coordinate.
1283    * @return True if the conversion succeeded.
1284    */
1285   bool ScreenToLocal(const Matrix&   viewMatrix,
1286                      const Matrix&   projectionMatrix,
1287                      const Viewport& viewport,
1288                      float&          localX,
1289                      float&          localY,
1290                      float           screenX,
1291                      float           screenY) const;
1292
1293   /**
1294    * Sets whether the actor should receive a notification when touch or hover motion events leave
1295    * the boundary of the actor.
1296    *
1297    * @note By default, this is set to false as most actors do not require this.
1298    * @note Need to connect to the SignalTouch or SignalHover to actually receive this event.
1299    *
1300    * @param[in]  required  Should be set to true if a Leave event is required
1301    */
1302   void SetLeaveRequired(bool required)
1303   {
1304     mLeaveRequired = required;
1305   }
1306
1307   /**
1308    * This returns whether the actor requires touch or hover events whenever touch or hover motion events leave
1309    * the boundary of the actor.
1310    * @return true if a Leave event is required, false otherwise.
1311    */
1312   bool GetLeaveRequired() const
1313   {
1314     return mLeaveRequired;
1315   }
1316
1317   /**
1318    * @copydoc Dali::Actor::SetKeyboardFocusable()
1319    */
1320   void SetKeyboardFocusable(bool focusable)
1321   {
1322     mKeyboardFocusable = focusable;
1323   }
1324
1325   /**
1326    * @copydoc Dali::Actor::IsKeyboardFocusable()
1327    */
1328   bool IsKeyboardFocusable() const
1329   {
1330     return mKeyboardFocusable;
1331   }
1332
1333   /**
1334    * @copydoc Dali::Actor::SetKeyboardFocusableChildren()
1335    */
1336   void SetKeyboardFocusableChildren(bool focusable)
1337   {
1338     mKeyboardFocusableChildren = focusable;
1339   }
1340
1341   /**
1342    * @copydoc Dali::Actor::AreChildrenKeyBoardFocusable()
1343    */
1344   bool AreChildrenKeyBoardFocusable() const
1345   {
1346     return mKeyboardFocusableChildren;
1347   }
1348
1349   /**
1350    * Set whether this view can focus by touch.
1351    * @param[in] focusable focuable by touch.
1352    */
1353   void SetTouchFocusable(bool focusable)
1354   {
1355     mTouchFocusable = focusable;
1356   }
1357
1358   /**
1359    * This returns whether this actor can focus by touch.
1360    * @return true if this actor can focus by touch.
1361    */
1362   bool IsTouchFocusable() const
1363   {
1364     return mTouchFocusable;
1365   }
1366
1367   /**
1368    * Query whether the application or derived actor type requires intercept touch events.
1369    * @return True if intercept touch events are required.
1370    */
1371   bool GetInterceptTouchRequired() const
1372   {
1373     return !mInterceptTouchedSignal.Empty();
1374   }
1375
1376   /**
1377    * Query whether the application or derived actor type requires touch events.
1378    * @return True if touch events are required.
1379    */
1380   bool GetTouchRequired() const
1381   {
1382     return !mTouchedSignal.Empty();
1383   }
1384
1385   /**
1386    * Query whether the application or derived actor type requires hover events.
1387    * @return True if hover events are required.
1388    */
1389   bool GetHoverRequired() const
1390   {
1391     return !mHoveredSignal.Empty();
1392   }
1393
1394   /**
1395    * Query whether the application or derived actor type requires wheel events.
1396    * @return True if wheel events are required.
1397    */
1398   bool GetWheelEventRequired() const
1399   {
1400     return !mWheelEventSignal.Empty();
1401   }
1402
1403   /**
1404    * Query whether the actor is actually hittable.  This method checks whether the actor is
1405    * sensitive, has the visibility flag set to true and is not fully transparent.
1406    * @return true, if it can be hit, false otherwise.
1407    */
1408   bool IsHittable() const
1409   {
1410     return IsSensitive() && IsVisible() && (GetCurrentWorldColor().a > FULLY_TRANSPARENT) && IsNodeConnected();
1411   }
1412
1413   /**
1414    * Query whether the actor captures all touch after it starts even if touch leaves its boundary.
1415    * @return true, if it captures all touch after start
1416    */
1417   bool CapturesAllTouchAfterStart() const
1418   {
1419     return mCaptureAllTouchAfterStart;
1420   }
1421
1422   /**
1423    * Sets the touch area offset of an actor.
1424    * @param [in] offset The new offset of area (left, right, bottom, top).
1425    */
1426   void SetTouchAreaOffset(Rect<int> offset)
1427   {
1428     mTouchAreaOffset = offset;
1429   }
1430
1431   /**
1432    * Retrieve the Actor's touch area offset.
1433    * @return The Actor's touch area offset.
1434    */
1435   const Rect<int>& GetTouchAreaOffset() const
1436   {
1437     return mTouchAreaOffset;
1438   }
1439
1440   // Gestures
1441
1442   /**
1443    * Retrieve the gesture data associated with this actor. The first call to this method will
1444    * allocate space for the ActorGestureData so this should only be called if an actor really does
1445    * require gestures.
1446    * @return Reference to the ActorGestureData for this actor.
1447    * @note Once the gesture-data is created for an actor it is likely that gestures are required
1448    * throughout the actor's lifetime so it will only be deleted when the actor is destroyed.
1449    */
1450   ActorGestureData& GetGestureData();
1451
1452   /**
1453    * Queries whether the actor requires the gesture type.
1454    * @param[in] type The gesture type.
1455    * @return True if the gesture is required, false otherwise.
1456    */
1457   bool IsGestureRequired(GestureType::Value type) const;
1458
1459   // Signals
1460
1461   /**
1462    * Used by the EventProcessor to emit intercept touch event signals.
1463    * @param[in] touch The touch data.
1464    * @return True if the event was intercepted.
1465    */
1466   bool EmitInterceptTouchEventSignal(const Dali::TouchEvent& touch);
1467
1468   /**
1469    * Used by the EventProcessor to emit touch event signals.
1470    * @param[in] touch The touch data.
1471    * @return True if the event was consumed.
1472    */
1473   bool EmitTouchEventSignal(const Dali::TouchEvent& touch);
1474
1475   /**
1476    * Used by the EventProcessor to emit hover event signals.
1477    * @param[in] event The hover event.
1478    * @return True if the event was consumed.
1479    */
1480   bool EmitHoverEventSignal(const Dali::HoverEvent& event);
1481
1482   /**
1483    * Used by the EventProcessor to emit wheel event signals.
1484    * @param[in] event The wheel event.
1485    * @return True if the event was consumed.
1486    */
1487   bool EmitWheelEventSignal(const Dali::WheelEvent& event);
1488
1489   /**
1490    * @brief Emits the visibility change signal for this actor and all its children.
1491    * @param[in] visible Whether the actor has become visible or not.
1492    * @param[in] type Whether the actor's visible property has changed or a parent's.
1493    */
1494   void EmitVisibilityChangedSignal(bool visible, DevelActor::VisibilityChange::Type type);
1495
1496   /**
1497    * @brief Emits the layout direction change signal for this actor and all its children.
1498    * @param[in] type Whether the actor's layout direction property has changed or a parent's.
1499    */
1500   void EmitLayoutDirectionChangedSignal(LayoutDirection::Type type);
1501
1502   /**
1503    * @copydoc DevelActor::InterceptTouchedSignal()
1504    */
1505   Dali::Actor::TouchEventSignalType& InterceptTouchedSignal()
1506   {
1507     return mInterceptTouchedSignal;
1508   }
1509
1510   /**
1511    * @copydoc Dali::Actor::TouchedSignal()
1512    */
1513   Dali::Actor::TouchEventSignalType& TouchedSignal()
1514   {
1515     return mTouchedSignal;
1516   }
1517
1518   /**
1519    * @copydoc Dali::Actor::HoveredSignal()
1520    */
1521   Dali::Actor::HoverSignalType& HoveredSignal()
1522   {
1523     return mHoveredSignal;
1524   }
1525
1526   /**
1527    * @copydoc Dali::Actor::WheelEventSignal()
1528    */
1529   Dali::Actor::WheelEventSignalType& WheelEventSignal()
1530   {
1531     return mWheelEventSignal;
1532   }
1533
1534   /**
1535    * @copydoc Dali::Actor::OnSceneSignal()
1536    */
1537   Dali::Actor::OnSceneSignalType& OnSceneSignal()
1538   {
1539     return mOnSceneSignal;
1540   }
1541
1542   /**
1543    * @copydoc Dali::Actor::OffSceneSignal()
1544    */
1545   Dali::Actor::OffSceneSignalType& OffSceneSignal()
1546   {
1547     return mOffSceneSignal;
1548   }
1549
1550   /**
1551    * @copydoc Dali::Actor::OnRelayoutSignal()
1552    */
1553   Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal()
1554   {
1555     return mOnRelayoutSignal;
1556   }
1557
1558   /**
1559    * @copydoc DevelActor::VisibilityChangedSignal
1560    */
1561   DevelActor::VisibilityChangedSignalType& VisibilityChangedSignal()
1562   {
1563     return mVisibilityChangedSignal;
1564   }
1565
1566   /**
1567    * @copydoc LayoutDirectionChangedSignal
1568    */
1569   Dali::Actor::LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal()
1570   {
1571     return mLayoutDirectionChangedSignal;
1572   }
1573
1574   /**
1575    * @copydoc DevelActor::ChildAddedSignal
1576    */
1577   DevelActor::ChildChangedSignalType& ChildAddedSignal();
1578
1579   /**
1580    * @copydoc DevelActor::ChildRemovedSignal
1581    */
1582   DevelActor::ChildChangedSignalType& ChildRemovedSignal();
1583
1584   /**
1585    * @copydoc DevelActor::ChildOrderChangedSignal
1586    */
1587   DevelActor::ChildOrderChangedSignalType& ChildOrderChangedSignal();
1588
1589   /**
1590    * Connects a callback function with the object's signals.
1591    * @param[in] object The object providing the signal.
1592    * @param[in] tracker Used to disconnect the signal.
1593    * @param[in] signalName The signal to connect to.
1594    * @param[in] functor A newly allocated FunctorDelegate.
1595    * @return True if the signal was connected.
1596    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
1597    */
1598   static bool DoConnectSignal(BaseObject*                 object,
1599                               ConnectionTrackerInterface* tracker,
1600                               const std::string&          signalName,
1601                               FunctorDelegate*            functor);
1602
1603   /**
1604    * Performs actions as requested using the action name.
1605    * @param[in] object The object on which to perform the action.
1606    * @param[in] actionName The action to perform.
1607    * @param[in] attributes The attributes with which to perfrom this action.
1608    * @return true if the action was done.
1609    */
1610   static bool DoAction(BaseObject*          object,
1611                        const std::string&   actionName,
1612                        const Property::Map& attributes);
1613
1614 public:
1615   // For Animation
1616
1617   /**
1618    * For use in derived classes.
1619    * This should only be called by Animation, when the actor is resized using Animation::Resize().
1620    */
1621   virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize)
1622   {
1623   }
1624
1625 protected:
1626   enum DerivedType
1627   {
1628     BASIC,
1629     LAYER,
1630     ROOT_LAYER
1631   };
1632
1633   /**
1634    * Protected Constructor.  See Actor::New().
1635    * The second-phase construction Initialize() member should be called immediately after this.
1636    * @param[in] derivedType The derived type of actor (if any).
1637    * @param[in] reference to the node
1638    */
1639   Actor(DerivedType derivedType, const SceneGraph::Node& node);
1640
1641   /**
1642    * Second-phase constructor. Must be called immediately after creating a new Actor;
1643    */
1644   void Initialize(void);
1645
1646   /**
1647    * A reference counted object may only be deleted by calling Unreference()
1648    */
1649   ~Actor() override;
1650
1651   /**
1652    * Called on a child during Add() when the parent actor is connected to the Scene.
1653    * @param[in] parentDepth The depth of the parent in the hierarchy.
1654    * @param[in] notify Emits notification if set to true.
1655    */
1656   void ConnectToScene(uint32_t parentDepth, bool notify);
1657
1658   /**
1659    * Helper for ConnectToScene, to recursively connect a tree of actors.
1660    * This is atomic i.e. not interrupted by user callbacks.
1661    * @param[in]  depth The depth in the hierarchy of the actor
1662    * @param[out] connectionList On return, the list of connected actors which require notification.
1663    */
1664   void RecursiveConnectToScene(ActorContainer& connectionList, uint32_t depth);
1665
1666   /**
1667    * Connect the Node associated with this Actor to the scene-graph.
1668    */
1669   void ConnectToSceneGraph();
1670
1671   /**
1672    * Helper for ConnectToScene, to notify a connected actor through the public API.
1673    * @param[in] notify Emits notification if set to true.
1674    */
1675   void NotifyStageConnection(bool notify);
1676
1677   /**
1678    * Called on a child during Remove() when the actor was previously on the Stage.
1679    * @param[in] notify Emits notification if set to true.
1680    */
1681   void DisconnectFromStage(bool notify);
1682
1683   /**
1684    * Helper for DisconnectFromStage, to recursively disconnect a tree of actors.
1685    * This is atomic i.e. not interrupted by user callbacks.
1686    * @param[out] disconnectionList On return, the list of disconnected actors which require notification.
1687    */
1688   void RecursiveDisconnectFromStage(ActorContainer& disconnectionList);
1689
1690   /**
1691    * Disconnect the Node associated with this Actor from the scene-graph.
1692    */
1693   void DisconnectFromSceneGraph();
1694
1695   /**
1696    * Helper for DisconnectFromStage, to notify a disconnected actor through the public API.
1697    * @param[in] notify Emits notification if set to true.
1698    */
1699   void NotifyStageDisconnection(bool notify);
1700
1701   /**
1702    * When the Actor is OnScene, checks whether the corresponding Node is connected to the scene graph.
1703    * @return True if the Actor is OnScene & has a Node connected to the scene graph.
1704    */
1705   bool IsNodeConnected() const;
1706
1707 public:
1708   /**
1709    * Trigger a rebuild of the actor depth tree from this root
1710    * If a Layer3D is encountered, then this doesn't descend any further.
1711    * The mSortedDepth of each actor is set appropriately.
1712    */
1713   void RebuildDepthTree();
1714
1715 protected:
1716   /**
1717    * Traverse the actor tree, inserting actors into the depth tree in sibling order.
1718    * @param[in] sceneGraphNodeDepths A vector capturing the nodes and their depth index
1719    * @param[in,out] depthIndex The current depth index (traversal index)
1720    */
1721   void DepthTraverseActorTree(OwnerPointer<SceneGraph::NodeDepths>& sceneGraphNodeDepths, int32_t& depthIndex);
1722
1723 public:
1724   // Default property extensions from Object
1725
1726   /**
1727    * @copydoc Dali::Internal::Object::SetDefaultProperty()
1728    */
1729   void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue) override;
1730
1731   /**
1732    * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
1733    */
1734   void SetSceneGraphProperty(Property::Index index, const PropertyMetadata& entry, const Property::Value& value) override;
1735
1736   /**
1737    * @copydoc Dali::Internal::Object::GetDefaultProperty()
1738    */
1739   Property::Value GetDefaultProperty(Property::Index index) const override;
1740
1741   /**
1742    * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue()
1743    */
1744   Property::Value GetDefaultPropertyCurrentValue(Property::Index index) const override;
1745
1746   /**
1747    * @copydoc Dali::Internal::Object::OnNotifyDefaultPropertyAnimation()
1748    */
1749   void OnNotifyDefaultPropertyAnimation(Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType) override;
1750
1751   /**
1752    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
1753    */
1754   const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty(Property::Index index) const override;
1755
1756   /**
1757    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
1758    */
1759   const PropertyInputImpl* GetSceneObjectInputProperty(Property::Index index) const override;
1760
1761   /**
1762    * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
1763    */
1764   int32_t GetPropertyComponentIndex(Property::Index index) const override;
1765
1766   /**
1767    * @copydoc Dali::Internal::Object::IsAnimationPossible()
1768    */
1769   bool IsAnimationPossible() const override
1770   {
1771     return OnScene();
1772   }
1773
1774   /**
1775    * Retrieve the actor's node.
1776    * @return The node used by this actor
1777    */
1778   const SceneGraph::Node& GetNode() const;
1779
1780   /**
1781    * @copydoc Dali::DevelActor::Raise()
1782    */
1783   void Raise();
1784
1785   /**
1786    * @copydoc Dali::DevelActor::Lower()
1787    */
1788   void Lower();
1789
1790   /**
1791    * @copydoc Dali::DevelActor::RaiseToTop()
1792    */
1793   void RaiseToTop();
1794
1795   /**
1796    * @copydoc Dali::DevelActor::LowerToBottom()
1797    */
1798   void LowerToBottom();
1799
1800   /**
1801    * @copydoc Dali::DevelActor::RaiseAbove()
1802    */
1803   void RaiseAbove(Internal::Actor& target);
1804
1805   /**
1806    * @copydoc Dali::DevelActor::LowerBelow()
1807    */
1808   void LowerBelow(Internal::Actor& target);
1809
1810 public:
1811   /**
1812    * Sets the scene which this actor is added to.
1813    * @param[in] scene The scene
1814    */
1815   void SetScene(Scene& scene)
1816   {
1817     mScene = &scene;
1818   }
1819
1820   /**
1821    * Gets the scene which this actor is added to.
1822    * @return The scene
1823    */
1824   Scene& GetScene() const
1825   {
1826     return *mScene;
1827   }
1828
1829   LayoutDirection::Type GetLayoutDirection() const
1830   {
1831     return mLayoutDirection;
1832   }
1833
1834 private:
1835   struct SendMessage
1836   {
1837     enum Type
1838     {
1839       FALSE = 0,
1840       TRUE  = 1,
1841     };
1842   };
1843
1844   struct AnimatedSizeFlag
1845   {
1846     enum Type
1847     {
1848       CLEAR  = 0,
1849       WIDTH  = 1,
1850       HEIGHT = 2,
1851       DEPTH  = 4
1852     };
1853   };
1854
1855   struct Relayouter;
1856
1857   // Remove default constructor and copy constructor
1858   Actor()             = delete;
1859   Actor(const Actor&) = delete;
1860   Actor& operator=(const Actor& rhs) = delete;
1861
1862   /**
1863    * Set the actor's parent.
1864    * @param[in] parent The new parent.
1865    * @param[in] notify Emits notification if set to true. Default is true.
1866    */
1867   void SetParent(ActorParent* parent, bool notify = true);
1868
1869   /**
1870    * For use in derived classes, called after Initialize()
1871    */
1872   virtual void OnInitialize()
1873   {
1874   }
1875
1876   /**
1877    * For use in internal derived classes.
1878    * This is called during ConnectToScene(), after the actor has finished adding its node to the scene-graph.
1879    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1880    */
1881   virtual void OnSceneConnectionInternal()
1882   {
1883   }
1884
1885   /**
1886    * For use in internal derived classes.
1887    * This is called during DisconnectFromStage(), before the actor removes its node from the scene-graph.
1888    * The derived class must not modify the actor hierachy (Add/Remove children) during this callback.
1889    */
1890   virtual void OnSceneDisconnectionInternal()
1891   {
1892   }
1893
1894   /**
1895    * For use in external (CustomActor) derived classes.
1896    * This is called after the atomic ConnectToScene() traversal has been completed.
1897    */
1898   virtual void OnSceneConnectionExternal(int depth)
1899   {
1900   }
1901
1902   /**
1903    * For use in external (CustomActor) derived classes.
1904    * This is called after the atomic DisconnectFromStage() traversal has been completed.
1905    */
1906   virtual void OnSceneDisconnectionExternal()
1907   {
1908   }
1909
1910   /**
1911    * For use in derived classes; this is called after Add() has added a child.
1912    * @param[in] child The child that was added.
1913    */
1914   virtual void OnChildAdd(Actor& child)
1915   {
1916   }
1917
1918   /**
1919    * For use in derived classes; this is called after Remove() has attempted to remove a child( regardless of whether it succeeded or not ).
1920    * @param[in] child The child that was removed.
1921    */
1922   virtual void OnChildRemove(Actor& child)
1923   {
1924   }
1925
1926   /**
1927    * For use in derived classes.
1928    * This is called after SizeSet() has been called.
1929    */
1930   virtual void OnSizeSet(const Vector3& targetSize)
1931   {
1932   }
1933
1934   /**
1935    * @brief Retrieves the cached event side value of a default property.
1936    * @param[in]  index  The index of the property
1937    * @param[out] value  Is set with the cached value of the property if found.
1938    * @return True if value set, false otherwise.
1939    */
1940   bool GetCachedPropertyValue(Property::Index index, Property::Value& value) const;
1941
1942   /**
1943    * @brief Retrieves the current value of a default property from the scene-graph.
1944    * @param[in]  index  The index of the property
1945    * @param[out] value  Is set with the current scene-graph value of the property
1946    * @return True if value set, false otherwise.
1947    */
1948   bool GetCurrentPropertyValue(Property::Index index, Property::Value& value) const;
1949
1950   /**
1951    * @brief Ensure the relayouter is allocated
1952    */
1953   Relayouter& EnsureRelayouter();
1954
1955   /**
1956    * @brief Apply the size set policy to the input size
1957    *
1958    * @param[in] size The size to apply the policy to
1959    * @return Return the adjusted size
1960    */
1961   Vector2 ApplySizeSetPolicy(const Vector2& size);
1962
1963   /**
1964    * Retrieve the parent object of an Actor.
1965    * @return The parent object, or NULL if the Actor does not have a parent.
1966    */
1967   Object* GetParentObject() const override
1968   {
1969     return static_cast<Actor*>(mParent);
1970   }
1971
1972   /**
1973    * @brief Get the current position of the actor in screen coordinates.
1974    *
1975    * @return Returns the screen position of actor
1976    */
1977   const Vector2 GetCurrentScreenPosition() const;
1978
1979   /**
1980    * Sets the visibility flag of an actor.
1981    * @param[in] visible The new visibility flag.
1982    * @param[in] sendMessage Whether to send a message to the update thread or not.
1983    */
1984   void SetVisibleInternal(bool visible, SendMessage::Type sendMessage);
1985
1986   /**
1987    * @copydoc ActorParent::SetSiblingOrderOfChild
1988    */
1989   void SetSiblingOrderOfChild(Actor& child, uint32_t order) override;
1990
1991   /**
1992    * @copydoc ActorParent::GetSiblingOrderOfChild
1993    */
1994   uint32_t GetSiblingOrderOfChild(const Actor& child) const override;
1995
1996   /**
1997    * @copydoc ActorParent::RaiseChild
1998    */
1999   void RaiseChild(Actor& child) override;
2000
2001   /**
2002    * @copydoc ActorParent::LowerChild
2003    */
2004   void LowerChild(Actor& child) override;
2005
2006   /**
2007    * @copydoc ActorParent::RaiseChildToTop
2008    */
2009   void RaiseChildToTop(Actor& child) override;
2010
2011   /**
2012    * @copydoc ActorParent::LowerChildToBottom
2013    */
2014   void LowerChildToBottom(Actor& child) override;
2015
2016   /**
2017    * @copydoc ActorParent::RaiseChildAbove
2018    */
2019   void RaiseChildAbove(Actor& child, Actor& target) override;
2020
2021   /**
2022    * @copydoc ActorParent::LowerChildBelow()
2023    */
2024   void LowerChildBelow(Actor& child, Actor& target) override;
2025
2026   /**
2027    * Set whether a child actor inherits it's parent's layout direction. Default is to inherit.
2028    * @param[in] inherit - true if the actor should inherit layout direction, false otherwise.
2029    */
2030   void SetInheritLayoutDirection(bool inherit);
2031
2032   /**
2033    * Returns whether the actor inherits it's parent's layout direction.
2034    * @return true if the actor inherits it's parent's layout direction, false otherwise.
2035    */
2036   bool IsLayoutDirectionInherited() const
2037   {
2038     return mInheritLayoutDirection;
2039   }
2040
2041   /**
2042    * @brief Propagates layout direction recursively.
2043    * @param[in] direction New layout direction.
2044    */
2045   void InheritLayoutDirectionRecursively(Dali::LayoutDirection::Type direction, bool set = false);
2046
2047   /**
2048    * @brief Sets the update size hint of an actor.
2049    * @param [in] updateSizeHint The update size hint.
2050    */
2051   void SetUpdateSizeHint(const Vector2& updateSizeHint);
2052
2053   /**
2054    * @brief Recursively emits the visibility-changed-signal on the actor tree.
2055    *
2056    * @param[in] visible The new visibility of the actor
2057    * @param[in] type Whether the actor's visible property has changed or a parent's
2058    */
2059   void EmitVisibilityChangedSignalRecursively(bool                               visible,
2060                                               DevelActor::VisibilityChange::Type type);
2061
2062 protected:
2063   ActorParentImpl    mParentImpl;   ///< Implementation of ActorParent;
2064   ActorParent*       mParent;       ///< Each actor (except the root) can have one parent
2065   Scene*             mScene;        ///< The scene the actor is added to
2066   RendererContainer* mRenderers;    ///< Renderer container
2067   Vector3*           mParentOrigin; ///< NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable
2068   Vector3*           mAnchorPoint;  ///< NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable
2069   Relayouter*        mRelayoutData; ///< Struct to hold optional collection of relayout variables
2070   ActorGestureData*  mGestureData;  ///< Optional Gesture data. Only created when actor requires gestures
2071
2072   // Signals
2073   Dali::Actor::TouchEventSignalType             mInterceptTouchedSignal;
2074   Dali::Actor::TouchEventSignalType             mTouchedSignal;
2075   Dali::Actor::HoverSignalType                  mHoveredSignal;
2076   Dali::Actor::WheelEventSignalType             mWheelEventSignal;
2077   Dali::Actor::OnSceneSignalType                mOnSceneSignal;
2078   Dali::Actor::OffSceneSignalType               mOffSceneSignal;
2079   Dali::Actor::OnRelayoutSignalType             mOnRelayoutSignal;
2080   DevelActor::VisibilityChangedSignalType       mVisibilityChangedSignal;
2081   Dali::Actor::LayoutDirectionChangedSignalType mLayoutDirectionChangedSignal;
2082
2083   Quaternion mTargetOrientation; ///< Event-side storage for orientation
2084   Vector4    mTargetColor;       ///< Event-side storage for color
2085   Vector3    mTargetSize;        ///< Event-side storage for size (not a pointer as most actors will have a size)
2086   Vector3    mTargetPosition;    ///< Event-side storage for position (not a pointer as most actors will have a position)
2087   Vector3    mTargetScale;       ///< Event-side storage for scale
2088   Vector3    mAnimatedSize;      ///< Event-side storage for size animation
2089   Rect<int>  mTouchAreaOffset;   ///< touch area offset (left, right, bottom, top)
2090
2091   ConstString mName;            ///< Name of the actor
2092   uint32_t    mSortedDepth;     ///< The sorted depth index. A combination of tree traversal and sibling order.
2093   int16_t     mDepth;           ///< The depth in the hierarchy of the actor. Only 32,767 levels of depth are supported
2094   uint16_t    mUseAnimatedSize; ///< Whether the size is animated.
2095
2096   const bool               mIsRoot : 1;                    ///< Flag to identify the root actor
2097   const bool               mIsLayer : 1;                   ///< Flag to identify that this is a layer
2098   bool                     mIsOnScene : 1;                 ///< Flag to identify whether the actor is on-scene
2099   bool                     mSensitive : 1;                 ///< Whether the actor emits touch event signals
2100   bool                     mLeaveRequired : 1;             ///< Whether a touch event signal is emitted when the a touch leaves the actor's bounds
2101   bool                     mKeyboardFocusable : 1;         ///< Whether the actor should be focusable by keyboard navigation
2102   bool                     mKeyboardFocusableChildren : 1; ///< Whether the children of this actor can be focusable by keyboard navigation.
2103   bool                     mTouchFocusable : 1;            ///< Whether the actor should be focusable by touch
2104   bool                     mOnSceneSignalled : 1;          ///< Set to true before OnSceneConnection signal is emitted, and false before OnSceneDisconnection
2105   bool                     mInsideOnSizeSet : 1;           ///< Whether we are inside OnSizeSet
2106   bool                     mInheritPosition : 1;           ///< Cached: Whether the parent's position should be inherited.
2107   bool                     mInheritOrientation : 1;        ///< Cached: Whether the parent's orientation should be inherited.
2108   bool                     mInheritScale : 1;              ///< Cached: Whether the parent's scale should be inherited.
2109   bool                     mPositionUsesAnchorPoint : 1;   ///< Cached: Whether the position uses the anchor point or not.
2110   bool                     mVisible : 1;                   ///< Cached: Whether the actor is visible or not.
2111   bool                     mInheritLayoutDirection : 1;    ///< Whether the actor inherits the layout direction from parent.
2112   bool                     mCaptureAllTouchAfterStart : 1; ///< Whether the actor should capture all touch after touch starts even if the motion moves outside of the actor area.
2113   bool                     mIsBlendEquationSet : 1;        ///< Flag to identify whether the Blend equation is set
2114   bool                     mNeedGesturePropagation : 1;    ///< Whether the parent listens for gesture events or not
2115   LayoutDirection::Type    mLayoutDirection : 2;           ///< Layout direction, Left to Right or Right to Left.
2116   DrawMode::Type           mDrawMode : 3;                  ///< Cached: How the actor and its children should be drawn
2117   ColorMode                mColorMode : 3;                 ///< Cached: Determines whether mWorldColor is inherited
2118   ClippingMode::Type       mClippingMode : 3;              ///< Cached: Determines which clipping mode (if any) to use.
2119   DevelBlendEquation::Type mBlendEquation : 16;            ///< Cached: Determines which blend equation will be used to render renderers.
2120
2121 private:
2122   static ActorContainer mNullChildren; ///< Empty container (shared by all actors, returned by GetChildren() const)
2123
2124   struct PropertyHandler;
2125   struct SiblingHandler;
2126
2127   friend class ActorParentImpl; // Allow impl to call private methods on actor
2128 };
2129
2130 } // namespace Internal
2131
2132 // Helpers for public-api forwarding methods
2133
2134 inline Internal::Actor& GetImplementation(Dali::Actor& actor)
2135 {
2136   DALI_ASSERT_ALWAYS(actor && "Actor handle is empty");
2137
2138   BaseObject& handle = actor.GetBaseObject();
2139
2140   return static_cast<Internal::Actor&>(handle);
2141 }
2142
2143 inline const Internal::Actor& GetImplementation(const Dali::Actor& actor)
2144 {
2145   DALI_ASSERT_ALWAYS(actor && "Actor handle is empty");
2146
2147   const BaseObject& handle = actor.GetBaseObject();
2148
2149   return static_cast<const Internal::Actor&>(handle);
2150 }
2151
2152 } // namespace Dali
2153
2154 #endif // DALI_INTERNAL_ACTOR_H