[dali_1.9.31] 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) 2019 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/visual-base-impl.h>
26 #include <dali-toolkit/internal/visuals/gradient/gradient.h>
27
28 namespace Dali
29 {
30 class Vector2;
31
32 namespace Toolkit
33 {
34
35 namespace Internal
36 {
37
38 class Gradient;
39 class GradientVisual;
40 typedef IntrusivePtr< GradientVisual > GradientVisualPtr;
41
42 /**
43  * The visual which renders smooth transition of colors to the control's quad.
44  * It supports two types of gradients: linear and radial.
45  *
46  * The following properties are essential for create a LINEAR GradientRender
47  *
48  * | %Property Name          | Type             |
49  * |-------------------------|------------------|
50  * | startPosition           | VECTOR2          |
51  * | endPosition             | VECTOR2          |
52  * | stopColor               | ARRAY of VECTOR4 |
53  *
54  * The following properties are essential for create a RADIAL GradientRender
55  *
56  * | %Property Name          | Type             |
57  * |-------------------------|------------------|
58  * | center                  | VECTOR2          |
59  * | radius                  | FLOAT            |
60  * | stopColor               | ARRAY of VECTOR4 |
61  *
62  * The following properties are optional for both LINEAR and RADIAL GradientRender.
63  *
64  * | %Property Name          | Type             |
65  * |-------------------------|------------------|
66  * | stopOffset              | ARRAY of FLOAT   |
67  * | units                   | STRING           |
68  * | spreadMethod            | STRING           |
69  *
70  * Valid values for units are 'userSpace' and 'objectBoundingBox'.
71  * Valid values for spreadMethod are 'pad', 'repeat' and 'reflect.'
72  * If not provided, 'objectBoundingBox' is used as default gradient units, and 'pad' is used as default spread method.
73  */
74 class GradientVisual: public Visual::Base
75 {
76 public:
77
78   /**
79    * Types of the gradient
80    */
81   enum Type
82   {
83     LINEAR,
84     RADIAL
85   };
86
87   /**
88    * @brief Create a new gradient visual.
89    *
90    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
91    * @param[in] properties A Property::Map containing settings for this visual
92    * @return A smart-pointer to the newly allocated visual.
93    */
94   static GradientVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
95
96 public:  // from Visual
97
98   /**
99    * @copydoc Visual::Base::CreatePropertyMap
100    */
101   void DoCreatePropertyMap( Property::Map& map ) const override;
102
103   /**
104    * @copydoc Visual::Base::CreateInstancePropertyMap
105    */
106   void DoCreateInstancePropertyMap( Property::Map& map ) const override;
107
108 protected:
109
110   /**
111    * @brief Constructor.
112    *
113    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
114    */
115   GradientVisual( VisualFactoryCache& factoryCache );
116
117   /**
118    * @brief A reference counted object may only be deleted by calling Unreference().
119    */
120   virtual ~GradientVisual();
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 private:
138
139   /**
140    * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
141    */
142   void InitializeRenderer();
143
144   /**
145    * New a gradient object with the given property map.
146    *
147    * @return True if the property map provides valid properties to create a gradient. Otherwise, returns false.
148    */
149   bool NewGradient(Type gradientType, const Property::Map& propertyMap);
150
151   /**
152    * Get the stop-offsets from the property.
153    * The valid property type are ARRAY, VECTOR2, VECTOR3, VECTOR4.
154    *
155    * @param[in] value The property value of stop-offsets
156    * @param[out] stopOffsets The vector contains the stop offset values.
157    */
158   static void GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets);
159
160   // Undefined
161   GradientVisual( const GradientVisual& gradientVisual );
162
163   // Undefined
164   GradientVisual& operator=( const GradientVisual& gradientVisual );
165
166 private:
167
168   Matrix3 mGradientTransform;
169   IntrusivePtr<Gradient> mGradient;
170   Type mGradientType;
171   bool mIsOpaque; ///< Set to false if any of the stop colors are not opaque
172 };
173
174 } // namespace Internal
175
176 } // namespace Toolkit
177
178 } // namespace Dali
179
180 #endif /* DALI_TOOLKIT_INTERNAL_GRADIENT_VISUAL_H */