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/visuals/text-visual-shader-factory.h>
45 #include <dali-toolkit/internal/visuals/text/text-visual.h>
46 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
47 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
48 #include <dali-toolkit/internal/visuals/visual-url.h>
49 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
50 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
51 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
52 #include <dali-toolkit/public-api/visuals/visual-properties.h>
62 #if defined(DEBUG_ENABLED)
63 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
68 BaseHandle handle = Toolkit::VisualFactory::Get();
73 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
74 DALI_TYPE_REGISTRATION_END()
75 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
79 VisualFactory::VisualFactory(bool debugEnabled)
81 mImageVisualShaderFactory(),
82 mTextVisualShaderFactory(),
84 mDebugEnabled(debugEnabled),
85 mPreMultiplyOnLoad(true)
89 VisualFactory::~VisualFactory()
93 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
95 if(type == StyleChange::THEME_CHANGE)
97 SetBrokenImageUrl(styleManager);
101 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
103 SetBrokenImageUrl(styleManager);
106 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
108 Visual::BasePtr visualPtr;
110 Property::Value* typeValue = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
111 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
114 Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
119 case Toolkit::Visual::BORDER:
121 visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
125 case Toolkit::Visual::COLOR:
127 visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
131 case Toolkit::Visual::GRADIENT:
133 visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
137 case Toolkit::Visual::IMAGE:
139 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
140 std::string imageUrl;
143 if(imageURLValue->Get(imageUrl))
145 if(!imageUrl.empty())
147 VisualUrl visualUrl(imageUrl);
149 switch(visualUrl.GetType())
151 case VisualUrl::N_PATCH:
153 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
159 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
163 case VisualUrl::WEBP:
165 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
168 case VisualUrl::JSON:
170 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
173 case VisualUrl::REGULAR_IMAGE:
175 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
183 Property::Array* array = imageURLValue->GetArray();
184 if(array && array->Count() > 0)
186 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
193 case Toolkit::Visual::MESH:
195 visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
199 case Toolkit::Visual::PRIMITIVE:
201 visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
205 case Toolkit::Visual::WIREFRAME:
207 visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
211 case Toolkit::Visual::TEXT:
213 visualPtr = TextVisual::New(GetFactoryCache(), GetTextVisualShaderFactory(), propertyMap);
217 case Toolkit::Visual::N_PATCH:
219 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
220 std::string imageUrl;
221 if(imageURLValue && imageURLValue->Get(imageUrl))
223 if(!imageUrl.empty())
225 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
231 case Toolkit::Visual::SVG:
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 = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
245 case Toolkit::Visual::ANIMATED_IMAGE:
247 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
248 std::string imageUrl;
251 if(imageURLValue->Get(imageUrl))
253 if(!imageUrl.empty())
255 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
260 Property::Array* array = imageURLValue->GetArray();
261 if(array && array->Count() > 0)
263 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
270 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
272 visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
276 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
278 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
279 std::string imageUrl;
280 if(imageURLValue && imageURLValue->Get(imageUrl))
282 if(!imageUrl.empty())
284 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
290 case Toolkit::DevelVisual::ARC:
292 visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
297 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) ? (([&]() {
298 // Return URL if present in PropertyMap else return "not found message"
299 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
300 return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
306 DALI_LOG_ERROR("VisualType unknown\n");
309 if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
311 //Create a WireframeVisual if we have debug enabled
312 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
315 return Toolkit::Visual::Base(visualPtr.Get());
318 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
320 Visual::BasePtr visualPtr;
324 // first resolve url type to know which visual to create
325 VisualUrl visualUrl(url);
326 switch(visualUrl.GetType())
328 case VisualUrl::N_PATCH:
330 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
336 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
340 case VisualUrl::WEBP:
342 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
345 case VisualUrl::JSON:
347 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
350 case VisualUrl::REGULAR_IMAGE:
352 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
360 //Create a WireframeVisual if we have debug enabled
361 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
364 return Toolkit::Visual::Base(visualPtr.Get());
367 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
369 if(mPreMultiplyOnLoad != preMultiply)
371 GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
373 mPreMultiplyOnLoad = preMultiply;
376 bool VisualFactory::GetPreMultiplyOnLoad() const
378 return mPreMultiplyOnLoad;
381 Internal::TextureManager& VisualFactory::GetTextureManager()
383 return GetFactoryCache().GetTextureManager();
386 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
388 const std::string imageDirPath = AssetManager::GetDaliImagePath();
389 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
390 std::vector<std::string> customBrokenImageUrlList;
394 customBrokenImageUrlList = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
395 const auto brokenImageUrlValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("brokenImageUrl", Property::Type::STRING);
396 if(brokenImageUrlValue)
398 brokenImageUrlValue->Get(brokenImageUrl);
403 mFactoryCache->SetBrokenImageUrl(brokenImageUrl, customBrokenImageUrlList);
406 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
410 mFactoryCache = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
411 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
414 styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
415 Toolkit::DevelStyleManager::BrokenImageChangedSignal(styleManager).Connect(mSlotDelegate, &VisualFactory::OnBrokenImageChangedSignal);
417 SetBrokenImageUrl(styleManager);
419 return *mFactoryCache;
422 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
424 if(!mImageVisualShaderFactory)
426 mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
428 return *mImageVisualShaderFactory;
431 TextVisualShaderFactory& VisualFactory::GetTextVisualShaderFactory()
433 if(!mTextVisualShaderFactory)
435 mTextVisualShaderFactory = std::unique_ptr<TextVisualShaderFactory>(new TextVisualShaderFactory());
437 return *mTextVisualShaderFactory;
440 } // namespace Internal
442 } // namespace Toolkit