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/adaptor-framework/adaptor.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/public-api/object/property-array.h>
25 #include <dali/public-api/object/type-registry-helper.h>
26 #include <dali/public-api/object/type-registry.h>
29 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
30 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
31 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
32 #include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
33 #include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
34 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
35 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
36 #include <dali-toolkit/internal/visuals/border/border-visual.h>
37 #include <dali-toolkit/internal/visuals/color/color-visual.h>
38 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
39 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
40 #include <dali-toolkit/internal/visuals/image/image-visual.h>
41 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
42 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
43 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
44 #include <dali-toolkit/internal/visuals/svg/svg-visual.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>
63 #if defined(DEBUG_ENABLED)
64 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
69 BaseHandle handle = Toolkit::VisualFactory::Get();
74 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
75 DALI_TYPE_REGISTRATION_END()
76 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
80 VisualFactory::VisualFactory(bool debugEnabled)
82 mImageVisualShaderFactory(),
83 mTextVisualShaderFactory(),
85 mIdleCallback(nullptr),
86 mDebugEnabled(debugEnabled),
87 mPreMultiplyOnLoad(true)
91 VisualFactory::~VisualFactory()
93 if(mIdleCallback && Adaptor::IsAvailable())
95 // Removes the callback from the callback manager in case the control is destroyed before the callback is executed.
96 Adaptor::Get().RemoveIdle(mIdleCallback);
97 mIdleCallback = nullptr;
101 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
103 if(type == StyleChange::THEME_CHANGE)
105 SetBrokenImageUrl(styleManager);
109 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
111 SetBrokenImageUrl(styleManager);
114 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
116 Visual::BasePtr visualPtr;
118 Property::Value* typeValue = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
119 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
122 Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
127 case Toolkit::Visual::BORDER:
129 visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
133 case Toolkit::Visual::COLOR:
135 visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
139 case Toolkit::Visual::GRADIENT:
141 visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
145 case Toolkit::Visual::IMAGE:
147 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
148 std::string imageUrl;
151 if(imageURLValue->Get(imageUrl))
153 if(!imageUrl.empty())
155 VisualUrl visualUrl(imageUrl);
157 switch(visualUrl.GetType())
159 case VisualUrl::N_PATCH:
161 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
167 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
171 case VisualUrl::WEBP:
173 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
176 case VisualUrl::JSON:
178 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
181 case VisualUrl::REGULAR_IMAGE:
183 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
191 Property::Array* array = imageURLValue->GetArray();
192 if(array && array->Count() > 0)
194 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
201 case Toolkit::Visual::MESH:
203 visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
207 case Toolkit::Visual::PRIMITIVE:
209 visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
213 case Toolkit::Visual::WIREFRAME:
215 visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
219 case Toolkit::Visual::TEXT:
221 visualPtr = TextVisual::New(GetFactoryCache(), GetTextVisualShaderFactory(), propertyMap);
225 case Toolkit::Visual::N_PATCH:
227 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
228 std::string imageUrl;
229 if(imageURLValue && imageURLValue->Get(imageUrl))
231 if(!imageUrl.empty())
233 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
239 case Toolkit::Visual::SVG:
241 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
242 std::string imageUrl;
243 if(imageURLValue && imageURLValue->Get(imageUrl))
245 if(!imageUrl.empty())
247 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
253 case Toolkit::Visual::ANIMATED_IMAGE:
255 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
256 std::string imageUrl;
259 if(imageURLValue->Get(imageUrl))
261 if(!imageUrl.empty())
263 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
268 Property::Array* array = imageURLValue->GetArray();
269 if(array && array->Count() > 0)
271 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
278 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
280 visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
284 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
286 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
287 std::string imageUrl;
288 if(imageURLValue && imageURLValue->Get(imageUrl))
290 if(!imageUrl.empty())
292 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
298 case Toolkit::DevelVisual::ARC:
300 visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
305 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) ? (([&]() {
306 // Return URL if present in PropertyMap else return "not found message"
307 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
308 return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
314 DALI_LOG_ERROR("VisualType unknown\n");
317 if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
319 //Create a WireframeVisual if we have debug enabled
320 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
323 return Toolkit::Visual::Base(visualPtr.Get());
326 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
328 Visual::BasePtr visualPtr;
332 // first resolve url type to know which visual to create
333 VisualUrl visualUrl(url);
334 switch(visualUrl.GetType())
336 case VisualUrl::N_PATCH:
338 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
344 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
348 case VisualUrl::WEBP:
350 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
353 case VisualUrl::JSON:
355 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
358 case VisualUrl::REGULAR_IMAGE:
360 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
368 //Create a WireframeVisual if we have debug enabled
369 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
372 return Toolkit::Visual::Base(visualPtr.Get());
375 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
377 if(mPreMultiplyOnLoad != preMultiply)
379 GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
381 mPreMultiplyOnLoad = preMultiply;
384 bool VisualFactory::GetPreMultiplyOnLoad() const
386 return mPreMultiplyOnLoad;
389 void VisualFactory::DiscardVisual(Toolkit::Visual::Base visual)
391 mDiscardedVisuals.emplace_back(visual);
393 RegisterDiscardCallback();
396 void VisualFactory::UsePreCompiledShader()
398 if(mPrecompiledShaderRequested)
402 mPrecompiledShaderRequested = true;
404 RawShaderData rawShaderData;
405 Integration::ShaderPrecompiler::Get().Enable();
406 GetImageVisualShaderFactory().GetPrecompiledShader(rawShaderData);
407 Integration::ShaderPrecompiler::Get().SavePrecomipleShaderList(rawShaderData);
410 Internal::TextureManager& VisualFactory::GetTextureManager()
412 return GetFactoryCache().GetTextureManager();
415 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
417 const std::string imageDirPath = AssetManager::GetDaliImagePath();
418 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
419 std::vector<std::string> customBrokenImageUrlList;
423 customBrokenImageUrlList = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
424 const auto brokenImageUrlValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("brokenImageUrl", Property::Type::STRING);
425 if(brokenImageUrlValue)
427 brokenImageUrlValue->Get(brokenImageUrl);
432 mFactoryCache->SetBrokenImageUrl(brokenImageUrl, customBrokenImageUrlList);
435 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
439 mFactoryCache = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
440 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
443 styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
444 Toolkit::DevelStyleManager::BrokenImageChangedSignal(styleManager).Connect(mSlotDelegate, &VisualFactory::OnBrokenImageChangedSignal);
446 SetBrokenImageUrl(styleManager);
449 //UsePreCompiledShader(); // Call forcelly
451 return *mFactoryCache;
454 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
456 if(!mImageVisualShaderFactory)
458 mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
460 return *mImageVisualShaderFactory;
463 TextVisualShaderFactory& VisualFactory::GetTextVisualShaderFactory()
465 if(!mTextVisualShaderFactory)
467 mTextVisualShaderFactory = std::unique_ptr<TextVisualShaderFactory>(new TextVisualShaderFactory());
469 return *mTextVisualShaderFactory;
472 void VisualFactory::OnDiscardCallback()
474 mIdleCallback = nullptr;
476 // Discard visual now.
477 mDiscardedVisuals.clear();
480 void VisualFactory::RegisterDiscardCallback()
482 if(!mIdleCallback && Adaptor::IsAvailable())
484 // The callback manager takes the ownership of the callback object.
485 mIdleCallback = MakeCallback(this, &VisualFactory::OnDiscardCallback);
487 Adaptor& adaptor = Adaptor::Get();
489 if(!adaptor.AddIdle(mIdleCallback, false))
491 // Fail to add idle. (Maybe adaptor is paused.)
492 mIdleCallback = nullptr;
497 } // namespace Internal
499 } // namespace Toolkit