#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
struct KeyEvent;
struct TouchEvent;
struct HoverEvent;
-struct MouseWheelEvent;
+struct WheelEvent;
namespace Internal
{
class ActorGestureData;
class Animation;
class RenderTask;
+class Renderer;
struct DynamicsData;
typedef IntrusivePtr< Actor > ActorPtr;
-typedef Dali::ActorContainer ActorContainer; // Store handles to return via public-api
+typedef std::vector< Dali::Actor > ActorContainer; // Store handles to return via public-api
typedef ActorContainer::iterator ActorIter;
typedef ActorContainer::const_iterator ActorConstIter;
Dali::Actor GetChildAt( unsigned int index ) const;
/**
- * Retrieve the Actor's children.
- * @return A copy of the container of children.
- */
- ActorContainer GetChildren();
-
- /**
- * Retrieve the Actor's children.
- * @return A const reference to the container of children.
- */
- const ActorContainer& GetChildren() const;
-
- /**
* Retrieve a reference to Actor's children.
* @note Not for public use.
* @return A reference to the container of children.
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.
Dimension::Type GetDimensionDependency( Dimension::Type dimension ) const;
/**
- * @copydoc Dali::Actor::SetRelayoutEnabled()
+ * @brief Set the size negotiation relayout enabled on this actor
+ *
+ * @param[in] relayoutEnabled Boolean to enable or disable relayout
*/
void SetRelayoutEnabled( bool relayoutEnabled );
/**
- * @copydoc Dali::Actor::IsRelayoutEnabled()
+ * @brief Return if relayout is enabled
+ *
+ * @return Return if relayout is enabled or not for this actor
*/
bool IsRelayoutEnabled() const;
void RelayoutRequest( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
/**
- * @brief Request to relayout of all actors in the sub-tree below the given actor.
- *
- * This flags the actor and all actors below it for relayout. The actual
- * relayout is performed at the end of the frame. This means that multiple calls to relayout
- * will not cause multiple relayouts to occur.
- */
- void RelayoutRequestTree();
-
- /*
- * @copydoc Dali::Actor::PropagateRelayoutFlags
- */
- void PropagateRelayoutFlags();
-
- /**
* @brief Determine if this actor is dependent on it's parent for relayout
*
* @param dimension The dimension(s) to check for
float CalculateSize( Dimension::Type dimension, const Vector2& maximumSize );
/**
- * @brief Constain a dimension given the relayout constraints on this actor
+ * @brief Clamp a dimension given the relayout constraints on this actor
*
* @param[in] size The size to constrain
* @param[in] dimension The dimension the size exists in
- * @return Return the constrained size
+ * @return Return the clamped size
*/
- float ConstrainDimension( float size, Dimension::Type dimension );
+ float ClampDimension( float size, Dimension::Type dimension );
/**
* Negotiate a dimension based on the size of the parent
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
* @copydoc Dali::Actor::GetMaximumSize
*/
float GetMaximumSize( Dimension::Type dimension ) const;
+
+ /**
+ * @copydoc Dali::Actor::AddRenderer()
+ */
+ unsigned int AddRenderer( Renderer& renderer );
+
+ /**
+ * @copydoc Dali::Actor::GetRendererCount()
+ */
+ unsigned int GetRendererCount() const;
+
+ /**
+ * @copydoc Dali::Actor::GetRendererAt()
+ */
+ Renderer& GetRendererAt( unsigned int index );
+
+ /**
+ * @copydoc Dali::Actor::RemoveRenderer()
+ */
+ void RemoveRenderer( Renderer& renderer );
+
+ /**
+ * @copydoc Dali::Actor::RemoveRenderer()
+ */
+ void RemoveRenderer( unsigned int index );
#ifdef DYNAMICS_SUPPORT
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
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()
Dali::Actor::HoverSignalType& HoveredSignal();
/**
- * @copydoc Dali::Actor::MouseWheelEventSignal()
+ * @copydoc Dali::Actor::WheelEventSignal()
*/
- Dali::Actor::MouseWheelEventSignalType& MouseWheelEventSignal();
+ Dali::Actor::WheelEventSignalType& WheelEventSignal();
/**
* @copydoc Dali::Actor::OnStageSignal()
*/
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
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().
*/
/**
* Called on a child during Add() when the parent actor is connected to the Stage.
* @param[in] stage The stage.
+ * @param[in] parentDepth The depth of the parent in the hierarchy
* @param[in] index If set, it is only used for positioning the actor within the parent's child list.
*/
- void ConnectToStage( int index = -1 );
+ void ConnectToStage( unsigned int parentDepth, int index = -1 );
/**
* 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, int index = -1 );
/**
* Connect the Node associated with this Actor to the scene-graph.
*/
float CalculateSizeZ( const Vector2& size ) const;
+ /**
+ * Return the depth in the hierarchy of the actor.
+ * The value returned is only valid if the actor is on the stage.
+ *
+ * @return Depth of the actor in the hierarchy
+ */
+ unsigned int GetDepth() const
+ {
+ return mDepth;
+ }
+
public:
// Default property extensions from Object
* For use in external (CustomActor) derived classes.
* This is called after the atomic ConnectToStage() traversal has been completed.
*/
- virtual void OnStageConnectionExternal()
+ virtual void OnStageConnectionExternal( unsigned int depth )
{
}
/**
* 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;
}
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
const SceneGraph::Node* mNode; ///< Not owned
// 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;
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 int mDepth :12; ///< 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 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