1 #ifndef DALI_TOOLKIT_GRADIENT_VISUAL_PROPERTIES_H
2 #define DALI_TOOLKIT_GRADIENT_VISUAL_PROPERTIES_H
5 * Copyright (c) 2020 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/public-api/toolkit-property-index-ranges.h>
29 * @addtogroup dali_toolkit_visuals
34 * @brief GradientVisual is to render a smooth transition of colors to the control's quad.
37 namespace GradientVisual
40 * @brief GradientVisual Property.
46 * @brief Enumeration for the instance of properties belonging to the GradientVisual.
52 * @brief The start position of a linear gradient.
53 * @details Name "startPosition", type Property::VECTOR2.
54 * Gradient is drawn in a rectangular area, TopLeft is (-0.5, -0.5) and BottomRight is (0.5, 0.5).
55 * The outside of the entered Start Position and End Position is extended to the value of the border.
56 * Even if the range between Start Position and End Position is greater than (-0.5, -0.5) to (0.5, 0.5),
57 * only the corresponding area is drawn.
59 * @note Mandatory for Linear.
61 START_POSITION = VISUAL_PROPERTY_START_INDEX,
64 * @brief The end position of a linear gradient.
65 * @details Name "endPosition", type Property::VECTOR2.
66 * Gradient is drawn in a rectangular area, TopLeft is (-0.5, -0.5) and BottomRight is (0.5, 0.5).
67 * The outside of the entered Start Position and End Position is extended to the value of the border.
68 * Even if the range between Start Position and End Position is greater than (-0.5, -0.5) to (0.5, 0.5),
69 * only the corresponding area is drawn.
71 * @note Mandatory for Linear.
76 * @brief The center point of a radial gradient.
77 * @details Name "center", type Property::VECTOR2.
79 * @note Mandatory for Radial.
84 * @brief The size of the radius of a radial gradient.
85 * @details Name "radius", type Property::FLOAT.
87 * @note Mandatory for Radial.
92 * @brief All the stop offsets.
93 * @details Name "stopOffset", type Property::ARRAY of Property::FLOAT.
95 * @note Optional. If not supplied, default is 0.0 and 1.0.
100 * @brief The color at the stop offsets.
101 * @details Name "stopColor", type Property::ARRAY of Property::VECTOR4.
103 * @note Mandatory. At least 2 values required to show a gradient.
108 * @brief Defines the coordinate system for certain attributes of the points in a gradient.
109 * @details Name "units", type Units::Type (Property::INTEGER) or Property::STRING.
111 * @note Optional. If not supplied, default is Units::OBJECT_BOUNDING_BOX.
117 * @brief Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
118 * @details Name "spreadMethod", type SpreadMethod::Type (Property::INTEGER) or Property::STRING.
120 * @note Optional. If not supplied, default is SpreadMethod::PAD.
121 * @see SpreadMethod::Type
126 } // namespace Property
129 * @brief The type of coordinate system for certain attributes of the points in a gradient.
131 * This applies to the:
132 * - Start (x1, y1) and End (x2 and y2) points of a line if using a linear gradient.
133 * - Center point (cx, cy) and radius (r) of a circle if using a radial gradient.
139 * @brief The type of coordinate system for certain attributes of the points in a gradient.
141 * This applies to the:
142 * - Start (x1, y1) and End (x2 and y2) points of a line if using a linear gradient.
143 * - Center point (cx, cy) and radius (r) of a circle if using a radial gradient.
148 OBJECT_BOUNDING_BOX, ///< Uses the normals for the start, end & center points, i.e. top-left is (-0.5, -0.5) and bottom-right is (0.5, 0.5). @SINCE_1_1.45
149 USER_SPACE ///< Uses the user coordinates for the start, end & center points, i.e. in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200). @SINCE_1_1.45
155 * @brief Policies that define what happens if the gradient starts or ends inside the bounds of the target rectangle.
158 namespace SpreadMethod
161 * @brief Policies that define what happens if the gradient starts or ends inside the bounds of the target rectangle.
166 PAD, ///< Uses the terminal colors of the gradient to fill the remainder of the quad. @SINCE_1_1.45
167 REFLECT, ///< Reflect the gradient pattern start-to-end, end-to-start, start-to-end etc. until the quad is filled. @SINCE_1_1.45
168 REPEAT ///< Repeat the gradient pattern start-to-end, start-to-end, start-to-end etc. until the quad is filled. @SINCE_1_1.45
171 } // namespace SpreadMethod
173 } // namespace GradientVisual
179 } // namespace Toolkit
183 #endif // DALI_TOOLKIT_GRADIENT_VISUAL_PROPERTIES_H