2 * Copyright (c) 2023 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.
18 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
21 #include <dali/devel-api/scripting/scripting.h>
22 #include <dali/integration-api/debug.h>
23 #include <dali/public-api/object/property-array.h>
24 #include <dali/public-api/object/type-registry-helper.h>
25 #include <dali/public-api/object/type-registry.h>
28 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
29 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
30 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
31 #include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
32 #include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
33 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
34 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
35 #include <dali-toolkit/internal/visuals/border/border-visual.h>
36 #include <dali-toolkit/internal/visuals/color/color-visual.h>
37 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
38 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
39 #include <dali-toolkit/internal/visuals/image/image-visual.h>
40 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
41 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
42 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
43 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
44 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
45 #include <dali-toolkit/internal/visuals/text-visual-shader-factory.h>
46 #include <dali-toolkit/internal/visuals/text/text-visual.h>
47 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
48 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
49 #include <dali-toolkit/internal/visuals/visual-url.h>
50 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
51 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
52 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
53 #include <dali-toolkit/public-api/visuals/visual-properties.h>
64 #if defined(DEBUG_ENABLED)
65 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
70 BaseHandle handle = Toolkit::VisualFactory::Get();
75 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
76 DALI_TYPE_REGISTRATION_END()
77 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
79 static constexpr auto SHADER_TYPE_COUNT = 2u;
80 const std::string_view VertexPredefines[SHADER_TYPE_COUNT]
82 "", //VisualFactoryCache::COLOR_SHADER
83 "#define IS_REQUIRED_ROUNDED_CORNER\n", //VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER
85 const std::string_view FragmentPredefines[SHADER_TYPE_COUNT]
87 "", //VisualFactoryCache::COLOR_SHADER
88 "#define IS_REQUIRED_ROUNDED_CORNER\n", //VisualFactoryCache::COLOR_SHADER_ROUNDED_CORNER
93 VisualFactory::VisualFactory(bool debugEnabled)
95 mImageVisualShaderFactory(),
96 mTextVisualShaderFactory(),
98 mDebugEnabled(debugEnabled),
99 mPreMultiplyOnLoad(true)
103 VisualFactory::~VisualFactory()
107 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
109 if(type == StyleChange::THEME_CHANGE)
111 SetBrokenImageUrl(styleManager);
115 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
117 SetBrokenImageUrl(styleManager);
120 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
122 Visual::BasePtr visualPtr;
124 Property::Value* typeValue = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
125 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
128 Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
133 case Toolkit::Visual::BORDER:
135 visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
139 case Toolkit::Visual::COLOR:
141 visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
145 case Toolkit::Visual::GRADIENT:
147 visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
151 case Toolkit::Visual::IMAGE:
153 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
154 std::string imageUrl;
157 if(imageURLValue->Get(imageUrl))
159 if(!imageUrl.empty())
161 VisualUrl visualUrl(imageUrl);
163 switch(visualUrl.GetType())
165 case VisualUrl::N_PATCH:
167 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
173 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
177 case VisualUrl::WEBP:
179 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
182 case VisualUrl::JSON:
184 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
187 case VisualUrl::REGULAR_IMAGE:
189 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
197 Property::Array* array = imageURLValue->GetArray();
198 if(array && array->Count() > 0)
200 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
207 case Toolkit::Visual::MESH:
209 visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
213 case Toolkit::Visual::PRIMITIVE:
215 visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
219 case Toolkit::Visual::WIREFRAME:
221 visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
225 case Toolkit::Visual::TEXT:
227 visualPtr = TextVisual::New(GetFactoryCache(), GetTextVisualShaderFactory(), propertyMap);
231 case Toolkit::Visual::N_PATCH:
233 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
234 std::string imageUrl;
235 if(imageURLValue && imageURLValue->Get(imageUrl))
237 if(!imageUrl.empty())
239 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
245 case Toolkit::Visual::SVG:
247 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
248 std::string imageUrl;
249 if(imageURLValue && imageURLValue->Get(imageUrl))
251 if(!imageUrl.empty())
253 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
259 case Toolkit::Visual::ANIMATED_IMAGE:
261 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
262 std::string imageUrl;
265 if(imageURLValue->Get(imageUrl))
267 if(!imageUrl.empty())
269 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
274 Property::Array* array = imageURLValue->GetArray();
275 if(array && array->Count() > 0)
277 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
284 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
286 visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
290 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
292 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
293 std::string imageUrl;
294 if(imageURLValue && imageURLValue->Get(imageUrl))
296 if(!imageUrl.empty())
298 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
304 case Toolkit::DevelVisual::ARC:
306 visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
311 DALI_LOG_INFO(gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n", Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>(visualType, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT), (visualType == Toolkit::DevelVisual::IMAGE) ? "url:" : "", (visualType == Toolkit::DevelVisual::IMAGE) ? (([&]() {
312 // Return URL if present in PropertyMap else return "not found message"
313 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
314 return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
320 DALI_LOG_ERROR("VisualType unknown\n");
323 if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
325 //Create a WireframeVisual if we have debug enabled
326 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
329 return Toolkit::Visual::Base(visualPtr.Get());
332 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
334 Visual::BasePtr visualPtr;
338 // first resolve url type to know which visual to create
339 VisualUrl visualUrl(url);
340 switch(visualUrl.GetType())
342 case VisualUrl::N_PATCH:
344 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
350 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
354 case VisualUrl::WEBP:
356 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
359 case VisualUrl::JSON:
361 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
364 case VisualUrl::REGULAR_IMAGE:
366 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
374 //Create a WireframeVisual if we have debug enabled
375 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
378 return Toolkit::Visual::Base(visualPtr.Get());
381 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
383 if(mPreMultiplyOnLoad != preMultiply)
385 GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
387 mPreMultiplyOnLoad = preMultiply;
390 bool VisualFactory::GetPreMultiplyOnLoad() const
392 return mPreMultiplyOnLoad;
395 void VisualFactory::UsePreCompiledShader()
397 if(mPrecompiledShaderRequested)
401 mPrecompiledShaderRequested = true;
403 Integration::ShaderPrecompiler::Get().Enable();
406 std::vector<RawShaderData> rawShaderList;
407 RawShaderData imageShaderData;
408 GetImageVisualShaderFactory().GetPrecompiledShader(imageShaderData);
409 rawShaderList.push_back(imageShaderData);
412 RawShaderData textShaderData;
413 GetTextVisualShaderFactory().GetPrecompiledShader(textShaderData);
414 rawShaderList.push_back(textShaderData);
417 RawShaderData colorShaderData;
418 GetPrecompiledShader(colorShaderData);
419 rawShaderList.push_back(colorShaderData);
423 Integration::ShaderPrecompiler::Get().SavePrecomipleShaderList(rawShaderList);
426 Internal::TextureManager& VisualFactory::GetTextureManager()
428 return GetFactoryCache().GetTextureManager();
431 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
433 const std::string imageDirPath = AssetManager::GetDaliImagePath();
434 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
435 std::vector<std::string> customBrokenImageUrlList;
439 customBrokenImageUrlList = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
440 const auto brokenImageUrlValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("brokenImageUrl", Property::Type::STRING);
441 if(brokenImageUrlValue)
443 brokenImageUrlValue->Get(brokenImageUrl);
448 mFactoryCache->SetBrokenImageUrl(brokenImageUrl, customBrokenImageUrlList);
451 void VisualFactory::GetPrecompiledShader(RawShaderData& shaders)
453 std::vector<std::string_view> vertexPrefix;
454 std::vector<std::string_view> fragmentPrefix;
456 shaders.shaderCount = 0;
457 for(int i=0; i< SHADER_TYPE_COUNT; ++i)
459 vertexPrefix.push_back(VertexPredefines[i]);
460 fragmentPrefix.push_back(FragmentPredefines[i]);
464 shaders.vertexPrefix = vertexPrefix;
465 shaders.fragmentPrefix = fragmentPrefix;
466 shaders.vertexShader = SHADER_COLOR_VISUAL_SHADER_VERT;
467 shaders.fragmentShader = SHADER_COLOR_VISUAL_SHADER_FRAG;
468 shaders.shaderCount = shaderCount;
471 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
475 mFactoryCache = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
476 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
479 styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
480 Toolkit::DevelStyleManager::BrokenImageChangedSignal(styleManager).Connect(mSlotDelegate, &VisualFactory::OnBrokenImageChangedSignal);
482 SetBrokenImageUrl(styleManager);
485 //UsePreCompiledShader(); // Call forcelly
487 return *mFactoryCache;
490 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
492 if(!mImageVisualShaderFactory)
494 mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
496 return *mImageVisualShaderFactory;
499 TextVisualShaderFactory& VisualFactory::GetTextVisualShaderFactory()
501 if(!mTextVisualShaderFactory)
503 mTextVisualShaderFactory = std::unique_ptr<TextVisualShaderFactory>(new TextVisualShaderFactory());
505 return *mTextVisualShaderFactory;
508 } // namespace Internal
510 } // namespace Toolkit