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
 275     Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
 276           Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
 277
 278     if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
 279     {
 280       std::swap( padding.start, padding.end );
 281     }
 282
 283     auto finalOffset = Vector2( padding.start, padding.top );
 284
 285     // remove padding from the size to know how much is left for the visual
 286     auto finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
 287
 288     // Should provide a transform that handles aspect ratio according to image size
 289     if( Toolkit::GetImplementation(mVisual).GetFittingMode() == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO )
 290     {
 291       auto availableVisualSize = finalSize;
 292
 293       Vector2 naturalSize;
 294       mVisual.GetNaturalSize( naturalSize );
 295
 296       // scale to fit the padded area
 297       finalSize = naturalSize * std::min( ( naturalSize.width  ? ( availableVisualSize.width  / naturalSize.width  ) : 0 ),
 298                                           ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
 299
 300       // calculate final offset within the padded area
 301       finalOffset += ( availableVisualSize - finalSize ) * .5f;
 302     }
 303
 304     // populate the transform map
 305     transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
 306                 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
 307                     Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
 308                 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
 309                 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
 310                 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize )
 311                 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
 312                     Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
 313
 314     mVisual.SetTransformAndSize( transformMap, size );
 315   }
 316 }
 317
 318 void ImageView::OnResourceReady( Toolkit::Control control )
 319 {
 320   // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
 321   mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
 322 }
 323
 324 ///////////////////////////////////////////////////////////
 325 //
 326 // Properties
 327 //
 328
 329 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 330 {
 331   Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 332
 333   if ( imageView )
 334   {
 335     ImageView& impl = GetImpl( imageView );
 336     switch ( index )
 337     {
 338       case Toolkit::ImageView::Property::RESOURCE_URL:
 339       {
 340         std::string imageUrl;
 341         if( value.Get( imageUrl ) )
 342         {
 343           impl.SetImage( imageUrl, ImageDimensions() );
 344         }
 345         break;
 346       }
 347
 348       case Toolkit::ImageView::Property::IMAGE:
 349       {
 350         std::string imageUrl;
 351         Property::Map* map;
 352         if( value.Get( imageUrl ) )
 353         {
 354           impl.SetImage( imageUrl, ImageDimensions() );
 355         }
 356         // if its not a string then get a Property::Map from the property if possible.
 357         else
 358         {
 359           map = value.GetMap();
 360           if( map )
 361           {
 362             Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
 363             // set image only if property map contains image information other than custom shader
 364             if( map->Count() > 1u ||  !shaderValue )
 365             {
 366               impl.SetImage( *map );
 367             }
 368             // the property map contains only the custom shader
 369             else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
 370             {
 371               Property::Map* shaderMap = shaderValue->GetMap();
 372               if( shaderMap )
 373               {
 374                 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
 375                 visual.SetCustomShader( *shaderMap );
 376                 if( imageView.OnStage() )
 377                 {
 378                   // force to create new core renderer to use the newly set shader
 379                   visual.SetOffStage( imageView );
 380                   visual.SetOnStage( imageView );
 381                 }
 382               }
 383             }
 384           }
 385         }
 386         break;
 387       }
 388
 389       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 390       {
 391         bool isPre;
 392         if( value.Get( isPre ) )
 393         {
 394           impl.EnablePreMultipliedAlpha( isPre );
 395         }
 396         break;
 397       }
 398     }
 399   }
 400 }
 401
 402 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 403 {
 404   Property::Value value;
 405
 406   Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
 407
 408   if ( imageview )
 409   {
 410     ImageView& impl = GetImpl( imageview );
 411     switch ( propertyIndex )
 412     {
 413       case Toolkit::ImageView::Property::RESOURCE_URL:
 414       {
 415         if ( !impl.mUrl.empty() )
 416         {
 417           value = impl.mUrl;
 418         }
 419         break;
 420       }
 421
 422       case Toolkit::ImageView::Property::IMAGE:
 423       {
 424         if ( !impl.mUrl.empty() )
 425         {
 426           value = impl.mUrl;
 427         }
 428         else if( impl.mImage )
 429         {
 430           Property::Map map;
 431           Scripting::CreatePropertyMap( impl.mImage, map );
 432           value = map;
 433         }
 434         else if( !impl.mPropertyMap.Empty() )
 435         {
 436           value = impl.mPropertyMap;
 437         }
 438         break;
 439       }
 440
 441       case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
 442       {
 443         value = impl.IsPreMultipliedAlphaEnabled();
 444         break;
 445       }
 446     }
 447   }
 448
 449   return value;
 450 }
 451
 452 } // namespace Internal
 453 } // namespace Toolkit
 454 } // namespace Dali