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

   1  /*
   2  * Copyright (c) 2016 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/enum-helper.h>
  27 #include <dali/devel-api/scripting/scripting.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  31 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  32 #include <dali-toolkit/internal/visuals/border/border-visual.h>
  33 #include <dali-toolkit/internal/visuals/color/color-visual.h>
  34 #include <dali-toolkit/internal/visuals/debug/debug-visual.h>
  35 #include <dali-toolkit/internal/visuals/gradient/gradient-visual.h>
  36 #include <dali-toolkit/internal/visuals/npatch/npatch-visual.h>
  37 #include <dali-toolkit/internal/visuals/image/image-visual.h>
  38 #include <dali-toolkit/internal/visuals/svg/svg-visual.h>
  39 #include <dali-toolkit/internal/visuals/mesh/mesh-visual.h>
  40 #include <dali-toolkit/internal/visuals/primitive/primitive-visual.h>
  41 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  42 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  43 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  44 #include <dali-toolkit/internal/visuals/image/batch-image-visual.h>
  45
  46 namespace
  47 {
  48 const char * const BROKEN_VISUAL_IMAGE_URL( DALI_IMAGE_DIR "broken.png");
  49 }
  50
  51 namespace Dali
  52 {
  53
  54 namespace Toolkit
  55 {
  56
  57 namespace Internal
  58 {
  59
  60 namespace
  61 {
  62
  63 DALI_ENUM_TO_STRING_TABLE_BEGIN( VISUAL_TYPE )
  64 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, BORDER )
  65 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, COLOR )
  66 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, GRADIENT )
  67 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, IMAGE )
  68 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, MESH )
  69 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, PRIMITIVE )
  70 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, DEBUG )
  71 DALI_ENUM_TO_STRING_TABLE_END( VISUAL_TYPE )
  72
  73 const char * const VISUAL_TYPE( "visualType" );
  74 const char * const BATCHING_ENABLED( "batchingEnabled" );
  75 BaseHandle Create()
  76 {
  77   BaseHandle handle = Toolkit::VisualFactory::Get();
  78
  79   return handle;
  80 }
  81
  82 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
  83 DALI_TYPE_REGISTRATION_END()
  84
  85 } // namespace
  86
  87 VisualFactory::VisualFactory( bool debugEnabled )
  88 :mDebugEnabled( debugEnabled )
  89 {
  90 }
  91
  92 VisualFactory::~VisualFactory()
  93 {
  94 }
  95
  96 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
  97 {
  98   // Create factory cache if it hasn't already been
  99   if( !mFactoryCache )
 100   {
 101     mFactoryCache = new VisualFactoryCache();
 102   }
 103
 104   // Return a new DebugVisual if we have debug enabled
 105   if( mDebugEnabled )
 106   {
 107     return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
 108   }
 109
 110   Visual::Base* visualPtr = NULL;
 111
 112   Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
 113   Toolkit::Visual::Type visualType = Toolkit::Visual::IMAGE; // Default to IMAGE type.
 114   if( typeValue )
 115   {
 116     Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
 117   }
 118
 119   switch( visualType )
 120   {
 121     case Toolkit::Visual::BORDER:
 122     {
 123       visualPtr = new BorderVisual( *( mFactoryCache.Get() ) );
 124       break;
 125     }
 126
 127     case Toolkit::Visual::COLOR:
 128     {
 129       visualPtr = new ColorVisual( *( mFactoryCache.Get() ) );
 130       break;
 131     }
 132
 133     case Toolkit::Visual::GRADIENT:
 134     {
 135       visualPtr = new GradientVisual( *( mFactoryCache.Get() ) );
 136       break;
 137     }
 138
 139     default: // Default to Image type if unknown (check if there is a URL)
 140     case Toolkit::Visual::IMAGE:
 141     {
 142       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 143       std::string imageUrl;
 144       if( imageURLValue && imageURLValue->Get( imageUrl ) )
 145       {
 146         Property::Value* batchingEnabledValue = propertyMap.Find( Toolkit::ImageVisual::Property::BATCHING_ENABLED, BATCHING_ENABLED );
 147         if( batchingEnabledValue  )
 148         {
 149           bool batchingEnabled( false );
 150           batchingEnabledValue->Get( batchingEnabled );
 151           if( batchingEnabled )
 152           {
 153             CreateAtlasManager();
 154             visualPtr = new BatchImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
 155             break;
 156           }
 157         }
 158         else if( NinePatchImage::IsNinePatchUrl( imageUrl ) )
 159         {
 160           visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
 161         }
 162         else
 163         {
 164           CreateAtlasManager();
 165
 166           if( SvgVisual::IsSvgUrl( imageUrl ) )
 167           {
 168             visualPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
 169           }
 170           else
 171           {
 172             visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
 173           }
 174         }
 175       }
 176       else if( propertyMap.Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER ) )
 177       {
 178         // Create Image Visual if it has a shader
 179         // TODO: This is required because of EffectsView which should be fixed
 180         CreateAtlasManager();
 181         visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
 182       }
 183       break;
 184     }
 185
 186     case Toolkit::Visual::MESH:
 187     {
 188       visualPtr = new MeshVisual( *( mFactoryCache.Get() ) );
 189       break;
 190     }
 191
 192     case Toolkit::Visual::PRIMITIVE:
 193     {
 194       visualPtr = new PrimitiveVisual( *( mFactoryCache.Get() ) );
 195       break;
 196     }
 197
 198     case Toolkit::Visual::DEBUG:
 199     {
 200       visualPtr = new DebugVisual( *( mFactoryCache.Get() ) );
 201       break;
 202     }
 203
 204   }
 205
 206   if( visualPtr )
 207   {
 208     Actor actor;
 209     visualPtr->Initialize( actor, propertyMap );
 210   }
 211   else
 212   {
 213     DALI_LOG_ERROR( "Renderer type unknown\n" );
 214   }
 215
 216   return Toolkit::Visual::Base( visualPtr );
 217 }
 218
 219 Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
 220 {
 221   if( !mFactoryCache )
 222   {
 223     mFactoryCache = new VisualFactoryCache();
 224   }
 225
 226   if( mDebugEnabled )
 227   {
 228     return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
 229   }
 230
 231   NinePatchImage npatchImage = NinePatchImage::DownCast( image );
 232   if( npatchImage )
 233   {
 234     NPatchVisual* visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
 235     visualPtr->SetImage( npatchImage );
 236
 237     return Toolkit::Visual::Base( visualPtr );
 238   }
 239   else
 240   {
 241     CreateAtlasManager();
 242     ImageVisual* visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
 243     Actor actor;
 244     visualPtr->SetImage( actor, image );
 245
 246     return Toolkit::Visual::Base( visualPtr );
 247   }
 248 }
 249
 250 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
 251 {
 252   if( !mFactoryCache )
 253   {
 254     mFactoryCache = new VisualFactoryCache();
 255   }
 256
 257   if( mDebugEnabled )
 258   {
 259     return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) );
 260   }
 261
 262   if( NinePatchImage::IsNinePatchUrl( url ) )
 263   {
 264     NPatchVisual* visualPtr = new NPatchVisual( *( mFactoryCache.Get() ) );
 265     visualPtr->SetImage( url );
 266
 267     return Toolkit::Visual::Base( visualPtr );
 268   }
 269   else if( SvgVisual::IsSvgUrl( url ) )
 270   {
 271     CreateAtlasManager();
 272     SvgVisual* visualPtr = new SvgVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
 273     visualPtr->SetImage( url, size );
 274     return Toolkit::Visual::Base( visualPtr );
 275   }
 276   else
 277   {
 278     CreateAtlasManager();
 279     ImageVisual* visualPtr = new ImageVisual( *( mFactoryCache.Get() ), *( mAtlasManager.Get() ) );
 280     Actor actor;
 281     visualPtr->SetImage( actor, url, size );
 282
 283     return Toolkit::Visual::Base( visualPtr );
 284   }
 285 }
 286
 287 Image VisualFactory::GetBrokenVisualImage()
 288 {
 289   return ResourceImage::New( BROKEN_VISUAL_IMAGE_URL );
 290 }
 291
 292 void VisualFactory::CreateAtlasManager()
 293 {
 294   if( !mAtlasManager )
 295   {
 296     Shader shader = ImageVisual::GetImageShader( *( mFactoryCache.Get() ) );
 297     mAtlasManager = new ImageAtlasManager();
 298     mAtlasManager->SetBrokenImage( BROKEN_VISUAL_IMAGE_URL );
 299   }
 300 }
 301
 302 } // namespace Internal
 303
 304 } // namespace Toolkit
 305
 306 } // namespace Dali