2 * Copyright (c) 2022 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/visuals/visual-properties-devel.h>
30 #include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
31 #include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
32 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
33 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
34 #include <dali-toolkit/internal/visuals/border/border-visual.h>
35 #include <dali-toolkit/internal/visuals/color/color-visual.h>
36 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
37 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
38 #include <dali-toolkit/internal/visuals/image/image-visual.h>
39 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
40 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
41 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
42 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
43 #include <dali-toolkit/internal/visuals/text/text-visual.h>
44 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
45 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
46 #include <dali-toolkit/internal/visuals/visual-url.h>
47 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
48 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
49 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
50 #include <dali-toolkit/public-api/visuals/visual-properties.h>
60 #if defined(DEBUG_ENABLED)
61 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
66 BaseHandle handle = Toolkit::VisualFactory::Get();
71 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
72 DALI_TYPE_REGISTRATION_END()
73 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
77 VisualFactory::VisualFactory(bool debugEnabled)
79 mImageVisualShaderFactory(),
81 mDebugEnabled(debugEnabled),
82 mPreMultiplyOnLoad(true)
86 VisualFactory::~VisualFactory()
90 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
92 if(type == StyleChange::THEME_CHANGE)
94 SetBrokenImageUrl(styleManager);
98 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
100 SetBrokenImageUrl(styleManager);
103 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
105 Visual::BasePtr visualPtr;
107 Property::Value* typeValue = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
108 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
111 Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
116 case Toolkit::Visual::BORDER:
118 visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
122 case Toolkit::Visual::COLOR:
124 visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
128 case Toolkit::Visual::GRADIENT:
130 visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
134 case Toolkit::Visual::IMAGE:
136 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
137 std::string imageUrl;
140 if(imageURLValue->Get(imageUrl))
142 if(!imageUrl.empty())
144 VisualUrl visualUrl(imageUrl);
146 switch(visualUrl.GetType())
148 case VisualUrl::N_PATCH:
150 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
156 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
160 case VisualUrl::WEBP:
162 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
165 case VisualUrl::JSON:
167 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
170 case VisualUrl::REGULAR_IMAGE:
172 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
180 Property::Array* array = imageURLValue->GetArray();
181 if(array && array->Count() > 0)
183 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
190 case Toolkit::Visual::MESH:
192 visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
196 case Toolkit::Visual::PRIMITIVE:
198 visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
202 case Toolkit::Visual::WIREFRAME:
204 visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
208 case Toolkit::Visual::TEXT:
210 visualPtr = TextVisual::New(GetFactoryCache(), propertyMap);
214 case Toolkit::Visual::N_PATCH:
216 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
217 std::string imageUrl;
218 if(imageURLValue && imageURLValue->Get(imageUrl))
220 if(!imageUrl.empty())
222 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
228 case Toolkit::Visual::SVG:
230 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
231 std::string imageUrl;
232 if(imageURLValue && imageURLValue->Get(imageUrl))
234 if(!imageUrl.empty())
236 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
242 case Toolkit::Visual::ANIMATED_IMAGE:
244 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
245 std::string imageUrl;
248 if(imageURLValue->Get(imageUrl))
250 if(!imageUrl.empty())
252 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
257 Property::Array* array = imageURLValue->GetArray();
258 if(array && array->Count() > 0)
260 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
267 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
269 visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
273 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
275 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
276 std::string imageUrl;
277 if(imageURLValue && imageURLValue->Get(imageUrl))
279 if(!imageUrl.empty())
281 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
287 case Toolkit::DevelVisual::ARC:
289 visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
294 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) ? (([&]() {
295 // Return URL if present in PropertyMap else return "not found message"
296 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
297 return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
303 DALI_LOG_ERROR("VisualType unknown\n");
306 if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
308 //Create a WireframeVisual if we have debug enabled
309 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
312 return Toolkit::Visual::Base(visualPtr.Get());
315 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
317 Visual::BasePtr visualPtr;
321 // first resolve url type to know which visual to create
322 VisualUrl visualUrl(url);
323 switch(visualUrl.GetType())
325 case VisualUrl::N_PATCH:
327 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
333 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
337 case VisualUrl::WEBP:
339 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
342 case VisualUrl::JSON:
344 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
347 case VisualUrl::REGULAR_IMAGE:
349 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
357 //Create a WireframeVisual if we have debug enabled
358 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
361 return Toolkit::Visual::Base(visualPtr.Get());
364 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
366 if(mPreMultiplyOnLoad != preMultiply)
368 GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
370 mPreMultiplyOnLoad = preMultiply;
373 bool VisualFactory::GetPreMultiplyOnLoad() const
375 return mPreMultiplyOnLoad;
378 Internal::TextureManager& VisualFactory::GetTextureManager()
380 return GetFactoryCache().GetTextureManager();
383 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
385 const std::string imageDirPath = AssetManager::GetDaliImagePath();
386 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
387 std::vector<std::string> customBrokenImageUrlList;
391 customBrokenImageUrlList = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
392 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
393 config["brokenImageUrl"].Get(brokenImageUrl);
397 mFactoryCache->SetBrokenImageUrl(brokenImageUrl, customBrokenImageUrlList);
400 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
404 mFactoryCache = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
405 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
408 styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
409 Toolkit::DevelStyleManager::BrokenImageChangedSignal(styleManager).Connect(mSlotDelegate, &VisualFactory::OnBrokenImageChangedSignal);
411 SetBrokenImageUrl(styleManager);
413 return *mFactoryCache;
416 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
418 if(!mImageVisualShaderFactory)
420 mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
422 return *mImageVisualShaderFactory;
425 } // namespace Internal
427 } // namespace Toolkit