dali-toolkit/internal/controls/image-view/image-view-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
  18 // CLASS HEADER
  19 #include "image-view-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/images/resource-image.h>
  23 #include <dali/public-api/object/type-registry.h>
  24 #include <dali/public-api/object/type-registry-helper.h>
  25 #include <dali/devel-api/scripting/scripting.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  29 #include <dali-toolkit/devel-api/controls/control-devel.h>
  30 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  31 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  32 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  33 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44
  45 namespace
  46 {
  47
  48 BaseHandle Create()
  49 {
  50   return Toolkit::ImageView::New();
  51 }
  52
  53 // Setup properties, signals and actions using the type-registry.
  54 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
  55 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "resourceUrl", STRING, RESOURCE_URL )
  56 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
  57 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
  58
  59 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA )
  60 DALI_TYPE_REGISTRATION_END()
  61
  62 } // anonymous namespace
  63
  64 using namespace Dali;
  65
  66 ImageView::ImageView()
  67 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
  68   mRelayoutRequired(true)
  69 {
  70 }
  71
  72 ImageView::~ImageView()
  73 {
  74 }
  75
  76 Toolkit::ImageView ImageView::New()
  77 {
  78   ImageView* impl = new ImageView();
  79
  80   Toolkit::ImageView handle = Toolkit::ImageView( *impl );
  81
  82   // Second-phase init of the implementation
  83   // This can only be done after the CustomActor connection has been made...
  84   impl->Initialize();
  85
  86   return handle;
  87 }
  88
  89 /////////////////////////////////////////////////////////////
  90
  91 void ImageView::OnInitialize()
  92 {
  93   // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
  94   Dali::Toolkit::Control handle( GetOwner() );
  95   Toolkit::DevelControl::ResourceReadySignal( handle ).Connect( this, &ImageView::OnResourceReady );
  96 }
  97
  98 void ImageView::SetImage( Image image )
  99 {
 100   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 101   mImage = image;
 102   mUrl.clear();
 103   mPropertyMap.Clear();
 104
 105   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( image );
 106   if (!mVisual)
 107   {
 108     mVisual = visual;
 109   }
 110
 111   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 112 }
 113
 114 void ImageView::SetImage( const Property::Map& map )
 115 {
 116   // Comparing a property map is too expensive so just creating a new visual
 117   mPropertyMap = map;
 118   mUrl.clear();
 119   mImage.Reset();
 120   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
 121   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 122   if (!mVisual)
 123   {
 124     mVisual = visual;
 125   }
 126
 127   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 128 }
 129
 130 void ImageView::SetImage( const std::string& url, ImageDimensions size )
 131 {
 132   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 133   mUrl = url;
 134   mImage.Reset();
 135   mPropertyMap.Clear();
 136
 137   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 138   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( url, size );
 139   if (!mVisual)
 140   {
 141     mVisual = visual;
 142   }
 143
 144   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
 145 }
 146
 147 Image ImageView::GetImage() const
 148 {
 149   return mImage;
 150 }
 151
 152 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
 153 {
 154   if( mVisual )
 155   {
 156     Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
 157   }
 158 }
 159
 160 bool ImageView::IsPreMultipliedAlphaEnabled() const
 161 {
 162   if( mVisual )
 163   {
 164     return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
 165   }
 166   return false;
 167 }
 168
 169 void ImageView::SetDepthIndex( int depthIndex )
 170 {
 171   if( mVisual )
 172   {
 173     mVisual.SetDepthIndex( depthIndex );
 174   }
 175 }
 176
 177 void ImageView::OnStageConnection( int depth )
 178 {
 179   if( mImage )
 180   {
 181     mImage.UploadedSignal().Emit( mImage );
 182   }
 183
 184   Dali::ResourceImage resourceImage = Dali::ResourceImage::DownCast( mImage );
 185   if( resourceImage )
 186   {
 187     resourceImage.LoadingFinishedSignal().Emit( resourceImage );
 188   }
 189
 190   Control::OnStageConnection( depth ); // Enabled visuals will be put on stage
 191 }
 192
 193 Vector3 ImageView::GetNaturalSize()
 194 {
 195   if( mVisual )
 196   {
 197     Vector2 rendererNaturalSize;
 198     mVisual.GetNaturalSize( rendererNaturalSize );
 199     return Vector3( rendererNaturalSize );
 200   }
 201
 202   // if no visual then use Control's natural size
 203   return Control::GetNaturalSize();
 204 }
 205
 206 float ImageView::GetHeightForWidth( float width )
 207 {
 208   if( mVisual )
 209   {
 210     return mVisual.GetHeightForWidth( width );
 211   }
 212   else
 213   {
 214     return Control::GetHeightForWidth( width );
 215   }
 216 }
 217
 218 float ImageView::GetWidthForHeight( float height )
 219 {
 220   if( mVisual )
 221   {
 222     return mVisual.GetWidthForHeight( height );
 223   }
 224   else
 225   {
 226     return Control::GetWidthForHeight( height );
 227   }
 228 }
 229
 230 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
 231 {
 232   Control::OnRelayout( size, container );
 233
 234   // If visual is being replaced then mVisual will be the replacement visual even if not ready.
 235   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 236
 237   if( mVisual )
 238   {
 239     // Pass in an empty map which uses default transform values meaning our visual fills the control
 240     // Should provide a transform that handles aspect ratio according to image size
 241     mVisual.SetTransformAndSize( Property::Map(), size );
 242   }
 243 }
 244
 245 void ImageView::OnResourceReady( Toolkit::Control control )
 246 {
 247   if( mRelayoutRequired)
 248   {
 249     mRelayoutRequired = false;
 250     RelayoutRequest();
 251   }
 252 }
 253
 254 ///////////////////////////////////////////////////////////
 255 //
 256 // Properties
 257 //
 258
 259 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 260 {
 261   Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 262
 263   if ( imageView )
 264   {
 265     ImageView& impl = GetImpl( imageView );
 266     switch ( index )
 267     {
 268       case Toolkit::ImageView::Property::RESOURCE_URL:
 269       {
 270         std::string imageUrl;
 271         if( value.Get( imageUrl ) )
 272         {
 273           impl.SetImage( imageUrl, ImageDimensions() );
 274         }
 275         break;
 276       }
 277
 278       case Toolkit::ImageView::Property::IMAGE:
 279       {
 280         std::string imageUrl;
 281         Property::Map* map;
 282         if( value.Get( imageUrl ) )
 283         {
 284           impl.SetImage( imageUrl, ImageDimensions() );
 285         }
 286         // if its not a string then get a Property::Map from the property if possible.
 287         else
 288         {
 289           map = value.GetMap();
 290           if( map )
 291           {
 292             Property::Value* shaderValue = map->Find( Toolkit::DevelVisual::Property::SHADER, CUSTOM_SHADER );
 293             // set image only if property map contains image information other than custom shader
 294             if( map->Count() > 1u ||  !shaderValue )
 295             {
 296               impl.SetImage( *map );
 297             }
 298             // the property map contains only the custom shader
 299             else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
 300             {
 301               Property::Map* shaderMap = shaderValue->GetMap();
 302               if( shaderMap )
 303               {
 304                 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
 305                 visual.SetCustomShader( *shaderMap );
 306                 if( imageView.OnStage() )
 307                 {
 308                   // force to create new core renderer to use the newly set shader
 309                   visual.SetOffStage( imageView );
 310                   visual.SetOnStage( imageView );
 311                 }
 312               }
 313             }
 314           }
 315         }
 316         break;
 317       }
 318
 319       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 320       {
 321         bool isPre;
 322         if( value.Get( isPre ) )
 323         {
 324           impl.EnablePreMultipliedAlpha( isPre );
 325         }
 326         break;
 327       }
 328     }
 329   }
 330 }
 331
 332 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 333 {
 334   Property::Value value;
 335
 336   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 337
 338   if ( imageview )
 339   {
 340     ImageView& impl = GetImpl( imageview );
 341     switch ( propertyIndex )
 342     {
 343       case Toolkit::ImageView::Property::RESOURCE_URL:
 344       {
 345         if ( !impl.mUrl.empty() )
 346         {
 347           value = impl.mUrl;
 348         }
 349         break;
 350       }
 351
 352       case Toolkit::ImageView::Property::IMAGE:
 353       {
 354         if ( !impl.mUrl.empty() )
 355         {
 356           value = impl.mUrl;
 357         }
 358         else if( impl.mImage )
 359         {
 360           Property::Map map;
 361           Scripting::CreatePropertyMap( impl.mImage, map );
 362           value = map;
 363         }
 364         else if( !impl.mPropertyMap.Empty() )
 365         {
 366           value = impl.mPropertyMap;
 367         }
 368         break;
 369       }
 370
 371       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 372       {
 373         value = impl.IsPreMultipliedAlphaEnabled();
 374         break;
 375       }
 376     }
 377   }
 378
 379   return value;
 380 }
 381
 382 } // namespace Internal
 383 } // namespace Toolkit
 384 } // namespace Dali