1 #ifndef __DALI_TOOLKIT_INTERNAL_GRADIENT_RENDERER_H__
2 #define __DALI_TOOLKIT_INTERNAL_GRADIENT_RENDERER_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/internal/controls/renderers/control-renderer-impl.h>
23 #include <dali-toolkit/internal/controls/renderers/gradient/gradient.h>
38 * The renderer which renders smooth transition of colors to the control's quad.
39 * It supports two types of gradients: linear and radial.
41 * The following properties are essential for create a LINEAR GradientRender
43 * | %Property Name | Type |
44 * |-------------------------|------------------|
45 * | startPosition | VECTOR2 |
46 * | endPosition | VECTOR2 |
47 * | stopColor | ARRAY of VECTOR4 |
49 * The following properties are essential for create a RADIAL GradientRender
51 * | %Property Name | Type |
52 * |-------------------------|------------------|
53 * | center | VECTOR2 |
55 * | stopColor | ARRAY of VECTOR4 |
57 * The following properties are optional for both LINEAR and RADIAL GradientRender.
59 * | %Property Name | Type |
60 * |-------------------------|------------------|
62 * | spreadMethod | STRING |
64 * Valid values for units are 'userSpace' and 'objectBoundingBox'.
65 * Valid values for spreadMethod are 'pad', 'repeat' and 'reflect.'
66 * If not provided, 'objectBoundingBox' is used as default gradient units, and 'pad' is used as default spread method.
68 class GradientRenderer: public ControlRenderer
73 * Types of the gradient
84 * @param[in] factoryCache A pointer pointing to the RendererFactoryCache object
86 GradientRenderer( RendererFactoryCache& factoryCache );
89 * @brief A reference counted object may only be deleted by calling Unreference().
93 public: // from ControlRenderer
96 * @copydoc ControlRenderer::SetSize
98 virtual void SetSize( const Vector2& size );
101 * @copydoc ControlRenderer::SetClipRect
103 virtual void SetClipRect( const Rect<int>& clipRect );
106 * @copydoc ControlRenderer::SetOffset
108 virtual void SetOffset( const Vector2& offset );
111 * @copydoc ControlRenderer::CreatePropertyMap
113 virtual void DoCreatePropertyMap( Property::Map& map ) const;
117 * @copydoc ControlRenderer::DoInitialize
119 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
122 * @copydoc ControlRenderer::DoSetOnStage
124 virtual void DoSetOnStage( Actor& actor );
129 * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
131 void InitializeRenderer();
134 * New a gradient object with the given property map.
136 * @return True if the property map provides valid properties to create a gradient. Otherwise, returns false.
138 bool NewGradient(Type gradientType, const Property::Map& propertyMap);
141 * Get the stop-offsets from the property.
142 * The valid property type are ARRAY, VECTOR2, VECTOR3, VECTOR4.
144 * @param[in] value The property value of stop-offsets
145 * @param[out] stopOffsets The vector contains the stop offset values.
147 static void GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets);
150 GradientRenderer( const GradientRenderer& gradientRenderer );
153 GradientRenderer& operator=( const GradientRenderer& gradientRenderer );
157 Matrix3 mGradientTransform;
158 IntrusivePtr<Gradient> mGradient;
162 } // namespace Internal
164 } // namespace Toolkit
168 #endif /* __DALI_TOOLKIT_INTERNAL_GRADIENT_RENDERER_H__ */