2 * Copyright (c) 2021 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 const std::string imageDirPath = AssetManager::GetDaliImagePath();
95 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
97 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
98 config["brokenImageUrl"].Get(brokenImageUrl);
102 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
107 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
109 Visual::BasePtr visualPtr;
111 Property::Value* typeValue = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
112 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
115 Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
120 case Toolkit::Visual::BORDER:
122 visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
126 case Toolkit::Visual::COLOR:
128 visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
132 case Toolkit::Visual::GRADIENT:
134 visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
138 case Toolkit::Visual::IMAGE:
140 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
141 std::string imageUrl;
144 if(imageURLValue->Get(imageUrl))
146 if(!imageUrl.empty())
148 VisualUrl visualUrl(imageUrl);
150 switch(visualUrl.GetType())
152 case VisualUrl::N_PATCH:
154 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();
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(), 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 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 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
239 case Toolkit::Visual::ANIMATED_IMAGE:
241 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
242 std::string imageUrl;
245 if(imageURLValue->Get(imageUrl))
247 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
251 Property::Array* array = imageURLValue->GetArray();
254 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
261 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
263 visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
267 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
269 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
270 std::string imageUrl;
271 if(imageURLValue && imageURLValue->Get(imageUrl))
273 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
278 case Toolkit::DevelVisual::ARC:
280 visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
285 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) ? (([&]() {
286 // Return URL if present in PropertyMap else return "not found message"
287 Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
288 return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
294 DALI_LOG_ERROR("VisualType unknown\n");
297 if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
299 //Create a WireframeVisual if we have debug enabled
300 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
303 return Toolkit::Visual::Base(visualPtr.Get());
306 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
308 Visual::BasePtr visualPtr;
312 // first resolve url type to know which visual to create
313 VisualUrl visualUrl(url);
314 switch(visualUrl.GetType())
316 case VisualUrl::N_PATCH:
318 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
323 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
327 case VisualUrl::WEBP:
329 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
332 case VisualUrl::JSON:
334 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
337 case VisualUrl::REGULAR_IMAGE:
339 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
347 //Create a WireframeVisual if we have debug enabled
348 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
351 return Toolkit::Visual::Base(visualPtr.Get());
354 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
356 if(mPreMultiplyOnLoad != preMultiply)
358 GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
360 mPreMultiplyOnLoad = preMultiply;
363 bool VisualFactory::GetPreMultiplyOnLoad() const
365 return mPreMultiplyOnLoad;
368 Internal::TextureManager& VisualFactory::GetTextureManager()
370 return GetFactoryCache().GetTextureManager();
373 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
377 mFactoryCache = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
379 const std::string imageDirPath = AssetManager::GetDaliImagePath();
380 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
382 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
385 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
386 config["brokenImageUrl"].Get(brokenImageUrl);
387 styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
390 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
392 return *mFactoryCache;
395 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
397 if(!mImageVisualShaderFactory)
399 mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
401 return *mImageVisualShaderFactory;
404 } // namespace Internal
406 } // namespace Toolkit