Updated visuals to add animatable mixColor property

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / visual-base-impl.h

diff --git a/dali-toolkit/internal/visuals/visual-base-impl.h b/dali-toolkit/internal/visuals/visual-base-impl.h
index 4028ca4..054708f 100644 (file)
--- a/dali-toolkit/internal/visuals/visual-base-impl.h
+++ b/dali-toolkit/internal/visuals/visual-base-impl.h
@@ -19,15 +19,18 @@
  */
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/animation/animation.h>
 #include <dali/public-api/common/intrusive-ptr.h>
 #include <dali/public-api/images/image-operations.h>
 #include <dali/public-api/object/base-object.h>
+#include <dali/public-api/rendering/renderer.h>
 #include <dali/public-api/rendering/shader.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
-#include <dali-toolkit/internal/visuals/visual-factory-cache.h>
 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
+#include <dali-toolkit/internal/visuals/transition-data-impl.h>
+#include <dali-toolkit/internal/visuals/visual-factory-cache.h>
 
 namespace Dali
 {
@@ -84,17 +87,17 @@ public:
   /**
    * @copydoc Toolkit::Visual::Base::SetSize
    */
-  virtual void SetSize( const Vector2& size );
+  void SetTransformAndSize( const Property::Map& transform, Size controlSize );
 
   /**
-   * @copydoc Toolkit::Visual::Base::GetSize
+   * @copydoc Toolkit::Visual::Base::GetHeightForWidth
    */
-  const Vector2& GetSize() const;
+  virtual float GetHeightForWidth( float width );
 
   /**
-   * @copydoc Toolkit::Visual::Base::GetHeightForWidth
+   * @copydoc Toolkit::Visual::Base::GetWidthForHeight
    */
-  virtual float GetHeightForWidth( float width ) const;
+  virtual float GetWidthForHeight( float height );
 
   /**
    * @copydoc Toolkit::Visual::Base::GetNaturalSize
@@ -157,6 +160,38 @@ public:
    */
   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:
 
   /**
@@ -172,6 +207,7 @@ protected:
   virtual ~Base();
 
 protected:
+
   /**
    * @brief Called by CreatePropertyMap() allowing sub classes to respond to the CreatePropertyMap event
    *
@@ -187,11 +223,10 @@ protected:
   virtual void DoSetProperties( const Property::Map& propertyMap ) = 0;
 
   /**
-   * @brief Called when transform property changes
+   * @brief Called when transform or control size changes
+   * ( Of use to SVG and Text visuals )
    */
-  virtual void OnSetTransform(){}
-
-protected:
+  virtual void OnSetTransform() = 0;
 
   /**
    * @brief Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
@@ -225,25 +260,20 @@ protected:
    */
   bool IsFromCache() const;
 
-protected:
+private:
+
   /**
-   * @brief Called by SetProperty(). To be overriden by derived clases in order to set properties.
-   *
-   * @param [in] index The index of the property.
-   * @param [in] propertyValue The new value of the property.
+   * 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.
    */
-  virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ) = 0;
+  void RegisterMixColor();
 
   /**
-   * @brief Called by GetProperty(). To be overriden by derived classes in order to retrieve properties.
-   *
-   * @param [in] index The index of the property.
-   *
-   * @return The property value.
+   * When a mix color animation has finished, ensure the blend mode is set back
+   * to the right value for the target opacity.
    */
-  virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index ) = 0;
-
-private:
+  void OnMixColorFinished( Animation& animation );
 
   // Undefined
   Base( const Visual::Base& visual );