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

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