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

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