2 * Copyright (c) 2016 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/enum-helper.h>
27 #include <dali/devel-api/scripting/scripting.h>
30 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
31 #include <dali-toolkit/public-api/visuals/visual-properties.h>
32 #include <dali-toolkit/internal/visuals/border/border-visual.h>
33 #include <dali-toolkit/internal/visuals/color/color-visual.h>
34 #include <dali-toolkit/internal/visuals/debug/debug-visual.h>
35 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
36 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
37 #include <dali-toolkit/internal/visuals/image/image-visual.h>
38 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
39 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
40 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
41 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
42 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
43 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
44 #include <dali-toolkit/internal/visuals/image/batch-image-visual.h>
48 const char * const BROKEN_VISUAL_IMAGE_URL( DALI_IMAGE_DIR "broken.png");
63 DALI_ENUM_TO_STRING_TABLE_BEGIN( VISUAL_TYPE )
64 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, BORDER )
65 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, COLOR )
66 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, GRADIENT )
67 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, IMAGE )
68 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, MESH )
69 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, PRIMITIVE )
70 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, DEBUG )
71 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, BATCH_IMAGE )
72 DALI_ENUM_TO_STRING_TABLE_END( VISUAL_TYPE )
74 const char * const VISUAL_TYPE( "visualType" );
75 const char * const BATCHING_ENABLED( "batchingEnabled" );
79 BaseHandle handle = Toolkit::VisualFactory::Get();
84 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
85 DALI_TYPE_REGISTRATION_END()
89 VisualFactory::VisualFactory( bool debugEnabled )
90 :mDebugEnabled( debugEnabled )
94 VisualFactory::~VisualFactory()
98 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
100 // Create factory cache if it hasn't already been
103 mFactoryCache = new VisualFactoryCache();
106 // Return a new DebugVisual if we have debug enabled
109 return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
112 Visual::Base* visualPtr = NULL;
114 Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
115 Toolkit::Visual::Type visualType = Toolkit::Visual::IMAGE; // Default to IMAGE type.
118 Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
121 // If the type is IMAGE, either from a default or the TYPE value in the property-map, change it to a BatchImage if required.
122 if( visualType == Toolkit::Visual::IMAGE )
124 bool batchingEnabled( false );
125 Property::Value* value = propertyMap.Find( Toolkit::Visual::Property::BATCHING_ENABLED, BATCHING_ENABLED );
128 value->Get( batchingEnabled );
129 if( batchingEnabled )
131 visualType = Toolkit::Visual::BATCH_IMAGE;
138 case Toolkit::Visual::BORDER:
140 visualPtr = new BorderVisual( *( mFactoryCache.Get() ) );
144 case Toolkit::Visual::COLOR:
146 visualPtr = new ColorVisual( *( mFactoryCache.Get() ) );
150 case Toolkit::Visual::GRADIENT:
152 visualPtr = new GradientVisual( *( mFactoryCache.Get() ) );
156 default: // Default to Image type if unknown (check if there is a URL)
157 case Toolkit::Visual::IMAGE:
159 Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
160 std::string imageUrl;
161 if( imageURLValue && imageURLValue->Get( imageUrl ) )
163 if( NinePatchImage::IsNinePatchUrl( imageUrl ) )
165 visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
169 CreateAtlasManager();
171 if( SvgVisual::IsSvgUrl( imageUrl ) )
173 visualPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
177 visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
181 else if( propertyMap.Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER ) )
183 // Create Image Visual if it has a shader
184 // TODO: This is required because of EffectsView which should be fixed
185 CreateAtlasManager();
186 visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
191 case Toolkit::Visual::MESH:
193 visualPtr = new MeshVisual( *( mFactoryCache.Get() ) );
197 case Toolkit::Visual::PRIMITIVE:
199 visualPtr = new PrimitiveVisual( *( mFactoryCache.Get() ) );
203 case Toolkit::Visual::DEBUG:
205 visualPtr = new DebugVisual( *( mFactoryCache.Get() ) );
209 case Toolkit::Visual::BATCH_IMAGE:
211 CreateAtlasManager();
212 visualPtr = new BatchImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
220 visualPtr->Initialize( actor, propertyMap );
224 DALI_LOG_ERROR( "Renderer type unknown\n" );
227 return Toolkit::Visual::Base( visualPtr );
230 Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
234 mFactoryCache = new VisualFactoryCache();
239 return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
242 NinePatchImage npatchImage = NinePatchImage::DownCast( image );
245 NPatchVisual* visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
246 visualPtr->SetImage( npatchImage );
248 return Toolkit::Visual::Base( visualPtr );
252 CreateAtlasManager();
253 ImageVisual* visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
255 visualPtr->SetImage( actor, image );
257 return Toolkit::Visual::Base( visualPtr );
261 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
265 mFactoryCache = new VisualFactoryCache();
270 return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
273 if( NinePatchImage::IsNinePatchUrl( url ) )
275 NPatchVisual* visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
276 visualPtr->SetImage( url );
278 return Toolkit::Visual::Base( visualPtr );
280 else if( SvgVisual::IsSvgUrl( url ) )
282 CreateAtlasManager();
283 SvgVisual* visualPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
284 visualPtr->SetImage( url, size );
285 return Toolkit::Visual::Base( visualPtr );
289 CreateAtlasManager();
290 ImageVisual* visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
292 visualPtr->SetImage( actor, url, size );
294 return Toolkit::Visual::Base( visualPtr );
298 Image VisualFactory::GetBrokenVisualImage()
300 return ResourceImage::New( BROKEN_VISUAL_IMAGE_URL );
303 void VisualFactory::CreateAtlasManager()
307 Shader shader = ImageVisual::GetImageShader( *( mFactoryCache.Get() ) );
308 mAtlasManager = new ImageAtlasManager();
309 mAtlasManager->SetBrokenImage( BROKEN_VISUAL_IMAGE_URL );
313 } // namespace Internal
315 } // namespace Toolkit