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