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-visual-shader-factory.h>
44 #include <dali-toolkit/internal/visuals/text/text-visual.h>
45 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
46 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
47 #include <dali-toolkit/internal/visuals/visual-url.h>
48 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
49 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
50 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
51 #include <dali-toolkit/public-api/visuals/visual-properties.h>
61 #if defined(DEBUG_ENABLED)
62 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
67 BaseHandle handle = Toolkit::VisualFactory::Get();
72 DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
73 DALI_TYPE_REGISTRATION_END()
74 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
78 VisualFactory::VisualFactory(bool debugEnabled)
80 mImageVisualShaderFactory(),
81 mTextVisualShaderFactory(),
83 mDebugEnabled(debugEnabled),
84 mPreMultiplyOnLoad(true)
88 VisualFactory::~VisualFactory()
92 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
94 if(type == StyleChange::THEME_CHANGE)
96 SetBrokenImageUrl(styleManager);
100 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
102 SetBrokenImageUrl(styleManager);
105 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
107 Visual::BasePtr visualPtr;
109 Property::Value* typeValue = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
110 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
113 Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
118 case Toolkit::Visual::BORDER:
120 visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
124 case Toolkit::Visual::COLOR:
126 visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
130 case Toolkit::Visual::GRADIENT:
132 visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
136 case Toolkit::Visual::IMAGE:
138 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
139 std::string imageUrl;
142 if(imageURLValue->Get(imageUrl))
144 if(!imageUrl.empty())
146 VisualUrl visualUrl(imageUrl);
148 switch(visualUrl.GetType())
150 case VisualUrl::N_PATCH:
152 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
158 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
162 case VisualUrl::WEBP:
164 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
167 case VisualUrl::JSON:
169 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
172 case VisualUrl::REGULAR_IMAGE:
174 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
182 Property::Array* array = imageURLValue->GetArray();
183 if(array && array->Count() > 0)
185 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
192 case Toolkit::Visual::MESH:
194 visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
198 case Toolkit::Visual::PRIMITIVE:
200 visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
204 case Toolkit::Visual::WIREFRAME:
206 visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
210 case Toolkit::Visual::TEXT:
212 visualPtr = TextVisual::New(GetFactoryCache(), GetTextVisualShaderFactory(), propertyMap);
216 case Toolkit::Visual::N_PATCH:
218 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
219 std::string imageUrl;
220 if(imageURLValue && imageURLValue->Get(imageUrl))
222 if(!imageUrl.empty())
224 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
230 case Toolkit::Visual::SVG:
232 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
233 std::string imageUrl;
234 if(imageURLValue && imageURLValue->Get(imageUrl))
236 if(!imageUrl.empty())
238 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
244 case Toolkit::Visual::ANIMATED_IMAGE:
246 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
247 std::string imageUrl;
250 if(imageURLValue->Get(imageUrl))
252 if(!imageUrl.empty())
254 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
259 Property::Array* array = imageURLValue->GetArray();
260 if(array && array->Count() > 0)
262 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
269 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
271 visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
275 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
277 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
278 std::string imageUrl;
279 if(imageURLValue && imageURLValue->Get(imageUrl))
281 if(!imageUrl.empty())
283 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
289 case Toolkit::DevelVisual::ARC:
291 visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
296 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) ? (([&]() {
297 // Return URL if present in PropertyMap else return "not found message"
298 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
299 return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
305 DALI_LOG_ERROR("VisualType unknown\n");
308 if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
310 //Create a WireframeVisual if we have debug enabled
311 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
314 return Toolkit::Visual::Base(visualPtr.Get());
317 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
319 Visual::BasePtr visualPtr;
323 // first resolve url type to know which visual to create
324 VisualUrl visualUrl(url);
325 switch(visualUrl.GetType())
327 case VisualUrl::N_PATCH:
329 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
335 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
339 case VisualUrl::WEBP:
341 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
344 case VisualUrl::JSON:
346 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
349 case VisualUrl::REGULAR_IMAGE:
351 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
359 //Create a WireframeVisual if we have debug enabled
360 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
363 return Toolkit::Visual::Base(visualPtr.Get());
366 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
368 if(mPreMultiplyOnLoad != preMultiply)
370 GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
372 mPreMultiplyOnLoad = preMultiply;
375 bool VisualFactory::GetPreMultiplyOnLoad() const
377 return mPreMultiplyOnLoad;
380 Internal::TextureManager& VisualFactory::GetTextureManager()
382 return GetFactoryCache().GetTextureManager();
385 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
387 const std::string imageDirPath = AssetManager::GetDaliImagePath();
388 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
389 std::vector<std::string> customBrokenImageUrlList;
393 customBrokenImageUrlList = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
394 const Property::Map& config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
395 const auto brokenImageUrlValue = config.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