Merge "Enhance texteditor background drawing performance" into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / gradient / gradient-visual.h
index be191be..9a471d4 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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.
  *
  */
 
+// EXTERNAL INCLUDES
+#include <dali/public-api/common/intrusive-ptr.h>
+
 // INTERNAL INCLUDES
-#include <dali-toolkit/internal/visuals/visual-base-impl.h>
 #include <dali-toolkit/internal/visuals/gradient/gradient.h>
+#include <dali-toolkit/internal/visuals/visual-base-impl.h>
 
 namespace Dali
 {
@@ -28,11 +31,11 @@ class Vector2;
 
 namespace Toolkit
 {
-
 namespace Internal
 {
-
 class Gradient;
+class GradientVisual;
+typedef IntrusivePtr<GradientVisual> GradientVisualPtr;
 
 /**
  * The visual which renders smooth transition of colors to the control's quad.
@@ -66,10 +69,9 @@ 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::Base
+class GradientVisual : public Visual::Base
 {
 public:
-
   /**
    * Types of the gradient
    */
@@ -80,57 +82,74 @@ 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
+   */
+  void DoCreatePropertyMap(Property::Map& map) const override;
+
+  /**
+   * @copydoc Visual::Base::CreateInstancePropertyMap
    */
-  ~GradientVisual();
+  void DoCreateInstancePropertyMap(Property::Map& map) const override;
 
-public:  // from Visual
+  /**
+   * @copydoc Visual::Base::EnablePreMultipliedAlpha
+   */
+  void EnablePreMultipliedAlpha(bool preMultiplied) 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::OnInitialize
    */
-  virtual void SetOffset( const Vector2& offset );
+  void OnInitialize() override;
 
   /**
-   * @copydoc Visual::CreatePropertyMap
+   * @copydoc Visual::Base::DoSetProperties
    */
-  virtual void DoCreatePropertyMap( Property::Map& map ) const;
+  void DoSetProperties(const Property::Map& propertyMap) override;
 
-protected:
   /**
-   * @copydoc Visual::DoInitialize
+   * @copydoc Visual::Base::OnSetTransform
    */
-  virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
+  void OnSetTransform() override;
 
   /**
-   * @copydoc Visual::DoSetOnStage
+   * @copydoc Visual::Base::DoSetOnScene
    */
-  virtual void DoSetOnStage( Actor& actor );
+  void DoSetOnScene(Actor& actor) override;
 
-private:
+  /**
+   * @copydoc Visual::Base::UpdateShader
+   */
+  void UpdateShader() override;
 
   /**
-   * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
+   * @copydoc Visual::Base::GenerateShader
    */
-  void InitializeRenderer();
+  Shader GenerateShader() const override;
 
+private:
   /**
    * New a gradient object with the given property map.
    *
@@ -148,16 +167,16 @@ private:
   static void GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets);
 
   // Undefined
-  GradientVisual( const GradientVisual& gradientVisual );
+  GradientVisual(const GradientVisual& gradientVisual);
 
   // Undefined
-  GradientVisual& operator=( const GradientVisual& gradientVisual );
+  GradientVisual& operator=(const GradientVisual& gradientVisual);
 
 private:
-
-  Matrix3 mGradientTransform;
+  Matrix3                mGradientTransform;
   IntrusivePtr<Gradient> mGradient;
-  Type mGradientType;
+  Type                   mGradientType;
+  bool                   mIsOpaque; ///< Set to false if any of the stop colors are not opaque
 };
 
 } // namespace Internal