Allow multiple renderers per Actor and sharing renderers between actors
[platform/core/uifw/dali-core.git] / dali / internal / event / actors / actor-impl.h
index faf1705..be4e6fb 100644 (file)
 #include <string>
 
 // INTERNAL INCLUDES
-#include <dali/public-api/common/vector-wrapper.h>
-#include <dali/public-api/object/ref-object.h>
 #include <dali/public-api/actors/actor.h>
+#include <dali/public-api/common/vector-wrapper.h>
 #include <dali/public-api/common/dali-common.h>
 #include <dali/public-api/events/gesture.h>
 #include <dali/public-api/math/viewport.h>
-#include <dali/internal/event/common/object-impl.h>
+#include <dali/public-api/object/ref-object.h>
 #include <dali/public-api/size-negotiation/relayout-container.h>
-#include <dali/internal/event/common/stage-def.h>
 #include <dali/internal/event/actors/actor-declarations.h>
 #include <dali/internal/event/actor-attachments/actor-attachment-declarations.h>
+#include <dali/internal/event/common/object-impl.h>
+#include <dali/internal/event/common/stage-def.h>
+#include <dali/internal/event/rendering/renderer-impl.h>
 #include <dali/internal/update/nodes/node-declarations.h>
 
-#ifdef DYNAMICS_SUPPORT
-#include <dali/internal/event/dynamics/dynamics-declarations.h>
-#endif
-
 namespace Dali
 {
 
 struct KeyEvent;
 struct TouchEvent;
 struct HoverEvent;
-struct MouseWheelEvent;
+struct WheelEvent;
 
 namespace Internal
 {
@@ -54,13 +51,15 @@ class Actor;
 class ActorGestureData;
 class Animation;
 class RenderTask;
-struct DynamicsData;
+class Renderer;
 
-typedef IntrusivePtr< Actor > ActorPtr;
-typedef std::vector< Dali::Actor > ActorContainer; // Store handles to return via public-api
+typedef std::vector< ActorPtr > ActorContainer;
 typedef ActorContainer::iterator ActorIter;
 typedef ActorContainer::const_iterator ActorConstIter;
 
+typedef std::vector< RendererPtr > RendererContainer;
+typedef RendererContainer::iterator RendererIter;
+
 /**
  * Actor is the primary object which Dali applications interact with.
  * UI controls can be built by combining multiple actors.
@@ -201,16 +200,6 @@ public:
   void Add( Actor& child );
 
   /**
-   * Inserts a child Actor to this Actor's child list
-   * @pre The child actor is not the same as the parent actor.
-   * @pre The child actor does not already have a parent.
-   * @param [in] index in childlist to insert child at
-   * @param [in] child The child.
-   * @post The child will be referenced by its parent.
-   */
-  void Insert( unsigned int index, Actor& child );
-
-  /**
    * Removes a child Actor from this Actor.
    * @param [in] child The child.
    * @post The child will be unreferenced.
@@ -231,7 +220,7 @@ public:
   /**
    * @copydoc Dali::Actor::GetChildAt
    */
-  Dali::Actor GetChildAt( unsigned int index ) const;
+  ActorPtr GetChildAt( unsigned int index ) const;
 
   /**
    * Retrieve a reference to Actor's children.
@@ -712,28 +701,6 @@ public:
   bool IsOverlay() const;
 
   /**
-   * Sets whether an actor transmits geometry scaling to it's children.
-   * The default value is for it not to transmit scaling.
-   * @param[in] transmitGeometryScaling True to transmit scaling.
-   */
-  void SetTransmitGeometryScaling( bool transmitGeometryScaling );
-
-  /**
-   * Get the TransmitGeometryScaling property for this actor.
-   * @return True if geometry scaling is applied to the inherited scale.
-   */
-  bool GetTransmitGeometryScaling() const;
-
-  /**
-   * Sets the initial volume of the actor. Used for scaling the
-   * actor appropriately as the actor is sized when transmitGeometryScaling
-   * is set to true.
-   *
-   * @param[in] volume the volume of the model and it's children
-   */
-  void SetInitialVolume( const Vector3& volume );
-
-  /**
    * Sets the actor's color.  The final color of actor depends on its color mode.
    * This final color is applied to the drawable elements of an actor.
    * @param [in] color The new color.
@@ -782,6 +749,19 @@ public:
    */
   const Vector4& GetCurrentWorldColor() const;
 
+  /**
+   * @copydoc Dali::Actor::GetHierarchyDepth()
+   */
+  int GetHierarchyDepth() const
+  {
+    if( mIsOnStage )
+    {
+      return static_cast<int>(mDepth);
+    }
+
+    return -1;
+  }
+
 public:
 
   // Size negotiation virtual functions
@@ -985,11 +965,6 @@ public:
    */
   void RelayoutRequest( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
 
-  /*
-   * @copydoc Dali::Actor::PropagateRelayoutFlags
-   */
-  void PropagateRelayoutFlags();
-
   /**
    * @brief Determine if this actor is dependent on it's parent for relayout
    *
@@ -1169,6 +1144,20 @@ public:
   bool IsLayoutNegotiated( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) const;
 
   /**
+   * @brief provides the Actor implementation of GetHeightForWidth
+   * @param width to use.
+   * @return the height based on the width.
+   */
+  float GetHeightForWidthBase( float width );
+
+  /**
+   * @brief provides the Actor implementation of GetWidthForHeight
+   * @param height to use.
+   * @return the width based on the height.
+   */
+  float GetWidthForHeightBase( float height );
+
+  /**
    * @brief Calculate the size for a child
    *
    * @param[in] child The child actor to calculate the size for
@@ -1210,94 +1199,34 @@ public:
    * @copydoc Dali::Actor::GetMaximumSize
    */
   float GetMaximumSize( Dimension::Type dimension ) const;
-
-#ifdef DYNAMICS_SUPPORT
-
-  // Dynamics
-
-  /// @copydoc Dali::Actor::DisableDynamics
-  void DisableDynamics();
-
-  /// @copydoc Dali::Actor::EnableDynamics(Dali::DynamicsBodyConfig)
-  DynamicsBodyPtr EnableDynamics(DynamicsBodyConfigPtr bodyConfig);
-
-  /// @copydoc Dali::Actor::GetDynamicsBody
-  DynamicsBodyPtr GetDynamicsBody() const;
-
-  /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&)
-  DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offset );
-
-  /// @copydoc Dali::Actor::AddDynamicsJoint(Dali::Actor,const Vector3&,const Vector3&)
-  DynamicsJointPtr AddDynamicsJoint( ActorPtr attachedActor, const Vector3& offsetA, const Vector3& offsetB );
-
-  /// @copydoc Dali::Actor::GetNumberOfJoints
-  const int GetNumberOfJoints() const;
-
-  /// @copydoc Dali::Actor::GetDynamicsJointByIndex
-  DynamicsJointPtr GetDynamicsJointByIndex( const int index ) const;
-
-  /// @copydoc Dali::Actor::GetDynamicsJoint
-  DynamicsJointPtr GetDynamicsJoint( ActorPtr attachedActor ) const;
-
-  /// @copydoc Dali::Actor::RemoveDynamicsJoint
-  void RemoveDynamicsJoint( DynamicsJointPtr joint );
-
-  /**
-   * Hold a reference to a DynamicsJoint
-   * @param[in] joint The joint
-   */
-  void ReferenceJoint( DynamicsJointPtr joint );
-
-  /**
-   * Release a reference to a DynamicsJoint
-   * @param[in] joint The joint
-   */
-  void ReleaseJoint( DynamicsJointPtr joint );
-
+  
   /**
-   * Set this actor to be the root actor in the dynamics simulation
-   * All children of the actor are added/removed from the simulation.
-   * @param[in] flag  When true sets this actor to be the simulation world root actor and
-   *                  if OnStage() all dynamics enabled child actors are added to the simulation,
-   *                  when false stops this actor being the simulation root and if OnStage() all
-   *                  dynamics enabled child actors are removed from the simulation.
+   * @copydoc Dali::Actor::AddRenderer()
    */
-  void SetDynamicsRoot(bool flag);
-
-private:
-  /**
-   * Check if this actor is the root actor in the dynamics simulation
-   * @return true if this is the dynamics root actor.
-   */
-  bool IsDynamicsRoot() const;
+  unsigned int AddRenderer( Renderer& renderer );
 
   /**
-   * Add actor to the dynamics simulation
-   * Invoked when the actor is staged, or it's parent becomes the simulation root
+   * @copydoc Dali::Actor::GetRendererCount()
    */
-  void ConnectDynamics();
+  unsigned int GetRendererCount() const;
 
   /**
-   * Remove actor from the dynamics simulation
-   * Invoked when the actor is unstaged, or it's parent stops being the the simulation root
+   * @copydoc Dali::Actor::GetRendererAt()
    */
-  void DisconnectDynamics();
+  RendererPtr GetRendererAt( unsigned int index );
 
   /**
-   * An actor in a DynamicsJoint relationship has been staged
-   * @param[in] actor The actor passed into AddDynamicsJoint()
+   * @copydoc Dali::Actor::RemoveRenderer()
    */
-  void AttachedActorOnStage( Dali::Actor actor );
+  void RemoveRenderer( Renderer& renderer );
 
   /**
-   * An actor in a DynamicsJoint relationship has been unstaged
-   * @param[in] actor The actor passed into AddDynamicsJoint()
+   * @copydoc Dali::Actor::RemoveRenderer()
    */
-  void AttachedActorOffStage( Dali::Actor actor );
-
-#endif // DYNAMICS_SUPPORT
+  void RemoveRenderer( unsigned int index );
 
 public:
+
   /**
    * Converts screen coordinates into the actor's coordinate system.
    * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
@@ -1405,10 +1334,10 @@ public:
   bool GetHoverRequired() const;
 
   /**
-   * Query whether the application or derived actor type requires mouse wheel events.
-   * @return True if mouse wheel events are required.
+   * Query whether the application or derived actor type requires wheel events.
+   * @return True if wheel events are required.
    */
-  bool GetMouseWheelEventRequired() const;
+  bool GetWheelEventRequired() const;
 
   /**
    * Query whether the actor is actually hittable.  This method checks whether the actor is
@@ -1452,11 +1381,11 @@ public:
   bool EmitHoverEventSignal( const HoverEvent& event );
 
   /**
-   * Used by the EventProcessor to emit mouse wheel event signals.
-   * @param[in] event The mouse wheel event.
+   * Used by the EventProcessor to emit wheel event signals.
+   * @param[in] event The wheel event.
    * @return True if the event was consumed.
    */
-  bool EmitMouseWheelEventSignal( const MouseWheelEvent& event );
+  bool EmitWheelEventSignal( const WheelEvent& event );
 
   /**
    * @copydoc Dali::Actor::TouchedSignal()
@@ -1469,9 +1398,9 @@ public:
   Dali::Actor::HoverSignalType& HoveredSignal();
 
   /**
-   * @copydoc Dali::Actor::MouseWheelEventSignal()
+   * @copydoc Dali::Actor::WheelEventSignal()
    */
-  Dali::Actor::MouseWheelEventSignalType& MouseWheelEventSignal();
+  Dali::Actor::WheelEventSignalType& WheelEventSignal();
 
   /**
    * @copydoc Dali::Actor::OnStageSignal()
@@ -1511,13 +1440,13 @@ public:
    */
   static bool DoAction( BaseObject* object,
                         const std::string& actionName,
-                        const std::vector< Property::Value >& attributes );
+                        const Property::Map& attributes );
 
 public:
   // For Animation
 
   /**
-   * This should only be called by Animation, when the actor is resized using Animation::Resize().
+   * This should only be called by Animation, when the actors SIZE property is animated.
    *
    * @param[in] animation The animation that resized the actor
    * @param[in] targetSize The new target size of the actor
@@ -1525,6 +1454,14 @@ public:
   void NotifySizeAnimation( Animation& animation, const Vector3& targetSize );
 
   /**
+   * This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT property is animated.
+   *
+   * @param[in] animation The animation that resized the actor
+   * @param[in] targetSize The new target size of the actor
+   */
+  void NotifySizeAnimation( Animation& animation, float targetSize, Property::Index property );
+
+  /**
    * For use in derived classes.
    * This should only be called by Animation, when the actor is resized using Animation::Resize().
    */
@@ -1558,24 +1495,22 @@ protected:
 
   /**
    * Called on a child during Add() when the parent actor is connected to the Stage.
-   * @param[in] stage The stage.
-   * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
+   * @param[in] parentDepth The depth of the parent in the hierarchy.
    */
-  void ConnectToStage( int index = -1 );
+  void ConnectToStage( unsigned int parentDepth );
 
   /**
    * Helper for ConnectToStage, to recursively connect a tree of actors.
    * This is atomic i.e. not interrupted by user callbacks.
-   * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
+   * @param[in]  depth The depth in the hierarchy of the actor
    * @param[out] connectionList On return, the list of connected actors which require notification.
    */
-  void RecursiveConnectToStage( ActorContainer& connectionList, int index = -1 );
+  void RecursiveConnectToStage( ActorContainer& connectionList, unsigned int depth );
 
   /**
    * Connect the Node associated with this Actor to the scene-graph.
-   * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
    */
-  void ConnectToSceneGraph( int index = -1 );
+  void ConnectToSceneGraph();
 
   /**
    * Helper for ConnectToStage, to notify a connected actor through the public API.
@@ -1610,16 +1545,8 @@ protected:
    */
   bool IsNodeConnected() const;
 
-  /**
-   * Calculate the size of the z dimension for a 2D size
-   *
-   * @param[in] size The 2D size (X, Y) to calculate Z from
-   *
-   * @return Return the Z dimension for this size
-   */
-  float CalculateSizeZ( const Vector2& size ) const;
-
 public:
+
   // Default property extensions from Object
 
   /**
@@ -1716,9 +1643,8 @@ private:
   /**
    * Set the actors parent.
    * @param[in] parent The new parent.
-   * @param[in] index If set, it is only used for positioning the actor within the parent's child list.
    */
-  void SetParent( Actor* parent, int index = -1 );
+  void SetParent( Actor* parent );
 
   /**
    * Helper to create a Node for this Actor.
@@ -1756,7 +1682,7 @@ private:
    * For use in external (CustomActor) derived classes.
    * This is called after the atomic ConnectToStage() traversal has been completed.
    */
-  virtual void OnStageConnectionExternal()
+  virtual void OnStageConnectionExternal( int depth )
   {
   }
 
@@ -1816,11 +1742,11 @@ private:
 
   /**
    * For use in derived classes.
-   * This is only called if the mouse wheel signal was not consumed.
-   * @param[in] event The mouse event.
+   * This is only called if the wheel signal was not consumed.
+   * @param[in] event The wheel event.
    * @return True if the event should be consumed.
    */
-  virtual bool OnMouseWheelEvent( const MouseWheelEvent& event )
+  virtual bool OnWheelEvent( const WheelEvent& event )
   {
     return false;
   }
@@ -1828,7 +1754,7 @@ private:
   /**
    * @brief Ensure the relayout data is allocated
    */
-  void EnsureRelayoutData() const;
+  void EnsureRelayoutData();
 
   /**
    * @brief Apply the size set policy to the input size
@@ -1840,19 +1766,16 @@ private:
 
 protected:
 
-  StagePtr mStage;                ///< Used to send messages to Node; valid until Core destruction
   Actor* mParent;                 ///< Each actor (except the root) can have one parent
   ActorContainer* mChildren;      ///< Container of referenced actors
+  RendererContainer* mRenderers;   ///< Renderer container
+
   const SceneGraph::Node* mNode;  ///< Not owned
   Vector3* mParentOrigin;         ///< NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable
   Vector3* mAnchorPoint;          ///< NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable
 
   struct RelayoutData;
-  mutable RelayoutData* mRelayoutData; ///< Struct to hold optional collection of relayout variables
-
-#ifdef DYNAMICS_SUPPORT
-  DynamicsData* mDynamicsData; ///< optional physics data
-#endif
+  RelayoutData* mRelayoutData; ///< Struct to hold optional collection of relayout variables
 
   ActorGestureData* mGestureData;   ///< Optional Gesture data. Only created when actor requires gestures
 
@@ -1861,7 +1784,7 @@ protected:
   // Signals
   Dali::Actor::TouchSignalType             mTouchedSignal;
   Dali::Actor::HoverSignalType             mHoveredSignal;
-  Dali::Actor::MouseWheelEventSignalType   mMouseWheelEventSignal;
+  Dali::Actor::WheelEventSignalType        mWheelEventSignal;
   Dali::Actor::OnStageSignalType           mOnStageSignal;
   Dali::Actor::OffStageSignalType          mOffStageSignal;
   Dali::Actor::OnRelayoutSignalType        mOnRelayoutSignal;
@@ -1872,18 +1795,19 @@ protected:
   std::string     mName;      ///< Name of the actor
   unsigned int    mId;        ///< A unique ID to identify the actor starting from 1, and 0 is reserved
 
+  unsigned short mDepth                            :12; ///< Cached: The depth in the hierarchy of the actor. Only 4096 levels of depth are supported
   const bool mIsRoot                               : 1; ///< Flag to identify the root actor
   const bool mIsRenderable                         : 1; ///< Flag to identify that this is a renderable actor
   const bool mIsLayer                              : 1; ///< Flag to identify that this is a layer
   bool mIsOnStage                                  : 1; ///< Flag to identify whether the actor is on-stage
-  bool mIsDynamicsRoot                             : 1; ///< Flag to identify if this is the dynamics world root
   bool mSensitive                                  : 1; ///< Whether the actor emits touch event signals
   bool mLeaveRequired                              : 1; ///< Whether a touch event signal is emitted when the a touch leaves the actor's bounds
   bool mKeyboardFocusable                          : 1; ///< Whether the actor should be focusable by keyboard navigation
   bool mDerivedRequiresTouch                       : 1; ///< Whether the derived actor type requires touch event signals
   bool mDerivedRequiresHover                       : 1; ///< Whether the derived actor type requires hover event signals
-  bool mDerivedRequiresMouseWheelEvent             : 1; ///< Whether the derived actor type requires mouse wheel event signals
+  bool mDerivedRequiresWheelEvent                  : 1; ///< Whether the derived actor type requires wheel event signals
   bool mOnStageSignalled                           : 1; ///< Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection
+  bool mInsideOnSizeSet                            : 1; ///< Whether we are inside OnSizeSet
   bool mInheritOrientation                         : 1; ///< Cached: Whether the parent's orientation should be inherited.
   bool mInheritScale                               : 1; ///< Cached: Whether the parent's scale should be inherited.
   DrawMode::Type mDrawMode                         : 2; ///< Cached: How the actor and its children should be drawn