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/object/property-array.h>
  23 #include <dali/public-api/object/type-registry.h>
  24 #include <dali/public-api/object/type-registry-helper.h>
  25 #include <dali/devel-api/scripting/scripting.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
  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/arc/arc-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               case VisualUrl::WEBP:
 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 std::string& url, ImageDimensions size )
 318 {
 319   Visual::BasePtr visualPtr;
 320
 321   if( !url.empty() )
 322   {
 323     // first resolve url type to know which visual to create
 324     VisualUrl visualUrl( url );
 325     switch( visualUrl.GetType() )
 326     {
 327       case VisualUrl::N_PATCH:
 328       {
 329         visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl );
 330         break;
 331       }
 332       case VisualUrl::SVG:
 333       {
 334         visualPtr = SvgVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
 335         break;
 336       }
 337       case VisualUrl::GIF:
 338       case VisualUrl::WEBP:
 339       {
 340         visualPtr = AnimatedImageVisual::New( GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl );
 341         break;
 342       }
 343       case VisualUrl::JSON:
 344       {
 345         visualPtr = AnimatedVectorImageVisual::New( GetFactoryCache(),  GetImageVisualShaderFactory(), visualUrl );
 346         break;
 347       }
 348       case VisualUrl::REGULAR_IMAGE:
 349       {
 350         visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size );
 351         break;
 352       }
 353     }
 354   }
 355
 356   if( mDebugEnabled )
 357   {
 358     //Create a WireframeVisual if we have debug enabled
 359     visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
 360   }
 361
 362   return Toolkit::Visual::Base( visualPtr.Get() );
 363 }
 364
 365 void VisualFactory::SetPreMultiplyOnLoad( bool preMultiply )
 366 {
 367   if( mPreMultiplyOnLoad != preMultiply )
 368   {
 369     GetFactoryCache().SetPreMultiplyOnLoad( preMultiply );
 370   }
 371   mPreMultiplyOnLoad = preMultiply;
 372 }
 373
 374 bool VisualFactory::GetPreMultiplyOnLoad() const
 375 {
 376   return mPreMultiplyOnLoad;
 377 }
 378
 379 Internal::TextureManager& VisualFactory::GetTextureManager()
 380 {
 381   return GetFactoryCache().GetTextureManager();
 382 }
 383
 384 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
 385 {
 386   if( !mFactoryCache )
 387   {
 388     mFactoryCache = std::unique_ptr<VisualFactoryCache>( new VisualFactoryCache( mPreMultiplyOnLoad ) );
 389
 390     const std::string imageDirPath = AssetManager::GetDaliImagePath();
 391     std::string brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
 392
 393     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 394     if( styleManager )
 395     {
 396       Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
 397       config["brokenImageUrl"].Get( brokenImageUrl );
 398       styleManager.StyleChangedSignal().Connect( mSlotDelegate, &VisualFactory::OnStyleChangedSignal );
 399     }
 400
 401     mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
 402   }
 403   return *mFactoryCache;
 404 }
 405
 406 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
 407 {
 408   if( !mImageVisualShaderFactory )
 409   {
 410     mImageVisualShaderFactory = std::unique_ptr< ImageVisualShaderFactory >( new ImageVisualShaderFactory() );
 411   }
 412   return *mImageVisualShaderFactory;
 413 }
 414
 415 } // namespace Internal
 416
 417 } // namespace Toolkit
 418
 419 } // namespace Dali