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/visuals/visual-properties-devel.h>
30 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
31 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
32 #include <dali-toolkit/public-api/visuals/visual-properties.h>
33 #include <dali-toolkit/internal/visuals/border/border-visual.h>
34 #include <dali-toolkit/internal/visuals/color/color-visual.h>
35 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
36 #include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
37 #include <dali-toolkit/internal/visuals/image/image-visual.h>
38 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
39 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
40 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
41 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
42 #include <dali-toolkit/internal/visuals/text/text-visual.h>
43 #include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
44 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
45 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
46 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
47 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
48 #include <dali-toolkit/internal/visuals/visual-url.h>
49 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
50 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
64 #if defined(DEBUG_ENABLED)
65 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
70 BaseHandle handle = Toolkit::VisualFactory::Get();
75 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
76 DALI_TYPE_REGISTRATION_END()
77 const char * const BROKEN_IMAGE_URL( DALI_IMAGE_DIR "broken.png" ); ///< URL For the broken image
81 VisualFactory::VisualFactory( bool debugEnabled )
83 mImageVisualShaderFactory(),
85 mDebugEnabled( debugEnabled ),
86 mPreMultiplyOnLoad( true )
90 VisualFactory::~VisualFactory()
94 void VisualFactory::OnStyleChangedSignal( Toolkit::StyleManager styleManager, StyleChange::Type type)
96 if( type == StyleChange::THEME_CHANGE )
98 std::string brokenImageUrl(BROKEN_IMAGE_URL);
100 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
101 config["brokenImageUrl"].Get( brokenImageUrl );
105 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
110 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
112 Visual::BasePtr visualPtr;
114 Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
115 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
118 Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
123 case Toolkit::Visual::BORDER:
125 visualPtr = BorderVisual::New( GetFactoryCache(), propertyMap );
129 case Toolkit::Visual::COLOR:
131 visualPtr = ColorVisual::New( GetFactoryCache(), propertyMap );
135 case Toolkit::Visual::GRADIENT:
137 visualPtr = GradientVisual::New( GetFactoryCache(), propertyMap );
141 case Toolkit::Visual::IMAGE:
143 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
144 std::string imageUrl;
147 if( imageURLValue->Get( imageUrl ) )
149 if( !imageUrl.empty() )
151 VisualUrl visualUrl( imageUrl );
153 switch( visualUrl.GetType() )
155 case VisualUrl::N_PATCH:
157 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl, propertyMap );
162 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
167 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
170 case VisualUrl::JSON:
172 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
175 case VisualUrl::REGULAR_IMAGE:
177 visualPtr = ImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
185 Property::Array* array = imageURLValue->GetArray();
188 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
195 case Toolkit::Visual::MESH:
197 visualPtr = MeshVisual::New( GetFactoryCache(), propertyMap );
201 case Toolkit::Visual::PRIMITIVE:
203 visualPtr = PrimitiveVisual::New( GetFactoryCache(), propertyMap );
207 case Toolkit::Visual::WIREFRAME:
209 visualPtr = WireframeVisual::New( GetFactoryCache(), propertyMap );
213 case Toolkit::Visual::TEXT:
215 visualPtr = TextVisual::New( GetFactoryCache(), propertyMap );
219 case Toolkit::Visual::N_PATCH:
221 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
222 std::string imageUrl;
223 if( imageURLValue && imageURLValue->Get( imageUrl ) )
225 visualPtr = NPatchVisual::New( GetFactoryCache(), 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 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
241 case Toolkit::Visual::ANIMATED_IMAGE:
243 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
244 std::string imageUrl;
247 if( imageURLValue->Get( imageUrl ) )
249 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
253 Property::Array* array = imageURLValue->GetArray();
256 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
263 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
265 visualPtr = AnimatedGradientVisual::New( GetFactoryCache(), propertyMap );
269 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
271 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
272 std::string imageUrl;
273 if( imageURLValue && imageURLValue->Get( imageUrl ) )
275 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
280 case Toolkit::DevelVisual::ARC:
282 visualPtr = ArcVisual::New( GetFactoryCache(), propertyMap );
287 DALI_LOG_INFO( gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n",
288 Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>( visualType,
290 VISUAL_TYPE_TABLE_COUNT ),
291 ( visualType == Toolkit::DevelVisual::IMAGE ) ? "url:" : "",
292 ( visualType == Toolkit::DevelVisual::IMAGE ) ?
294 // Return URL if present in PropertyMap else return "not found message"
295 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
296 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 Image& image )
317 Visual::BasePtr visualPtr;
321 NinePatchImage npatchImage = NinePatchImage::DownCast( image );
324 visualPtr = NPatchVisual::New( GetFactoryCache(), npatchImage );
328 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), image );
334 //Create a WireframeVisual if we have debug enabled
335 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
338 return Toolkit::Visual::Base( visualPtr.Get() );
341 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
343 Visual::BasePtr visualPtr;
347 // first resolve url type to know which visual to create
348 VisualUrl visualUrl( url );
349 switch( visualUrl.GetType() )
351 case VisualUrl::N_PATCH:
353 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl );
358 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
363 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
366 case VisualUrl::JSON:
368 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
371 case VisualUrl::REGULAR_IMAGE:
373 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size );
381 //Create a WireframeVisual if we have debug enabled
382 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
385 return Toolkit::Visual::Base( visualPtr.Get() );
388 void VisualFactory::SetPreMultiplyOnLoad( bool preMultiply )
390 if( mPreMultiplyOnLoad != preMultiply )
392 GetFactoryCache().SetPreMultiplyOnLoad( preMultiply );
394 mPreMultiplyOnLoad = preMultiply;
397 bool VisualFactory::GetPreMultiplyOnLoad() const
399 return mPreMultiplyOnLoad;
402 Internal::TextureManager& VisualFactory::GetTextureManager()
404 return GetFactoryCache().GetTextureManager();
407 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
411 mFactoryCache = std::unique_ptr<VisualFactoryCache>( new VisualFactoryCache( mPreMultiplyOnLoad ) );
413 std::string brokenImageUrl(BROKEN_IMAGE_URL);
414 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
417 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
418 config["brokenImageUrl"].Get( brokenImageUrl );
419 styleManager.StyleChangedSignal().Connect( mSlotDelegate, &VisualFactory::OnStyleChangedSignal );
422 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
424 return *mFactoryCache;
427 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
429 if( !mImageVisualShaderFactory )
431 mImageVisualShaderFactory = std::unique_ptr< ImageVisualShaderFactory >( new ImageVisualShaderFactory() );
433 return *mImageVisualShaderFactory;
436 } // namespace Internal
438 } // namespace Toolkit