dali-toolkit/internal/controls/image-view/image-view-impl.cpp

   1 /*
   2  * Copyright (c) 2020 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/object/type-registry.h>
  23 #include <dali/public-api/object/type-registry-helper.h>
  24 #include <dali/devel-api/scripting/scripting.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  28 #include <dali-toolkit/devel-api/controls/control-devel.h>
  29 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  30 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
  31 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  32 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  33 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  34 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Internal
  43 {
  44
  45 namespace
  46 {
  47
  48 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
  49
  50 BaseHandle Create()
  51 {
  52   return Toolkit::ImageView::New();
  53 }
  54
  55 // Setup properties, signals and actions using the type-registry.
  56 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
  57 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
  58 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
  59
  60 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA )
  61 DALI_TYPE_REGISTRATION_END()
  62
  63 } // anonymous namespace
  64
  65 using namespace Dali;
  66
  67 ImageView::ImageView()
  68 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
  69   mImageSize(),
  70   mImageVisualPaddingSetByTransform( false ),
  71   mImageViewPixelAreaSetByFittingMode( false )
  72 {
  73 }
  74
  75 ImageView::~ImageView()
  76 {
  77 }
  78
  79 Toolkit::ImageView ImageView::New()
  80 {
  81   ImageView* impl = new ImageView();
  82
  83   Toolkit::ImageView handle = Toolkit::ImageView( *impl );
  84
  85   // Second-phase init of the implementation
  86   // This can only be done after the CustomActor connection has been made...
  87   impl->Initialize();
  88
  89   return handle;
  90 }
  91
  92 /////////////////////////////////////////////////////////////
  93
  94 void ImageView::OnInitialize()
  95 {
  96   // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
  97   Dali::Toolkit::Control handle( GetOwner() );
  98   handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
  99
 100   DevelControl::SetAccessibilityConstructor( Self(), []( Dali::Actor actor ) {
 101     return std::unique_ptr< Dali::Accessibility::Accessible >(
 102       new Control::Impl::AccessibleImpl( actor, Dali::Accessibility::Role::IMAGE ) );
 103   } );
 104 }
 105
 106 void ImageView::SetImage( const Property::Map& map )
 107 {
 108   // Comparing a property map is too expensive so just creating a new visual
 109   mPropertyMap = map;
 110   mUrl.clear();
 111
 112   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
 113   if( visual )
 114   {
 115     // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 116     if( !mVisual )
 117     {
 118       mVisual = visual;
 119     }
 120
 121     if( !mShaderMap.Empty() )
 122     {
 123       Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 124       visualImpl.SetCustomShader( mShaderMap );
 125     }
 126
 127     DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual  );
 128   }
 129   else
 130   {
 131     // Unregister the exsiting visual
 132     DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
 133
 134     // Trigger a size negotiation request that may be needed when unregistering a visual.
 135     RelayoutRequest();
 136   }
 137
 138   // Signal that a Relayout may be needed
 139 }
 140
 141 void ImageView::SetImage( const std::string& url, ImageDimensions size )
 142 {
 143   // Don't bother comparing if we had a visual previously, just drop old visual and create new one
 144   mUrl = url;
 145   mImageSize = size;
 146   mPropertyMap.Clear();
 147
 148   // Don't set mVisual until it is ready and shown. Getters will still use current visual.
 149   Toolkit::Visual::Base visual =  Toolkit::VisualFactory::Get().CreateVisual( url, size );
 150   if( visual )
 151   {
 152     if( !mVisual )
 153     {
 154       mVisual = visual;
 155     }
 156
 157     if( !mShaderMap.Empty() )
 158     {
 159       Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
 160       visualImpl.SetCustomShader( mShaderMap );
 161     }
 162
 163     DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
 164   }
 165   else
 166   {
 167     // Unregister the exsiting visual
 168     DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
 169
 170     // Trigger a size negotiation request that may be needed when unregistering a visual.
 171     RelayoutRequest();
 172   }
 173
 174   // Signal that a Relayout may be needed
 175 }
 176
 177 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
 178 {
 179   if( mVisual )
 180   {
 181     Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
 182   }
 183 }
 184
 185 bool ImageView::IsPreMultipliedAlphaEnabled() const
 186 {
 187   if( mVisual )
 188   {
 189     return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
 190   }
 191   return false;
 192 }
 193
 194 void ImageView::SetDepthIndex( int depthIndex )
 195 {
 196   if( mVisual )
 197   {
 198     mVisual.SetDepthIndex( depthIndex );
 199   }
 200 }
 201
 202 Vector3 ImageView::GetNaturalSize()
 203 {
 204   if( mVisual )
 205   {
 206     Vector2 rendererNaturalSize;
 207     mVisual.GetNaturalSize( rendererNaturalSize );
 208
 209     Extents padding;
 210     padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 211
 212     rendererNaturalSize.width += ( padding.start + padding.end );
 213     rendererNaturalSize.height += ( padding.top + padding.bottom );
 214     return Vector3( rendererNaturalSize );
 215   }
 216
 217   // if no visual then use Control's natural size
 218   return Control::GetNaturalSize();
 219 }
 220
 221 float ImageView::GetHeightForWidth( float width )
 222 {
 223   Extents padding;
 224   padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 225
 226   if( mVisual )
 227   {
 228     return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
 229   }
 230   else
 231   {
 232     return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
 233   }
 234 }
 235
 236 float ImageView::GetWidthForHeight( float height )
 237 {
 238   Extents padding;
 239   padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 240
 241   if( mVisual )
 242   {
 243     return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
 244   }
 245   else
 246   {
 247     return Control::GetWidthForHeight( height ) + padding.start + padding.end;
 248   }
 249 }
 250
 251 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
 252 {
 253   Control::OnRelayout( size, container );
 254   if( mVisual )
 255   {
 256     Property::Map transformMap = Property::Map();
 257
 258     Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
 259
 260     bool zeroPadding = ( padding == Extents() );
 261
 262     Vector2 naturalSize;
 263     mVisual.GetNaturalSize( naturalSize );
 264
 265     Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
 266           Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
 267     if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
 268     {
 269       std::swap( padding.start, padding.end );
 270     }
 271
 272     // remove padding from the size to know how much is left for the visual
 273     Vector2 finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
 274     Vector2 finalOffset = Vector2( padding.start, padding.top );
 275
 276     ApplyFittingMode( finalSize, naturalSize, finalOffset, zeroPadding , transformMap );
 277
 278     mVisual.SetTransformAndSize( transformMap, size );
 279
 280     // mVisual is not updated util the resource is ready in the case of visual replacement.
 281     // in this case, the Property Map must be initialized so that the previous value is not reused.
 282     // after mVisual is updated, the correct value will be reset.
 283     Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 284     if( visual && visual != mVisual )
 285     {
 286       visual.SetTransformAndSize( Property::Map(), size );
 287     }
 288   }
 289 }
 290
 291 void ImageView::OnResourceReady( Toolkit::Control control )
 292 {
 293   // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
 294   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 295   // Signal that a Relayout may be needed
 296 }
 297
 298 void ImageView::SetTransformMapForFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap )
 299 {
 300   switch(fittingMode)
 301   {
 302     case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
 303     {
 304       auto availableVisualSize = finalSize;
 305
 306       // scale to fit the padded area
 307       finalSize = naturalSize * std::min( ( naturalSize.width  ? ( availableVisualSize.width  / naturalSize.width  ) : 0 ),
 308                                             ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
 309
 310       // calculate final offset within the padded area
 311       finalOffset += ( availableVisualSize - finalSize ) * .5f;
 312
 313       // populate the transform map
 314       transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
 315                   .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
 316       break;
 317     }
 318     case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
 319     {
 320       mImageViewPixelAreaSetByFittingMode = true;
 321       auto availableVisualSize = finalSize;
 322       finalSize = naturalSize * std::max( ( naturalSize.width  ? ( availableVisualSize.width  / naturalSize.width  ) : 0 ),
 323                                           ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
 324
 325       auto originalOffset = finalOffset;
 326       finalOffset += ( availableVisualSize - finalSize ) * .5f;
 327
 328       float x = abs( (availableVisualSize.width - finalSize.width ) / finalSize.width )* .5f;
 329       float y = abs( (availableVisualSize.height - finalSize.height ) / finalSize.height ) * .5f;
 330       float widthRatio = 1.f - abs( (availableVisualSize.width - finalSize.width ) / finalSize.width );
 331       float heightRatio = 1.f - abs( (availableVisualSize.height - finalSize.height ) / finalSize.height );
 332       Vector4 pixelArea = Vector4( x, y, widthRatio, heightRatio);
 333       Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, pixelArea );
 334
 335       // populate the transform map
 336       transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, originalOffset )
 337                   .Add( Toolkit::Visual::Transform::Property::SIZE, availableVisualSize );
 338       break;
 339     }
 340     case Visual::FittingMode::CENTER:
 341     {
 342       auto availableVisualSize = finalSize;
 343       if( availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height )
 344       {
 345         finalSize = naturalSize;
 346       }
 347       else
 348       {
 349         finalSize = naturalSize * std::min( ( naturalSize.width  ? ( availableVisualSize.width  / naturalSize.width  ) : 0 ),
 350                                           ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
 351       }
 352
 353       finalOffset += ( availableVisualSize - finalSize ) * .5f;
 354
 355       // populate the transform map
 356       transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
 357                   .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
 358       break;
 359     }
 360     case Visual::FittingMode::FILL:
 361     {
 362       transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
 363                   .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
 364       break;
 365     }
 366     case Visual::FittingMode::FIT_WIDTH:
 367     case Visual::FittingMode::FIT_HEIGHT:
 368     {
 369       // This FittingMode already converted
 370       break;
 371     }
 372   }
 373 }
 374
 375 void ImageView::ApplyFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding , Property::Map& transformMap )
 376 {
 377     Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
 378
 379     // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
 380     if( mImageViewPixelAreaSetByFittingMode )
 381     {
 382       Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT );
 383       mImageViewPixelAreaSetByFittingMode = false;
 384     }
 385
 386     if( ( !zeroPadding ) || // If padding is not zero
 387         ( fittingMode != Visual::FittingMode::FILL ) )
 388     {
 389       mImageVisualPaddingSetByTransform = true;
 390
 391       // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
 392       if( fittingMode == Visual::FittingMode::FIT_WIDTH )
 393       {
 394         fittingMode = ( finalSize.height  / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
 395       }
 396       else if( fittingMode == Visual::FittingMode::FIT_HEIGHT )
 397       {
 398         fittingMode = ( finalSize.height  / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
 399       }
 400
 401       SetTransformMapForFittingMode( finalSize, naturalSize, finalOffset, fittingMode, transformMap );
 402
 403       // Set extra value for applying transformMap
 404       transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
 405                         Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
 406                   .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
 407                   .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
 408                   .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
 409                         Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
 410     }
 411     else if ( mImageVisualPaddingSetByTransform && zeroPadding )  // Reset offset to zero only if padding applied previously
 412     {
 413       mImageVisualPaddingSetByTransform = false;
 414       // Reset the transform map
 415       transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO )
 416                   .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
 417                         Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) )
 418                   .Add( Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE )
 419                   .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
 420                         Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) );
 421     }
 422 }
 423
 424 ///////////////////////////////////////////////////////////
 425 //
 426 // Properties
 427 //
 428
 429 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 430 {
 431   Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 432
 433   if ( imageView )
 434   {
 435     ImageView& impl = GetImpl( imageView );
 436     switch ( index )
 437     {
 438       case Toolkit::ImageView::Property::IMAGE:
 439       {
 440         std::string imageUrl;
 441         const Property::Map* map;
 442         if( value.Get( imageUrl ) )
 443         {
 444           impl.SetImage( imageUrl, ImageDimensions() );
 445         }
 446         // if its not a string then get a Property::Map from the property if possible.
 447         else
 448         {
 449           map = value.GetMap();
 450           if( map )
 451           {
 452             Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
 453             // set image only if property map contains image information other than custom shader
 454             if( map->Count() > 1u ||  !shaderValue )
 455             {
 456               impl.SetImage( *map );
 457             }
 458             // the property map contains only the custom shader
 459             else if( ( map->Count() == 1u )&&( shaderValue ) )
 460             {
 461               Property::Map* shaderMap = shaderValue->GetMap();
 462               if( shaderMap )
 463               {
 464                 impl.mShaderMap = *shaderMap;
 465
 466                 if( !impl.mUrl.empty() )
 467                 {
 468                   impl.SetImage( impl.mUrl, impl.mImageSize );
 469                 }
 470                 else if( !impl.mPropertyMap.Empty() )
 471                 {
 472                   impl.SetImage( impl.mPropertyMap );
 473                 }
 474               }
 475             }
 476           }
 477         }
 478         break;
 479       }
 480
 481       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 482       {
 483         bool isPre;
 484         if( value.Get( isPre ) )
 485         {
 486           impl.EnablePreMultipliedAlpha( isPre );
 487         }
 488         break;
 489       }
 490     }
 491   }
 492 }
 493
 494 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 495 {
 496   Property::Value value;
 497
 498   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 499
 500   if ( imageview )
 501   {
 502     ImageView& impl = GetImpl( imageview );
 503     switch ( propertyIndex )
 504     {
 505       case Toolkit::ImageView::Property::IMAGE:
 506       {
 507         if ( !impl.mUrl.empty() )
 508         {
 509           value = impl.mUrl;
 510         }
 511         else
 512         {
 513           Property::Map map;
 514           Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
 515           if( visual )
 516           {
 517             visual.CreatePropertyMap( map );
 518           }
 519           value = map;
 520         }
 521         break;
 522       }
 523
 524       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 525       {
 526         value = impl.IsPreMultipliedAlphaEnabled();
 527         break;
 528       }
 529     }
 530   }
 531
 532   return value;
 533 }
 534
 535 } // namespace Internal
 536 } // namespace Toolkit
 537 } // namespace Dali