2 * Copyright (c) 2020 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/integration-api/debug.h>
22 #include <dali/public-api/images/image.h>
23 #include <dali/public-api/object/property-array.h>
24 #include <dali/public-api/object/type-registry.h>
25 #include <dali/public-api/object/type-registry-helper.h>
26 #include <dali/devel-api/scripting/scripting.h>
29 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
30 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
31 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
32 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
33 #include <dali-toolkit/public-api/visuals/visual-properties.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/animated-gradient/animated-gradient-visual.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/animated-image/animated-image-visual.h>
45 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
46 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
47 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
48 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
49 #include <dali-toolkit/internal/visuals/visual-url.h>
50 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
51 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
65 #if defined(DEBUG_ENABLED)
66 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
71 BaseHandle handle = Toolkit::VisualFactory::Get();
76 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
77 DALI_TYPE_REGISTRATION_END()
78 const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
82 VisualFactory::VisualFactory( bool debugEnabled )
84 mImageVisualShaderFactory(),
86 mDebugEnabled( debugEnabled ),
87 mPreMultiplyOnLoad( true )
91 VisualFactory::~VisualFactory()
95 void VisualFactory::OnStyleChangedSignal( Toolkit::StyleManager styleManager, StyleChange::Type type)
97 if( type == StyleChange::THEME_CHANGE )
99 const std::string imageDirPath = AssetManager::GetDaliImagePath();
100 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
102 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
103 config["brokenImageUrl"].Get( brokenImageUrl );
107 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
112 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
114 Visual::BasePtr visualPtr;
116 Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
117 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
120 Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
125 case Toolkit::Visual::BORDER:
127 visualPtr = BorderVisual::New( GetFactoryCache(), propertyMap );
131 case Toolkit::Visual::COLOR:
133 visualPtr = ColorVisual::New( GetFactoryCache(), propertyMap );
137 case Toolkit::Visual::GRADIENT:
139 visualPtr = GradientVisual::New( GetFactoryCache(), propertyMap );
143 case Toolkit::Visual::IMAGE:
145 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
146 std::string imageUrl;
149 if( imageURLValue->Get( imageUrl ) )
151 if( !imageUrl.empty() )
153 VisualUrl visualUrl( imageUrl );
155 switch( visualUrl.GetType() )
157 case VisualUrl::N_PATCH:
159 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl, propertyMap );
164 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
169 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
172 case VisualUrl::JSON:
174 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
177 case VisualUrl::REGULAR_IMAGE:
179 visualPtr = ImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
187 Property::Array* array = imageURLValue->GetArray();
190 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
197 case Toolkit::Visual::MESH:
199 visualPtr = MeshVisual::New( GetFactoryCache(), propertyMap );
203 case Toolkit::Visual::PRIMITIVE:
205 visualPtr = PrimitiveVisual::New( GetFactoryCache(), propertyMap );
209 case Toolkit::Visual::WIREFRAME:
211 visualPtr = WireframeVisual::New( GetFactoryCache(), propertyMap );
215 case Toolkit::Visual::TEXT:
217 visualPtr = TextVisual::New( GetFactoryCache(), propertyMap );
221 case Toolkit::Visual::N_PATCH:
223 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
224 std::string imageUrl;
225 if( imageURLValue && imageURLValue->Get( imageUrl ) )
227 visualPtr = NPatchVisual::New( GetFactoryCache(), imageUrl, propertyMap );
232 case Toolkit::Visual::SVG:
234 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
235 std::string imageUrl;
236 if( imageURLValue && imageURLValue->Get( imageUrl ) )
238 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
243 case Toolkit::Visual::ANIMATED_IMAGE:
245 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
246 std::string imageUrl;
249 if( imageURLValue->Get( imageUrl ) )
251 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
255 Property::Array* array = imageURLValue->GetArray();
258 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
265 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
267 visualPtr = AnimatedGradientVisual::New( GetFactoryCache(), propertyMap );
271 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
273 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
274 std::string imageUrl;
275 if( imageURLValue && imageURLValue->Get( imageUrl ) )
277 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
282 case Toolkit::DevelVisual::ARC:
284 visualPtr = ArcVisual::New( GetFactoryCache(), propertyMap );
289 DALI_LOG_INFO( gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n",
290 Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>( visualType,
292 VISUAL_TYPE_TABLE_COUNT ),
293 ( visualType == Toolkit::DevelVisual::IMAGE ) ? "url:" : "",
294 ( visualType == Toolkit::DevelVisual::IMAGE ) ?
296 // Return URL if present in PropertyMap else return "not found message"
297 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
298 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 Image& image )
319 Visual::BasePtr visualPtr;
323 NinePatchImage npatchImage = NinePatchImage::DownCast( image );
326 visualPtr = NPatchVisual::New( GetFactoryCache(), npatchImage );
330 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), image );
336 //Create a WireframeVisual if we have debug enabled
337 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
340 return Toolkit::Visual::Base( visualPtr.Get() );
343 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
345 Visual::BasePtr visualPtr;
349 // first resolve url type to know which visual to create
350 VisualUrl visualUrl( url );
351 switch( visualUrl.GetType() )
353 case VisualUrl::N_PATCH:
355 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl );
360 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
365 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
368 case VisualUrl::JSON:
370 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
373 case VisualUrl::REGULAR_IMAGE:
375 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size );
383 //Create a WireframeVisual if we have debug enabled
384 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
387 return Toolkit::Visual::Base( visualPtr.Get() );
390 void VisualFactory::SetPreMultiplyOnLoad( bool preMultiply )
392 if( mPreMultiplyOnLoad != preMultiply )
394 GetFactoryCache().SetPreMultiplyOnLoad( preMultiply );
396 mPreMultiplyOnLoad = preMultiply;
399 bool VisualFactory::GetPreMultiplyOnLoad() const
401 return mPreMultiplyOnLoad;
404 Internal::TextureManager& VisualFactory::GetTextureManager()
406 return GetFactoryCache().GetTextureManager();
409 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
413 mFactoryCache = std::unique_ptr<VisualFactoryCache>( new VisualFactoryCache( mPreMultiplyOnLoad ) );
415 const std::string imageDirPath = AssetManager::GetDaliImagePath();
416 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
418 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
421 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
422 config["brokenImageUrl"].Get( brokenImageUrl );
423 styleManager.StyleChangedSignal().Connect( mSlotDelegate, &VisualFactory::OnStyleChangedSignal );
426 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
428 return *mFactoryCache;
431 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
433 if( !mImageVisualShaderFactory )
435 mImageVisualShaderFactory = std::unique_ptr< ImageVisualShaderFactory >( new ImageVisualShaderFactory() );
437 return *mImageVisualShaderFactory;
440 } // namespace Internal
442 } // namespace Toolkit