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