dali-toolkit/internal/visuals/image/image-visual.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
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/visuals/image/image-visual.h>
  20
  21 // EXTERNAL HEADERS
  22 #include <cstring> // for strlen()
  23 #include <dali/public-api/images/resource-image.h>
  24 #include <dali/public-api/images/native-image.h>
  25 #include <dali/devel-api/images/texture-set-image.h>
  26 #include <dali/devel-api/adaptor-framework/bitmap-loader.h>
  27 #include <dali/devel-api/adaptor-framework/image-loading.h>
  28 #include <dali/devel-api/scripting/enum-helper.h>
  29 #include <dali/devel-api/scripting/scripting.h>
  30 #include <dali/integration-api/debug.h>
  31
  32 // INTERNAL HEADERS
  33 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
  34 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  35 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  36 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  37 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
  38 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  39 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  40 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  41 #include <dali-toolkit/internal/visuals/visual-url.h>
  42
  43 namespace Dali
  44 {
  45
  46 namespace Toolkit
  47 {
  48
  49 namespace Internal
  50 {
  51
  52 namespace
  53 {
  54
  55 // property names
  56 const char * const IMAGE_FITTING_MODE( "fittingMode" );
  57 const char * const IMAGE_SAMPLING_MODE( "samplingMode" );
  58 const char * const IMAGE_DESIRED_WIDTH( "desiredWidth" );
  59 const char * const IMAGE_DESIRED_HEIGHT( "desiredHeight" );
  60 const char * const SYNCHRONOUS_LOADING( "synchronousLoading" );
  61
  62 // fitting modes
  63 DALI_ENUM_TO_STRING_TABLE_BEGIN( FITTING_MODE )
  64 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SHRINK_TO_FIT )
  65 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, SCALE_TO_FILL )
  66 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_WIDTH )
  67 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, FIT_HEIGHT )
  68 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::FittingMode, DEFAULT )
  69 DALI_ENUM_TO_STRING_TABLE_END( FITTING_MODE )
  70
  71 // sampling modes
  72 DALI_ENUM_TO_STRING_TABLE_BEGIN( SAMPLING_MODE )
  73 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX )
  74 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NEAREST )
  75 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, LINEAR )
  76 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_NEAREST )
  77 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, BOX_THEN_LINEAR )
  78 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, NO_FILTER )
  79 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::SamplingMode, DONT_CARE )
  80 DALI_ENUM_TO_STRING_TABLE_END( SAMPLING_MODE )
  81
  82 // wrap modes
  83 DALI_ENUM_TO_STRING_TABLE_BEGIN( WRAP_MODE )
  84 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, DEFAULT )
  85 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, CLAMP_TO_EDGE )
  86 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, REPEAT )
  87 DALI_ENUM_TO_STRING_WITH_SCOPE( Dali::WrapMode, MIRRORED_REPEAT )
  88 DALI_ENUM_TO_STRING_TABLE_END( WRAP_MODE )
  89
  90 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
  91
  92 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
  93
  94 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
  95   attribute mediump vec2 aPosition;\n
  96   uniform mediump mat4 uModelMatrix;\n
  97   uniform mediump mat4 uViewMatrix;\n
  98   uniform mediump mat4 uProjection;\n
  99   uniform mediump vec3 uSize;\n
 100   uniform mediump vec4 pixelArea;
 101   varying mediump vec2 vTexCoord;\n
 102   \n
 103
 104   //Visual size and offset
 105   uniform mediump vec2 offset;\n
 106   uniform mediump vec2 size;\n
 107   uniform mediump vec4 offsetSizeMode;\n
 108   uniform mediump vec2 origin;\n
 109   uniform mediump vec2 anchorPoint;\n
 110
 111   vec4 ComputeVertexPosition()\n
 112   {\n
 113     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
 114     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
 115     return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
 116   }\n
 117
 118   void main()\n
 119   {\n
 120     mediump vec4 vertexPosition = uViewMatrix * uModelMatrix * ComputeVertexPosition();\n
 121     vertexPosition.xy = floor ( vertexPosition.xy );\n // Pixel alignment
 122     vertexPosition = uProjection *  vertexPosition;\n
 123     vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
 124     gl_Position = vertexPosition;\n
 125   }\n
 126 );
 127
 128 const char* FRAGMENT_SHADER_NO_ATLAS = DALI_COMPOSE_SHADER(
 129   varying mediump vec2 vTexCoord;\n
 130   uniform sampler2D sTexture;\n
 131   uniform lowp vec4 uColor;\n
 132   uniform lowp vec3 mixColor;\n
 133   uniform lowp float opacity;\n
 134   uniform lowp float preMultipliedAlpha;\n
 135   \n
 136   lowp vec4 visualMixColor()\n
 137   {\n
 138     return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
 139   }\n
 140   void main()\n
 141   {\n
 142       gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * visualMixColor();\n
 143   }\n
 144 );
 145
 146 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
 147     varying mediump vec2 vTexCoord;\n
 148     uniform sampler2D sTexture;\n
 149     uniform mediump vec4 uAtlasRect;\n
 150     uniform lowp vec4 uColor;\n
 151     uniform lowp vec3 mixColor;\n
 152     uniform lowp float opacity;\n
 153     uniform lowp float preMultipliedAlpha;\n
 154     \n
 155     lowp vec4 visualMixColor()\n
 156     {\n
 157         return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
 158     }\n
 159     \n
 160     void main()\n
 161     {\n
 162         mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
 163         gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
 164      }\n
 165 );
 166
 167 const char* FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP = DALI_COMPOSE_SHADER(
 168     varying mediump vec2 vTexCoord;\n
 169     uniform sampler2D sTexture;\n
 170     uniform mediump vec4 uAtlasRect;\n
 171     // WrapMode -- 0: CLAMP; 1: REPEAT; 2: REFLECT;
 172     uniform lowp vec2 wrapMode;\n
 173     uniform lowp vec4 uColor;\n
 174     uniform lowp vec3 mixColor;\n
 175     uniform lowp float opacity;\n
 176     uniform lowp float preMultipliedAlpha;\n
 177     \n
 178     mediump float wrapCoordinate( mediump vec2 range, mediump float coordinate, lowp float wrap )\n
 179     {\n
 180       mediump float coord;\n
 181       if( wrap > 1.5 )\n // REFLECT
 182         coord = 1.0-abs(fract(coordinate*0.5)*2.0 - 1.0);\n
 183       else \n// warp == 0 or 1
 184         coord = mix(coordinate, fract( coordinate ), wrap);\n
 185       return clamp( mix(range.x, range.y, coord), range.x, range.y );
 186     }\n
 187     \n
 188     lowp vec4 visualMixColor()\n
 189     {\n
 190       return vec4( mixColor * mix( 1.0, opacity, preMultipliedAlpha ), opacity );\n
 191     }\n
 192     \n
 193     void main()\n
 194     {\n
 195         mediump vec2 texCoord = vec2( wrapCoordinate( uAtlasRect.xz, vTexCoord.x, wrapMode.x ),
 196                                       wrapCoordinate( uAtlasRect.yw, vTexCoord.y, wrapMode.y ) );\n
 197         gl_FragColor = texture2D( sTexture, texCoord ) * uColor * visualMixColor();\n
 198     }\n
 199 );
 200
 201 Geometry CreateGeometry( VisualFactoryCache& factoryCache, ImageDimensions gridSize )
 202 {
 203   Geometry geometry;
 204
 205   if( gridSize == ImageDimensions( 1, 1 ) )
 206   {
 207     geometry = factoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 208   }
 209   else
 210   {
 211     geometry = VisualFactoryCache::CreateGridGeometry( gridSize );
 212   }
 213
 214   return geometry;
 215 }
 216
 217 } // unnamed namespace
 218
 219 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
 220                                  const VisualUrl& imageUrl,
 221                                  const Property::Map& properties,
 222                                  ImageDimensions size,
 223                                  FittingMode::Type fittingMode,
 224                                  Dali::SamplingMode::Type samplingMode )
 225 {
 226   ImageVisualPtr imageVisualPtr( new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode ) );
 227   imageVisualPtr->SetProperties( properties );
 228   return imageVisualPtr;
 229 }
 230
 231 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache,
 232                                  const VisualUrl& imageUrl,
 233                                  ImageDimensions size,
 234                                  FittingMode::Type fittingMode,
 235                                  Dali::SamplingMode::Type samplingMode )
 236 {
 237   return new ImageVisual( factoryCache, imageUrl, size, fittingMode, samplingMode );
 238 }
 239
 240 ImageVisualPtr ImageVisual::New( VisualFactoryCache& factoryCache, const Image& image )
 241 {
 242   return new ImageVisual( factoryCache, image );
 243 }
 244
 245 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache,
 246                           const VisualUrl& imageUrl,
 247                           ImageDimensions size,
 248                           FittingMode::Type fittingMode,
 249                           Dali::SamplingMode::Type samplingMode )
 250 : Visual::Base( factoryCache ),
 251   mImage(),
 252   mPixels(),
 253   mPixelArea( FULL_TEXTURE_RECT ),
 254   mPlacementActor(),
 255   mImageUrl( imageUrl ),
 256   mDesiredSize( size ),
 257   mFittingMode( fittingMode ),
 258   mSamplingMode( samplingMode ),
 259   mWrapModeU( WrapMode::DEFAULT ),
 260   mWrapModeV( WrapMode::DEFAULT )
 261 {
 262 }
 263
 264 ImageVisual::ImageVisual( VisualFactoryCache& factoryCache, const Image& image )
 265 : Visual::Base( factoryCache ),
 266   mImage( image ),
 267   mPixels(),
 268   mPixelArea( FULL_TEXTURE_RECT ),
 269   mPlacementActor(),
 270   mImageUrl(),
 271   mDesiredSize(),
 272   mFittingMode( FittingMode::DEFAULT ),
 273   mSamplingMode( SamplingMode::DEFAULT ),
 274   mWrapModeU( WrapMode::DEFAULT ),
 275   mWrapModeV( WrapMode::DEFAULT )
 276 {
 277 }
 278
 279 ImageVisual::~ImageVisual()
 280 {
 281 }
 282
 283 void ImageVisual::DoSetProperties( const Property::Map& propertyMap )
 284 {
 285   // Url is already received in constructor
 286   for( Property::Map::SizeType iter = 0; iter < propertyMap.Count(); ++iter )
 287   {
 288     KeyValuePair keyValue = propertyMap.GetKeyValue( iter );
 289     if( keyValue.first.type == Property::Key::INDEX )
 290     {
 291       DoSetProperty( keyValue.first.indexKey, keyValue.second );
 292     }
 293     else
 294     {
 295       if( keyValue.first == IMAGE_FITTING_MODE )
 296       {
 297         DoSetProperty( Toolkit::ImageVisual::Property::FITTING_MODE, keyValue.second );
 298       }
 299       else if( keyValue.first == IMAGE_SAMPLING_MODE )
 300       {
 301         DoSetProperty( Toolkit::ImageVisual::Property::SAMPLING_MODE, keyValue.second );
 302       }
 303       else if( keyValue.first == IMAGE_DESIRED_WIDTH )
 304       {
 305         DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_WIDTH, keyValue.second );
 306       }
 307       else if( keyValue.first == IMAGE_DESIRED_HEIGHT )
 308       {
 309         DoSetProperty( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, keyValue.second );
 310       }
 311       else if( keyValue.first == PIXEL_AREA_UNIFORM_NAME )
 312       {
 313         DoSetProperty( Toolkit::ImageVisual::Property::PIXEL_AREA, keyValue.second );
 314       }
 315       else if( keyValue.first == IMAGE_WRAP_MODE_U )
 316       {
 317         DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_U, keyValue.second );
 318       }
 319       else if( keyValue.first == IMAGE_WRAP_MODE_V )
 320       {
 321         DoSetProperty( Toolkit::ImageVisual::Property::WRAP_MODE_V, keyValue.second );
 322       }
 323       else if( keyValue.first == SYNCHRONOUS_LOADING )
 324       {
 325         DoSetProperty( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, keyValue.second );
 326       }
 327     }
 328   }
 329
 330   if( mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING && mImageUrl.IsValid() )
 331   {
 332     // if sync loading is required, the loading should start
 333     // immediately when new image url is set or the actor is off stage
 334     // ( for on-stage actor with image url unchanged, resource loading
 335     // is already finished )
 336     LoadResourceSynchronously();
 337   }
 338 }
 339
 340 void ImageVisual::DoSetProperty( Property::Index index, const Property::Value& value )
 341 {
 342   switch( index )
 343   {
 344     case Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING:
 345     {
 346       bool sync;
 347       if( value.Get( sync ) )
 348       {
 349         if( sync )
 350         {
 351           mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 352         }
 353         else
 354         {
 355           mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 356         }
 357       }
 358       else
 359       {
 360         DALI_LOG_ERROR("ImageVisual: synchronousLoading property has incorrect type\n");
 361       }
 362       break;
 363     }
 364
 365     case Toolkit::ImageVisual::Property::DESIRED_WIDTH:
 366     {
 367       float desiredWidth;
 368       if( value.Get( desiredWidth ) )
 369       {
 370         mDesiredSize.SetWidth( desiredWidth );
 371       }
 372       else
 373       {
 374         DALI_LOG_ERROR("ImageVisual: desiredWidth property has incorrect type\n");
 375       }
 376       break;
 377     }
 378
 379     case Toolkit::ImageVisual::Property::DESIRED_HEIGHT:
 380     {
 381       float desiredHeight;
 382       if( value.Get( desiredHeight ) )
 383       {
 384         mDesiredSize.SetHeight( desiredHeight );
 385       }
 386       else
 387       {
 388         DALI_LOG_ERROR("ImageVisual: desiredHeight property has incorrect type\n");
 389       }
 390       break;
 391     }
 392
 393     case Toolkit::ImageVisual::Property::FITTING_MODE:
 394     {
 395       int fittingMode;
 396       Scripting::GetEnumerationProperty( value, FITTING_MODE_TABLE, FITTING_MODE_TABLE_COUNT, fittingMode );
 397       mFittingMode = Dali::FittingMode::Type( fittingMode );
 398       break;
 399     }
 400
 401     case Toolkit::ImageVisual::Property::SAMPLING_MODE:
 402     {
 403       int samplingMode;
 404       Scripting::GetEnumerationProperty( value, SAMPLING_MODE_TABLE, SAMPLING_MODE_TABLE_COUNT, samplingMode );
 405       mSamplingMode = Dali::SamplingMode::Type( samplingMode );
 406       break;
 407     }
 408
 409     case Toolkit::ImageVisual::Property::PIXEL_AREA:
 410     {
 411       value.Get( mPixelArea );
 412       break;
 413     }
 414
 415     case Toolkit::ImageVisual::Property::WRAP_MODE_U:
 416     {
 417       int wrapMode;
 418       Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
 419       mWrapModeU = Dali::WrapMode::Type( wrapMode );
 420       break;
 421     }
 422
 423     case Toolkit::ImageVisual::Property::WRAP_MODE_V:
 424     {
 425       int wrapMode;
 426       Scripting::GetEnumerationProperty( value, WRAP_MODE_TABLE, WRAP_MODE_TABLE_COUNT, wrapMode );
 427       mWrapModeV = Dali::WrapMode::Type( wrapMode );
 428       break;
 429     }
 430   }
 431 }
 432
 433 void ImageVisual::GetNaturalSize( Vector2& naturalSize )
 434 {
 435   if(mImage)
 436   {
 437     naturalSize.x = mImage.GetWidth();
 438     naturalSize.y = mImage.GetHeight();
 439     return;
 440   }
 441   else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
 442   {
 443     naturalSize.x = mDesiredSize.GetWidth();
 444     naturalSize.y = mDesiredSize.GetHeight();
 445     return;
 446   }
 447   else if( mImageUrl.IsValid() && mImageUrl.GetLocation() == VisualUrl::LOCAL )
 448   {
 449     ImageDimensions dimentions = Dali::GetClosestImageSize( mImageUrl.GetUrl() );
 450     naturalSize.x = dimentions.GetWidth();
 451     naturalSize.y = dimentions.GetHeight();
 452     return;
 453   }
 454
 455   naturalSize = Vector2::ZERO;
 456 }
 457
 458 void ImageVisual::CreateRenderer( TextureSet& textures )
 459 {
 460   Geometry geometry;
 461   Shader shader;
 462
 463   if( !mImpl->mCustomShader )
 464   {
 465     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 466
 467     shader = GetImageShader( mFactoryCache,
 468                              mImpl->mFlags & Impl::IS_ATLASING_APPLIED,
 469                              mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE );
 470   }
 471   else
 472   {
 473     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 474     if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
 475     {
 476       shader = GetImageShader( mFactoryCache, false, true );
 477     }
 478     else
 479     {
 480       shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 481                              mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER_NO_ATLAS : mImpl->mCustomShader->mFragmentShader,
 482                              mImpl->mCustomShader->mHints );
 483       if( mImpl->mCustomShader->mVertexShader.empty() )
 484       {
 485         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 486       }
 487     }
 488   }
 489
 490   mImpl->mRenderer = Renderer::New( geometry, shader );
 491   DALI_ASSERT_DEBUG( textures );
 492   mImpl->mRenderer.SetTextures( textures );
 493
 494   //Register transform properties
 495   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 496 }
 497
 498 void ImageVisual::CreateNativeImageRenderer( NativeImage& nativeImage )
 499 {
 500   Geometry geometry;
 501   Shader shader;
 502
 503   std::string fragmentShader;
 504   const char* fragmentPreFix = nativeImage.GetCustomFragmentPreFix();
 505   const char* customSamplerTypename = nativeImage.GetCustomSamplerTypename();
 506
 507   if( fragmentPreFix )
 508   {
 509     fragmentShader = fragmentPreFix;
 510     fragmentShader += "\n";
 511   }
 512
 513   if( mImpl->mCustomShader && !mImpl->mCustomShader->mFragmentShader.empty() )
 514   {
 515     fragmentShader += mImpl->mCustomShader->mFragmentShader;
 516   }
 517   else
 518   {
 519     fragmentShader += FRAGMENT_SHADER_NO_ATLAS;
 520   }
 521
 522   if( customSamplerTypename )
 523   {
 524     fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
 525   }
 526
 527   if( !mImpl->mCustomShader )
 528   {
 529     geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
 530
 531     shader  = Shader::New( VERTEX_SHADER, fragmentShader );
 532     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 533   }
 534   else
 535   {
 536     geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
 537     shader  = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
 538                            fragmentShader,
 539                            mImpl->mCustomShader->mHints );
 540     if( mImpl->mCustomShader->mVertexShader.empty() )
 541     {
 542       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 543     }
 544   }
 545
 546   mImpl->mRenderer = Renderer::New( geometry, shader );
 547
 548   //Register transform properties
 549   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 550 }
 551
 552
 553 bool ImageVisual::IsSynchronousResourceLoading() const
 554 {
 555   return mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
 556 }
 557
 558 void ImageVisual::LoadResourceSynchronously()
 559 {
 560   if( mImageUrl.IsValid() )
 561   {
 562     BitmapLoader loader = BitmapLoader::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
 563     loader.Load();
 564     mPixels = loader.GetPixelData();
 565   }
 566 }
 567
 568 TextureSet ImageVisual::CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing )
 569 {
 570   TextureSet textureSet;
 571   textureRect = FULL_TEXTURE_RECT;
 572   if( synchronousLoading )
 573   {
 574     if( !mPixels )
 575     {
 576       // use broken image
 577       textureSet = TextureSet::New();
 578       TextureSetImage( textureSet, 0u, VisualFactoryCache::GetBrokenVisualImage() );
 579     }
 580     else
 581     {
 582       if( attemptAtlasing )
 583       {
 584         textureSet = mFactoryCache.GetAtlasManager()->Add(textureRect, mPixels );
 585         mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 586       }
 587       if( !textureSet ) // big image, no atlasing or atlasing failed
 588       {
 589         mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 590         Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D, mPixels.GetPixelFormat(),
 591                                         mPixels.GetWidth(), mPixels.GetHeight() );
 592         texture.Upload( mPixels );
 593         textureSet = TextureSet::New();
 594         textureSet.SetTexture( 0u, texture );
 595       }
 596     }
 597   }
 598   else
 599   {
 600     if( attemptAtlasing )
 601     {
 602       textureSet = mFactoryCache.GetAtlasManager()->Add( textureRect, mImageUrl.GetUrl(), mDesiredSize, mFittingMode, true, this );
 603       mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
 604     }
 605     if( !textureSet ) // big image, no atlasing or atlasing failed
 606     {
 607       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 608       ResourceImage resourceImage = Dali::ResourceImage::New( mImageUrl.GetUrl(), mDesiredSize, mFittingMode, mSamplingMode );
 609       resourceImage.LoadingFinishedSignal().Connect( this, &ImageVisual::OnImageLoaded );
 610       textureSet = TextureSet::New();
 611       TextureSetImage( textureSet, 0u, resourceImage );
 612     }
 613   }
 614
 615   if( !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
 616   {
 617     Sampler sampler = Sampler::New();
 618     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 619     textureSet.SetSampler( 0u, sampler );
 620   }
 621   return textureSet;
 622 }
 623
 624 void ImageVisual::InitializeRenderer()
 625 {
 626   mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 627
 628   if( !mImpl->mCustomShader && mImageUrl.GetLocation() == VisualUrl::LOCAL )
 629   {
 630     bool defaultWrapMode = mWrapModeU <= WrapMode::CLAMP_TO_EDGE && mWrapModeV <= WrapMode::CLAMP_TO_EDGE;
 631
 632     Vector4 atlasRect;
 633     // texture set has to be created first as we need to know if atlasing succeeded or not
 634     // when selecting the shader
 635     TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), true );
 636     CreateRenderer( textures );
 637
 638     if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED ) // the texture is packed inside atlas
 639     {
 640       mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
 641       if( !defaultWrapMode ) // custom wrap mode, renderer is not cached.
 642       {
 643         Vector2 wrapMode(mWrapModeU-WrapMode::CLAMP_TO_EDGE, mWrapModeV-WrapMode::CLAMP_TO_EDGE);
 644         wrapMode.Clamp( Vector2::ZERO, Vector2( 2.f, 2.f ) );
 645         mImpl->mRenderer.RegisterProperty( WRAP_MODE_UNIFORM_NAME, wrapMode );
 646       }
 647     }
 648   }
 649   else
 650   {
 651     // for custom shader or remote image, atlas is not applied
 652     Vector4 atlasRect; // ignored in this case
 653     TextureSet textures = CreateTextureSet( atlasRect, IsSynchronousResourceLoading(), false );
 654     CreateRenderer( textures );
 655   }
 656 }
 657
 658 void ImageVisual::InitializeRenderer( const Image& image )
 659 {
 660   // don't reuse CreateTextureSet
 661   TextureSet textures = TextureSet::New();
 662
 663   // Renderer can't be shared if mImage is NativeImage
 664   NativeImage nativeImage = NativeImage::DownCast( image );
 665   if( nativeImage )
 666   {
 667     CreateNativeImageRenderer( nativeImage );
 668     DALI_ASSERT_DEBUG( textures );
 669     mImpl->mRenderer.SetTextures( textures );
 670   }
 671   else
 672   {
 673     // reuse existing code for regular images
 674     CreateRenderer( textures );
 675   }
 676   ApplyImageToSampler( image );
 677 }
 678
 679 void ImageVisual::UploadCompleted()
 680 {
 681   // Resource image is loaded. If weak handle is holding a placement actor, it is the time to add the renderer to actor.
 682   Actor actor = mPlacementActor.GetHandle();
 683   if( actor )
 684   {
 685     actor.AddRenderer( mImpl->mRenderer );
 686     // reset the weak handle so that the renderer only get added to actor once
 687     mPlacementActor.Reset();
 688   }
 689 }
 690
 691 void ImageVisual::DoSetOnStage( Actor& actor )
 692 {
 693   if( mImageUrl.IsValid() )
 694   {
 695     InitializeRenderer();
 696   }
 697   else if ( mImage )
 698   {
 699     InitializeRenderer( mImage );
 700   }
 701
 702   if ( !mImpl->mRenderer )
 703   {
 704     return;
 705   }
 706
 707   mPlacementActor = actor;
 708
 709   if( mPixelArea != FULL_TEXTURE_RECT )
 710   {
 711     mImpl->mRenderer.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, mPixelArea );
 712   }
 713
 714   if( IsSynchronousResourceLoading() || !(mImpl->mFlags & Impl::IS_ATLASING_APPLIED) )
 715   {
 716     actor.AddRenderer( mImpl->mRenderer );
 717     mPlacementActor.Reset();
 718   }
 719 }
 720
 721 void ImageVisual::DoSetOffStage( Actor& actor )
 722 {
 723   // Visual::Base::SetOffStage only calls DoSetOffStage if mRenderer exists (is on onstage)
 724
 725   //If we own the image then make sure we release it when we go off stage
 726   actor.RemoveRenderer( mImpl->mRenderer);
 727   if( mImageUrl.IsValid() )
 728   {
 729     RemoveFromAtlas( mImageUrl.GetUrl() );
 730     mImage.Reset();
 731   }
 732
 733   mImpl->mRenderer.Reset();
 734   mPlacementActor.Reset();
 735 }
 736
 737 void ImageVisual::DoCreatePropertyMap( Property::Map& map ) const
 738 {
 739   map.Clear();
 740   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
 741
 742   bool sync = IsSynchronousResourceLoading();
 743   map.Insert( SYNCHRONOUS_LOADING, sync );
 744   if( mImageUrl.IsValid() )
 745   {
 746     map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
 747     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
 748     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
 749   }
 750   else if( mImage )
 751   {
 752     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
 753     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
 754
 755     ResourceImage resourceImage = ResourceImage::DownCast(mImage);
 756     if( resourceImage )
 757     {
 758       map.Insert( Toolkit::ImageVisual::Property::URL, resourceImage.GetUrl() );
 759     }
 760   }
 761
 762   map.Insert( Toolkit::ImageVisual::Property::FITTING_MODE, mFittingMode );
 763   map.Insert( Toolkit::ImageVisual::Property::SAMPLING_MODE, mSamplingMode );
 764
 765   map.Insert( Toolkit::ImageVisual::Property::PIXEL_AREA, mPixelArea );
 766   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_U, mWrapModeU );
 767   map.Insert( Toolkit::ImageVisual::Property::WRAP_MODE_V, mWrapModeV );
 768 }
 769
 770 void ImageVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 771 {
 772   map.Clear();
 773   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::Visual::IMAGE );
 774   if( mImageUrl.IsValid() )
 775   {
 776     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, mDesiredSize.GetWidth() );
 777     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, mDesiredSize.GetHeight() );
 778   }
 779   else if( mImage )
 780   {
 781     map.Insert( Toolkit::ImageVisual::Property::DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
 782     map.Insert( Toolkit::ImageVisual::Property::DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
 783   }
 784 }
 785
 786 void ImageVisual::OnSetTransform()
 787 {
 788   if( mImpl->mRenderer )
 789   {
 790     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 791   }
 792 }
 793
 794 Shader ImageVisual::GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping )
 795 {
 796   Shader shader;
 797   if( atlasing )
 798   {
 799     if( defaultTextureWrapping )
 800     {
 801       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
 802       if( !shader )
 803       {
 804         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
 805         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 806         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
 807       }
 808     }
 809     else
 810     {
 811       shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP );
 812       if( !shader )
 813       {
 814         shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_VARIOUS_WRAP );
 815         shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 816         factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_CUSTOM_WRAP, shader );
 817       }
 818     }
 819   }
 820   else
 821   {
 822     shader = factoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER );
 823     if( !shader )
 824     {
 825       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_NO_ATLAS );
 826       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 827       factoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER, shader );
 828     }
 829   }
 830
 831   return shader;
 832 }
 833
 834 void ImageVisual::ApplyImageToSampler( const Image& image )
 835 {
 836   if( image )
 837   {
 838     TextureSet textureSet = mImpl->mRenderer.GetTextures();
 839     DALI_ASSERT_DEBUG( textureSet ); // texture set should always exist by this time
 840
 841     TextureSetImage( textureSet, 0u, image );
 842     Sampler sampler = Sampler::New();
 843     sampler.SetWrapMode(  mWrapModeU, mWrapModeV  );
 844     textureSet.SetSampler( 0u, sampler );
 845   }
 846 }
 847
 848 void ImageVisual::OnImageLoaded( ResourceImage image )
 849 {
 850   if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
 851   {
 852     Image brokenImage = VisualFactoryCache::GetBrokenVisualImage();
 853     if( mImpl->mRenderer )
 854     {
 855       ApplyImageToSampler( brokenImage );
 856     }
 857   }
 858 }
 859
 860 void ImageVisual::RemoveFromAtlas(const std::string& url)
 861 {
 862   Vector4 atlasRect( 0.f, 0.f, 1.f, 1.f );
 863   Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
 864   if( index != Property::INVALID_INDEX )
 865   {
 866     Property::Value atlasRectValue = mImpl->mRenderer.GetProperty( index );
 867     atlasRectValue.Get( atlasRect );
 868   }
 869
 870   TextureSet textureSet = mImpl->mRenderer.GetTextures();
 871   mImpl->mRenderer.Reset();
 872
 873   if( index != Property::INVALID_INDEX )
 874   {
 875     mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
 876   }
 877 }
 878
 879 } // namespace Internal
 880
 881 } // namespace Toolkit
 882
 883 } // namespace Dali