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/integration-api/debug.h>
23 #include <dali/devel-api/rendering/renderer-devel.h>
26 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
27 #include <dali-toolkit/public-api/visuals/visual-properties.h>
28 #include <dali-toolkit/devel-api/visuals/color-visual-properties-devel.h>
29 #include <dali-toolkit/devel-api/visuals/color-visual-actions-devel.h>
30 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
31 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
32 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
33 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
34 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
45 ColorVisualPtr ColorVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
47 ColorVisualPtr colorVisualPtr( new ColorVisual( factoryCache ) );
48 colorVisualPtr->SetProperties( properties );
49 colorVisualPtr->Initialize();
50 return colorVisualPtr;
53 ColorVisual::ColorVisual(VisualFactoryCache& factoryCache)
54 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::COLOR),
56 mBlurRadiusIndex(Property::INVALID_INDEX),
57 mRenderIfTransparent(false),
58 mNeedBlurRadius(false)
62 ColorVisual::~ColorVisual()
66 void ColorVisual::DoSetProperties( const Property::Map& propertyMap )
68 // By virtue of DoSetProperties being called last, this will override
69 // anything set by Toolkit::Visual::Property::MIX_COLOR
70 Property::Value* colorValue = propertyMap.Find( Toolkit::ColorVisual::Property::MIX_COLOR, MIX_COLOR );
74 if( colorValue->Get( color ) )
76 Property::Type type = colorValue->GetType();
77 if( type == Property::VECTOR4 )
81 else if( type == Property::VECTOR3 )
83 Vector3 color3(color);
84 SetMixColor( color3 );
89 DALI_LOG_ERROR("ColorVisual: mixColor property has incorrect type\n");
93 Property::Value* renderIfTransparentValue = propertyMap.Find( Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT, RENDER_IF_TRANSPARENT_NAME );
94 if( renderIfTransparentValue )
96 if( ! renderIfTransparentValue->Get( mRenderIfTransparent ) )
98 DALI_LOG_ERROR( "ColorVisual: renderIfTransparent property has incorrect type: %d\n", renderIfTransparentValue->GetType() );
102 Property::Value* blurRadiusValue = propertyMap.Find( Toolkit::DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME );
103 if( blurRadiusValue )
105 if( !blurRadiusValue->Get( mBlurRadius ) )
107 DALI_LOG_ERROR( "ColorVisual:DoSetProperties:: BLUR_RADIUS property has incorrect type: %d\n", blurRadiusValue->GetType() );
112 void ColorVisual::DoSetOnScene( Actor& actor )
114 // Only add the renderer if it's not fully transparent
115 // We cannot avoid creating a renderer as it's used in the base class
116 if( mRenderIfTransparent || mImpl->mMixColor.a > 0.0f )
118 actor.AddRenderer( mImpl->mRenderer );
121 // Color Visual generated and ready to display
122 ResourceReady( Toolkit::Visual::ResourceStatus::READY );
125 void ColorVisual::DoSetOffScene(Actor& actor)
127 actor.RemoveRenderer(mImpl->mRenderer);
130 void ColorVisual::DoCreatePropertyMap( Property::Map& map ) const
133 map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR );
134 map.Insert( Toolkit::ColorVisual::Property::MIX_COLOR, mImpl->mMixColor );
135 map.Insert( Toolkit::DevelColorVisual::Property::RENDER_IF_TRANSPARENT, mRenderIfTransparent );
137 if(mImpl->mRenderer && mBlurRadiusIndex != Property::INVALID_INDEX)
139 // Update values from Renderer
140 float blurRadius = mImpl->mRenderer.GetProperty<float>(mBlurRadiusIndex);
141 map.Insert(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, blurRadius);
145 map.Insert(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, mBlurRadius);
149 void ColorVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
154 void ColorVisual::OnSetTransform()
156 if( mImpl->mRenderer )
158 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
162 void ColorVisual::OnDoAction( const Property::Index actionId, const Property::Value& attributes )
164 // Check if action is valid for this visual type and perform action if possible
167 case DevelColorVisual::Action::UPDATE_PROPERTY:
169 const Property::Map* map = attributes.GetMap();
172 DoSetProperties( *map );
179 void ColorVisual::UpdateShader()
183 Shader shader = GetShader();
184 mImpl->mRenderer.SetShader(shader);
188 void ColorVisual::OnInitialize()
190 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
192 Shader shader = GetShader();
194 mImpl->mRenderer = Renderer::New(geometry, shader);
196 // ColorVisual has it's own index key for mix color - use this instead
197 // of using the new base index to avoid changing existing applications
198 // String keys will get to this property.
199 mImpl->mMixColorIndex = mImpl->mRenderer.RegisterProperty(Toolkit::ColorVisual::Property::MIX_COLOR, MIX_COLOR, Vector3(mImpl->mMixColor));
201 if(!EqualsZero(mBlurRadius))
203 mBlurRadiusIndex = mImpl->mRenderer.RegisterProperty(DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME, mBlurRadius);
204 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
207 // Register transform properties
208 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
211 Shader ColorVisual::GetShader()
214 if(!EqualsZero(mBlurRadius) || mNeedBlurRadius)
216 shader = mFactoryCache.GetShader( VisualFactoryCache::COLOR_SHADER_BLUR_EDGE );
219 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() );
220 mFactoryCache.SaveShader( VisualFactoryCache::COLOR_SHADER_BLUR_EDGE, shader );
223 else if( !IsRoundedCornerRequired() )
225 shader = mFactoryCache.GetShader( VisualFactoryCache::COLOR_SHADER );
228 shader = Shader::New( Dali::Shader::GetVertexShaderPrefix() + SHADER_COLOR_VISUAL_SHADER_VERT.data(), Dali::Shader::GetFragmentShaderPrefix() + SHADER_COLOR_VISUAL_SHADER_FRAG.data() );
229 mFactoryCache.SaveShader( VisualFactoryCache::COLOR_SHADER, shader );
234 shader = mFactoryCache.GetShader( VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER );
237 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() );
238 mFactoryCache.SaveShader( VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER, shader );
245 Dali::Property ColorVisual::OnGetPropertyObject(Dali::Property::Key key)
247 if(!mImpl->mRenderer)
250 return Dali::Property(handle, Property::INVALID_INDEX);
253 if((key.type == Property::Key::INDEX && key.indexKey == DevelColorVisual::Property::BLUR_RADIUS) || (key.type == Property::Key::STRING && key.stringKey == BLUR_RADIUS_NAME))
255 mBlurRadiusIndex = mImpl->mRenderer.RegisterProperty(DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME, mBlurRadius);
257 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
259 mNeedBlurRadius = true;
264 return Dali::Property(mImpl->mRenderer, mBlurRadiusIndex);
268 return Dali::Property(handle, Property::INVALID_INDEX);
271 } // namespace Internal
273 } // namespace Toolkit