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/wireframe/wireframe-visual.h>
46 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
47 #include <dali-toolkit/internal/visuals/visual-url.h>
48 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
49 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
63 #if defined(DEBUG_ENABLED)
64 Debug::Filter* gLogFilter = Debug::Filter::New( Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
69 BaseHandle handle = Toolkit::VisualFactory::Get();
74 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
75 DALI_TYPE_REGISTRATION_END()
76 const char * const BROKEN_IMAGE_URL( DALI_IMAGE_DIR "broken.png" ); ///< URL For the broken image
80 VisualFactory::VisualFactory( bool debugEnabled )
82 mImageVisualShaderFactory(),
84 mDebugEnabled( debugEnabled ),
85 mPreMultiplyOnLoad( true )
89 VisualFactory::~VisualFactory()
93 void VisualFactory::OnStyleChangedSignal( Toolkit::StyleManager styleManager, StyleChange::Type type)
95 if( type == StyleChange::THEME_CHANGE )
97 std::string brokenImageUrl(BROKEN_IMAGE_URL);
99 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
100 config["brokenImageUrl"].Get( brokenImageUrl );
104 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
109 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
111 Visual::BasePtr visualPtr;
113 Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
114 Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
117 Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
122 case Toolkit::Visual::BORDER:
124 visualPtr = BorderVisual::New( GetFactoryCache(), propertyMap );
128 case Toolkit::Visual::COLOR:
130 visualPtr = ColorVisual::New( GetFactoryCache(), propertyMap );
134 case Toolkit::Visual::GRADIENT:
136 visualPtr = GradientVisual::New( GetFactoryCache(), propertyMap );
140 case Toolkit::Visual::IMAGE:
142 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
143 std::string imageUrl;
146 if( imageURLValue->Get( imageUrl ) )
148 if( !imageUrl.empty() )
150 VisualUrl visualUrl( imageUrl );
152 switch( visualUrl.GetType() )
154 case VisualUrl::N_PATCH:
156 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl, propertyMap );
161 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
166 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
169 case VisualUrl::JSON:
171 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
174 case VisualUrl::REGULAR_IMAGE:
176 visualPtr = ImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
184 Property::Array* array = imageURLValue->GetArray();
187 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
194 case Toolkit::Visual::MESH:
196 visualPtr = MeshVisual::New( GetFactoryCache(), propertyMap );
200 case Toolkit::Visual::PRIMITIVE:
202 visualPtr = PrimitiveVisual::New( GetFactoryCache(), propertyMap );
206 case Toolkit::Visual::WIREFRAME:
208 visualPtr = WireframeVisual::New( GetFactoryCache(), propertyMap );
212 case Toolkit::Visual::TEXT:
214 visualPtr = TextVisual::New( GetFactoryCache(), propertyMap );
218 case Toolkit::Visual::N_PATCH:
220 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
221 std::string imageUrl;
222 if( imageURLValue && imageURLValue->Get( imageUrl ) )
224 visualPtr = NPatchVisual::New( GetFactoryCache(), imageUrl, propertyMap );
229 case Toolkit::Visual::SVG:
231 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
232 std::string imageUrl;
233 if( imageURLValue && imageURLValue->Get( imageUrl ) )
235 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
240 case Toolkit::Visual::ANIMATED_IMAGE:
242 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
243 std::string imageUrl;
246 if( imageURLValue->Get( imageUrl ) )
248 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
252 Property::Array* array = imageURLValue->GetArray();
255 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
262 case Toolkit::DevelVisual::ANIMATED_GRADIENT:
264 visualPtr = AnimatedGradientVisual::New( GetFactoryCache(), propertyMap );
268 case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
270 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
271 std::string imageUrl;
272 if( imageURLValue && imageURLValue->Get( imageUrl ) )
274 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
280 DALI_LOG_INFO( gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n",
281 Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>( visualType,
283 VISUAL_TYPE_TABLE_COUNT ),
284 ( visualType == Toolkit::DevelVisual::IMAGE ) ? "url:" : "",
285 ( visualType == Toolkit::DevelVisual::IMAGE ) ?
287 // Return URL if present in PropertyMap else return "not found message"
288 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
289 return ( imageURLValue ) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
296 DALI_LOG_ERROR( "VisualType unknown\n" );
299 if( mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME )
301 //Create a WireframeVisual if we have debug enabled
302 visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap );
305 return Toolkit::Visual::Base( visualPtr.Get() );
308 Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
310 Visual::BasePtr visualPtr;
314 NinePatchImage npatchImage = NinePatchImage::DownCast( image );
317 visualPtr = NPatchVisual::New( GetFactoryCache(), npatchImage );
321 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), image );
327 //Create a WireframeVisual if we have debug enabled
328 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
331 return Toolkit::Visual::Base( visualPtr.Get() );
334 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
336 Visual::BasePtr visualPtr;
340 // first resolve url type to know which visual to create
341 VisualUrl visualUrl( url );
342 switch( visualUrl.GetType() )
344 case VisualUrl::N_PATCH:
346 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl );
351 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
356 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
359 case VisualUrl::JSON:
361 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
364 case VisualUrl::REGULAR_IMAGE:
366 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size );
374 //Create a WireframeVisual if we have debug enabled
375 visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
378 return Toolkit::Visual::Base( visualPtr.Get() );
381 void VisualFactory::SetPreMultiplyOnLoad( bool preMultiply )
383 if( mPreMultiplyOnLoad != preMultiply )
385 GetFactoryCache().SetPreMultiplyOnLoad( preMultiply );
387 mPreMultiplyOnLoad = preMultiply;
390 bool VisualFactory::GetPreMultiplyOnLoad() const
392 return mPreMultiplyOnLoad;
395 Internal::TextureManager& VisualFactory::GetTextureManager()
397 return GetFactoryCache().GetTextureManager();
400 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
404 mFactoryCache = std::unique_ptr<VisualFactoryCache>( new VisualFactoryCache( mPreMultiplyOnLoad ) );
406 std::string brokenImageUrl(BROKEN_IMAGE_URL);
407 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
410 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
411 config["brokenImageUrl"].Get( brokenImageUrl );
412 styleManager.StyleChangedSignal().Connect( mSlotDelegate, &VisualFactory::OnStyleChangedSignal );
415 mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
417 return *mFactoryCache;
420 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
422 if( !mImageVisualShaderFactory )
424 mImageVisualShaderFactory = std::unique_ptr< ImageVisualShaderFactory >( new ImageVisualShaderFactory() );
426 return *mImageVisualShaderFactory;
429 } // namespace Internal
431 } // namespace Toolkit