2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "color-visual.h"
22 #include <dali/devel-api/rendering/renderer-devel.h>
23 #include <dali/integration-api/debug.h>
26 #include <dali-toolkit/devel-api/visuals/color-visual-actions-devel.h>
27 #include <dali-toolkit/devel-api/visuals/color-visual-properties-devel.h>
28 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
29 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
30 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
31 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
32 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
33 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
34 #include <dali-toolkit/public-api/visuals/visual-properties.h>
42 ColorVisualPtr ColorVisual::New(VisualFactoryCache& factoryCache, const Property::Map& properties)
44 ColorVisualPtr colorVisualPtr(new ColorVisual(factoryCache));
45 colorVisualPtr->SetProperties(properties);
46 colorVisualPtr->Initialize();
47 return colorVisualPtr;
50 ColorVisual::ColorVisual(VisualFactoryCache& factoryCache)
51 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::COLOR),
53 mBlurRadiusIndex(Property::INVALID_INDEX),
54 mRenderIfTransparent(false),
55 mNeedBlurRadius(false)
59 ColorVisual::~ColorVisual()
63 void ColorVisual::DoSetProperties(const Property::Map& propertyMap)
65 // By virtue of DoSetProperties being called last, this will override
66 // anything set by Toolkit::Visual::Property::MIX_COLOR
67 Property::Value* colorValue = propertyMap.Find(Toolkit::ColorVisual::Property::MIX_COLOR, MIX_COLOR);
71 if(colorValue->Get(color))
73 Property::Type type = colorValue->GetType();
74 if(type == Property::VECTOR4)
78 else if(type == Property::VECTOR3)
80 Vector3 color3(color);
86 DALI_LOG_ERROR("ColorVisual: mixColor property has incorrect type\n");
90 Property::Value* renderIfTransparentValue = propertyMap.Find(Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT, RENDER_IF_TRANSPARENT_NAME);
91 if(renderIfTransparentValue)
93 if(!renderIfTransparentValue->Get(mRenderIfTransparent))
95 DALI_LOG_ERROR("ColorVisual: renderIfTransparent property has incorrect type: %d\n", renderIfTransparentValue->GetType());
99 Property::Value* blurRadiusValue = propertyMap.Find(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME);
102 if(!blurRadiusValue->Get(mBlurRadius))
104 DALI_LOG_ERROR("ColorVisual:DoSetProperties:: BLUR_RADIUS property has incorrect type: %d\n", blurRadiusValue->GetType());
109 void ColorVisual::DoSetOnScene(Actor& actor)
111 // Only add the renderer if it's not fully transparent
112 // We cannot avoid creating a renderer as it's used in the base class
113 if(mRenderIfTransparent || mImpl->mMixColor.a > 0.0f)
115 actor.AddRenderer(mImpl->mRenderer);
118 // Color Visual generated and ready to display
119 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
122 void ColorVisual::DoSetOffScene(Actor& actor)
124 actor.RemoveRenderer(mImpl->mRenderer);
127 void ColorVisual::DoCreatePropertyMap(Property::Map& map) const
130 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR);
131 map.Insert(Toolkit::ColorVisual::Property::MIX_COLOR, mImpl->mMixColor);
132 map.Insert(Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT, mRenderIfTransparent);
134 if(mImpl->mRenderer && mBlurRadiusIndex != Property::INVALID_INDEX)
136 // Update values from Renderer
137 float blurRadius = mImpl->mRenderer.GetProperty<float>(mBlurRadiusIndex);
138 map.Insert(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, blurRadius);
142 map.Insert(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, mBlurRadius);
146 void ColorVisual::DoCreateInstancePropertyMap(Property::Map& map) const
151 void ColorVisual::OnSetTransform()
155 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
159 void ColorVisual::OnDoAction(const Property::Index actionId, const Property::Value& attributes)
161 // Check if action is valid for this visual type and perform action if possible
164 case DevelColorVisual::Action::UPDATE_PROPERTY:
166 const Property::Map* map = attributes.GetMap();
169 DoSetProperties(*map);
176 void ColorVisual::UpdateShader()
180 Shader shader = GetShader();
181 mImpl->mRenderer.SetShader(shader);
185 void ColorVisual::OnInitialize()
187 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
189 Shader shader = GetShader();
191 mImpl->mRenderer = Renderer::New(geometry, shader);
193 // ColorVisual has it's own index key for mix color - use this instead
194 // of using the new base index to avoid changing existing applications
195 // String keys will get to this property.
196 mImpl->mMixColorIndex = mImpl->mRenderer.RegisterProperty(Toolkit::ColorVisual::Property::MIX_COLOR, MIX_COLOR, Vector3(mImpl->mMixColor));
198 if(!EqualsZero(mBlurRadius))
200 mBlurRadiusIndex = mImpl->mRenderer.RegisterProperty(DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME, mBlurRadius);
201 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
204 // Register transform properties
205 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
208 Shader ColorVisual::GetShader()
211 if(!EqualsZero(mBlurRadius) || mNeedBlurRadius)
213 shader = mFactoryCache.GetShader(VisualFactoryCache::COLOR_SHADER_BLUR_EDGE);
216 shader = Shader::New(Dali::Shader::GetVertexShaderPrefix() + SHADER_COLOR_VISUAL_BLUR_EDGE_SHADER_VERT.data(), Dali::Shader::GetFragmentShaderPrefix() + SHADER_COLOR_VISUAL_BLUR_EDGE_SHADER_FRAG.data());
217 mFactoryCache.SaveShader(VisualFactoryCache::COLOR_SHADER_BLUR_EDGE, shader);
220 else if(!IsRoundedCornerRequired())
222 shader = mFactoryCache.GetShader(VisualFactoryCache::COLOR_SHADER);
225 shader = Shader::New(Dali::Shader::GetVertexShaderPrefix() + SHADER_COLOR_VISUAL_SHADER_VERT.data(), Dali::Shader::GetFragmentShaderPrefix() + SHADER_COLOR_VISUAL_SHADER_FRAG.data());
226 mFactoryCache.SaveShader(VisualFactoryCache::COLOR_SHADER, shader);
231 shader = mFactoryCache.GetShader(VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER);
234 shader = Shader::New(Dali::Shader::GetVertexShaderPrefix() + SHADER_COLOR_VISUAL_ROUNDED_CORNER_SHADER_VERT.data(), Dali::Shader::GetFragmentShaderPrefix() + SHADER_COLOR_VISUAL_ROUNDED_CORNER_SHADER_FRAG.data());
235 mFactoryCache.SaveShader(VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER, shader);
242 Dali::Property ColorVisual::OnGetPropertyObject(Dali::Property::Key key)
244 if(!mImpl->mRenderer)
247 return Dali::Property(handle, Property::INVALID_INDEX);
250 if((key.type == Property::Key::INDEX && key.indexKey == DevelColorVisual::Property::BLUR_RADIUS) || (key.type == Property::Key::STRING && key.stringKey == BLUR_RADIUS_NAME))
252 mBlurRadiusIndex = mImpl->mRenderer.RegisterProperty(DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME, mBlurRadius);
254 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
256 mNeedBlurRadius = true;
261 return Dali::Property(mImpl->mRenderer, mBlurRadiusIndex);
265 return Dali::Property(handle, Property::INVALID_INDEX);
268 } // namespace Internal
270 } // namespace Toolkit