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/public-api/visuals/visual-properties.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 {
  69 }
  70
  71 ImageView::~ImageView()
  72 {
  73 }
  74
  75 Toolkit::ImageView ImageView::New()
  76 {
  77   ImageView* impl = new ImageView();
  78
  79   Toolkit::ImageView handle = Toolkit::ImageView( *impl );
  80
  81   // Second-phase init of the implementation
  82   // This can only be done after the CustomActor connection has been made...
  83   impl->Initialize();
  84
  85   return handle;
  86 }
  87
  88 /////////////////////////////////////////////////////////////
  89
  90 void ImageView::OnInitialize()
  91 {
  92   // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
  93   Dali::Toolkit::Control handle( GetOwner() );
  94   handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
  95 }
  96
  97 void ImageView::SetImage( Image image )
  98 {
  99   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 100   mImage = image;
 101   mUrl.clear();
 102   mPropertyMap.Clear();
 103
 104   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( image );
 105   if (!mVisual)
 106   {
 107     mVisual = visual;
 108   }
 109
 110   DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 111 }
 112
 113 void ImageView::SetImage( const Property::Map& map )
 114 {
 115   // Comparing a property map is too expensive so just creating a new visual
 116   mPropertyMap = map;
 117   mUrl.clear();
 118   mImage.Reset();
 119
 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( mVisual )
 235   {
 236     // Pass in an empty map which uses default transform values meaning our visual fills the control
 237     // Should provide a transform that handles aspect ratio according to image size
 238     mVisual.SetTransformAndSize( Property::Map(), size );
 239   }
 240 }
 241
 242 void ImageView::OnResourceReady( Toolkit::Control control )
 243 {
 244   // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
 245   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 246 }
 247
 248 ///////////////////////////////////////////////////////////
 249 //
 250 // Properties
 251 //
 252
 253 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 254 {
 255   Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 256
 257   if ( imageView )
 258   {
 259     ImageView& impl = GetImpl( imageView );
 260     switch ( index )
 261     {
 262       case Toolkit::ImageView::Property::RESOURCE_URL:
 263       {
 264         std::string imageUrl;
 265         if( value.Get( imageUrl ) )
 266         {
 267           impl.SetImage( imageUrl, ImageDimensions() );
 268         }
 269         break;
 270       }
 271
 272       case Toolkit::ImageView::Property::IMAGE:
 273       {
 274         std::string imageUrl;
 275         Property::Map* map;
 276         if( value.Get( imageUrl ) )
 277         {
 278           impl.SetImage( imageUrl, ImageDimensions() );
 279         }
 280         // if its not a string then get a Property::Map from the property if possible.
 281         else
 282         {
 283           map = value.GetMap();
 284           if( map )
 285           {
 286             Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
 287             // set image only if property map contains image information other than custom shader
 288             if( map->Count() > 1u ||  !shaderValue )
 289             {
 290               impl.SetImage( *map );
 291             }
 292             // the property map contains only the custom shader
 293             else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
 294             {
 295               Property::Map* shaderMap = shaderValue->GetMap();
 296               if( shaderMap )
 297               {
 298                 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
 299                 visual.SetCustomShader( *shaderMap );
 300                 if( imageView.OnStage() )
 301                 {
 302                   // force to create new core renderer to use the newly set shader
 303                   visual.SetOffStage( imageView );
 304                   visual.SetOnStage( imageView );
 305                 }
 306               }
 307             }
 308           }
 309         }
 310         break;
 311       }
 312
 313       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 314       {
 315         bool isPre;
 316         if( value.Get( isPre ) )
 317         {
 318           impl.EnablePreMultipliedAlpha( isPre );
 319         }
 320         break;
 321       }
 322     }
 323   }
 324 }
 325
 326 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 327 {
 328   Property::Value value;
 329
 330   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 331
 332   if ( imageview )
 333   {
 334     ImageView& impl = GetImpl( imageview );
 335     switch ( propertyIndex )
 336     {
 337       case Toolkit::ImageView::Property::RESOURCE_URL:
 338       {
 339         if ( !impl.mUrl.empty() )
 340         {
 341           value = impl.mUrl;
 342         }
 343         break;
 344       }
 345
 346       case Toolkit::ImageView::Property::IMAGE:
 347       {
 348         if ( !impl.mUrl.empty() )
 349         {
 350           value = impl.mUrl;
 351         }
 352         else if( impl.mImage )
 353         {
 354           Property::Map map;
 355           Scripting::CreatePropertyMap( impl.mImage, map );
 356           value = map;
 357         }
 358         else if( !impl.mPropertyMap.Empty() )
 359         {
 360           value = impl.mPropertyMap;
 361         }
 362         break;
 363       }
 364
 365       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 366       {
 367         value = impl.IsPreMultipliedAlphaEnabled();
 368         break;
 369       }
 370     }
 371   }
 372
 373   return value;
 374 }
 375
 376 } // namespace Internal
 377 } // namespace Toolkit
 378 } // namespace Dali