Updated all cpp files to new format
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / visual-factory-impl.cpp
index 239f5c4..8c4b2f8 100644 (file)
@@ -1,5 +1,5 @@
- /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+/*
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
 
 // EXTERNAL INCLUDES
+#include <dali/devel-api/scripting/scripting.h>
 #include <dali/integration-api/debug.h>
-#include <dali/public-api/images/image.h>
 #include <dali/public-api/object/property-array.h>
-#include <dali/public-api/object/type-registry.h>
 #include <dali/public-api/object/type-registry-helper.h>
-#include <dali/devel-api/scripting/enum-helper.h>
-#include <dali/devel-api/scripting/scripting.h>
+#include <dali/public-api/object/type-registry.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
-#include <dali-toolkit/devel-api/visuals/text-visual-properties.h>
+#include <dali-toolkit/devel-api/asset-manager/asset-manager.h>
 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
+#include <dali-toolkit/internal/visuals/animated-gradient/animated-gradient-visual.h>
+#include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
+#include <dali-toolkit/internal/visuals/animated-vector-image/animated-vector-image-visual.h>
+#include <dali-toolkit/internal/visuals/arc/arc-visual.h>
 #include <dali-toolkit/internal/visuals/border/border-visual.h>
 #include <dali-toolkit/internal/visuals/color/color-visual.h>
 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
-#include <dali-toolkit/internal/visuals/image/batch-image-visual.h>
+#include <dali-toolkit/internal/visuals/image-visual-shader-factory.h>
 #include <dali-toolkit/internal/visuals/image/image-visual.h>
 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
 #include <dali-toolkit/internal/visuals/text/text-visual.h>
-#include <dali-toolkit/internal/visuals/animated-image/animated-image-visual.h>
-#include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
-#include <dali-toolkit/internal/visuals/visual-factory-resolve-url.h>
 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
+#include <dali-toolkit/internal/visuals/visual-url.h>
+#include <dali-toolkit/internal/visuals/wireframe/wireframe-visual.h>
+#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
+#include <dali-toolkit/public-api/visuals/text-visual-properties.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Internal
 {
-
 namespace
 {
+#if defined(DEBUG_ENABLED)
+Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_CONTROL_VISUALS");
+#endif
 
-DALI_ENUM_TO_STRING_TABLE_BEGIN( VISUAL_TYPE )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, BORDER )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, COLOR )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, GRADIENT )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, IMAGE )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, MESH )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, PRIMITIVE )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::DevelVisual, TEXT )
-DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, WIREFRAME )
-DALI_ENUM_TO_STRING_TABLE_END( VISUAL_TYPE )
-
-const char * const VISUAL_TYPE( "visualType" );
-const char * const BATCHING_ENABLED( "batchingEnabled" );
 BaseHandle Create()
 {
   BaseHandle handle = Toolkit::VisualFactory::Get();
@@ -78,13 +68,18 @@ BaseHandle Create()
   return handle;
 }
 
-DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
+DALI_TYPE_REGISTRATION_BEGIN_CREATE(Toolkit::VisualFactory, Dali::BaseHandle, Create, true)
 DALI_TYPE_REGISTRATION_END()
+const char* const BROKEN_IMAGE_FILE_NAME = "broken.png"; ///< The file name of the broken image.
 
 } // namespace
 
-VisualFactory::VisualFactory( bool debugEnabled )
-:mDebugEnabled( debugEnabled )
+VisualFactory::VisualFactory(bool debugEnabled)
+: mFactoryCache(),
+  mImageVisualShaderFactory(),
+  mSlotDelegate(this),
+  mDebugEnabled(debugEnabled),
+  mPreMultiplyOnLoad(true)
 {
 }
 
@@ -92,188 +87,318 @@ VisualFactory::~VisualFactory()
 {
 }
 
-Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
+void VisualFactory::OnStyleChangedSignal(Toolkit::StyleManager styleManager, StyleChange::Type type)
 {
-  // Create factory cache if it hasn't already been
-  if( !mFactoryCache )
+  if(type == StyleChange::THEME_CHANGE)
   {
-    mFactoryCache = new VisualFactoryCache();
+    const std::string imageDirPath   = AssetManager::GetDaliImagePath();
+    std::string       brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
+
+    Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
+    config["brokenImageUrl"].Get(brokenImageUrl);
+
+    if(mFactoryCache)
+    {
+      mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
+    }
   }
+}
 
+Toolkit::Visual::Base VisualFactory::CreateVisual(const Property::Map& propertyMap)
+{
   Visual::BasePtr visualPtr;
 
-  if( mDebugEnabled )
+  Property::Value*           typeValue  = propertyMap.Find(Toolkit::Visual::Property::TYPE, VISUAL_TYPE);
+  Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
+  if(typeValue)
   {
-    //Create a WireframeVisual if we have debug enabled
-    visualPtr = WireframeVisual::New( *( mFactoryCache.Get() ) );
+    Scripting::GetEnumerationProperty(*typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType);
   }
-  else
+
+  switch(visualType)
   {
-    Property::Value* typeValue = propertyMap.Find( Toolkit::DevelVisual::Property::TYPE, VISUAL_TYPE );
-    Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
-    if( typeValue )
+    case Toolkit::Visual::BORDER:
     {
-      Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
+      visualPtr = BorderVisual::New(GetFactoryCache(), propertyMap);
+      break;
     }
 
-    switch( visualType )
+    case Toolkit::Visual::COLOR:
     {
-      case Toolkit::Visual::BORDER:
-      {
-        visualPtr = BorderVisual::New( *( mFactoryCache.Get() ), propertyMap );
-        break;
-      }
-
-      case Toolkit::Visual::COLOR:
-      {
-        visualPtr = ColorVisual::New( *( mFactoryCache.Get() ), propertyMap );
-        break;
-      }
+      visualPtr = ColorVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
 
-      case Toolkit::Visual::GRADIENT:
-      {
-        visualPtr = GradientVisual::New( *( mFactoryCache.Get() ), propertyMap );
-        break;
-      }
+    case Toolkit::Visual::GRADIENT:
+    {
+      visualPtr = GradientVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
 
-      case Toolkit::Visual::IMAGE:
+    case Toolkit::Visual::IMAGE:
+    {
+      Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
+      std::string      imageUrl;
+      if(imageURLValue)
       {
-        Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
-        std::string imageUrl;
-        if( imageURLValue && imageURLValue->Get( imageUrl ) )
+        if(imageURLValue->Get(imageUrl))
         {
-          // first resolve url type to know which visual to create
-          UrlType::Type type = ResolveUrlType( imageUrl );
-          if( UrlType::N_PATCH == type )
-          {
-            visualPtr = NPatchVisual::New( *( mFactoryCache.Get() ), imageUrl, propertyMap );
-          }
-          else if( UrlType::SVG == type )
-          {
-            visualPtr = SvgVisual::New( *( mFactoryCache.Get() ), imageUrl, propertyMap );
-          }
-          else if( UrlType::GIF == type )
+          if(!imageUrl.empty())
           {
-            visualPtr = AnimatedImageVisual::New( *( mFactoryCache.Get() ), imageUrl, propertyMap );
-          }
-          else // Regular image
-          {
-            bool batchingEnabled( false );
-            Property::Value* batchingEnabledValue = propertyMap.Find( Toolkit::ImageVisual::Property::BATCHING_ENABLED, BATCHING_ENABLED );
-            if( batchingEnabledValue  )
-            {
-              batchingEnabledValue->Get( batchingEnabled );
-            }
+            VisualUrl visualUrl(imageUrl);
 
-            if( batchingEnabled )
+            switch(visualUrl.GetType())
             {
-              visualPtr = BatchImageVisual::New( *( mFactoryCache.Get() ), imageUrl, propertyMap );
-            }
-            else
-            {
-              visualPtr = ImageVisual::New( *( mFactoryCache.Get() ), imageUrl, propertyMap );
+              case VisualUrl::N_PATCH:
+              {
+                visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
+                break;
+              }
+              case VisualUrl::SVG:
+              {
+                visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
+                break;
+              }
+              case VisualUrl::GIF:
+              case VisualUrl::WEBP:
+              {
+                visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
+                break;
+              }
+              case VisualUrl::JSON:
+              {
+                visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
+                break;
+              }
+              case VisualUrl::REGULAR_IMAGE:
+              {
+                visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, propertyMap);
+                break;
+              }
             }
           }
         }
-
-        break;
+        else
+        {
+          Property::Array* array = imageURLValue->GetArray();
+          if(array)
+          {
+            visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
+          }
+        }
       }
+      break;
+    }
 
-      case Toolkit::Visual::MESH:
+    case Toolkit::Visual::MESH:
+    {
+      visualPtr = MeshVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
+
+    case Toolkit::Visual::PRIMITIVE:
+    {
+      visualPtr = PrimitiveVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
+
+    case Toolkit::Visual::WIREFRAME:
+    {
+      visualPtr = WireframeVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
+
+    case Toolkit::Visual::TEXT:
+    {
+      visualPtr = TextVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
+
+    case Toolkit::Visual::N_PATCH:
+    {
+      Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
+      std::string      imageUrl;
+      if(imageURLValue && imageURLValue->Get(imageUrl))
       {
-        visualPtr = MeshVisual::New( *( mFactoryCache.Get() ), propertyMap );
-        break;
+        visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
       }
+      break;
+    }
 
-      case Toolkit::Visual::PRIMITIVE:
+    case Toolkit::Visual::SVG:
+    {
+      Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
+      std::string      imageUrl;
+      if(imageURLValue && imageURLValue->Get(imageUrl))
       {
-        visualPtr = PrimitiveVisual::New( *( mFactoryCache.Get() ), propertyMap );
-        break;
+        visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
       }
+      break;
+    }
 
-      case Toolkit::Visual::WIREFRAME:
+    case Toolkit::Visual::ANIMATED_IMAGE:
+    {
+      Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
+      std::string      imageUrl;
+      if(imageURLValue)
       {
-        visualPtr = WireframeVisual::New( *( mFactoryCache.Get() ) );
-        break;
+        if(imageURLValue->Get(imageUrl))
+        {
+          visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
+        }
+        else
+        {
+          Property::Array* array = imageURLValue->GetArray();
+          if(array)
+          {
+            visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), *array, propertyMap);
+          }
+        }
       }
+      break;
+    }
+
+    case Toolkit::DevelVisual::ANIMATED_GRADIENT:
+    {
+      visualPtr = AnimatedGradientVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
 
-      case Toolkit::DevelVisual::TEXT:
+    case Toolkit::DevelVisual::ANIMATED_VECTOR_IMAGE:
+    {
+      Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
+      std::string      imageUrl;
+      if(imageURLValue && imageURLValue->Get(imageUrl))
       {
-        visualPtr = TextVisual::New( *( mFactoryCache.Get() ), propertyMap );
-        break;
+        visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), imageUrl, propertyMap);
       }
+      break;
     }
-  }
 
-  if( !visualPtr )
-  {
-    DALI_LOG_ERROR( "Renderer type unknown\n" );
+    case Toolkit::DevelVisual::ARC:
+    {
+      visualPtr = ArcVisual::New(GetFactoryCache(), propertyMap);
+      break;
+    }
   }
 
-  return Toolkit::Visual::Base( visualPtr.Get() );
-}
+  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) ? (([&]() {
+                  // Return URL if present in PropertyMap else return "not found message"
+                  Property::Value* imageURLValue = propertyMap.Find(Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME);
+                  return (imageURLValue) ? imageURLValue->Get<std::string>().c_str() : "url not found in PropertyMap";
+                })())
+                                                                                                                                                                                                                                                                                                                            : "");
 
-Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
-{
-  if( !mFactoryCache )
+  if(!visualPtr)
   {
-    mFactoryCache = new VisualFactoryCache();
+    DALI_LOG_ERROR("VisualType unknown\n");
   }
 
-  if( mDebugEnabled )
+  if(mDebugEnabled && visualType != Toolkit::DevelVisual::WIREFRAME)
   {
-    return Toolkit::Visual::Base( WireframeVisual::New( *( mFactoryCache.Get() ) ).Get() );
+    //Create a WireframeVisual if we have debug enabled
+    visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap);
   }
 
+  return Toolkit::Visual::Base(visualPtr.Get());
+}
+
+Toolkit::Visual::Base VisualFactory::CreateVisual(const std::string& url, ImageDimensions size)
+{
   Visual::BasePtr visualPtr;
 
-  NinePatchImage npatchImage = NinePatchImage::DownCast( image );
-  if( npatchImage )
+  if(!url.empty())
   {
-    visualPtr = NPatchVisual::New( *( mFactoryCache.Get() ), npatchImage );
+    // first resolve url type to know which visual to create
+    VisualUrl visualUrl(url);
+    switch(visualUrl.GetType())
+    {
+      case VisualUrl::N_PATCH:
+      {
+        visualPtr = NPatchVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
+        break;
+      }
+      case VisualUrl::SVG:
+      {
+        visualPtr = SvgVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
+        break;
+      }
+      case VisualUrl::GIF:
+      case VisualUrl::WEBP:
+      {
+        visualPtr = AnimatedImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
+        break;
+      }
+      case VisualUrl::JSON:
+      {
+        visualPtr = AnimatedVectorImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl);
+        break;
+      }
+      case VisualUrl::REGULAR_IMAGE:
+      {
+        visualPtr = ImageVisual::New(GetFactoryCache(), GetImageVisualShaderFactory(), visualUrl, size);
+        break;
+      }
+    }
   }
-  else
+
+  if(mDebugEnabled)
   {
-    visualPtr = ImageVisual::New( *( mFactoryCache.Get() ), image );
+    //Create a WireframeVisual if we have debug enabled
+    visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr);
   }
 
-  return Toolkit::Visual::Base( visualPtr.Get() );
+  return Toolkit::Visual::Base(visualPtr.Get());
 }
 
-Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
+void VisualFactory::SetPreMultiplyOnLoad(bool preMultiply)
 {
-  if( !mFactoryCache )
+  if(mPreMultiplyOnLoad != preMultiply)
   {
-    mFactoryCache = new VisualFactoryCache();
+    GetFactoryCache().SetPreMultiplyOnLoad(preMultiply);
   }
+  mPreMultiplyOnLoad = preMultiply;
+}
 
-  if( mDebugEnabled )
-  {
-    return Toolkit::Visual::Base( WireframeVisual::New( *( mFactoryCache.Get() ) ).Get() );
-  }
+bool VisualFactory::GetPreMultiplyOnLoad() const
+{
+  return mPreMultiplyOnLoad;
+}
 
-  Visual::BasePtr visualPtr;
+Internal::TextureManager& VisualFactory::GetTextureManager()
+{
+  return GetFactoryCache().GetTextureManager();
+}
 
-  // first resolve url type to know which visual to create
-  UrlType::Type type = ResolveUrlType( url );
-  if( UrlType::N_PATCH == type )
-  {
-    visualPtr = NPatchVisual::New( *( mFactoryCache.Get() ), url );
-  }
-  else if( UrlType::SVG == type )
-  {
-    visualPtr = SvgVisual::New( *( mFactoryCache.Get() ), url );
-  }
-  else if( UrlType::GIF == type )
+Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
+{
+  if(!mFactoryCache)
   {
-    visualPtr = AnimatedImageVisual::New( *( mFactoryCache.Get() ), url );
+    mFactoryCache = std::unique_ptr<VisualFactoryCache>(new VisualFactoryCache(mPreMultiplyOnLoad));
+
+    const std::string imageDirPath   = AssetManager::GetDaliImagePath();
+    std::string       brokenImageUrl = imageDirPath + BROKEN_IMAGE_FILE_NAME;
+
+    Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
+    if(styleManager)
+    {
+      Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
+      config["brokenImageUrl"].Get(brokenImageUrl);
+      styleManager.StyleChangedSignal().Connect(mSlotDelegate, &VisualFactory::OnStyleChangedSignal);
+    }
+
+    mFactoryCache->SetBrokenImageUrl(brokenImageUrl);
   }
-  else // Regular image
+  return *mFactoryCache;
+}
+
+ImageVisualShaderFactory& VisualFactory::GetImageVisualShaderFactory()
+{
+  if(!mImageVisualShaderFactory)
   {
-    visualPtr = ImageVisual::New( *( mFactoryCache.Get() ), url, size );
+    mImageVisualShaderFactory = std::unique_ptr<ImageVisualShaderFactory>(new ImageVisualShaderFactory());
   }
-
-  return Toolkit::Visual::Base( visualPtr.Get() );
+  return *mImageVisualShaderFactory;
 }
 
 } // namespace Internal