[dali_2.0.49] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / gradient / gradient-visual.h
1 #ifndef DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H
3
4 /*
5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/common/intrusive-ptr.h>
23
24 // INTERNAL INCLUDES
25 #include <dali-toolkit/internal/visuals/gradient/gradient.h>
26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
27
28 namespace Dali
29 {
30 class Vector2;
31
32 namespace Toolkit
33 {
34 namespace Internal
35 {
36 class Gradient;
37 class GradientVisual;
38 typedef IntrusivePtr<GradientVisual> GradientVisualPtr;
39
40 /**
41  * The visual which renders smooth transition of colors to the control's quad.
42  * It supports two types of gradients: linear and radial.
43  *
44  * The following properties are essential for create a LINEAR GradientRender
45  *
46  * | %Property Name          | Type             |
47  * |-------------------------|------------------|
48  * | startPosition           | VECTOR2          |
49  * | endPosition             | VECTOR2          |
50  * | stopColor               | ARRAY of VECTOR4 |
51  *
52  * The following properties are essential for create a RADIAL GradientRender
53  *
54  * | %Property Name          | Type             |
55  * |-------------------------|------------------|
56  * | center                  | VECTOR2          |
57  * | radius                  | FLOAT            |
58  * | stopColor               | ARRAY of VECTOR4 |
59  *
60  * The following properties are optional for both LINEAR and RADIAL GradientRender.
61  *
62  * | %Property Name          | Type             |
63  * |-------------------------|------------------|
64  * | stopOffset              | ARRAY of FLOAT   |
65  * | units                   | STRING           |
66  * | spreadMethod            | STRING           |
67  *
68  * Valid values for units are 'userSpace' and 'objectBoundingBox'.
69  * Valid values for spreadMethod are 'pad', 'repeat' and 'reflect.'
70  * If not provided, 'objectBoundingBox' is used as default gradient units, and 'pad' is used as default spread method.
71  */
72 class GradientVisual : public Visual::Base
73 {
74 public:
75   /**
76    * Types of the gradient
77    */
78   enum Type
79   {
80     LINEAR,
81     RADIAL
82   };
83
84   /**
85    * @brief Create a new gradient visual.
86    *
87    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
88    * @param[in] properties A Property::Map containing settings for this visual
89    * @return A smart-pointer to the newly allocated visual.
90    */
91   static GradientVisualPtr New(VisualFactoryCache& factoryCache, const Property::Map& properties);
92
93 public: // from Visual
94   /**
95    * @copydoc Visual::Base::CreatePropertyMap
96    */
97   void DoCreatePropertyMap(Property::Map& map) const override;
98
99   /**
100    * @copydoc Visual::Base::CreateInstancePropertyMap
101    */
102   void DoCreateInstancePropertyMap(Property::Map& map) const override;
103
104 protected:
105   /**
106    * @brief Constructor.
107    *
108    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
109    */
110   GradientVisual(VisualFactoryCache& factoryCache);
111
112   /**
113    * @brief A reference counted object may only be deleted by calling Unreference().
114    */
115   virtual ~GradientVisual();
116
117   /**
118    * @copydoc Visual::Base::OnInitialize
119    */
120   void OnInitialize() override;
121
122   /**
123    * @copydoc Visual::Base::DoSetProperties
124    */
125   void DoSetProperties(const Property::Map& propertyMap) override;
126
127   /**
128    * @copydoc Visual::Base::OnSetTransform
129    */
130   void OnSetTransform() override;
131
132   /**
133    * @copydoc Visual::Base::DoSetOnScene
134    */
135   void DoSetOnScene(Actor& actor) override;
136
137   /**
138    * @copydoc Visual::Base::UpdateShader
139    */
140   void UpdateShader() override;
141
142   /**
143    * @copydoc Visual::Base::GenerateShader
144    */
145   Shader GenerateShader() const override;
146
147 private:
148   /**
149    * New a gradient object with the given property map.
150    *
151    * @return True if the property map provides valid properties to create a gradient. Otherwise, returns false.
152    */
153   bool NewGradient(Type gradientType, const Property::Map& propertyMap);
154
155   /**
156    * Get the stop-offsets from the property.
157    * The valid property type are ARRAY, VECTOR2, VECTOR3, VECTOR4.
158    *
159    * @param[in] value The property value of stop-offsets
160    * @param[out] stopOffsets The vector contains the stop offset values.
161    */
162   static void GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets);
163
164   // Undefined
165   GradientVisual(const GradientVisual& gradientVisual);
166
167   // Undefined
168   GradientVisual& operator=(const GradientVisual& gradientVisual);
169
170 private:
171   Matrix3                mGradientTransform;
172   IntrusivePtr<Gradient> mGradient;
173   Type                   mGradientType;
174   bool                   mIsOpaque; ///< Set to false if any of the stop colors are not opaque
175 };
176
177 } // namespace Internal
178
179 } // namespace Toolkit
180
181 } // namespace Dali
182
183 #endif /* DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H */