X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Finternal%2Fevent%2Factors%2Factor-impl.h;h=a3ad757a2b5111ba823b38365409c525a0735b21;hb=refs%2Fchanges%2F91%2F246391%2F2;hp=feef5407349120100559626b8a53c109aacc20fa;hpb=eaa35becf46fcd9793be784e8e99a546966d6c25;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 feef540..a3ad757 --- 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) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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. @@ -30,6 +30,7 @@ #include #include #include +#include #include #include #include @@ -41,10 +42,10 @@ namespace Dali { -struct KeyEvent; +class KeyEvent; class TouchData; -struct HoverEvent; -struct WheelEvent; +class TouchEvent; +class WheelEvent; namespace Internal { @@ -54,16 +55,17 @@ class ActorGestureData; class Animation; class RenderTask; class Renderer; +class Scene; -typedef std::vector< ActorPtr > ActorContainer; -typedef ActorContainer::iterator ActorIter; -typedef ActorContainer::const_iterator ActorConstIter; +using ActorContainer = std::vector; +using ActorIter = ActorContainer::iterator; +using ActorConstIter = ActorContainer::const_iterator; -typedef std::vector< RendererPtr > RendererContainer; -typedef RendererContainer::iterator RendererIter; +using RendererContainer = std::vector; +using RendererIter = RendererContainer::iterator; class ActorDepthTreeNode; -typedef Dali::Internal::MemoryPoolObjectAllocator< ActorDepthTreeNode > DepthNodeMemoryPool; +using DepthNodeMemoryPool = Dali::Internal::MemoryPoolObjectAllocator; /** * Actor is the primary object which Dali applications interact with. @@ -111,7 +113,7 @@ public: Dimension::Type dimension; ///< The dimension to hold }; - typedef std::vector< ActorDimensionPair > ActorDimensionStack; + using ActorDimensionStack = std::vector; public: @@ -122,10 +124,19 @@ 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. */ - const std::string& GetName() const; + const std::string& GetName() const + { + return mName; + } /** * Set the name of the actor. @@ -136,7 +147,7 @@ public: /** * @copydoc Dali::Actor::GetId */ - unsigned int GetId() const; + uint32_t GetId() const; // Containment @@ -150,9 +161,12 @@ public: } /** - * Query whether the actor is connected to the Stage. + * Query whether the actor is connected to the Scene. */ - bool OnStage() const; + bool OnScene() const + { + return mIsOnScene; + } /** * Query whether the actor has any renderers. @@ -205,12 +219,12 @@ 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. @@ -231,7 +245,7 @@ public: /** * @copydoc Dali::Actor::FindChildById */ - ActorPtr FindChildById( const unsigned int id ); + ActorPtr FindChildById( const uint32_t id ); /** * Retrieve the parent of an Actor. @@ -243,6 +257,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. @@ -337,24 +358,6 @@ public: void SetParentOrigin( const Vector3& origin ); /** - * Set the x component of the parent-origin - * @param [in] x The new x value. - */ - void SetParentOriginX( float x ); - - /** - * Set the y component of the parent-origin - * @param [in] y The new y value. - */ - void SetParentOriginY( float y ); - - /** - * Set the z component of the parent-origin - * @param [in] z The new z value. - */ - void SetParentOriginZ( float z ); - - /** * Retrieve the parent-origin of an actor. * @return The parent-origin. */ @@ -371,24 +374,6 @@ public: void SetAnchorPoint( const Vector3& anchorPoint ); /** - * Set the x component of the anchor-point. - * @param [in] x The new x value. - */ - void SetAnchorPointX( float x ); - - /** - * Set the y component of the anchor-point. - * @param [in] y The new y value. - */ - void SetAnchorPointY( float y ); - - /** - * Set the z component of the anchor-point. - * @param [in] z The new z value. - */ - void SetAnchorPointZ( float z ); - - /** * Retrieve the anchor-point of an actor. * @return The anchor-point. */ @@ -455,7 +440,10 @@ public: * The coordinates are relative to the Actor's parent. * @return the Actor's position. */ - const Vector3& GetTargetPosition() const; + const Vector3& GetTargetPosition() const + { + return mTargetPosition; + } /** * @copydoc Dali::Actor::GetCurrentWorldPosition() @@ -463,16 +451,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 ); @@ -480,7 +458,10 @@ public: /** * @copydoc Dali::Actor::IsPositionInherited() */ - bool IsPositionInherited() const; + bool IsPositionInherited() const + { + return mInheritPosition; + } /** * Sets the orientation of the Actor. @@ -525,7 +506,10 @@ public: * Returns whether the actor inherit's it's parent's orientation. * @return true if the actor inherit's it's parent orientation, false if it uses world orientation. */ - bool IsOrientationInherited() const; + bool IsOrientationInherited() const + { + return mInheritOrientation; + } /** * Sets the factor of the parents size used for the child actor. @@ -609,7 +593,10 @@ public: /** * @copydoc Dali::Actor::IsScaleInherited() */ - bool IsScaleInherited() const; + bool IsScaleInherited() const + { + return mInheritScale; + } /** * @copydoc Dali::Actor::GetCurrentWorldMatrix() @@ -646,7 +633,10 @@ public: * Retrieve the actor's clipping mode. * @return The actor's clipping mode (cached) */ - ClippingMode::Type GetClippingMode() const; + ClippingMode::Type GetClippingMode() const + { + return mClippingMode; + } /** * Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover(). @@ -691,12 +681,18 @@ public: /** * @copydoc Dali::Actor::GetDrawMode */ - DrawMode::Type GetDrawMode() const; + DrawMode::Type GetDrawMode() const + { + return mDrawMode; + } /** * @copydoc Dali::Actor::IsOverlay */ - bool IsOverlay() const; + bool IsOverlay() const + { + return ( DrawMode::OVERLAY_2D == mDrawMode ); + } /** * Sets the actor's color. The final color of actor depends on its color mode. @@ -740,7 +736,10 @@ public: * Returns the actor's color mode. * @return currently used colorMode. */ - ColorMode GetColorMode() const; + ColorMode GetColorMode() const + { + return mColorMode; + } /** * @copydoc Dali::Actor::GetCurrentWorldColor() @@ -750,11 +749,11 @@ public: /** * @copydoc Dali::Actor::GetHierarchyDepth() */ - inline int GetHierarchyDepth() const + inline int32_t GetHierarchyDepth() const { - if( mIsOnStage ) + if( mIsOnScene ) { - return static_cast(mDepth); + return mDepth; } return -1; @@ -765,7 +764,10 @@ public: * * @return The depth used for hit-testing and renderer sorting */ - unsigned int GetSortingDepth(); + uint32_t GetSortingDepth() + { + return mSortedDepth; + } public: @@ -805,7 +807,7 @@ public: * * @param dimension The dimension that is about to be calculated */ - virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); + virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) {} /** * @brief Virtual method to notify deriving classes that the size for a dimension @@ -814,7 +816,7 @@ public: * @param[in] size The new size for the given dimension * @param[in] dimension The dimension that was just negotiated */ - virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ); + virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) {} /** * @brief Determine if this actor is dependent on it's children for relayout @@ -976,7 +978,7 @@ public: /** * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene) * - * This method is automatically called from OnStageConnection(), OnChildAdd(), + * This method is automatically called from OnSceneConnection(), OnChildAdd(), * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize(). * * This method can also be called from a derived class every time it needs a different size. @@ -1037,15 +1039,6 @@ public: float CalculateSize( Dimension::Type dimension, const Vector2& maximumSize ); /** - * @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 clamped size - */ - float ClampDimension( float size, Dimension::Type dimension ); - - /** * Negotiate a dimension based on the size of the parent * * @param[in] dimension The dimension to negotiate on @@ -1226,17 +1219,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() @@ -1246,7 +1239,7 @@ public: /** * @copydoc Dali::Actor::RemoveRenderer() */ - void RemoveRenderer( unsigned int index ); + void RemoveRenderer( uint32_t index ); public: @@ -1294,29 +1287,6 @@ public: float screenY ) const; /** - * Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere. - * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5) - * @param[in] rayOrigin The ray origin in the world's reference system. - * @param[in] rayDir The ray director vector in the world's reference system. - * @return True if the ray intersects the actor's bounding sphere. - */ - bool RaySphereTest( const Vector4& rayOrigin, const Vector4& rayDir ) const; - - /** - * Performs a ray-actor test with the given pick-ray and the actor's geometry. - * @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5) - * @param[in] rayOrigin The ray origin in the world's reference system. - * @param[in] rayDir The ray director vector in the world's reference system. - * @param[out] hitPointLocal The hit point in the Actor's local reference system. - * @param[out] distance The distance from the hit point to the camera. - * @return True if the ray intersects the actor's geometry. - */ - bool RayActorTest( const Vector4& rayOrigin, - const Vector4& rayDir, - Vector2& hitPointLocal, - float& distance ) const; - - /** * Sets whether the actor should receive a notification when touch or hover motion events leave * the boundary of the actor. * @@ -1325,49 +1295,111 @@ public: * * @param[in] required Should be set to true if a Leave event is required */ - void SetLeaveRequired( bool required ); + void SetLeaveRequired( bool required ) + { + mLeaveRequired = required; + } /** * This returns whether the actor requires touch or hover events whenever touch or hover motion events leave * the boundary of the actor. * @return true if a Leave event is required, false otherwise. */ - bool GetLeaveRequired() const; + bool GetLeaveRequired() const + { + return mLeaveRequired; + } /** * @copydoc Dali::Actor::SetKeyboardFocusable() */ - void SetKeyboardFocusable( bool focusable ); + void SetKeyboardFocusable( bool focusable ) + { + mKeyboardFocusable = focusable; + } /** * @copydoc Dali::Actor::IsKeyboardFocusable() */ - bool IsKeyboardFocusable() const; + bool IsKeyboardFocusable() const + { + return mKeyboardFocusable; + } + + + /** + * Query whether the application or derived actor type requires intercept touch events. + * @return True if intercept touch events are required. + */ + bool GetInterceptTouchRequired() const + { + return !mInterceptTouchedSignal.Empty(); + } /** * Query whether the application or derived actor type requires touch events. * @return True if touch events are required. */ - bool GetTouchRequired() const; + bool GetTouchRequired() const + { + return !mTouchedSignal.Empty(); + } /** * Query whether the application or derived actor type requires hover events. * @return True if hover events are required. */ - bool GetHoverRequired() const; + bool GetHoverRequired() const + { + return !mHoveredSignal.Empty(); + } /** * Query whether the application or derived actor type requires wheel events. * @return True if wheel events are required. */ - bool GetWheelEventRequired() const; + bool GetWheelEventRequired() const + { + return !mWheelEventSignal.Empty(); + } /** * Query whether the actor is actually hittable. This method checks whether the actor is * sensitive, has the visibility flag set to true and is not fully transparent. * @return true, if it can be hit, false otherwise. */ - bool IsHittable() const; + bool IsHittable() const + { + return IsSensitive() && IsVisible() && ( GetCurrentWorldColor().a > FULLY_TRANSPARENT ) && IsNodeConnected(); + } + + /** + * Query whether the actor captures all touch after it starts even if touch leaves its boundary. + * @return true, if it captures all touch after start + */ + bool CapturesAllTouchAfterStart() const + { + return mCaptureAllTouchAfterStart; + } + + /** + * Sets the touch area of an actor. + * @param [in] area The new area. + */ + void SetTouchArea(Vector2 area) + { + mTouchArea = area; + } + + /** + * Retrieve the Actor's touch area. + * @return The Actor's touch area. + */ + const Vector2& GetTouchArea() const + { + return mTouchArea; + } + // Gestures @@ -1384,32 +1416,39 @@ public: /** * Queries whether the actor requires the gesture type. * @param[in] type The gesture type. + * @return True if the gesture is required, false otherwise. */ - bool IsGestureRequred( Gesture::Type type ) const; + bool IsGestureRequired( GestureType::Value type ) const; // Signals /** + * Used by the EventProcessor to emit intercept touch event signals. + * @param[in] touch The touch data. + * @return True if the event was intercepted. + */ + bool EmitInterceptTouchEventSignal( const Dali::TouchEvent& touch ); + + /** * Used by the EventProcessor to emit touch event signals. - * @param[in] event The touch event (Old API). * @param[in] touch The touch data. * @return True if the event was consumed. */ - bool EmitTouchEventSignal( const TouchEvent& event, const Dali::TouchData& touch ); + bool EmitTouchEventSignal( const Dali::TouchEvent& touch ); /** * Used by the EventProcessor to emit hover event signals. * @param[in] event The hover event. * @return True if the event was consumed. */ - bool EmitHoverEventSignal( const HoverEvent& event ); + bool EmitHoverEventSignal( const Dali::HoverEvent& event ); /** * Used by the EventProcessor to emit wheel event signals. * @param[in] event The wheel event. * @return True if the event was consumed. */ - bool EmitWheelEventSignal( const WheelEvent& event ); + bool EmitWheelEventSignal( const Dali::WheelEvent& event ); /** * @brief Emits the visibility change signal for this actor and all its children. @@ -1419,44 +1458,118 @@ public: void EmitVisibilityChangedSignal( bool visible, DevelActor::VisibilityChange::Type type ); /** - * @copydoc Dali::Actor::TouchedSignal() + * @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 */ - Dali::Actor::TouchSignalType& TouchedSignal(); + void EmitChildAddedSignal( Actor& child ); /** - * @copydoc Dali::Actor::TouchEventSignal() + * @brief Emits the ChildRemoved signal for this actor + * @param[in] child The child actor that has been removed + */ + void EmitChildRemovedSignal( Actor& child ); + + /** + * @copydoc DevelActor::InterceptTouchedSignal() + */ + Dali::Actor::TouchEventSignalType& InterceptTouchedSignal() + { + return mInterceptTouchedSignal; + } + + /** + * @copydoc Dali::Actor::TouchedSignal() */ - Dali::Actor::TouchDataSignalType& TouchSignal(); + Dali::Actor::TouchEventSignalType& TouchedSignal() + { + return mTouchedSignal; + } /** * @copydoc Dali::Actor::HoveredSignal() */ - Dali::Actor::HoverSignalType& HoveredSignal(); + Dali::Actor::HoverSignalType& HoveredSignal() + { + return mHoveredSignal; + } /** * @copydoc Dali::Actor::WheelEventSignal() */ - Dali::Actor::WheelEventSignalType& WheelEventSignal(); + Dali::Actor::WheelEventSignalType& WheelEventSignal() + { + return mWheelEventSignal; + } /** - * @copydoc Dali::Actor::OnStageSignal() + * @copydoc Dali::Actor::OnSceneSignal() */ - Dali::Actor::OnStageSignalType& OnStageSignal(); + Dali::Actor::OnSceneSignalType& OnSceneSignal() + { + return mOnSceneSignal; + } /** - * @copydoc Dali::Actor::OffStageSignal() + * @copydoc Dali::Actor::OffSceneSignal() */ - Dali::Actor::OffStageSignalType& OffStageSignal(); + Dali::Actor::OffSceneSignalType& OffSceneSignal() + { + return mOffSceneSignal; + } /** * @copydoc Dali::Actor::OnRelayoutSignal() */ - Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal(); + Dali::Actor::OnRelayoutSignalType& OnRelayoutSignal() + { + return mOnRelayoutSignal; + } /** * @copydoc DevelActor::VisibilityChangedSignal */ - DevelActor::VisibilityChangedSignalType& VisibilityChangedSignal(); + DevelActor::VisibilityChangedSignalType& VisibilityChangedSignal() + { + return mVisibilityChangedSignal; + } + + /** + * @copydoc LayoutDirectionChangedSignal + */ + Dali::Actor::LayoutDirectionChangedSignalType& LayoutDirectionChangedSignal() + { + return mLayoutDirectionChangedSignal; + } + + /** + * @copydoc DevelActor::ChildAddedSignal + */ + DevelActor::ChildChangedSignalType& ChildAddedSignal() + { + return mChildAddedSignal; + } + + /** + * @copydoc DevelActor::ChildRemovedSignal + */ + DevelActor::ChildChangedSignalType& ChildRemovedSignal() + { + return mChildRemovedSignal; + } + + /** + * @copydoc DevelActor::ChildOrderChangedSignal + */ + DevelActor::ChildOrderChangedSignalType& ChildOrderChangedSignal() + { + return mChildOrderChangedSignal; + } /** * Connects a callback function with the object's signals. @@ -1505,8 +1618,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; @@ -1516,21 +1630,21 @@ protected: /** * A reference counted object may only be deleted by calling Unreference() */ - virtual ~Actor(); + ~Actor() override; /** - * Called on a child during Add() when the parent actor is connected to the Stage. + * Called on a child during Add() when the parent actor is connected to the Scene. * @param[in] parentDepth The depth of the parent in the hierarchy. */ - void ConnectToStage( unsigned int parentDepth ); + void ConnectToScene( uint32_t parentDepth ); /** - * Helper for ConnectToStage, to recursively connect a tree of actors. + * Helper for ConnectToScene, to recursively connect a tree of actors. * This is atomic i.e. not interrupted by user callbacks. * @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 RecursiveConnectToScene( ActorContainer& connectionList, uint32_t depth ); /** * Connect the Node associated with this Actor to the scene-graph. @@ -1538,7 +1652,7 @@ protected: void ConnectToSceneGraph(); /** - * Helper for ConnectToStage, to notify a connected actor through the public API. + * Helper for ConnectToScene, to notify a connected actor through the public API. */ void NotifyStageConnection(); @@ -1565,8 +1679,8 @@ protected: void NotifyStageDisconnection(); /** - * When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph. - * @return True if the Actor is OnStage & has a Node connected to the scene graph. + * When the Actor is OnScene, checks whether the corresponding Node is connected to the scene graph. + * @return True if the Actor is OnScene & has a Node connected to the scene graph. */ bool IsNodeConnected() const; @@ -1585,101 +1699,68 @@ protected: * @param[in] sceneGraphNodeDepths A vector capturing the nodes and their depth index * @param[in,out] depthIndex The current depth index (traversal index) */ - void DepthTraverseActorTree( OwnerPointer& sceneGraphNodeDepths, int& depthIndex ); + void DepthTraverseActorTree( OwnerPointer& sceneGraphNodeDepths, int32_t& depthIndex ); public: // Default property extensions from Object /** - * @copydoc Dali::Internal::Object::GetDefaultPropertyCount() - */ - virtual unsigned int GetDefaultPropertyCount() const; - - /** - * @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; - - /** - * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable() - */ - virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const; - - /** - * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput() - */ - virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const; - - /** - * @copydoc Dali::Internal::Object::GetDefaultPropertyType() - */ - virtual Property::Type GetDefaultPropertyType( Property::Index index ) const; - - /** * @copydoc Dali::Internal::Object::SetDefaultProperty() */ - virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ); + void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue ) override; /** * @copydoc Dali::Internal::Object::SetSceneGraphProperty() */ - virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value ); + void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value ) override; /** * @copydoc Dali::Internal::Object::GetDefaultProperty() */ - virtual Property::Value GetDefaultProperty( Property::Index index ) const; + Property::Value GetDefaultProperty( Property::Index index ) const override; /** * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue() */ - virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const; + Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const override; /** * @copydoc Dali::Internal::Object::OnNotifyDefaultPropertyAnimation() */ - virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType ); + void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType ) override; /** - * @copydoc Dali::Internal::Object::GetPropertyOwner() + * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty() */ - virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const; + const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const override; /** - * @copydoc Dali::Internal::Object::GetSceneObject() + * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty() */ - virtual const SceneGraph::PropertyOwner* GetSceneObject() const; + const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const override; /** - * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty() + * @copydoc Dali::Internal::Object::GetPropertyComponentIndex() */ - virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const; + int32_t GetPropertyComponentIndex( Property::Index index ) const override; /** - * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty() + * @copydoc Dali::Internal::Object::IsAnimationPossible() */ - virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const; + bool IsAnimationPossible() const override + { + return OnScene(); + } /** - * @copydoc Dali::Internal::Object::GetPropertyComponentIndex() + * Retrieve the actor's node. + * @return The node used by this actor */ - virtual int GetPropertyComponentIndex( Property::Index index ) const; + const SceneGraph::Node& GetNode() const + { + return *static_cast( mUpdateObject ); + } /** * @copydoc Dali::DevelActor::Raise() @@ -1711,6 +1792,26 @@ public: */ void LowerBelow( Internal::Actor& target ); +public: + + /** + * Sets the scene which this actor is added to. + * @param[in] scene The scene + */ + void SetScene( Scene& scene ) + { + mScene = &scene; + } + + /** + * Gets the scene which this actor is added to. + * @return The scene + */ + Scene& GetScene() const + { + return *mScene; + } + private: struct SendMessage @@ -1722,14 +1823,23 @@ private: }; }; - // Undefined - Actor(); + struct AnimatedSizeFlag + { + enum Type + { + CLEAR = 0, + WIDTH = 1, + HEIGHT = 2, + DEPTH = 4 + }; + }; - // Undefined - Actor( const Actor& ); + struct Relayouter; - // 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. @@ -1738,13 +1848,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() @@ -1753,10 +1856,10 @@ private: /** * For use in internal derived classes. - * This is called during ConnectToStage(), after the actor has finished adding its node to the scene-graph. + * This is called during ConnectToScene(), after the actor has finished adding its node to the scene-graph. * The derived class must not modify the actor hierachy (Add/Remove children) during this callback. */ - virtual void OnStageConnectionInternal() + virtual void OnSceneConnectionInternal() { } @@ -1765,15 +1868,15 @@ private: * This is called during DisconnectFromStage(), before the actor removes its node from the scene-graph. * The derived class must not modify the actor hierachy (Add/Remove children) during this callback. */ - virtual void OnStageDisconnectionInternal() + virtual void OnSceneDisconnectionInternal() { } /** * For use in external (CustomActor) derived classes. - * This is called after the atomic ConnectToStage() traversal has been completed. + * This is called after the atomic ConnectToScene() traversal has been completed. */ - virtual void OnStageConnectionExternal( int depth ) + virtual void OnSceneConnectionExternal( int depth ) { } @@ -1781,7 +1884,7 @@ private: * For use in external (CustomActor) derived classes. * This is called after the atomic DisconnectFromStage() traversal has been completed. */ - virtual void OnStageDisconnectionExternal() + virtual void OnSceneDisconnectionExternal() { } @@ -1810,39 +1913,6 @@ private: } /** - * For use in derived classes. - * This is only called if mDerivedRequiresTouch is true, and the touch-signal was not consumed. - * @param[in] event The touch event. - * @return True if the event should be consumed. - */ - virtual bool OnTouchEvent( const TouchEvent& event ) - { - return false; - } - - /** - * For use in derived classes. - * This is only called if mDerivedRequiresHover is true, and the hover-signal was not consumed. - * @param[in] event The hover event. - * @return True if the event should be consumed. - */ - virtual bool OnHoverEvent( const HoverEvent& event ) - { - return false; - } - - /** - * For use in derived classes. - * 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 OnWheelEvent( const WheelEvent& event ) - { - return false; - } - - /** * @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. @@ -1859,9 +1929,9 @@ private: bool GetCurrentPropertyValue( Property::Index index, Property::Value& value ) const; /** - * @brief Ensure the relayout data is allocated + * @brief Ensure the relayouter is allocated */ - void EnsureRelayoutData(); + Relayouter& EnsureRelayouter(); /** * @brief Apply the size set policy to the input size @@ -1875,20 +1945,23 @@ private: * 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; + Object* GetParentObject() const override + { + return mParent; + } /** * Set Sibling order * @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); /** * Get Sibling order * @return the order of this actor amongst it's siblings */ - unsigned int GetSiblingOrder() const; + uint32_t GetSiblingOrder() const; /** * Request that the stage rebuilds the actor depth indices. @@ -1910,77 +1983,100 @@ private: 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 + { + return mInheritLayoutDirection; + } + + /** * @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::DevelActor::LayoutDirection::Type direction ); + void InheritLayoutDirectionRecursively( ActorPtr actor, Dali::LayoutDirection::Type direction, bool set = false ); + + /** + * @brief Sets the update size hint of an actor. + * @param [in] updateSizeHint The update size hint. + */ + void SetUpdateSizeHint( const Vector2& updateSizeHint ); 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, 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 - struct RelayoutData; - RelayoutData* mRelayoutData; ///< Struct to hold optional collection of relayout variables + Relayouter* mRelayoutData; ///< Struct to hold optional collection of relayout variables ActorGestureData* mGestureData; ///< Optional Gesture data. Only created when actor requires gestures // Signals - Dali::Actor::TouchSignalType mTouchedSignal; - Dali::Actor::TouchDataSignalType mTouchSignal; + Dali::Actor::TouchEventSignalType mInterceptTouchedSignal; + Dali::Actor::TouchEventSignalType mTouchedSignal; Dali::Actor::HoverSignalType mHoveredSignal; Dali::Actor::WheelEventSignalType mWheelEventSignal; - Dali::Actor::OnStageSignalType mOnStageSignal; - Dali::Actor::OffStageSignalType mOffStageSignal; + Dali::Actor::OnSceneSignalType mOnSceneSignal; + Dali::Actor::OffSceneSignalType mOffSceneSignal; Dali::Actor::OnRelayoutSignalType mOnRelayoutSignal; 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 + Vector3 mAnimatedSize; ///< Event-side storage for size animation + Vector2 mTouchArea; ///< touch area - std::string mName; ///< Name of the actor - unsigned int mId; ///< A unique ID to identify the actor starting from 1, and 0 is reserved - - uint32_t mSortedDepth; ///< The sorted depth index. A combination of tree traversal and sibling order. - uint16_t mDepth; ///< The depth in the hierarchy of the actor. Only 4096 levels of depth are supported - + 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 + uint16_t mUseAnimatedSize; ///< Whether the size is animated. const bool mIsRoot : 1; ///< Flag to identify the root 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 mIsOnScene : 1; ///< Flag to identify whether the actor is on-scene 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 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 mOnSceneSignalled : 1; ///< Set to true before OnSceneConnection signal is emitted, and false before OnSceneDisconnection 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. 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 mLayoutDirectionInheritance : 1; ///< Whether the actor inherits the layout direction from parent. - DevelActor::LayoutDirection::Type mLayoutDirection : 1; ///< Layout direction, Left to Right or Right to Left. - 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 mInheritLayoutDirection : 1; ///< Whether the actor inherits the layout direction from parent. + bool mCaptureAllTouchAfterStart : 1; ///< Whether the actor should capture all touch after touch starts even if the motion moves outside of the actor area. + 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 + + struct PropertyHandler; }; } // namespace Internal