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

   1  /*
   2  * Copyright (c) 2017 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/wireframe/wireframe-visual.h>
  45 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  46 #include <dali-toolkit/internal/visuals/visual-url.h>
  47 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  48
  49 namespace Dali
  50 {
  51
  52 namespace Toolkit
  53 {
  54
  55 namespace Internal
  56 {
  57
  58 namespace
  59 {
  60
  61 BaseHandle Create()
  62 {
  63   BaseHandle handle = Toolkit::VisualFactory::Get();
  64
  65   return handle;
  66 }
  67
  68 DALI_TYPE_REGISTRATION_BEGIN_CREATE( Toolkit::VisualFactory, Dali::BaseHandle, Create, true )
  69 DALI_TYPE_REGISTRATION_END()
  70
  71 } // namespace
  72
  73 VisualFactory::VisualFactory( bool debugEnabled )
  74 : mFactoryCache(),
  75   mDebugEnabled( debugEnabled ),
  76   mPreMultiplyOnLoad( true )
  77 {
  78 }
  79
  80 VisualFactory::~VisualFactory()
  81 {
  82 }
  83
  84 Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& propertyMap )
  85 {
  86   Visual::BasePtr visualPtr;
  87
  88   Property::Value* typeValue = propertyMap.Find( Toolkit::Visual::Property::TYPE, VISUAL_TYPE );
  89   Toolkit::DevelVisual::Type visualType = Toolkit::DevelVisual::IMAGE; // Default to IMAGE type.
  90   if( typeValue )
  91   {
  92     Scripting::GetEnumerationProperty( *typeValue, VISUAL_TYPE_TABLE, VISUAL_TYPE_TABLE_COUNT, visualType );
  93   }
  94
  95   switch( visualType )
  96   {
  97     case Toolkit::Visual::BORDER:
  98     {
  99       visualPtr = BorderVisual::New( GetFactoryCache(), propertyMap );
 100       break;
 101     }
 102
 103     case Toolkit::Visual::COLOR:
 104     {
 105       visualPtr = ColorVisual::New( GetFactoryCache(), propertyMap );
 106       break;
 107     }
 108
 109     case Toolkit::Visual::GRADIENT:
 110     {
 111       visualPtr = GradientVisual::New( GetFactoryCache(), propertyMap );
 112       break;
 113     }
 114
 115     case Toolkit::Visual::IMAGE:
 116     {
 117       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 118       std::string imageUrl;
 119       if( imageURLValue )
 120       {
 121         if( imageURLValue->Get( imageUrl ) )
 122         {
 123           if( !imageUrl.empty() )
 124           {
 125             VisualUrl visualUrl( imageUrl );
 126
 127             switch( visualUrl.GetType() )
 128             {
 129               case VisualUrl::N_PATCH:
 130               {
 131                 visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl, propertyMap );
 132                 break;
 133               }
 134               case VisualUrl::SVG:
 135               {
 136                 visualPtr = SvgVisual::New( GetFactoryCache(), visualUrl, propertyMap );
 137                 break;
 138               }
 139               case VisualUrl::GIF:
 140               {
 141                 visualPtr = AnimatedImageVisual::New( GetFactoryCache(), visualUrl, propertyMap );
 142                 break;
 143               }
 144               case VisualUrl::REGULAR_IMAGE:
 145               {
 146                 visualPtr = ImageVisual::New( GetFactoryCache(), visualUrl, propertyMap );
 147                 break;
 148               }
 149             }
 150           }
 151         }
 152         else
 153         {
 154           Property::Array* array = imageURLValue->GetArray();
 155           if( array )
 156           {
 157             visualPtr = AnimatedImageVisual::New( GetFactoryCache(), *array, propertyMap );
 158           }
 159         }
 160       }
 161       break;
 162     }
 163
 164     case Toolkit::Visual::MESH:
 165     {
 166       visualPtr = MeshVisual::New( GetFactoryCache(), propertyMap );
 167       break;
 168     }
 169
 170     case Toolkit::Visual::PRIMITIVE:
 171     {
 172       visualPtr = PrimitiveVisual::New( GetFactoryCache(), propertyMap );
 173       break;
 174     }
 175
 176     case Toolkit::Visual::WIREFRAME:
 177     {
 178       visualPtr = WireframeVisual::New( GetFactoryCache(), propertyMap );
 179       break;
 180     }
 181
 182     case Toolkit::Visual::TEXT:
 183     {
 184       visualPtr = TextVisual::New( GetFactoryCache(), propertyMap );
 185       break;
 186     }
 187
 188     case Toolkit::Visual::N_PATCH:
 189     {
 190       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 191       std::string imageUrl;
 192       if( imageURLValue && imageURLValue->Get( imageUrl ) )
 193       {
 194         visualPtr = NPatchVisual::New( GetFactoryCache(), imageUrl, propertyMap );
 195       }
 196       break;
 197     }
 198
 199     case Toolkit::Visual::SVG:
 200     {
 201       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 202       std::string imageUrl;
 203       if( imageURLValue && imageURLValue->Get( imageUrl ) )
 204       {
 205         visualPtr = SvgVisual::New( GetFactoryCache(), imageUrl, propertyMap );
 206       }
 207       break;
 208     }
 209
 210     case Toolkit::Visual::ANIMATED_IMAGE:
 211     {
 212       Property::Value* imageURLValue = propertyMap.Find( Toolkit::ImageVisual::Property::URL, IMAGE_URL_NAME );
 213       std::string imageUrl;
 214       if( imageURLValue )
 215       {
 216         if( imageURLValue->Get( imageUrl ) )
 217         {
 218           visualPtr = AnimatedImageVisual::New( GetFactoryCache(), imageUrl, propertyMap );
 219         }
 220         else
 221         {
 222           Property::Array* array = imageURLValue->GetArray();
 223           if( array )
 224           {
 225             visualPtr = AnimatedImageVisual::New( GetFactoryCache(), *array, propertyMap );
 226           }
 227         }
 228       }
 229       break;
 230     }
 231
 232     case Toolkit::DevelVisual::ANIMATED_GRADIENT:
 233     {
 234       visualPtr = AnimatedGradientVisual::New( GetFactoryCache(), propertyMap );
 235       break;
 236     }
 237   }
 238
 239   if( !visualPtr )
 240   {
 241     DALI_LOG_ERROR( "Renderer type unknown\n" );
 242   }
 243
 244   if( mDebugEnabled && visualType !=  Toolkit::DevelVisual::WIREFRAME )
 245   {
 246     //Create a WireframeVisual if we have debug enabled
 247     visualPtr = WireframeVisual::New(GetFactoryCache(), visualPtr, propertyMap );
 248   }
 249
 250   return Toolkit::Visual::Base( visualPtr.Get() );
 251 }
 252
 253 Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image )
 254 {
 255   Visual::BasePtr visualPtr;
 256
 257   if( image )
 258   {
 259     NinePatchImage npatchImage = NinePatchImage::DownCast( image );
 260     if( npatchImage )
 261     {
 262       visualPtr = NPatchVisual::New( GetFactoryCache(), npatchImage );
 263     }
 264     else
 265     {
 266       visualPtr = ImageVisual::New(GetFactoryCache(), image );
 267     }
 268   }
 269
 270   if( mDebugEnabled )
 271   {
 272     //Create a WireframeVisual if we have debug enabled
 273     visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
 274   }
 275
 276   return Toolkit::Visual::Base( visualPtr.Get() );
 277 }
 278
 279 Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, ImageDimensions size )
 280 {
 281   Visual::BasePtr visualPtr;
 282
 283   if( !url.empty() )
 284   {
 285     // first resolve url type to know which visual to create
 286     VisualUrl visualUrl( url );
 287     switch( visualUrl.GetType() )
 288     {
 289       case VisualUrl::N_PATCH:
 290       {
 291         visualPtr = NPatchVisual::New( GetFactoryCache(), visualUrl );
 292         break;
 293       }
 294       case VisualUrl::SVG:
 295       {
 296         visualPtr = SvgVisual::New( GetFactoryCache(), visualUrl );
 297         break;
 298       }
 299       case VisualUrl::GIF:
 300       {
 301         visualPtr = AnimatedImageVisual::New( GetFactoryCache(), visualUrl );
 302         break;
 303       }
 304       case VisualUrl::REGULAR_IMAGE:
 305       {
 306         visualPtr = ImageVisual::New(GetFactoryCache(), visualUrl, size );
 307         break;
 308       }
 309     }
 310   }
 311
 312   if( mDebugEnabled )
 313   {
 314     //Create a WireframeVisual if we have debug enabled
 315     visualPtr = WireframeVisual::New( GetFactoryCache(), visualPtr );
 316   }
 317
 318   return Toolkit::Visual::Base( visualPtr.Get() );
 319 }
 320
 321 void VisualFactory::SetPreMultiplyOnLoad( bool preMultiply )
 322 {
 323   if( mPreMultiplyOnLoad != preMultiply )
 324   {
 325     GetFactoryCache().SetPreMultiplyOnLoad( preMultiply );
 326   }
 327   mPreMultiplyOnLoad = preMultiply;
 328 }
 329
 330 bool VisualFactory::GetPreMultiplyOnLoad() const
 331 {
 332   return mPreMultiplyOnLoad;
 333 }
 334
 335 Internal::TextureManager& VisualFactory::GetTextureManager()
 336 {
 337   return GetFactoryCache().GetTextureManager();
 338 }
 339
 340 Internal::VisualFactoryCache& VisualFactory::GetFactoryCache()
 341 {
 342   if( !mFactoryCache )
 343   {
 344     mFactoryCache = std::unique_ptr<VisualFactoryCache>( new VisualFactoryCache( mPreMultiplyOnLoad ) );
 345   }
 346   return *mFactoryCache;
 347 }
 348
 349 } // namespace Internal
 350
 351 } // namespace Toolkit
 352
 353 } // namespace Dali