X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Finternal%2Fevent%2Factors%2Factor-impl.h;h=53fe06a06d0de923bd80205cd09eddbaf6552167;hb=17f28cc04cbb2708a29a6ef7a353ce15fc434b2d;hp=b73371bdb506ddee2f53fd60f867dda4bde9f34f;hpb=19ab6276b29f8a7d1c52c6cc0a38e494f4ac9a05;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 old mode 100644 new mode 100755 index b73371b..53fe06a --- 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) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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. @@ -23,17 +23,20 @@ // INTERNAL INCLUDES #include +#include #include #include #include #include #include #include +#include #include #include #include #include #include +#include namespace Dali { @@ -51,6 +54,7 @@ class ActorGestureData; class Animation; class RenderTask; class Renderer; +class Scene; typedef std::vector< ActorPtr > ActorContainer; typedef ActorContainer::iterator ActorIter; @@ -59,6 +63,9 @@ typedef ActorContainer::const_iterator ActorConstIter; typedef std::vector< RendererPtr > RendererContainer; typedef RendererContainer::iterator RendererIter; +class ActorDepthTreeNode; +typedef Dali::Internal::MemoryPoolObjectAllocator< ActorDepthTreeNode > DepthNodeMemoryPool; + /** * Actor is the primary object which Dali applications interact with. * UI controls can be built by combining multiple actors. @@ -116,6 +123,12 @@ public: static ActorPtr New(); /** + * Helper to create node for derived classes who don't have their own node type + * @return pointer to newly created unique node + */ + static const SceneGraph::Node* CreateNode(); + + /** * Retrieve the name of the actor. * @return The name. */ @@ -130,7 +143,7 @@ public: /** * @copydoc Dali::Actor::GetId */ - unsigned int GetId() const; + uint32_t GetId() const; // Containment @@ -199,17 +212,18 @@ public: * Retrieve the number of children held by the actor. * @return The number of children */ - unsigned int GetChildCount() const; + uint32_t GetChildCount() const; /** * @copydoc Dali::Actor::GetChildAt */ - ActorPtr GetChildAt( unsigned int index ) const; + ActorPtr GetChildAt( uint32_t index ) const; /** * Retrieve a reference to Actor's children. * @note Not for public use. * @return A reference to the container of children. + * @note The internal container is lazily initialized so ensure you check the child count before using the value returned by this method. */ ActorContainer& GetChildrenInternal() { @@ -224,7 +238,7 @@ public: /** * @copydoc Dali::Actor::FindChildById */ - ActorPtr FindChildById( const unsigned int id ); + ActorPtr FindChildById( const uint32_t id ); /** * Retrieve the parent of an Actor. @@ -236,6 +250,13 @@ public: } /** + * Calculates screen position and size. + * + * @return pair of two values, position of top-left corner on screen and size respectively. + */ + Rect<> CalculateScreenExtents( ) const; + + /** * Sets the size of an actor. * This does not interfere with the actors scale factor. * @param [in] width The new width. @@ -303,7 +324,7 @@ public: * This size will be the size set or if animating then the target size. * @return The Actor's size. */ - const Vector3& GetTargetSize() const; + Vector3 GetTargetSize() const; /** * Retrieve the Actor's size from update side. @@ -456,16 +477,6 @@ public: const Vector3& GetCurrentWorldPosition() const; /** - * @copydoc Dali::Actor::SetPositionInheritanceMode() - */ - void SetPositionInheritanceMode( PositionInheritanceMode mode ); - - /** - * @copydoc Dali::Actor::GetPositionInheritanceMode() - */ - PositionInheritanceMode GetPositionInheritanceMode() const; - - /** * @copydoc Dali::Actor::SetInheritPosition() */ void SetInheritPosition( bool inherit ); @@ -613,7 +624,7 @@ public: /** * Sets the visibility flag of an actor. - * @param [in] visible The new visibility flag. + * @param[in] visible The new visibility flag. */ void SetVisible( bool visible ); @@ -743,23 +754,22 @@ public: /** * @copydoc Dali::Actor::GetHierarchyDepth() */ - inline int GetHierarchyDepth() const + inline int32_t GetHierarchyDepth() const { if( mIsOnStage ) { - return static_cast(mDepth); + return mDepth; } return -1; } /** - * Get the actor's sorting depth (The hierarchy depth combined with - * the sibling order) + * Get the actor's sorting depth * * @return The depth used for hit-testing and renderer sorting */ - unsigned int GetSortingDepth(); + uint32_t GetSortingDepth(); public: @@ -876,6 +886,24 @@ public: void NegotiateSize( const Vector2& size, RelayoutContainer& container ); /** + * @brief Set whether size negotiation should use the assigned size of the actor + * during relayout for the given dimension(s) + * + * @param[in] use Whether the assigned size of the actor should be used + * @param[in] dimension The dimension(s) to set. Can be a bitfield of multiple dimensions + */ + void SetUseAssignedSize( bool use, Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); + + /** + * @brief Returns whether size negotiation should use the assigned size of the actor + * during relayout for a single dimension + * + * @param[in] dimension The dimension to get + * @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 + */ + bool GetUseAssignedSize( Dimension::Type dimension ) const; + + /** * @copydoc Dali::Actor::SetResizePolicy() */ void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); @@ -1202,17 +1230,17 @@ public: /** * @copydoc Dali::Actor::AddRenderer() */ - unsigned int AddRenderer( Renderer& renderer ); + uint32_t AddRenderer( Renderer& renderer ); /** * @copydoc Dali::Actor::GetRendererCount() */ - unsigned int GetRendererCount() const; + uint32_t GetRendererCount() const; /** * @copydoc Dali::Actor::GetRendererAt() */ - RendererPtr GetRendererAt( unsigned int index ); + RendererPtr GetRendererAt( uint32_t index ); /** * @copydoc Dali::Actor::RemoveRenderer() @@ -1222,7 +1250,7 @@ public: /** * @copydoc Dali::Actor::RemoveRenderer() */ - void RemoveRenderer( unsigned int index ); + void RemoveRenderer( uint32_t index ); public: @@ -1388,6 +1416,31 @@ public: bool EmitWheelEventSignal( const WheelEvent& event ); /** + * @brief Emits the visibility change signal for this actor and all its children. + * @param[in] visible Whether the actor has become visible or not. + * @param[in] type Whether the actor's visible property has changed or a parent's. + */ + void EmitVisibilityChangedSignal( bool visible, DevelActor::VisibilityChange::Type type ); + + /** + * @brief Emits the layout direction change signal for this actor and all its children. + * @param[in] type Whether the actor's layout direction property has changed or a parent's. + */ + void EmitLayoutDirectionChangedSignal( LayoutDirection::Type type ); + + /** + * @brief Emits the ChildAdded signal for this actor + * @param[in] child The child actor that has been added + */ + void EmitChildAddedSignal( Actor& child ); + + /** + * @brief Emits the ChildRemoved signal for this actor + * @param[in] child The child actor that has been removed + */ + void EmitChildRemovedSignal( Actor& child ); + + /** * @copydoc Dali::Actor::TouchedSignal() */ Dali::Actor::TouchSignalType& TouchedSignal(); @@ -1423,6 +1476,31 @@ public: Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal(); /** + * @copydoc DevelActor::VisibilityChangedSignal + */ + DevelActor::VisibilityChangedSignalType& VisibilityChangedSignal(); + + /** + * @copydoc LayoutDirectionChangedSignal + */ + Dali::Actor::LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal(); + + /** + * @copydoc DevelActor::ChildAddedSignal + */ + DevelActor::ChildChangedSignalType& ChildAddedSignal(); + + /** + * @copydoc DevelActor::ChildRemovedSignal + */ + DevelActor::ChildChangedSignalType& ChildRemovedSignal(); + + /** + * @copydoc DevelActor::ChildOrderChangedSignal + */ + DevelActor::ChildOrderChangedSignalType& ChildOrderChangedSignal(); + + /** * Connects a callback function with the object's signals. * @param[in] object The object providing the signal. * @param[in] tracker Used to disconnect the signal. @@ -1451,23 +1529,6 @@ public: // For Animation /** - * 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 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(). */ @@ -1475,23 +1536,6 @@ 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 @@ -1503,8 +1547,9 @@ protected: * Protected Constructor. See Actor::New(). * The second-phase construction Initialize() member should be called immediately after this. * @param[in] derivedType The derived type of actor (if any). + * @param[in] reference to the node */ - Actor( DerivedType derivedType ); + Actor( DerivedType derivedType, const SceneGraph::Node& node ); /** * Second-phase constructor. Must be called immediately after creating a new Actor; @@ -1520,7 +1565,7 @@ protected: * Called on a child during Add() when the parent actor is connected to the Stage. * @param[in] parentDepth The depth of the parent in the hierarchy. */ - void ConnectToStage( unsigned int parentDepth ); + void ConnectToStage( uint32_t parentDepth ); /** * Helper for ConnectToStage, to recursively connect a tree of actors. @@ -1528,7 +1573,7 @@ protected: * @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, unsigned int depth ); + void RecursiveConnectToStage( ActorContainer& connectionList, uint32_t depth ); /** * Connect the Node associated with this Actor to the scene-graph. @@ -1569,48 +1614,25 @@ protected: bool IsNodeConnected() const; public: - - // Default property extensions from Object - /** - * @copydoc Dali::Internal::Object::GetDefaultPropertyCount() + * Trigger a rebuild of the actor depth tree from this root + * If a Layer3D is encountered, then this doesn't descend any further. + * The mSortedDepth of each actor is set appropriately. */ - virtual unsigned int GetDefaultPropertyCount() const; + void RebuildDepthTree(); - /** - * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices() - */ - virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const; - - /** - * @copydoc Dali::Internal::Object::GetDefaultPropertyName() - */ - virtual const char* GetDefaultPropertyName( Property::Index index ) const; - - /** - * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex() - */ - virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const; - - /** - * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable() - */ - virtual bool IsDefaultPropertyWritable( Property::Index index ) const; +protected: /** - * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable() + * Traverse the actor tree, inserting actors into the depth tree in sibling order. + * @param[in] sceneGraphNodeDepths A vector capturing the nodes and their depth index + * @param[in,out] depthIndex The current depth index (traversal index) */ - virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const; + void DepthTraverseActorTree( OwnerPointer& sceneGraphNodeDepths, int32_t& depthIndex ); - /** - * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput() - */ - virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const; +public: - /** - * @copydoc Dali::Internal::Object::GetDefaultPropertyType() - */ - virtual Property::Type GetDefaultPropertyType( Property::Index index ) const; + // Default property extensions from Object /** * @copydoc Dali::Internal::Object::SetDefaultProperty() @@ -1628,14 +1650,14 @@ public: virtual Property::Value GetDefaultProperty( Property::Index index ) const; /** - * @copydoc Dali::Internal::Object::GetPropertyOwner() + * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue() */ - virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const; + virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const; /** - * @copydoc Dali::Internal::Object::GetSceneObject() + * @copydoc Dali::Internal::Object::OnNotifyDefaultPropertyAnimation() */ - virtual const SceneGraph::PropertyOwner* GetSceneObject() const; + virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType ); /** * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty() @@ -1650,7 +1672,16 @@ public: /** * @copydoc Dali::Internal::Object::GetPropertyComponentIndex() */ - virtual int GetPropertyComponentIndex( Property::Index index ) const; + virtual int32_t GetPropertyComponentIndex( Property::Index index ) const; + + /** + * Retrieve the actor's node. + * @return The node used by this actor + */ + const SceneGraph::Node& GetNode() const + { + return *static_cast( mUpdateObject ); + } /** * @copydoc Dali::DevelActor::Raise() @@ -1682,16 +1713,35 @@ public: */ void LowerBelow( Internal::Actor& target ); -private: +public: + + /** + * Sets the scene which this actor is added to. + * @param[in] scene The scene + */ + void SetScene( Scene& scene ); - // Undefined - Actor(); + /** + * Gets the scene which this actor is added to. + * @return The scene + */ + Scene& GetScene() const; + +private: - // Undefined - Actor( const Actor& ); + struct SendMessage + { + enum Type + { + FALSE = 0, + TRUE = 1, + }; + }; - // Undefined - Actor& operator=( const Actor& rhs ); + // Remove default constructor and copy constructor + Actor() = delete; + Actor( const Actor& ) = delete; + Actor& operator=( const Actor& rhs ) = delete; /** * Set the actors parent. @@ -1700,13 +1750,6 @@ private: void SetParent( Actor* parent ); /** - * Helper to create a Node for this Actor. - * To be overriden in derived classes. - * @return A newly allocated node. - */ - virtual SceneGraph::Node* CreateNode() const; - - /** * For use in derived classes, called after Initialize() */ virtual void OnInitialize() @@ -1805,6 +1848,22 @@ private: } /** + * @brief Retrieves the cached event side value of a default property. + * @param[in] index The index of the property + * @param[out] value Is set with the cached value of the property if found. + * @return True if value set, false otherwise. + */ + bool GetCachedPropertyValue( Property::Index index, Property::Value& value ) const; + + /** + * @brief Retrieves the current value of a default property from the scene-graph. + * @param[in] index The index of the property + * @param[out] value Is set with the current scene-graph value of the property + * @return True if value set, false otherwise. + */ + bool GetCurrentPropertyValue( Property::Index index, Property::Value& value ) const; + + /** * @brief Ensure the relayout data is allocated */ void EnsureRelayoutData(); @@ -1815,7 +1874,7 @@ private: * @param[in] size The size to apply the policy to * @return Return the adjusted size */ - Vector2 ApplySizeSetPolicy( const Vector2 size ); + Vector2 ApplySizeSetPolicy( const Vector2& size ); /** * Retrieve the parent object of an Actor. @@ -1825,27 +1884,21 @@ private: /** * Set Sibling order - * @param[in] order The sibling order this Actor should be + * @param[in] order The sibling order this Actor should be. It will place + * the actor at this index in it's parent's child array. */ - void SetSiblingOrder( unsigned int order); + void SetSiblingOrder( uint32_t order); /** - * @brief Re-orders the sibling order when any actor raised to the max level - * @param[in] siblings the container of sibling actors + * Get Sibling order + * @return the order of this actor amongst it's siblings */ - void DefragmentSiblingIndexes( ActorContainer& siblings ); + uint32_t GetSiblingOrder() const; /** - * @brief Shifts all siblings levels from the target level up by 1 to make space for a newly insert sibling - * at an exclusive level. - * - * @note Used with Raise and Lower API - * - * @param[in] siblings the actor container of the siblings - * @param[in] targetLevelToShiftFrom the sibling level to start shifting from + * Request that the stage rebuilds the actor depth indices. */ - bool ShiftSiblingsLevels( ActorContainer& siblings, int targetLevelToShiftFrom ); - + void RequestRebuildDepthTree(); /** * @brief Get the current position of the actor in screen coordinates. @@ -1854,13 +1907,40 @@ private: */ const Vector2 GetCurrentScreenPosition() const; + /** + * Sets the visibility flag of an actor. + * @param[in] visible The new visibility flag. + * @param[in] sendMessage Whether to send a message to the update thread or not. + */ + void SetVisibleInternal( bool visible, SendMessage::Type sendMessage ); + + /** + * Set whether a child actor inherits it's parent's layout direction. Default is to inherit. + * @param[in] inherit - true if the actor should inherit layout direction, false otherwise. + */ + void SetInheritLayoutDirection( bool inherit ); + + /** + * Returns whether the actor inherits it's parent's layout direction. + * @return true if the actor inherits it's parent's layout direction, false otherwise. + */ + bool IsLayoutDirectionInherited() const; + + /** + * @brief Propagates layout direction recursively. + * @param[in] actor The actor for seting layout direction. + * @param[in] direction New layout direction. + */ + void InheritLayoutDirectionRecursively( ActorPtr actor, Dali::LayoutDirection::Type direction, bool set = false ); + protected: + Scene* mScene; ///< The scene the actor is added to + Actor* mParent; ///< Each actor (except the root) can have one parent - ActorContainer* mChildren; ///< Container of referenced actors + ActorContainer* mChildren; ///< Container of referenced actors, lazily initialized 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 @@ -1877,15 +1957,21 @@ protected: Dali::Actor::OnStageSignalType mOnStageSignal; Dali::Actor::OffStageSignalType mOffStageSignal; Dali::Actor::OnRelayoutSignalType mOnRelayoutSignal; - - Vector3 mTargetSize; ///< Event-side storage for size (not a pointer as most actors will have a size) - Vector3 mTargetPosition; ///< Event-side storage for position (not a pointer as most actors will have a position) - - std::string mName; ///< Name of the actor - unsigned int mId; ///< A unique ID to identify the actor starting from 1, and 0 is reserved - - uint16_t mDepth; ///< The depth in the hierarchy of the actor. Only 4096 levels of depth are supported - uint16_t mSiblingOrder; ///< The sibling order of the actor + DevelActor::VisibilityChangedSignalType mVisibilityChangedSignal; + Dali::Actor::LayoutDirectionChangedSignalType mLayoutDirectionChangedSignal; + DevelActor::ChildChangedSignalType mChildAddedSignal; + DevelActor::ChildChangedSignalType mChildRemovedSignal; + DevelActor::ChildOrderChangedSignalType mChildOrderChangedSignal; + + Quaternion mTargetOrientation; ///< Event-side storage for orientation + Vector4 mTargetColor; ///< Event-side storage for color + Vector3 mTargetSize; ///< Event-side storage for size (not a pointer as most actors will have a size) + Vector3 mTargetPosition; ///< Event-side storage for position (not a pointer as most actors will have a position) + Vector3 mTargetScale; ///< Event-side storage for scale + + std::string mName; ///< Name of the actor + uint32_t mSortedDepth; ///< The sorted depth index. A combination of tree traversal and sibling order. + int16_t mDepth; ///< The depth in the hierarchy of the actor. Only 32,767 levels of depth are supported const bool mIsRoot : 1; ///< Flag to identify the root actor const bool mIsLayer : 1; ///< Flag to identify that this is a layer @@ -1901,15 +1987,18 @@ protected: 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 - PositionInheritanceMode mPositionInheritanceMode : 2; ///< Cached: Determines how position is inherited - ColorMode mColorMode : 2; ///< Cached: Determines whether mWorldColor is inherited - ClippingMode::Type mClippingMode : 2; ///< Cached: Determines which clipping mode (if any) to use. + bool mPositionUsesAnchorPoint : 1; ///< Cached: Whether the position uses the anchor point or not. + bool mVisible : 1; ///< Cached: Whether the actor is visible or not. + bool mInheritLayoutDirection : 1; ///< Whether the actor inherits the layout direction from parent. + LayoutDirection::Type mLayoutDirection : 2; ///< Layout direction, Left to Right or Right to Left. + DrawMode::Type mDrawMode : 3; ///< Cached: How the actor and its children should be drawn + ColorMode mColorMode : 3; ///< Cached: Determines whether mWorldColor is inherited + ClippingMode::Type mClippingMode : 3; ///< Cached: Determines which clipping mode (if any) to use. private: static ActorContainer mNullChildren; ///< Empty container (shared by all actors, returned by GetChildren() const) - static unsigned int mActorCounter; ///< A counter to track the actor instance creation + }; } // namespace Internal