X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fvisual-base-impl.h;h=17229648a345e1050987bbbc7b77861d30efa92d;hb=6b6c1a325a1a66f17225e712f3b94054a771e7c8;hp=da15492ad5ba3246e399005a38d53278c4b78c2a;hpb=901499a7ec86ca342c4e0fdec62a6e4eeeee5c5f;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/visuals/visual-base-impl.h b/dali-toolkit/internal/visuals/visual-base-impl.h index da15492..1722964 100644 --- a/dali-toolkit/internal/visuals/visual-base-impl.h +++ b/dali-toolkit/internal/visuals/visual-base-impl.h @@ -19,14 +19,18 @@ */ // EXTERNAL INCLUDES +#include +#include #include #include +#include #include // INTERNAL INCLUDES #include -#include #include +#include +#include namespace Dali { @@ -65,48 +69,40 @@ class Base : public BaseObject public: /** - * Initialisation of the visual, this API should only called by the VisualFactory: - * request the geometry and shader from the cache, if not available, create and save to the cache for sharing; - * record the property values. - * - * @param[in] actor The Actor the visual is applied to if, empty if the visual has not been applied to any Actor + * Setting the properties of the visual, this API should only called by the VisualFactory * @param[in] propertyMap The properties for the requested Visual object. */ - void Initialize( Actor& actor, const Property::Map& propertyMap ); + void SetProperties( const Property::Map& propertyMap ); /** - * @copydoc Toolkit::Visual::Base::SetSize + * @copydoc Toolkit::Visual::Base::SetName */ - virtual void SetSize( const Vector2& size ); + void SetName( const std::string& name ); /** - * @copydoc Toolkit::Visual::Base::GetSize + * @copydoc Toolkit::Visual::Base::GetName */ - const Vector2& GetSize() const; + const std::string& GetName(); /** - * @copydoc Toolkit::Visual::Base::GetNaturalSize + * @copydoc Toolkit::Visual::Base::SetSize */ - virtual void GetNaturalSize( Vector2& naturalSize ) const; + void SetTransformAndSize( const Property::Map& transform, Size controlSize ); /** - * ToDo: Add this function to Toolkit::Visual when it is fully implemented. - * - * Set the clip rectangular of this visual. - * The contents of the visual will not be visible outside this rectangular. - * - * @param [in] clipRect The clipping rectangular. + * @copydoc Toolkit::Visual::Base::GetHeightForWidth */ - virtual void SetClipRect( const Rect& clipRect ); + virtual float GetHeightForWidth( float width ); /** - *ToDo: Add this function to Toolkit::Visual when it is fully implemented. - * - * Reposition this visual with a 2D offset. - * - * @param[in] offset The offset to reposition the visual. + * @copydoc Toolkit::Visual::Base::GetWidthForHeight + */ + virtual float GetWidthForHeight( float height ); + + /** + * @copydoc Toolkit::Visual::Base::GetNaturalSize */ - virtual void SetOffset( const Vector2& offset ); + virtual void GetNaturalSize( Vector2& naturalSize ); /** * @copydoc Toolkit::Visual::Base::SetDepthIndex @@ -139,7 +135,7 @@ public: * * @param[in] preMultipled whether alpha is pre-multiplied. */ - void EnablePreMultipliedAlpha( bool preMultipled ); + void EnablePreMultipliedAlpha( bool preMultipled ); /** * @brief Query whether alpha is pre-multiplied. @@ -154,6 +150,48 @@ public: */ void SetCustomShader( const Property::Map& propertyMap ); + /** + * @copydoc Toolkit::Visual::Base::SetProperty + */ + void SetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ); + + /** + * @copydoc Toolkit::Visual::Base::GetProperty + */ + Dali::Property::Value GetProperty( Dali::Property::Index index ); + + /** + * Gets currently staged renderer, or an empty handle if not staged + */ + Renderer GetRenderer(); + + /** + * Sets the mix color of the visual. + * @param[in] mixColor The new mix color + */ + void SetMixColor( const Vector4& color ); + + /** + * Gets the mix color of the visual. + * @return The mix color + */ + const Vector4& GetMixColor() const; + + /** + * Animate the property if it exists in the visual or renderer. + * + * If it's a visual property such as mix color or a transform property, + * saves the target value to the local data. + * + * If the visual isn't staged (i.e. it doesn't have a renderer), + * then this will not add an animation. + * + * @param[in] transition The animation to create or attach to + * @param[in] animator The animation parameters of the property. + */ + void AnimateProperty( Dali::Animation& transition, + Internal::TransitionData::Animator& animator ); + protected: /** @@ -169,6 +207,7 @@ protected: virtual ~Base(); protected: + /** * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event * @@ -177,21 +216,26 @@ protected: virtual void DoCreatePropertyMap( Property::Map& map ) const = 0; /** - * @brief Called by Initialize() allowing sub classes to respond to the Initialize event + * @brief Called by SetProperties() allowing sub classes to set their properties * - * @param[in] actor The Actor the visual is applied to if, empty if the visual has not been applied to any Actor * @param[in] propertyMap The properties for the requested Visual object. */ - virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap ) {} + virtual void DoSetProperties( const Property::Map& propertyMap ) = 0; -protected: + /** + * @brief Called when transform or control size changes + * ( Of use to SVG and Text visuals ) + */ + virtual void OnSetTransform() = 0; /** * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event * + * @note The derived class is required to create the renderer, and add it to the actor when all the resources are in place. + * * @param[in] actor The actor applying this visual. */ - virtual void DoSetOnStage( Actor& actor ); + virtual void DoSetOnStage( Actor& actor )=0; /** * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event @@ -201,22 +245,57 @@ protected: virtual void DoSetOffStage( Actor& actor ); protected: + /** * @brief Gets the on stage state for this Visual * * @return Returns true if this Visual is on stage, false if it is off the stage */ - bool GetIsOnStage() const; + bool IsOnStage() const; /** * @brief Gets whether the Dali::Renderer is from a shared cache (and therefore any modifications will affect other users of that renderer) * * @return Returns true if the renderer is from shared cache, false otherwise */ - bool GetIsFromCache() const; + bool IsFromCache() const; private: + /** + * Register the mix color uniform on the Renderer and store the property index. + * Note, this is not used by Color or Primitive Visuals, which will use their + * own property index. + */ + void RegisterMixColor(); + + /** + * Find the matching property on the renderer or shader. If it's a shader + * property, register it on the renderer in order to animate it for this + * visual independently. + * @param[in] key The key to match. + * @return the matching index, or INVALID_INDEX if it's not found + */ + Property::Index GetPropertyIndex( Property::Key key ); + + /** + * Set up the transition. If no animation is required, then + * transition will be untouched. + * + * @param[in] transition The transition to use or set up. + * @param[in] animator The animation data to use + * @param[in] index The property index on the renderer to animate + */ + void SetupTransition( Dali::Animation& transition, + Internal::TransitionData::Animator& animator, + Property::Index index ); + + /** + * When a mix color animation has finished, ensure the blend mode is set back + * to the right value for the target opacity. + */ + void OnMixColorFinished( Animation& animation ); + // Undefined Base( const Visual::Base& visual ); @@ -229,6 +308,8 @@ protected: VisualFactoryCache& mFactoryCache; }; +typedef IntrusivePtr BasePtr; + } // namspace Visual } // namespace Internal