X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Finternal%2Fevent%2Factors%2Factor-impl.h;h=9eb16903fcef0a69d0d56831131bb0362f00412c;hb=2b14556d9c28a96b8b90fff90eedd5563b6d2f14;hp=7c1744a83d58333f9f09c1507d7d5e72cc20d48b;hpb=93460e870dcbb949193f2e790aba4f4e0defd2e2;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/internal/event/actors/actor-impl.h b/dali/internal/event/actors/actor-impl.h index 7c1744a..9eb1690 100644 --- a/dali/internal/event/actors/actor-impl.h +++ b/dali/internal/event/actors/actor-impl.h @@ -2,7 +2,7 @@ #define __DALI_INTERNAL_ACTOR_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2016 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -22,31 +22,26 @@ #include // INTERNAL INCLUDES -#include -#include #include +#include #include #include #include -#include +#include #include -#include #include -#include -#include +#include +#include +#include #include -#ifdef DYNAMICS_SUPPORT -#include -#endif - namespace Dali { struct KeyEvent; struct TouchEvent; struct HoverEvent; -struct MouseWheelEvent; +struct WheelEvent; namespace Internal { @@ -56,21 +51,22 @@ class ActorGestureData; class Animation; class RenderTask; class Renderer; -struct DynamicsData; -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. * Multi-Touch events are received through signals emitted by the actor tree. * * An Actor is a proxy for a Node in the scene graph. - * When an Actor is added to the Stage, it creates a node and attaches it to the scene graph. - * The scene-graph can be updated in a separate thread, so the attachment is done using an asynchronous message. + * When an Actor is added to the Stage, it creates a node and connects it to the scene graph. + * The scene-graph can be updated in a separate thread, so the connection is done using an asynchronous message. * When a tree of Actors is detached from the Stage, a message is sent to destroy the associated nodes. */ class Actor : public Object @@ -136,21 +132,6 @@ public: */ unsigned int GetId() const; - // Attachments - - /** - * Attach an object to an actor. - * @pre The actor does not already have an attachment. - * @param[in] attachment The object to attach. - */ - void Attach( ActorAttachment& attachment ); - - /** - * Retreive the object attached to an actor. - * @return The attachment. - */ - ActorAttachmentPtr GetAttachment(); - // Containment /** @@ -168,13 +149,13 @@ public: bool OnStage() const; /** - * Query whether the actor is a RenderableActor derived type. + * Query whether the actor has any renderers. * @return True if the actor is renderable. */ bool IsRenderable() const { // inlined as this is called a lot in hit testing - return mIsRenderable; + return mRenderers && !mRenderers->empty(); } /** @@ -203,16 +184,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. @@ -233,7 +204,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. @@ -266,7 +237,6 @@ public: /** * Sets the size of an actor. - * ActorAttachments attached to the actor, can be scaled to fit within this area. * This does not interfere with the actors scale factor. * @param [in] width The new width. * @param [in] height The new height. @@ -275,7 +245,6 @@ public: /** * Sets the size of an actor. - * ActorAttachments attached to the actor, can be scaled to fit within this area. * This does not interfere with the actors scale factor. * @param [in] width The size of the actor along the x-axis. * @param [in] height The size of the actor along the y-axis. @@ -285,7 +254,6 @@ public: /** * Sets the size of an actor. - * ActorAttachments attached to the actor, can be scaled to fit within this area. * This does not interfere with the actors scale factor. * @param [in] size The new size. */ @@ -300,7 +268,6 @@ public: /** * Sets the size of an actor. - * ActorAttachments attached to the actor, can be scaled to fit within this area. * This does not interfere with the actors scale factor. * @param [in] size The new size. */ @@ -499,6 +466,16 @@ public: PositionInheritanceMode GetPositionInheritanceMode() const; /** + * @copydoc Dali::Actor::SetInheritPosition() + */ + void SetInheritPosition( bool inherit ); + + /** + * @copydoc Dali::Actor::IsPositionInherited() + */ + bool IsPositionInherited() const; + + /** * Sets the orientation of the Actor. * @param [in] angleRadians The new orientation angle in radians. * @param [in] axis The new axis of orientation. @@ -762,6 +739,19 @@ public: */ const Vector4& GetCurrentWorldColor() const; + /** + * @copydoc Dali::Actor::GetHierarchyDepth() + */ + int GetHierarchyDepth() const + { + if( mIsOnStage ) + { + return static_cast(mDepth); + } + + return -1; + } + public: // Size negotiation virtual functions @@ -965,11 +955,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 * @@ -1149,6 +1134,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 @@ -1190,7 +1189,7 @@ public: * @copydoc Dali::Actor::GetMaximumSize */ float GetMaximumSize( Dimension::Type dimension ) const; - + /** * @copydoc Dali::Actor::AddRenderer() */ @@ -1204,7 +1203,7 @@ public: /** * @copydoc Dali::Actor::GetRendererAt() */ - Renderer& GetRendererAt( unsigned int index ); + RendererPtr GetRendererAt( unsigned int index ); /** * @copydoc Dali::Actor::RemoveRenderer() @@ -1216,93 +1215,8 @@ public: */ void RemoveRenderer( unsigned int index ); -#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. - */ - 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; - - /** - * Add actor to the dynamics simulation - * Invoked when the actor is staged, or it's parent becomes the simulation root - */ - void ConnectDynamics(); - - /** - * Remove actor from the dynamics simulation - * Invoked when the actor is unstaged, or it's parent stops being the the simulation root - */ - void DisconnectDynamics(); - - /** - * An actor in a DynamicsJoint relationship has been staged - * @param[in] actor The actor passed into AddDynamicsJoint() - */ - void AttachedActorOnStage( Dali::Actor actor ); - - /** - * An actor in a DynamicsJoint relationship has been unstaged - * @param[in] actor The actor passed into AddDynamicsJoint() - */ - void AttachedActorOffStage( Dali::Actor actor ); - -#endif // DYNAMICS_SUPPORT - 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) @@ -1324,7 +1238,7 @@ public: * @param[in] screenY The screen Y-coordinate. * @return True if the conversion succeeded. */ - bool ScreenToLocal( RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY ) const; + bool ScreenToLocal( const RenderTask& renderTask, float& localX, float& localY, float screenX, float screenY ) const; /** * Converts from the actor's coordinate system to screen coordinates. @@ -1410,10 +1324,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 @@ -1457,11 +1371,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() @@ -1474,9 +1388,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() @@ -1516,13 +1430,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 @@ -1530,6 +1444,15 @@ public: void NotifySizeAnimation( Animation& animation, const Vector3& targetSize ); /** + * This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT or SIZE_DEPTH property is animated. + * + * @param[in] animation The animation that resized the actor + * @param[in] targetSize The new target size of the actor + * @param[in] property The index of the property being animated + */ + 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(). */ @@ -1537,11 +1460,28 @@ public: { } + /** + * This should only be called by Animation, when the actors POSITION property is animated. + * + * @param[in] animation The animation that repositioned the actor + * @param[in] targetPosition The new target position of the actor + */ + void NotifyPositionAnimation( Animation& animation, const Vector3& targetPosition ); + + /** + * This should only be called by Animation, when the actors POSITION_X or POSITION_Y or POSITION_Z property is animated. + * + * @param[in] animation The animation that repositioned the actor + * @param[in] targetPosition The new target position of the actor + * @param[in] property The index of the property being animated + */ + void NotifyPositionAnimation( Animation& animation, float targetPosition, Property::Index property ); + protected: enum DerivedType { - BASIC, RENDERABLE, LAYER, ROOT_LAYER + BASIC, LAYER, ROOT_LAYER }; /** @@ -1563,24 +1503,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. @@ -1615,16 +1553,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 /** @@ -1721,9 +1651,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. @@ -1761,7 +1690,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 ) { } @@ -1782,7 +1711,7 @@ private: } /** - * For use in derived classes; this is called after Remove() has removed a child. + * For use in derived classes; this is called after Remove() has attempted to remove a child( regardless of whether it succeeded or not ). * @param[in] child The child that was removed. */ virtual void OnChildRemove( Actor& child ) @@ -1821,11 +1750,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; } @@ -1833,7 +1762,7 @@ private: /** * @brief Ensure the relayout data is allocated */ - void EnsureRelayoutData() const; + void EnsureRelayoutData(); /** * @brief Apply the size set policy to the input size @@ -1843,30 +1772,31 @@ private: */ Vector2 ApplySizeSetPolicy( const Vector2 size ); + /** + * Retrieve the parent object of an Actor. + * @return The parent object, or NULL if the Actor does not have a parent. + */ + virtual Object* GetParentObject() const; + 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 - ActorAttachmentPtr mAttachment; ///< Optional referenced attachment - // 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; @@ -1877,18 +1807,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 mInheritPosition : 1; ///< Cached: Whether the parent's position should be inherited. 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