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/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_FILE_NAME = "broken.png"; ///< The file name of 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 const std::string imageDirPath = AssetManager::GetDaliImagePath();
99 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
101 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
102 config["brokenImageUrl"].Get( brokenImageUrl );
106 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
111 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
113 Visual::BasePtr visualPtr;
115 Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
116 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
119 Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
124 case Toolkit::Visual::BORDER:
126 visualPtr = BorderVisual::New( GetFactoryCache(), propertyMap );
130 case Toolkit::Visual::COLOR:
132 visualPtr = ColorVisual::New( GetFactoryCache(), propertyMap );
136 case Toolkit::Visual::GRADIENT:
138 visualPtr = GradientVisual::New( GetFactoryCache(), propertyMap );
142 case Toolkit::Visual::IMAGE:
144 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
145 std::string imageUrl;
148 if( imageURLValue->Get( imageUrl ) )
150 if( !imageUrl.empty() )
152 VisualUrl visualUrl( imageUrl );
154 switch( visualUrl.GetType() )
156 case VisualUrl::N_PATCH:
158 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl, propertyMap );
163 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
168 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
171 case VisualUrl::JSON:
173 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
176 case VisualUrl::REGULAR_IMAGE:
178 visualPtr = ImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
186 Property::Array* array = imageURLValue->GetArray();
189 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
196 case Toolkit::Visual::MESH:
198 visualPtr = MeshVisual::New( GetFactoryCache(), propertyMap );
202 case Toolkit::Visual::PRIMITIVE:
204 visualPtr = PrimitiveVisual::New( GetFactoryCache(), propertyMap );
208 case Toolkit::Visual::WIREFRAME:
210 visualPtr = WireframeVisual::New( GetFactoryCache(), propertyMap );
214 case Toolkit::Visual::TEXT:
216 visualPtr = TextVisual::New( GetFactoryCache(), propertyMap );
220 case Toolkit::Visual::N_PATCH:
222 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
223 std::string imageUrl;
224 if( imageURLValue && imageURLValue->Get( imageUrl ) )
226 visualPtr = NPatchVisual::New( GetFactoryCache(), imageUrl, propertyMap );
231 case Toolkit::Visual::SVG:
233 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
234 std::string imageUrl;
235 if( imageURLValue && imageURLValue->Get( imageUrl ) )
237 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 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
254 Property::Array* array = imageURLValue->GetArray();
257 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
264 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
266 visualPtr = AnimatedGradientVisual::New( GetFactoryCache(), propertyMap );
270 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
272 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
273 std::string imageUrl;
274 if( imageURLValue && imageURLValue->Get( imageUrl ) )
276 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
282 DALI_LOG_INFO( gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n",
283 Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>( visualType,
285 VISUAL_TYPE_TABLE_COUNT ),
286 ( visualType == Toolkit::DevelVisual::IMAGE ) ? "url:" : "",
287 ( visualType == Toolkit::DevelVisual::IMAGE ) ?
289 // Return URL if present in PropertyMap else return "not found message"
290 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
291 return ( imageURLValue ) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
298 DALI_LOG_ERROR( "VisualType unknown\n" );
301 if( mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME )
303 //Create a WireframeVisual if we have debug enabled
304 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap );
307 return Toolkit::Visual::Base( visualPtr.Get() );
310 Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
312 Visual::BasePtr visualPtr;
316 NinePatchImage npatchImage = NinePatchImage::DownCast( image );
319 visualPtr = NPatchVisual::New( GetFactoryCache(), npatchImage );
323 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), image );
329 //Create a WireframeVisual if we have debug enabled
330 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
333 return Toolkit::Visual::Base( visualPtr.Get() );
336 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
338 Visual::BasePtr visualPtr;
342 // first resolve url type to know which visual to create
343 VisualUrl visualUrl( url );
344 switch( visualUrl.GetType() )
346 case VisualUrl::N_PATCH:
348 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl );
353 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
358 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
361 case VisualUrl::JSON:
363 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
366 case VisualUrl::REGULAR_IMAGE:
368 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size );
376 //Create a WireframeVisual if we have debug enabled
377 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
380 return Toolkit::Visual::Base( visualPtr.Get() );
383 void VisualFactory::SetPreMultiplyOnLoad( bool preMultiply )
385 if( mPreMultiplyOnLoad != preMultiply )
387 GetFactoryCache().SetPreMultiplyOnLoad( preMultiply );
389 mPreMultiplyOnLoad = preMultiply;
392 bool VisualFactory::GetPreMultiplyOnLoad() const
394 return mPreMultiplyOnLoad;
397 Internal::TextureManager& VisualFactory::GetTextureManager()
399 return GetFactoryCache().GetTextureManager();
402 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
406 mFactoryCache = std::unique_ptr<VisualFactoryCache>( new VisualFactoryCache( mPreMultiplyOnLoad ) );
408 const std::string imageDirPath = AssetManager::GetDaliImagePath();
409 std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
411 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
414 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
415 config["brokenImageUrl"].Get( brokenImageUrl );
416 styleManager.StyleChangedSignal().Connect( mSlotDelegate, &VisualFactory::OnStyleChangedSignal );
419 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
421 return *mFactoryCache;
424 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
426 if( !mImageVisualShaderFactory )
428 mImageVisualShaderFactory = std::unique_ptr< ImageVisualShaderFactory >( new ImageVisualShaderFactory() );
430 return *mImageVisualShaderFactory;
433 } // namespace Internal
435 } // namespace Toolkit