dali-toolkit/internal/visuals/color/color-visual.cpp

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "color-visual.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/rendering/renderer-devel.h>
  23 #include <dali/integration-api/debug.h>
  24
  25 //INTERNAL INCLUDES
  26 #include <dali-toolkit/devel-api/visuals/color-visual-properties-devel.h>
  27 #include <dali-toolkit/devel-api/visuals/visual-actions-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>
  35
  36 namespace Dali
  37 {
  38 namespace Toolkit
  39 {
  40 namespace Internal
  41 {
  42 namespace
  43 {
  44 const int CUSTOM_PROPERTY_COUNT(12); // 5 transform properties + Blur Radius + Mix Color + border/corner
  45
  46 VisualFactoryCache::ShaderType SHADER_TYPE_TABLE[6] =
  47   {
  48     VisualFactoryCache::COLOR_SHADER,
  49     VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER,
  50     VisualFactoryCache::COLOR_SHADER_BORDERLINE,
  51     VisualFactoryCache::COLOR_SHADER_ROUNDED_BORDERLINE,
  52     VisualFactoryCache::COLOR_SHADER_BLUR_EDGE,
  53     VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER_BLUR_EDGE,
  54 };
  55
  56 // enum of required list when we select shader
  57 enum ColorVisualRequireFlag
  58 {
  59   DEFAULT        = 0,
  60   ROUNDED_CORNER = 1 << 0,
  61   BORDERLINE     = 1 << 1,
  62   BLUR           = 1 << 2,
  63 };
  64 } // unnamed namespace
  65 ColorVisualPtr ColorVisual::New(VisualFactoryCache& factoryCache, const Property::Map& properties)
  66 {
  67   ColorVisualPtr colorVisualPtr(new ColorVisual(factoryCache));
  68   colorVisualPtr->SetProperties(properties);
  69   colorVisualPtr->Initialize();
  70   return colorVisualPtr;
  71 }
  72
  73 ColorVisual::ColorVisual(VisualFactoryCache& factoryCache)
  74 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::COLOR),
  75   mBlurRadius(0.0f),
  76   mBlurRadiusIndex(Property::INVALID_INDEX),
  77   mAlwaysUsingBlurRadius(false)
  78 {
  79 }
  80
  81 ColorVisual::~ColorVisual()
  82 {
  83 }
  84
  85 void ColorVisual::DoSetProperties(const Property::Map& propertyMap)
  86 {
  87   // By virtue of DoSetProperties being called last, this will override
  88   // anything set by Toolkit::Visual::Property::MIX_COLOR
  89   Property::Value* colorValue = propertyMap.Find(Toolkit::ColorVisual::Property::MIX_COLOR, MIX_COLOR);
  90   if(colorValue)
  91   {
  92     Vector4 color;
  93     if(colorValue->Get(color))
  94     {
  95       Property::Type type = colorValue->GetType();
  96       if(type == Property::VECTOR4)
  97       {
  98         SetMixColor(color);
  99       }
 100       else if(type == Property::VECTOR3)
 101       {
 102         Vector3 color3(color);
 103         SetMixColor(color3);
 104       }
 105     }
 106     else
 107     {
 108       DALI_LOG_ERROR("ColorVisual: mixColor property has incorrect type\n");
 109     }
 110   }
 111
 112   Property::Value* blurRadiusValue = propertyMap.Find(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME);
 113   if(blurRadiusValue)
 114   {
 115     if(!blurRadiusValue->Get(mBlurRadius))
 116     {
 117       DALI_LOG_ERROR("ColorVisual:DoSetProperties:: BLUR_RADIUS property has incorrect type: %d\n", blurRadiusValue->GetType());
 118     }
 119
 120     if(mBlurRadiusIndex != Property::INVALID_INDEX)
 121     {
 122       mImpl->mRenderer.SetProperty(mBlurRadiusIndex, mBlurRadius);
 123     }
 124     else if(DALI_UNLIKELY(mImpl->mRenderer && (!EqualsZero(mBlurRadius) || mAlwaysUsingBlurRadius)))
 125     {
 126       // Unusual case. SetProperty called after OnInitialize().
 127       // Assume that DoAction call UPDATE_PROPERTY.
 128       // We must regist properies into renderer, and update shader.
 129
 130       // BlurRadius added by this action. Regist property to renderer.
 131       mBlurRadiusIndex = mImpl->mRenderer.RegisterUniqueProperty(DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME, mBlurRadius);
 132       mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
 133
 134       // Change the shader must not be occured many times. we always have to use blur feature.
 135       mAlwaysUsingBlurRadius = true;
 136
 137       // Change shader
 138       UpdateShader();
 139     }
 140   }
 141 }
 142
 143 void ColorVisual::DoSetOnScene(Actor& actor)
 144 {
 145   actor.AddRenderer(mImpl->mRenderer);
 146
 147   // Color Visual generated and ready to display
 148   ResourceReady(Toolkit::Visual::ResourceStatus::READY);
 149 }
 150
 151 void ColorVisual::DoSetOffScene(Actor& actor)
 152 {
 153   actor.RemoveRenderer(mImpl->mRenderer);
 154 }
 155
 156 void ColorVisual::DoCreatePropertyMap(Property::Map& map) const
 157 {
 158   map.Clear();
 159   map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::COLOR);
 160   map.Insert(Toolkit::ColorVisual::Property::MIX_COLOR, mImpl->mMixColor);
 161
 162   if(mImpl->mRenderer && mBlurRadiusIndex != Property::INVALID_INDEX)
 163   {
 164     // Update values from Renderer
 165     float blurRadius = mImpl->mRenderer.GetProperty<float>(mBlurRadiusIndex);
 166     map.Insert(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, blurRadius);
 167   }
 168   else
 169   {
 170     map.Insert(Toolkit::DevelColorVisual::Property::BLUR_RADIUS, mBlurRadius);
 171   }
 172 }
 173
 174 void ColorVisual::DoCreateInstancePropertyMap(Property::Map& map) const
 175 {
 176   // Do nothing
 177 }
 178
 179 void ColorVisual::OnSetTransform()
 180 {
 181   if(mImpl->mRenderer)
 182   {
 183     mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 184   }
 185 }
 186
 187 void ColorVisual::UpdateShader()
 188 {
 189   if(mImpl->mRenderer)
 190   {
 191     Shader shader = GenerateShader();
 192     mImpl->mRenderer.SetShader(shader);
 193   }
 194 }
 195
 196 void ColorVisual::OnInitialize()
 197 {
 198   Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
 199
 200   Shader shader = GenerateShader();
 201
 202   mImpl->mRenderer = Renderer::New(geometry, shader);
 203   mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
 204
 205   // ColorVisual has it's own index key for mix color - use this instead
 206   // of using the new base index to avoid changing existing applications
 207   // String keys will get to this property.
 208   mImpl->mMixColorIndex = mImpl->mRenderer.RegisterProperty(Toolkit::ColorVisual::Property::MIX_COLOR, MIX_COLOR, Vector3(mImpl->mMixColor));
 209
 210   if(!EqualsZero(mBlurRadius))
 211   {
 212     mBlurRadiusIndex = mImpl->mRenderer.RegisterUniqueProperty(DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME, mBlurRadius);
 213     mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
 214   }
 215
 216   // Register transform properties
 217   mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
 218 }
 219
 220 Shader ColorVisual::GenerateShader() const
 221 {
 222   Shader                         shader;
 223   VisualFactoryCache::ShaderType shaderType;
 224
 225   bool roundedCorner  = IsRoundedCornerRequired();
 226   bool borderline     = IsBorderlineRequired();
 227   bool blur           = !EqualsZero(mBlurRadius) || mAlwaysUsingBlurRadius;
 228   int  shaderTypeFlag = ColorVisualRequireFlag::DEFAULT;
 229
 230   if(roundedCorner)
 231   {
 232     shaderTypeFlag |= ColorVisualRequireFlag::ROUNDED_CORNER;
 233   }
 234   if(blur)
 235   {
 236     // If we use blur, just ignore borderline
 237     borderline = false;
 238     shaderTypeFlag |= ColorVisualRequireFlag::BLUR;
 239   }
 240   if(borderline)
 241   {
 242     shaderTypeFlag |= ColorVisualRequireFlag::BORDERLINE;
 243   }
 244
 245   shaderType = SHADER_TYPE_TABLE[shaderTypeFlag];
 246   shader     = mFactoryCache.GetShader(shaderType);
 247   if(!shader)
 248   {
 249     std::string vertexShaderPrefixList;
 250     std::string fragmentShaderPrefixList;
 251     if(roundedCorner)
 252     {
 253       vertexShaderPrefixList += "#define IS_REQUIRED_ROUNDED_CORNER 1\n";
 254       fragmentShaderPrefixList += "#define IS_REQUIRED_ROUNDED_CORNER 1\n";
 255     }
 256     if(blur)
 257     {
 258       vertexShaderPrefixList += "#define IS_REQUIRED_BLUR 1\n";
 259       fragmentShaderPrefixList += "#define IS_REQUIRED_BLUR 1\n";
 260     }
 261     if(borderline)
 262     {
 263       vertexShaderPrefixList += "#define IS_REQUIRED_BORDERLINE 1\n";
 264       fragmentShaderPrefixList += "#define IS_REQUIRED_BORDERLINE 1\n";
 265     }
 266     shader = Shader::New(Dali::Shader::GetVertexShaderPrefix() + vertexShaderPrefixList + SHADER_COLOR_VISUAL_SHADER_VERT.data(),
 267                          Dali::Shader::GetFragmentShaderPrefix() + fragmentShaderPrefixList + SHADER_COLOR_VISUAL_SHADER_FRAG.data());
 268     mFactoryCache.SaveShader(shaderType, shader);
 269   }
 270
 271   return shader;
 272 }
 273
 274 Dali::Property ColorVisual::OnGetPropertyObject(Dali::Property::Key key)
 275 {
 276   if(!mImpl->mRenderer)
 277   {
 278     Handle handle;
 279     return Dali::Property(handle, Property::INVALID_INDEX);
 280   }
 281
 282   if((key.type == Property::Key::INDEX && key.indexKey == DevelColorVisual::Property::BLUR_RADIUS) || (key.type == Property::Key::STRING && key.stringKey == BLUR_RADIUS_NAME))
 283   {
 284     mBlurRadiusIndex = mImpl->mRenderer.RegisterProperty(DevelColorVisual::Property::BLUR_RADIUS, BLUR_RADIUS_NAME, mBlurRadius);
 285
 286     // Blur is animated now. we always have to use blur feature.
 287     mAlwaysUsingBlurRadius = true;
 288
 289     mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::ON);
 290
 291     // Change shader
 292     UpdateShader();
 293
 294     return Dali::Property(mImpl->mRenderer, mBlurRadiusIndex);
 295   }
 296
 297   Handle handle;
 298   return Dali::Property(handle, Property::INVALID_INDEX);
 299 }
 300
 301 } // namespace Internal
 302
 303 } // namespace Toolkit
 304
 305 } // namespace Dali