Add GetVisualProperty to Control

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

diff --git a/dali-toolkit/internal/visuals/gradient/gradient-visual.h b/dali-toolkit/internal/visuals/gradient/gradient-visual.h
index 6c82b57..71ae1d6 100644 (file)
--- a/dali-toolkit/internal/visuals/gradient/gradient-visual.h
+++ b/dali-toolkit/internal/visuals/gradient/gradient-visual.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
@@ -18,8 +18,11 @@
  *
  */
 
+// EXTERNAL INCLUDES
+#include <dali/public-api/common/intrusive-ptr.h>
+
 // INTERNAL INCLUDES
-#include <dali-toolkit/internal/visuals/visual-impl.h>
+#include <dali-toolkit/internal/visuals/visual-base-impl.h>
 #include <dali-toolkit/internal/visuals/gradient/gradient.h>
 
 namespace Dali
@@ -33,9 +36,11 @@ namespace Internal
 {
 
 class Gradient;
+class GradientVisual;
+typedef IntrusivePtr< GradientVisual > GradientVisualPtr;
 
 /**
- * The renderer which renders smooth transition of colors to the control's quad.
+ * The visual which renders smooth transition of colors to the control's quad.
  * It supports two types of gradients: linear and radial.
  *
  * The following properties are essential for create a LINEAR GradientRender
@@ -66,7 +71,7 @@ class Gradient;
  * Valid values for spreadMethod are 'pad', 'repeat' and 'reflect.'
  * If not provided, 'objectBoundingBox' is used as default gradient units, and 'pad' is used as default spread method.
  */
-class GradientVisual: public Visual
+class GradientVisual: public Visual::Base
 {
 public:
 
@@ -80,49 +85,59 @@ public:
   };
 
   /**
-   * @brief Constructor.
+   * @brief Create a new gradient visual.
    *
    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+   * @param[in] properties A Property::Map containing settings for this visual
+   * @return A smart-pointer to the newly allocated visual.
    */
-  GradientVisual( VisualFactoryCache& factoryCache );
+  static GradientVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
+
+public:  // from Visual
 
   /**
-   * @brief A reference counted object may only be deleted by calling Unreference().
+   * @copydoc Visual::Base::CreatePropertyMap
    */
-  ~GradientVisual();
+  void DoCreatePropertyMap( Property::Map& map ) const override;
 
-public:  // from Visual
+  /**
+   * @copydoc Visual::Base::CreateInstancePropertyMap
+   */
+  void DoCreateInstancePropertyMap( Property::Map& map ) const override;
+
+protected:
 
   /**
-   * @copydoc Visual::SetSize
+   * @brief Constructor.
+   *
+   * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
    */
-  virtual void SetSize( const Vector2& size );
+  GradientVisual( VisualFactoryCache& factoryCache );
 
   /**
-   * @copydoc Visual::SetClipRect
+   * @brief A reference counted object may only be deleted by calling Unreference().
    */
-  virtual void SetClipRect( const Rect<int>& clipRect );
+  virtual ~GradientVisual();
 
   /**
-   * @copydoc Visual::SetOffset
+   * @copydoc Visual::Base::DoSetProperties
    */
-  virtual void SetOffset( const Vector2& offset );
+  void DoSetProperties( const Property::Map& propertyMap ) override;
 
   /**
-   * @copydoc Visual::CreatePropertyMap
+   * @copydoc Visual::Base::OnSetTransform
    */
-  virtual void DoCreatePropertyMap( Property::Map& map ) const;
+  void OnSetTransform() override;
 
-protected:
   /**
-   * @copydoc Visual::DoInitialize
+   * @copydoc Visual::Base::DoSetOnScene
    */
-  virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
+  void DoSetOnScene( Actor& actor ) override;
 
   /**
-   * @copydoc Visual::DoSetOnStage
+   * @copydoc Visual::Base::UpdateShader
    */
-  virtual void DoSetOnStage( Actor& actor );
+  void UpdateShader() override;
 
 private:
 
@@ -139,6 +154,12 @@ private:
   bool NewGradient(Type gradientType, const Property::Map& propertyMap);
 
   /**
+   * @brief Get a shader for the current properties.
+   * @return The shader for the current properties.
+   */
+  Shader GetShader();
+
+  /**
    * Get the stop-offsets from the property.
    * The valid property type are ARRAY, VECTOR2, VECTOR3, VECTOR4.
    *
@@ -148,16 +169,17 @@ private:
   static void GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets);
 
   // Undefined
-  GradientVisual( const GradientVisual& gradientRenderer );
+  GradientVisual( const GradientVisual& gradientVisual );
 
   // Undefined
-  GradientVisual& operator=( const GradientVisual& gradientRenderer );
+  GradientVisual& operator=( const GradientVisual& gradientVisual );
 
 private:
 
   Matrix3 mGradientTransform;
   IntrusivePtr<Gradient> mGradient;
   Type mGradientType;
+  bool mIsOpaque; ///< Set to false if any of the stop colors are not opaque
 };
 
 } // namespace Internal