1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_BASE_DATA_IMPL_H
2 #define DALI_TOOLKIT_INTERNAL_VISUAL_BASE_DATA_IMPL_H
5 * Copyright (c) 2022 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/public-api/math/vector2.h>
23 #include <dali/public-api/rendering/visual-renderer.h>
26 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
27 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
28 #include <dali-toolkit/internal/visuals/visual-event-observer.h>
29 #include <dali-toolkit/public-api/align-enumerations.h>
30 #include <dali-toolkit/public-api/visuals/visual-properties.h>
44 * @param [in] fittingMode that the derived class prefers
45 * @param [in] type The type of the this visual
47 Impl(FittingMode fittingMode, Toolkit::Visual::Type type);
57 IS_ATLASING_APPLIED = 1 << 1,
58 IS_PREMULTIPLIED_ALPHA = 1 << 2,
59 IS_SYNCHRONOUS_RESOURCE_LOADING = 1 << 3,
64 CustomShader(const Property::Map& map);
65 void SetPropertyMap(const Property::Map& map);
66 void CreatePropertyMap(Property::Map& map) const;
68 std::string mVertexShader;
69 std::string mFragmentShader;
70 Dali::ImageDimensions mGridSize;
71 Dali::Shader::Hint::Value mHints; //(bitfield) values from enum Shader::Hint
77 * Default constructor ensures the visual fills the control
82 * Use the property map to set zero or more of the transform
83 * attributes, and sets the remaining attributes to their default
86 void SetPropertyMap(const Property::Map& map);
89 * Add the transform attributes to the map (using integer keys)
91 void GetPropertyMap(Property::Map& map) const;
94 * Update zero or more attributes from the property map.
96 void UpdatePropertyMap(const Property::Map& map);
99 * Set the uniform properties onto the renderer
101 void SetUniforms(VisualRenderer renderer, Toolkit::Direction::Type direction);
104 * Convert the control size and the transform attributes into the actual
105 * size of the visual.
107 Vector2 GetVisualSize(const Vector2& controlSize);
112 Vector4 mOffsetSizeMode;
113 Toolkit::Align::Type mOrigin;
114 Toolkit::Align::Type mAnchorPoint;
117 struct DecorationData
119 // Default constructor
121 : mBorderlineColor(Color::BLACK),
122 mCornerRadius(Vector4::ZERO),
123 mBorderlineWidth(0.0f),
124 mBorderlineOffset(0.0f),
125 mCornerRadiusPolicy(static_cast<int>(Toolkit::Visual::Transform::Policy::ABSOLUTE))
128 Vector4 mBorderlineColor;
129 Vector4 mCornerRadius;
130 float mBorderlineWidth;
131 float mBorderlineOffset;
132 int mCornerRadiusPolicy;
135 DecorationData* EnsureDecorationData()
137 if(mDecorationData == nullptr)
139 mDecorationData = new DecorationData();
141 return mDecorationData;
145 * @brief Get decoration data value : borderline width
147 * Keep these API as inline function due to the performance.
149 float GetBorderlineWidth()
151 return mDecorationData ? mDecorationData->mBorderlineWidth : 0.0f;
155 * @brief Set decoration data value : borderline width
157 * Keep these API as inline function due to the performance.
159 void SetBorderlineWidth(float value)
161 EnsureDecorationData()->mBorderlineWidth = value;
165 * @brief Get decoration data value : borderline color
167 * Keep these API as inline function due to the performance.
169 Vector4 GetBorderlineColor()
171 return mDecorationData ? mDecorationData->mBorderlineColor : Color::BLACK;
175 * @brief Set decoration data value : borderline color
177 * Keep these API as inline function due to the performance.
179 void SetBorderlineColor(Vector4 value)
181 EnsureDecorationData()->mBorderlineColor = value;
185 * @brief Get decoration data value : borderline offset
187 * Keep these API as inline function due to the performance.
189 float GetBorderlineOffset()
191 return mDecorationData ? mDecorationData->mBorderlineOffset : 0.0f;
195 * @brief Set decoration data value : borderline offset
197 * Keep these API as inline function due to the performance.
199 void SetBorderlineOffset(float value)
201 EnsureDecorationData()->mBorderlineOffset = value;
205 * @brief Get decoration data value : corner radius
207 * Keep these API as inline function due to the performance.
209 Vector4 GetCornerRadius()
211 return mDecorationData ? mDecorationData->mCornerRadius : Vector4::ZERO;
215 * @brief Set decoration data value : corner radius
217 * Keep these API as inline function due to the performance.
219 void SetCornerRadius(Vector4 value)
221 EnsureDecorationData()->mCornerRadius = value;
225 * @brief Get decoration data value : corner radius policy
227 * Keep these API as inline function due to the performance.
229 int GetCornerRadiusPolicy()
231 return mDecorationData ? mDecorationData->mCornerRadiusPolicy : static_cast<int>(Toolkit::Visual::Transform::Policy::ABSOLUTE);
235 * @brief Set decoration data value : corner radius policy
237 * Keep these API as inline function due to the performance.
239 void SetCornerRadiusPolicy(int value)
241 EnsureDecorationData()->mCornerRadiusPolicy = value;
244 VisualRenderer mRenderer;
245 CustomShader* mCustomShader;
246 EventObserver* mEventObserver; ///< Allows controls to observe when the visual has events to notify
248 Transform mTransform;
251 DecorationData* mDecorationData;
253 FittingMode mFittingMode; ///< How the contents should fit the view
255 Toolkit::Visual::ResourceStatus mResourceStatus;
256 const Toolkit::Visual::Type mType;
257 bool mAlwaysUsingBorderline : 1; ///< Whether we need the borderline in shader always.
258 bool mAlwaysUsingCornerRadius : 1; ///< Whether we need the corner radius in shader always.
261 } // namespace Visual
263 } // namespace Internal
265 } // namespace Toolkit
269 #endif // DALI_TOOLKIT_INTERNAL_VISUAL_BASE_DATA_IMPL_H