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