Merge "Geometry Batching" into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / visual-factory-impl.cpp
index cbf752f..f4677a7 100644 (file)
@@ -1,5 +1,5 @@
  /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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/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>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
 #include <dali-toolkit/internal/visuals/border/border-visual.h>
 #include <dali-toolkit/internal/visuals/color/color-visual.h>
 #include <dali-toolkit/internal/visuals/debug/debug-visual.h>
 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
+#include <dali-toolkit/internal/visuals/image/batch-image-visual.h>
 
 namespace
 {
-const char * const BROKEN_RENDERER_IMAGE_URL( DALI_IMAGE_DIR "broken.png");
+const char * const BROKEN_VISUAL_IMAGE_URL( DALI_IMAGE_DIR "broken.png");
 }
 
 namespace Dali
@@ -55,6 +60,20 @@ namespace Internal
 namespace
 {
 
+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::Visual, DEBUG )
+DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, BATCH_IMAGE )
+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();
@@ -76,145 +95,136 @@ VisualFactory::~VisualFactory()
 {
 }
 
-VisualFactory::RendererType VisualFactory::GetRendererType( const Property::Map& propertyMap )
+Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
 {
-  RendererType rendererType = UNDEFINED;
-
-  Property::Value* type = propertyMap.Find( RENDERER_TYPE );
-  std::string typeValue ;
-  if( type && type->Get( typeValue ))
+  // Create factory cache if it hasn't already been
+  if( !mFactoryCache )
   {
-    if( typeValue == COLOR_RENDERER )
-    {
-      rendererType = COLOR;
-    }
-    else if( typeValue == BORDER_RENDERER )
-    {
-      rendererType = BORDER;
-    }
-    else if( typeValue == GRADIENT_RENDERER )
-    {
-      rendererType = GRADIENT;
-    }
-    else if( typeValue == IMAGE_RENDERER )
-    {
-      rendererType = IMAGE;
-    }
-    else if( typeValue == MESH_RENDERER )
-    {
-      rendererType = MESH;
-    }
-    else if( typeValue == PRIMITIVE_RENDERER )
-    {
-      rendererType = PRIMITIVE;
-    }
+    mFactoryCache = new VisualFactoryCache();
   }
 
-  // check the url if exist, to decide the renderer type
-  if( rendererType == IMAGE || rendererType == UNDEFINED )
+  // Return a new DebugVisual if we have debug enabled
+  if( mDebugEnabled )
   {
-    Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
-    std::string imageUrl;
-    if( imageURLValue && imageURLValue->Get( imageUrl ))
-    {
-      if( NinePatchImage::IsNinePatchUrl( imageUrl ) )
-      {
-        rendererType = N_PATCH;
-      }
-      else if( SvgVisual::IsSvgUrl( imageUrl ) )
-      {
-        rendererType = SVG;
-      }
-      else
-      {
-        rendererType = IMAGE;
-      }
-    }
+    return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
   }
 
-  return rendererType;
-}
+  Visual::Base* visualPtr = NULL;
 
-Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
-{
-  Visual::Base* rendererPtr = NULL;
-
-  RendererType type = GetRendererType( propertyMap );
-  if( type != UNDEFINED)
+  Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
+  Toolkit::Visual::Type visualType = Toolkit::Visual::IMAGE; // Default to IMAGE type.
+  if( typeValue )
   {
-    if( !mFactoryCache )
-    {
-      mFactoryCache = new VisualFactoryCache();
-    }
+    Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
+  }
 
-    if( mDebugEnabled )
+  // If the type is IMAGE, either from a default or the TYPE value in the property-map, change it to a BatchImage if required.
+  if( visualType == Toolkit::Visual::IMAGE )
+  {
+    bool batchingEnabled( false );
+    Property::Value* value = propertyMap.Find( Toolkit::Visual::Property::BATCHING_ENABLED, BATCHING_ENABLED );
+    if( value )
     {
-      return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
+      value->Get( batchingEnabled );
+      if( batchingEnabled )
+      {
+        visualType = Toolkit::Visual::BATCH_IMAGE;
+      }
     }
   }
 
-  switch( type )
+  switch( visualType )
   {
-    case COLOR:
+    case Toolkit::Visual::BORDER:
     {
-      rendererPtr = new ColorVisual( *( mFactoryCache.Get() ) );
+      visualPtr = new BorderVisual( *( mFactoryCache.Get() ) );
       break;
     }
-     case GRADIENT:
-     {
-       rendererPtr = new GradientVisual( *( mFactoryCache.Get() ) );
-       break;
-     }
-    case BORDER:
+
+    case Toolkit::Visual::COLOR:
     {
-      rendererPtr = new BorderVisual( *( mFactoryCache.Get() ) );
+      visualPtr = new ColorVisual( *( mFactoryCache.Get() ) );
       break;
     }
-    case IMAGE:
+
+    case Toolkit::Visual::GRADIENT:
     {
-      CreateAtlasManager();
-      rendererPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+      visualPtr = new GradientVisual( *( mFactoryCache.Get() ) );
       break;
     }
-    case N_PATCH:
+
+    default: // Default to Image type if unknown (check if there is a URL)
+    case Toolkit::Visual::IMAGE:
     {
-      rendererPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
+      Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
+      std::string imageUrl;
+      if( imageURLValue && imageURLValue->Get( imageUrl ) )
+      {
+        if( NinePatchImage::IsNinePatchUrl( imageUrl ) )
+        {
+          visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
+        }
+        else
+        {
+          CreateAtlasManager();
+
+          if( SvgVisual::IsSvgUrl( imageUrl ) )
+          {
+            visualPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+          }
+          else
+          {
+            visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+          }
+        }
+      }
+      else if( propertyMap.Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER ) )
+      {
+        // Create Image Visual if it has a shader
+        // TODO: This is required because of EffectsView which should be fixed
+        CreateAtlasManager();
+        visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+      }
       break;
     }
-    case SVG:
+
+    case Toolkit::Visual::MESH:
     {
-      CreateAtlasManager();
-      rendererPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+      visualPtr = new MeshVisual( *( mFactoryCache.Get() ) );
       break;
     }
-    case MESH:
+
+    case Toolkit::Visual::PRIMITIVE:
     {
-      rendererPtr = new MeshVisual( *( mFactoryCache.Get() ) );
+      visualPtr = new PrimitiveVisual( *( mFactoryCache.Get() ) );
       break;
     }
-    case PRIMITIVE:
+
+    case Toolkit::Visual::DEBUG:
     {
-      rendererPtr = new PrimitiveVisual( *( mFactoryCache.Get() ) );
+      visualPtr = new DebugVisual( *( mFactoryCache.Get() ) );
       break;
     }
-    case UNDEFINED:
-    default:
+
+    case Toolkit::Visual::BATCH_IMAGE:
     {
+      CreateAtlasManager();
+      visualPtr = new BatchImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
       break;
     }
   }
 
-  if( rendererPtr )
+  if( visualPtr )
   {
     Actor actor;
-    rendererPtr->Initialize( actor, propertyMap );
+    visualPtr->Initialize( actor, propertyMap );
   }
   else
   {
-    DALI_LOG_ERROR( "Renderer type unknown" );
+    DALI_LOG_ERROR( "Renderer type unknown\n" );
   }
 
-  return Toolkit::Visual::Base( rendererPtr );
+  return Toolkit::Visual::Base( visualPtr );
 }
 
 Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
@@ -232,19 +242,19 @@ Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
   NinePatchImage npatchImage = NinePatchImage::DownCast( image );
   if( npatchImage )
   {
-    NPatchVisual* rendererPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
-    rendererPtr->SetImage( npatchImage );
+    NPatchVisual* visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
+    visualPtr->SetImage( npatchImage );
 
-    return Toolkit::Visual::Base( rendererPtr );
+    return Toolkit::Visual::Base( visualPtr );
   }
   else
   {
     CreateAtlasManager();
-    ImageVisual* rendererPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+    ImageVisual* visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
     Actor actor;
-    rendererPtr->SetImage( actor, image );
+    visualPtr->SetImage( actor, image );
 
-    return Toolkit::Visual::Base( rendererPtr );
+    return Toolkit::Visual::Base( visualPtr );
   }
 }
 
@@ -262,32 +272,32 @@ Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, Image
 
   if( NinePatchImage::IsNinePatchUrl( url ) )
   {
-    NPatchVisual* rendererPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
-    rendererPtr->SetImage( url );
+    NPatchVisual* visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
+    visualPtr->SetImage( url );
 
-    return Toolkit::Visual::Base( rendererPtr );
+    return Toolkit::Visual::Base( visualPtr );
   }
   else if( SvgVisual::IsSvgUrl( url ) )
   {
     CreateAtlasManager();
-    SvgVisual* rendererPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
-    rendererPtr->SetImage( url, size );
-    return Toolkit::Visual::Base( rendererPtr );
+    SvgVisual* visualPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+    visualPtr->SetImage( url, size );
+    return Toolkit::Visual::Base( visualPtr );
   }
   else
   {
     CreateAtlasManager();
-    ImageVisual* rendererPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
+    ImageVisual* visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
     Actor actor;
-    rendererPtr->SetImage( actor, url, size );
+    visualPtr->SetImage( actor, url, size );
 
-    return Toolkit::Visual::Base( rendererPtr );
+    return Toolkit::Visual::Base( visualPtr );
   }
 }
 
-Image VisualFactory::GetBrokenRendererImage()
+Image VisualFactory::GetBrokenVisualImage()
 {
-  return ResourceImage::New( BROKEN_RENDERER_IMAGE_URL );
+  return ResourceImage::New( BROKEN_VISUAL_IMAGE_URL );
 }
 
 void VisualFactory::CreateAtlasManager()
@@ -296,7 +306,7 @@ void VisualFactory::CreateAtlasManager()
   {
     Shader shader = ImageVisual::GetImageShader( *( mFactoryCache.Get() ) );
     mAtlasManager = new ImageAtlasManager();
-    mAtlasManager->SetBrokenImage( BROKEN_RENDERER_IMAGE_URL );
+    mAtlasManager->SetBrokenImage( BROKEN_VISUAL_IMAGE_URL );
   }
 }