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

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