Merge "Added code for stylable transitions" into devel/master

[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 da15492..475a5fa 100644 (file)
--- a/dali-toolkit/internal/visuals/visual-base-impl.h
+++ b/dali-toolkit/internal/visuals/visual-base-impl.h
@@ -19,6 +19,7 @@
  */
 
 // EXTERNAL INCLUDES
+#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/shader.h>
@@ -75,6 +76,16 @@ public:
   void Initialize( Actor& actor, const Property::Map& propertyMap );
 
   /**
+   * @copydoc Toolkit::Visual::Base::SetName
+   */
+  void SetName( const std::string& name );
+
+  /**
+   * @copydoc Toolkit::Visual::Base::GetName
+   */
+  const std::string& GetName();
+
+  /**
    * @copydoc Toolkit::Visual::Base::SetSize
    */
   virtual void SetSize( const Vector2& size );
@@ -85,28 +96,14 @@ public:
   const Vector2& GetSize() const;
 
   /**
-   * @copydoc Toolkit::Visual::Base::GetNaturalSize
-   */
-  virtual void GetNaturalSize( Vector2& naturalSize ) const;
-
-  /**
-   * 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<int>& clipRect );
+  virtual float GetHeightForWidth( float width ) const;
 
   /**
-   *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::GetNaturalSize
    */
-  virtual void SetOffset( const Vector2& offset );
+  virtual void GetNaturalSize( Vector2& naturalSize ) const;
 
   /**
    * @copydoc Toolkit::Visual::Base::SetDepthIndex
@@ -139,7 +136,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 +151,16 @@ 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 );
+
 protected:
 
   /**
@@ -189,9 +196,11 @@ protected:
   /**
    * @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,19 +210,38 @@ 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;
+
+protected:
+  /**
+   * @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.
+   */
+  virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ) = 0;
+
+  /**
+   * @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.
+   */
+  virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index ) = 0;
 
 private:
 
@@ -229,6 +257,8 @@ protected:
   VisualFactoryCache& mFactoryCache;
 };
 
+typedef IntrusivePtr<Base> BasePtr;
+
 } // namspace Visual
 
 } // namespace Internal