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