dali-toolkit/internal/visuals/visual-factory-impl.cpp

   1  /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 // CLASS HEADER
  18 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  19
  20 // EXTERNAL INCLUDES
  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>
  27
  28 // INTERNAL INCLUDES
  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>
  50
  51 namespace Dali
  52 {
  53
  54 namespace Toolkit
  55 {
  56
  57 namespace Internal
  58 {
  59
  60 namespace
  61 {
  62
  63 BaseHandle Create()
  64 {
  65   BaseHandle handle = Toolkit::VisualFactory::Get();
  66
  67   return handle;
  68 }
  69
  70 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
  71 DALI_TYPE_REGISTRATION_END()
  72 const char * const  BROKEN_IMAGE_URL( DALI_IMAGE_DIR "broken.png" ); ///< URL For the broken image
  73
  74 } // namespace
  75
  76 VisualFactory::VisualFactory( bool debugEnabled )
  77 : mFactoryCache(),
  78   mImageVisualShaderFactory(),
  79   mSlotDelegate(this),
  80   mDebugEnabled( debugEnabled ),
  81   mPreMultiplyOnLoad( true )
  82 {
  83 }
  84
  85 VisualFactory::~VisualFactory()
  86 {
  87 }
  88
  89 void VisualFactory::OnStyleChangedSignal( Toolkit::StyleManager styleManager, StyleChange::Type type)
  90 {
  91   if( type == StyleChange::THEME_CHANGE )
  92   {
  93     std::string brokenImageUrl(BROKEN_IMAGE_URL);
  94
  95     Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
  96     config["brokenImageUrl"].Get( brokenImageUrl );
  97
  98     if( mFactoryCache )
  99     {
 100       mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
 101     }
 102   }
 103 }
 104
 105 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
 106 {
 107   Visual::BasePtr visualPtr;
 108
 109   Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
 110   Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
 111   if( typeValue )
 112   {
 113     Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
 114   }
 115
 116   switch( visualType )
 117   {
 118     case Toolkit::Visual::BORDER:
 119     {
 120       visualPtr = BorderVisual::New( GetFactoryCache(), propertyMap );
 121       break;
 122     }
 123
 124     case Toolkit::Visual::COLOR:
 125     {
 126       visualPtr = ColorVisual::New( GetFactoryCache(), propertyMap );
 127       break;
 128     }
 129
 130     case Toolkit::Visual::GRADIENT:
 131     {
 132       visualPtr = GradientVisual::New( GetFactoryCache(), propertyMap );
 133       break;
 134     }
 135
 136     case Toolkit::Visual::IMAGE:
 137     {
 138       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 139       std::string imageUrl;
 140       if( imageURLValue )
 141       {
 142         if( imageURLValue->Get( imageUrl ) )
 143         {
 144           if( !imageUrl.empty() )
 145           {
 146             VisualUrl visualUrl( imageUrl );
 147
 148             switch( visualUrl.GetType() )
 149             {
 150               case VisualUrl::N_PATCH:
 151               {
 152                 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl, propertyMap );
 153                 break;
 154               }
 155               case VisualUrl::SVG:
 156               {
 157                 visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
 158                 break;
 159               }
 160               case VisualUrl::GIF:
 161               {
 162                 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
 163                 break;
 164               }
 165               case VisualUrl::JSON:
 166               {
 167                 visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(),  GetImageVisualShaderFactory(), imageUrl, propertyMap );
 168                 break;
 169               }
 170               case VisualUrl::REGULAR_IMAGE:
 171               {
 172                 visualPtr = ImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap );
 173                 break;
 174               }
 175             }
 176           }
 177         }
 178         else
 179         {
 180           Property::Array* array = imageURLValue->GetArray();
 181           if( array )
 182           {
 183             visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
 184           }
 185         }
 186       }
 187       break;
 188     }
 189
 190     case Toolkit::Visual::MESH:
 191     {
 192       visualPtr = MeshVisual::New( GetFactoryCache(), propertyMap );
 193       break;
 194     }
 195
 196     case Toolkit::Visual::PRIMITIVE:
 197     {
 198       visualPtr = PrimitiveVisual::New( GetFactoryCache(), propertyMap );
 199       break;
 200     }
 201
 202     case Toolkit::Visual::WIREFRAME:
 203     {
 204       visualPtr = WireframeVisual::New( GetFactoryCache(), propertyMap );
 205       break;
 206     }
 207
 208     case Toolkit::Visual::TEXT:
 209     {
 210       visualPtr = TextVisual::New( GetFactoryCache(), propertyMap );
 211       break;
 212     }
 213
 214     case Toolkit::Visual::N_PATCH:
 215     {
 216       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 217       std::string imageUrl;
 218       if( imageURLValue && imageURLValue->Get( imageUrl ) )
 219       {
 220         visualPtr = NPatchVisual::New( GetFactoryCache(), imageUrl, propertyMap );
 221       }
 222       break;
 223     }
 224
 225     case Toolkit::Visual::SVG:
 226     {
 227       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 228       std::string imageUrl;
 229       if( imageURLValue && imageURLValue->Get( imageUrl ) )
 230       {
 231         visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
 232       }
 233       break;
 234     }
 235
 236     case Toolkit::Visual::ANIMATED_IMAGE:
 237     {
 238       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 239       std::string imageUrl;
 240       if( imageURLValue )
 241       {
 242         if( imageURLValue->Get( imageUrl ) )
 243         {
 244           visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap );
 245         }
 246         else
 247         {
 248           Property::Array* array = imageURLValue->GetArray();
 249           if( array )
 250           {
 251             visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap );
 252           }
 253         }
 254       }
 255       break;
 256     }
 257
 258     case Toolkit::DevelVisual::ANIMATED_GRADIENT:
 259     {
 260       visualPtr = AnimatedGradientVisual::New( GetFactoryCache(), propertyMap );
 261       break;
 262     }
 263
 264     case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
 265     {
 266       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 267       std::string imageUrl;
 268       if( imageURLValue && imageURLValue->Get( imageUrl ) )
 269       {
 270         visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(),  GetImageVisualShaderFactory(), imageUrl, propertyMap );
 271       }
 272       break;
 273     }
 274   }
 275
 276   if( !visualPtr )
 277   {
 278     DALI_LOG_ERROR( "Renderer type unknown\n" );
 279   }
 280
 281   if( mDebugEnabled && visualType !=  Toolkit::DevelVisual::WIREFRAME )
 282   {
 283     //Create a WireframeVisual if we have debug enabled
 284     visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap );
 285   }
 286
 287   return Toolkit::Visual::Base( visualPtr.Get() );
 288 }
 289
 290 Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
 291 {
 292   Visual::BasePtr visualPtr;
 293
 294   if( image )
 295   {
 296     NinePatchImage npatchImage = NinePatchImage::DownCast( image );
 297     if( npatchImage )
 298     {
 299       visualPtr = NPatchVisual::New( GetFactoryCache(), npatchImage );
 300     }
 301     else
 302     {
 303       visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), image );
 304     }
 305   }
 306
 307   if( mDebugEnabled )
 308   {
 309     //Create a WireframeVisual if we have debug enabled
 310     visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
 311   }
 312
 313   return Toolkit::Visual::Base( visualPtr.Get() );
 314 }
 315
 316 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
 317 {
 318   Visual::BasePtr visualPtr;
 319
 320   if( !url.empty() )
 321   {
 322     // first resolve url type to know which visual to create
 323     VisualUrl visualUrl( url );
 324     switch( visualUrl.GetType() )
 325     {
 326       case VisualUrl::N_PATCH:
 327       {
 328         visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl );
 329         break;
 330       }
 331       case VisualUrl::SVG:
 332       {
 333         visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
 334         break;
 335       }
 336       case VisualUrl::GIF:
 337       {
 338         visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
 339         break;
 340       }
 341       case VisualUrl::JSON:
 342       {
 343         visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(),  GetImageVisualShaderFactory(), visualUrl );
 344         break;
 345       }
 346       case VisualUrl::REGULAR_IMAGE:
 347       {
 348         visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size );
 349         break;
 350       }
 351     }
 352   }
 353
 354   if( mDebugEnabled )
 355   {
 356     //Create a WireframeVisual if we have debug enabled
 357     visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
 358   }
 359
 360   return Toolkit::Visual::Base( visualPtr.Get() );
 361 }
 362
 363 void VisualFactory::SetPreMultiplyOnLoad( bool preMultiply )
 364 {
 365   if( mPreMultiplyOnLoad != preMultiply )
 366   {
 367     GetFactoryCache().SetPreMultiplyOnLoad( preMultiply );
 368   }
 369   mPreMultiplyOnLoad = preMultiply;
 370 }
 371
 372 bool VisualFactory::GetPreMultiplyOnLoad() const
 373 {
 374   return mPreMultiplyOnLoad;
 375 }
 376
 377 Internal::TextureManager& VisualFactory::GetTextureManager()
 378 {
 379   return GetFactoryCache().GetTextureManager();
 380 }
 381
 382 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
 383 {
 384   if( !mFactoryCache )
 385   {
 386     mFactoryCache = std::unique_ptr<VisualFactoryCache>( new VisualFactoryCache( mPreMultiplyOnLoad ) );
 387
 388     std::string brokenImageUrl(BROKEN_IMAGE_URL);
 389     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 390     if( styleManager )
 391     {
 392       Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
 393       config["brokenImageUrl"].Get( brokenImageUrl );
 394       styleManager.StyleChangedSignal().Connect( mSlotDelegate, &VisualFactory::OnStyleChangedSignal );
 395     }
 396
 397     mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
 398   }
 399   return *mFactoryCache;
 400 }
 401
 402 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
 403 {
 404   if( !mImageVisualShaderFactory )
 405   {
 406     mImageVisualShaderFactory = std::unique_ptr< ImageVisualShaderFactory >( new ImageVisualShaderFactory() );
 407   }
 408   return *mImageVisualShaderFactory;
 409 }
 410
 411 } // namespace Internal
 412
 413 } // namespace Toolkit
 414
 415 } // namespace Dali