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