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

   1 /*
   2  * Copyright (c) 2023 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/devel-api/scripting/scripting.h>
  22 #include <dali/integration-api/adaptor-framework/adaptor.h>
  23 #include <dali/integration-api/debug.h>
  24 #include <dali/public-api/object/property-array.h>
  25 #include <dali/public-api/object/type-registry-helper.h>
  26 #include <dali/public-api/object/type-registry.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
  30 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
  31 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  32 #include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
  33 #include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
  34 #include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
  35 #include <dali-toolkit/internal/visuals/arc/arc-visual.h>
  36 #include <dali-toolkit/internal/visuals/border/border-visual.h>
  37 #include <dali-toolkit/internal/visuals/color/color-visual.h>
  38 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
  39 #include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
  40 #include <dali-toolkit/internal/visuals/image/image-visual.h>
  41 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
  42 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
  43 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
  44 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
  45 #include <dali-toolkit/internal/visuals/text-visual-shader-factory.h>
  46 #include <dali-toolkit/internal/visuals/text/text-visual.h>
  47 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  48 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  49 #include <dali-toolkit/internal/visuals/visual-url.h>
  50 #include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
  51 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  52 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
  53 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  54
  55 namespace Dali
  56 {
  57 namespace Toolkit
  58 {
  59 namespace Internal
  60 {
  61 namespace
  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_FILE_NAME = "broken.png"; ///< The file name of the broken image.
  77
  78 } // namespace
  79
  80 VisualFactory::VisualFactory(bool debugEnabled)
  81 : mFactoryCache(),
  82   mImageVisualShaderFactory(),
  83   mTextVisualShaderFactory(),
  84   mSlotDelegate(this),
  85   mIdleCallback(nullptr),
  86   mDebugEnabled(debugEnabled),
  87   mPreMultiplyOnLoad(true)
  88 {
  89 }
  90
  91 VisualFactory::~VisualFactory()
  92 {
  93   if(mIdleCallback && Adaptor::IsAvailable())
  94   {
  95     // Removes the callback from the callback manager in case the control is destroyed before the callback is executed.
  96     Adaptor::Get().RemoveIdle(mIdleCallback);
  97     mIdleCallback = nullptr;
  98   }
  99 }
 100
 101 void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
 102 {
 103   if(type == StyleChange::THEME_CHANGE)
 104   {
 105     SetBrokenImageUrl(styleManager);
 106   }
 107 }
 108
 109 void VisualFactory::OnBrokenImageChangedSignal(Toolkit::StyleManager styleManager)
 110 {
 111   SetBrokenImageUrl(styleManager);
 112 }
 113
 114 Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
 115 {
 116   Visual::BasePtr visualPtr;
 117
 118   Property::Value*           typeValue  = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
 119   Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
 120   if(typeValue)
 121   {
 122     Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
 123   }
 124
 125   switch(visualType)
 126   {
 127     case Toolkit::Visual::BORDER:
 128     {
 129       visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
 130       break;
 131     }
 132
 133     case Toolkit::Visual::COLOR:
 134     {
 135       visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
 136       break;
 137     }
 138
 139     case Toolkit::Visual::GRADIENT:
 140     {
 141       visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
 142       break;
 143     }
 144
 145     case Toolkit::Visual::IMAGE:
 146     {
 147       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 148       std::string      imageUrl;
 149       if(imageURLValue)
 150       {
 151         if(imageURLValue->Get(imageUrl))
 152         {
 153           if(!imageUrl.empty())
 154           {
 155             VisualUrl visualUrl(imageUrl);
 156
 157             switch(visualUrl.GetType())
 158             {
 159               case VisualUrl::N_PATCH:
 160               {
 161                 visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 162                 break;
 163               }
 164               case VisualUrl::TVG:
 165               case VisualUrl::SVG:
 166               {
 167                 visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 168                 break;
 169               }
 170               case VisualUrl::GIF:
 171               case VisualUrl::WEBP:
 172               {
 173                 visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 174                 break;
 175               }
 176               case VisualUrl::JSON:
 177               {
 178                 visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 179                 break;
 180               }
 181               case VisualUrl::REGULAR_IMAGE:
 182               {
 183                 visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
 184                 break;
 185               }
 186             }
 187           }
 188         }
 189         else
 190         {
 191           Property::Array* array = imageURLValue->GetArray();
 192           if(array && array->Count() > 0)
 193           {
 194             visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
 195           }
 196         }
 197       }
 198       break;
 199     }
 200
 201     case Toolkit::Visual::MESH:
 202     {
 203       visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
 204       break;
 205     }
 206
 207     case Toolkit::Visual::PRIMITIVE:
 208     {
 209       visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
 210       break;
 211     }
 212
 213     case Toolkit::Visual::WIREFRAME:
 214     {
 215       visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
 216       break;
 217     }
 218
 219     case Toolkit::Visual::TEXT:
 220     {
 221       visualPtr = TextVisual::New(GetFactoryCache(), GetTextVisualShaderFactory(), propertyMap);
 222       break;
 223     }
 224
 225     case Toolkit::Visual::N_PATCH:
 226     {
 227       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 228       std::string      imageUrl;
 229       if(imageURLValue && imageURLValue->Get(imageUrl))
 230       {
 231         if(!imageUrl.empty())
 232         {
 233           visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 234         }
 235       }
 236       break;
 237     }
 238
 239     case Toolkit::Visual::SVG:
 240     {
 241       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 242       std::string      imageUrl;
 243       if(imageURLValue && imageURLValue->Get(imageUrl))
 244       {
 245         if(!imageUrl.empty())
 246         {
 247           visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 248         }
 249       }
 250       break;
 251     }
 252
 253     case Toolkit::Visual::ANIMATED_IMAGE:
 254     {
 255       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 256       std::string      imageUrl;
 257       if(imageURLValue)
 258       {
 259         if(imageURLValue->Get(imageUrl))
 260         {
 261           if(!imageUrl.empty())
 262           {
 263             visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 264           }
 265         }
 266         else
 267         {
 268           Property::Array* array = imageURLValue->GetArray();
 269           if(array && array->Count() > 0)
 270           {
 271             visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
 272           }
 273         }
 274       }
 275       break;
 276     }
 277
 278     case Toolkit::DevelVisual::ANIMATED_GRADIENT:
 279     {
 280       visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
 281       break;
 282     }
 283
 284     case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
 285     {
 286       Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 287       std::string      imageUrl;
 288       if(imageURLValue && imageURLValue->Get(imageUrl))
 289       {
 290         if(!imageUrl.empty())
 291         {
 292           visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
 293         }
 294       }
 295       break;
 296     }
 297
 298     case Toolkit::DevelVisual::ARC:
 299     {
 300       visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
 301       break;
 302     }
 303   }
 304
 305   DALI_LOG_INFO(gLogFilter, Debug::Concise, "VisualFactory::CreateVisual( VisualType:%s %s%s)\n", Scripting::GetEnumerationName<Toolkit::DevelVisual::Type>(visualType, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT), (visualType == Toolkit::DevelVisual::IMAGE) ? "url:" : "", (visualType == Toolkit::DevelVisual::IMAGE) ? (([&]() {
 306                   // Return URL if present in PropertyMap else return "not found message"
 307                   Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
 308                   return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
 309                 })())
 310                                                                                                                                                                                                                                                                                                                             : "");
 311
 312   if(!visualPtr)
 313   {
 314     DALI_LOG_ERROR("VisualType unknown\n");
 315   }
 316
 317   if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
 318   {
 319     //Create a WireframeVisual if we have debug enabled
 320     visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
 321   }
 322
 323   return Toolkit::Visual::Base(visualPtr.Get());
 324 }
 325
 326 Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
 327 {
 328   Visual::BasePtr visualPtr;
 329
 330   if(!url.empty())
 331   {
 332     // first resolve url type to know which visual to create
 333     VisualUrl visualUrl(url);
 334     switch(visualUrl.GetType())
 335     {
 336       case VisualUrl::N_PATCH:
 337       {
 338         visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
 339         break;
 340       }
 341       case VisualUrl::TVG:
 342       case VisualUrl::SVG:
 343       {
 344         visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 345         break;
 346       }
 347       case VisualUrl::GIF:
 348       case VisualUrl::WEBP:
 349       {
 350         visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 351         break;
 352       }
 353       case VisualUrl::JSON:
 354       {
 355         visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 356         break;
 357       }
 358       case VisualUrl::REGULAR_IMAGE:
 359       {
 360         visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
 361         break;
 362       }
 363     }
 364   }
 365
 366   if(mDebugEnabled)
 367   {
 368     //Create a WireframeVisual if we have debug enabled
 369     visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
 370   }
 371
 372   return Toolkit::Visual::Base(visualPtr.Get());
 373 }
 374
 375 void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
 376 {
 377   if(mPreMultiplyOnLoad != preMultiply)
 378   {
 379     GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
 380   }
 381   mPreMultiplyOnLoad = preMultiply;
 382 }
 383
 384 bool VisualFactory::GetPreMultiplyOnLoad() const
 385 {
 386   return mPreMultiplyOnLoad;
 387 }
 388
 389 void VisualFactory::DiscardVisual(Toolkit::Visual::Base visual)
 390 {
 391   mDiscardedVisuals.emplace_back(visual);
 392
 393   RegisterDiscardCallback();
 394 }
 395
 396 Internal::TextureManager& VisualFactory::GetTextureManager()
 397 {
 398   return GetFactoryCache().GetTextureManager();
 399 }
 400
 401 void VisualFactory::SetBrokenImageUrl(Toolkit::StyleManager& styleManager)
 402 {
 403   const std::string        imageDirPath   = AssetManager::GetDaliImagePath();
 404   std::string              brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
 405   std::vector<std::string> customBrokenImageUrlList;
 406
 407   if(styleManager)
 408   {
 409     customBrokenImageUrlList       = Toolkit::DevelStyleManager::GetBrokenImageUrlList(styleManager);
 410     const auto brokenImageUrlValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("brokenImageUrl", Property::Type::STRING);
 411     if(brokenImageUrlValue)
 412     {
 413       brokenImageUrlValue->Get(brokenImageUrl);
 414     }
 415   }
 416
 417   // Add default image
 418   mFactoryCache->SetBrokenImageUrl(brokenImageUrl, customBrokenImageUrlList);
 419 }
 420
 421 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
 422 {
 423   if(!mFactoryCache)
 424   {
 425     mFactoryCache                      = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
 426     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 427     if(styleManager)
 428     {
 429       styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
 430       Toolkit::DevelStyleManager::BrokenImageChangedSignal(styleManager).Connect(mSlotDelegate, &VisualFactory::OnBrokenImageChangedSignal);
 431     }
 432     SetBrokenImageUrl(styleManager);
 433   }
 434   return *mFactoryCache;
 435 }
 436
 437 ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
 438 {
 439   if(!mImageVisualShaderFactory)
 440   {
 441     mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
 442   }
 443   return *mImageVisualShaderFactory;
 444 }
 445
 446 TextVisualShaderFactory& VisualFactory::GetTextVisualShaderFactory()
 447 {
 448   if(!mTextVisualShaderFactory)
 449   {
 450     mTextVisualShaderFactory = std::unique_ptr<TextVisualShaderFactory>(new TextVisualShaderFactory());
 451   }
 452   return *mTextVisualShaderFactory;
 453 }
 454
 455 void VisualFactory::OnDiscardCallback()
 456 {
 457   mIdleCallback = nullptr;
 458
 459   // Discard visual now.
 460   mDiscardedVisuals.clear();
 461 }
 462
 463 void VisualFactory::RegisterDiscardCallback()
 464 {
 465   if(!mIdleCallback && Adaptor::IsAvailable())
 466   {
 467     // The callback manager takes the ownership of the callback object.
 468     mIdleCallback = MakeCallback(this, &VisualFactory::OnDiscardCallback);
 469
 470     Adaptor& adaptor = Adaptor::Get();
 471
 472     if(!adaptor.AddIdle(mIdleCallback, false))
 473     {
 474       // Fail to add idle. (Maybe adaptor is paused.)
 475       mIdleCallback = nullptr;
 476     }
 477   }
 478 }
 479
 480 } // namespace Internal
 481
 482 } // namespace Toolkit
 483
 484 } // namespace Dali