dali-toolkit/internal/controls/image-view/image-view-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
  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( visual )
 106   {
 107     if( !mVisual )
 108     {
 109       mVisual = visual;
 110     }
 111
 112     DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 113   }
 114   else
 115   {
 116     // Unregister the exsiting visual
 117     DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
 118
 119     // Trigger a size negotiation request that may be needed when unregistering a visual.
 120     RelayoutRequest();
 121   }
 122
 123   Toolkit::DevelControl::RequestLayout( *this );
 124 }
 125
 126 void ImageView::SetImage( const Property::Map& map )
 127 {
 128   // Comparing a property map is too expensive so just creating a new visual
 129   mPropertyMap = map;
 130   mUrl.clear();
 131   mImage.Reset();
 132
 133   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
 134   if( visual )
 135   {
 136     // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 137     if( !mVisual )
 138     {
 139       mVisual = visual;
 140     }
 141
 142     DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 143   }
 144   else
 145   {
 146     // Unregister the exsiting visual
 147     DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
 148
 149     // Trigger a size negotiation request that may be needed when unregistering a visual.
 150     RelayoutRequest();
 151   }
 152
 153   Toolkit::DevelControl::RequestLayout( *this );
 154 }
 155
 156 void ImageView::SetImage( const std::string& url, ImageDimensions size )
 157 {
 158   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 159   mUrl = url;
 160   mImage.Reset();
 161   mPropertyMap.Clear();
 162
 163   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 164   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( url, size );
 165   if( visual )
 166   {
 167     if( !mVisual )
 168     {
 169       mVisual = visual;
 170     }
 171
 172     DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
 173   }
 174   else
 175   {
 176     // Unregister the exsiting visual
 177     DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
 178
 179     // Trigger a size negotiation request that may be needed when unregistering a visual.
 180     RelayoutRequest();
 181   }
 182
 183   Toolkit::DevelControl::RequestLayout( *this );
 184 }
 185
 186 Image ImageView::GetImage() const
 187 {
 188   return mImage;
 189 }
 190
 191 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
 192 {
 193   if( mVisual )
 194   {
 195     Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
 196   }
 197 }
 198
 199 bool ImageView::IsPreMultipliedAlphaEnabled() const
 200 {
 201   if( mVisual )
 202   {
 203     return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
 204   }
 205   return false;
 206 }
 207
 208 void ImageView::SetDepthIndex( int depthIndex )
 209 {
 210   if( mVisual )
 211   {
 212     mVisual.SetDepthIndex( depthIndex );
 213   }
 214 }
 215
 216 Vector3 ImageView::GetNaturalSize()
 217 {
 218   if( mVisual )
 219   {
 220     Vector2 rendererNaturalSize;
 221     mVisual.GetNaturalSize( rendererNaturalSize );
 222
 223     Extents padding;
 224     padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 225
 226     rendererNaturalSize.width += ( padding.start + padding.end );
 227     rendererNaturalSize.height += ( padding.top + padding.bottom );
 228     return Vector3( rendererNaturalSize );
 229   }
 230
 231   // if no visual then use Control's natural size
 232   return Control::GetNaturalSize();
 233 }
 234
 235 float ImageView::GetHeightForWidth( float width )
 236 {
 237   Extents padding;
 238   padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 239
 240   if( mVisual )
 241   {
 242     return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
 243   }
 244   else
 245   {
 246     return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
 247   }
 248 }
 249
 250 float ImageView::GetWidthForHeight( float height )
 251 {
 252   Extents padding;
 253   padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 254
 255   if( mVisual )
 256   {
 257     return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
 258   }
 259   else
 260   {
 261     return Control::GetWidthForHeight( height ) + padding.start + padding.end;
 262   }
 263 }
 264
 265 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
 266 {
 267   Control::OnRelayout( size, container );
 268
 269   if( mVisual )
 270   {
 271     Property::Map transformMap = Property::Map();
 272
 273     Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 274     const Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
 275
 276     if( ( padding != Extents() ) || // If padding is not zero
 277         ( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ) )
 278     {
 279       Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
 280             Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
 281
 282       if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
 283       {
 284         std::swap( padding.start, padding.end );
 285       }
 286
 287       auto finalOffset = Vector2( padding.start, padding.top );
 288
 289       // remove padding from the size to know how much is left for the visual
 290       auto finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
 291
 292       // Should provide a transform that handles aspect ratio according to image size
 293       if( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO )
 294       {
 295         auto availableVisualSize = finalSize;
 296
 297         Vector2 naturalSize;
 298         mVisual.GetNaturalSize( naturalSize );
 299
 300         // scale to fit the padded area
 301         finalSize = naturalSize * std::min( ( naturalSize.width  ? ( availableVisualSize.width  / naturalSize.width  ) : 0 ),
 302                                             ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
 303
 304         // calculate final offset within the padded area
 305         finalOffset += ( availableVisualSize - finalSize ) * .5f;
 306       }
 307
 308       // populate the transform map
 309       transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
 310                   .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
 311                       Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
 312                   .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
 313                   .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
 314                   .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize )
 315                   .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
 316                       Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
 317     }
 318
 319     mVisual.SetTransformAndSize( transformMap, size );
 320   }
 321 }
 322
 323 void ImageView::OnResourceReady( Toolkit::Control control )
 324 {
 325   // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
 326   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 327 }
 328
 329 ///////////////////////////////////////////////////////////
 330 //
 331 // Properties
 332 //
 333
 334 void ImageView::SetProperty( BaseObject* object, Property::Index index, const 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 ( index )
 342     {
 343       case Toolkit::ImageView::Property::RESOURCE_URL:
 344       {
 345         std::string imageUrl;
 346         if( value.Get( imageUrl ) )
 347         {
 348           impl.SetImage( imageUrl, ImageDimensions() );
 349         }
 350         break;
 351       }
 352
 353       case Toolkit::ImageView::Property::IMAGE:
 354       {
 355         std::string imageUrl;
 356         Property::Map* map;
 357         if( value.Get( imageUrl ) )
 358         {
 359           impl.SetImage( imageUrl, ImageDimensions() );
 360         }
 361         // if its not a string then get a Property::Map from the property if possible.
 362         else
 363         {
 364           map = value.GetMap();
 365           if( map )
 366           {
 367             Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
 368             // set image only if property map contains image information other than custom shader
 369             if( map->Count() > 1u ||  !shaderValue )
 370             {
 371               impl.SetImage( *map );
 372             }
 373             // the property map contains only the custom shader
 374             else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
 375             {
 376               Property::Map* shaderMap = shaderValue->GetMap();
 377               if( shaderMap )
 378               {
 379                 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
 380                 visual.SetCustomShader( *shaderMap );
 381                 if( imageView.OnStage() )
 382                 {
 383                   // force to create new core renderer to use the newly set shader
 384                   visual.SetOffStage( imageView );
 385                   visual.SetOnStage( imageView );
 386                 }
 387               }
 388             }
 389           }
 390         }
 391         break;
 392       }
 393
 394       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 395       {
 396         bool isPre;
 397         if( value.Get( isPre ) )
 398         {
 399           impl.EnablePreMultipliedAlpha( isPre );
 400         }
 401         break;
 402       }
 403     }
 404   }
 405 }
 406
 407 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 408 {
 409   Property::Value value;
 410
 411   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 412
 413   if ( imageview )
 414   {
 415     ImageView& impl = GetImpl( imageview );
 416     switch ( propertyIndex )
 417     {
 418       case Toolkit::ImageView::Property::RESOURCE_URL:
 419       {
 420         if ( !impl.mUrl.empty() )
 421         {
 422           value = impl.mUrl;
 423         }
 424         break;
 425       }
 426
 427       case Toolkit::ImageView::Property::IMAGE:
 428       {
 429         if ( !impl.mUrl.empty() )
 430         {
 431           value = impl.mUrl;
 432         }
 433         else if( impl.mImage )
 434         {
 435           Property::Map map;
 436           Scripting::CreatePropertyMap( impl.mImage, map );
 437           value = map;
 438         }
 439         else if( !impl.mPropertyMap.Empty() )
 440         {
 441           value = impl.mPropertyMap;
 442         }
 443         break;
 444       }
 445
 446       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 447       {
 448         value = impl.IsPreMultipliedAlphaEnabled();
 449         break;
 450       }
 451     }
 452   }
 453
 454   return value;
 455 }
 456
 457 } // namespace Internal
 458 } // namespace Toolkit
 459 } // namespace Dali