2 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "image-view-impl.h"
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>
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>
48 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
52 return Toolkit::ImageView::New();
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, "reservedProperty01", STRING, RESERVED_PROPERTY_01 )
58 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
59 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
61 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA )
62 DALI_TYPE_REGISTRATION_END()
64 } // anonymous namespace
68 ImageView::ImageView()
69 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
71 mImageVisualPaddingSetByTransform( false ),
72 mImageViewPixelAreaSetByFittingMode( false )
76 ImageView::~ImageView()
80 Toolkit::ImageView ImageView::New()
82 ImageView* impl = new ImageView();
84 Toolkit::ImageView handle = Toolkit::ImageView( *impl );
86 // Second-phase init of the implementation
87 // This can only be done after the CustomActor connection has been made...
93 /////////////////////////////////////////////////////////////
95 void ImageView::OnInitialize()
97 // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
98 Dali::Toolkit::Control handle( GetOwner() );
99 handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
102 void ImageView::SetImage( Image image )
104 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
107 mPropertyMap.Clear();
109 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
117 if( !mShaderMap.Empty() )
119 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
120 visualImpl.SetCustomShader( mShaderMap );
123 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
127 // Unregister the existing visual
128 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
130 // Trigger a size negotiation request that may be needed when unregistering a visual.
134 // Signal that a Relayout may be needed
137 void ImageView::SetImage( const Property::Map& map )
139 // Comparing a property map is too expensive so just creating a new visual
144 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
147 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
153 if( !mShaderMap.Empty() )
155 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
156 visualImpl.SetCustomShader( mShaderMap );
159 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
163 // Unregister the exsiting visual
164 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
166 // Trigger a size negotiation request that may be needed when unregistering a visual.
170 // Signal that a Relayout may be needed
173 void ImageView::SetImage( const std::string& url, ImageDimensions size )
175 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
179 mPropertyMap.Clear();
181 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
182 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
190 if( !mShaderMap.Empty() )
192 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
193 visualImpl.SetCustomShader( mShaderMap );
196 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
200 // Unregister the exsiting visual
201 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
203 // Trigger a size negotiation request that may be needed when unregistering a visual.
207 // Signal that a Relayout may be needed
210 Image ImageView::GetImage() const
215 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
219 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
223 bool ImageView::IsPreMultipliedAlphaEnabled() const
227 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
232 void ImageView::SetDepthIndex( int depthIndex )
236 mVisual.SetDepthIndex( depthIndex );
240 void ImageView::OnStageConnection( int depth )
244 mImage.UploadedSignal().Emit( mImage );
247 Dali::ResourceImage resourceImage = Dali::ResourceImage::DownCast( mImage );
250 resourceImage.LoadingFinishedSignal().Emit( resourceImage );
253 Control::OnStageConnection( depth ); // Enabled visuals will be put on stage
256 Vector3 ImageView::GetNaturalSize()
260 Vector2 rendererNaturalSize;
261 mVisual.GetNaturalSize( rendererNaturalSize );
264 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
266 rendererNaturalSize.width += ( padding.start + padding.end );
267 rendererNaturalSize.height += ( padding.top + padding.bottom );
268 return Vector3( rendererNaturalSize );
271 // if no visual then use Control's natural size
272 return Control::GetNaturalSize();
275 float ImageView::GetHeightForWidth( float width )
278 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
282 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
286 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
290 float ImageView::GetWidthForHeight( float height )
293 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
297 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
301 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
305 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
307 Control::OnRelayout( size, container );
310 Property::Map transformMap = Property::Map();
312 Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
314 bool zeroPadding = ( padding == Extents() );
317 mVisual.GetNaturalSize( naturalSize );
319 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
320 Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
321 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
323 std::swap( padding.start, padding.end );
326 // remove padding from the size to know how much is left for the visual
327 Vector2 finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
328 Vector2 finalOffset = Vector2( padding.start, padding.top );
330 ApplyFittingMode( finalSize, naturalSize, finalOffset, zeroPadding , transformMap );
332 mVisual.SetTransformAndSize( transformMap, size );
334 // mVisual is not updated util the resource is ready in the case of visual replacement.
335 // So apply the transform and size to the new visual.
336 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
337 if( visual && visual != mVisual )
339 visual.SetTransformAndSize( transformMap, size );
344 void ImageView::OnResourceReady( Toolkit::Control control )
346 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
347 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
348 // Signal that a Relayout may be needed
351 void ImageView::SetTransformMapForFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap )
355 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
357 auto availableVisualSize = finalSize;
359 // scale to fit the padded area
360 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
361 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
363 // calculate final offset within the padded area
364 finalOffset += ( availableVisualSize - finalSize ) * .5f;
366 // populate the transform map
367 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
368 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
371 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
373 mImageViewPixelAreaSetByFittingMode = true;
374 auto availableVisualSize = finalSize;
375 finalSize = naturalSize * std::max( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
376 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
378 auto originalOffset = finalOffset;
379 finalOffset += ( availableVisualSize - finalSize ) * .5f;
381 float x = abs( (availableVisualSize.width - finalSize.width ) / finalSize.width )* .5f;
382 float y = abs( (availableVisualSize.height - finalSize.height ) / finalSize.height ) * .5f;
383 float widthRatio = 1.f - abs( (availableVisualSize.width - finalSize.width ) / finalSize.width );
384 float heightRatio = 1.f - abs( (availableVisualSize.height - finalSize.height ) / finalSize.height );
385 Vector4 pixelArea = Vector4( x, y, widthRatio, heightRatio);
386 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, pixelArea );
388 // populate the transform map
389 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, originalOffset )
390 .Add( Toolkit::Visual::Transform::Property::SIZE, availableVisualSize );
393 case Visual::FittingMode::CENTER:
395 auto availableVisualSize = finalSize;
396 if( availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height )
398 finalSize = naturalSize;
402 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
403 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
406 finalOffset += ( availableVisualSize - finalSize ) * .5f;
408 // populate the transform map
409 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
410 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
413 case Visual::FittingMode::FILL:
415 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
416 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
419 case Visual::FittingMode::FIT_WIDTH:
420 case Visual::FittingMode::FIT_HEIGHT:
422 // This FittingMode already converted
428 void ImageView::ApplyFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding , Property::Map& transformMap )
430 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
432 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
433 if( mImageViewPixelAreaSetByFittingMode )
435 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT );
436 mImageViewPixelAreaSetByFittingMode = false;
439 if( ( !zeroPadding ) || // If padding is not zero
440 ( fittingMode != Visual::FittingMode::FILL ) )
442 mImageVisualPaddingSetByTransform = true;
444 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
445 if( fittingMode == Visual::FittingMode::FIT_WIDTH )
447 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
449 else if( fittingMode == Visual::FittingMode::FIT_HEIGHT )
451 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
454 SetTransformMapForFittingMode( finalSize, naturalSize, finalOffset, fittingMode, transformMap );
456 // Set extra value for applying transformMap
457 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
458 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
459 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
460 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
461 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
462 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
464 else if ( mImageVisualPaddingSetByTransform && zeroPadding ) // Reset offset to zero only if padding applied previously
466 mImageVisualPaddingSetByTransform = false;
467 // Reset the transform map
468 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO )
469 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
470 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) )
471 .Add( Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE )
472 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
473 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) );
477 ///////////////////////////////////////////////////////////
482 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
484 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
488 ImageView& impl = GetImpl( imageView );
491 case Toolkit::ImageView::Property::IMAGE:
493 std::string imageUrl;
495 if( value.Get( imageUrl ) )
497 impl.SetImage( imageUrl, ImageDimensions() );
499 // if its not a string then get a Property::Map from the property if possible.
502 map = value.GetMap();
505 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
506 // set image only if property map contains image information other than custom shader
507 if( map->Count() > 1u || !shaderValue )
509 impl.SetImage( *map );
511 // the property map contains only the custom shader
512 else if( ( map->Count() == 1u )&&( shaderValue ) )
514 Property::Map* shaderMap = shaderValue->GetMap();
517 impl.mShaderMap = *shaderMap;
519 if( !impl.mUrl.empty() )
521 impl.SetImage( impl.mUrl, impl.mImageSize );
523 else if( impl.mImage )
525 impl.SetImage( impl.mImage );
527 else if( !impl.mPropertyMap.Empty() )
529 impl.SetImage( impl.mPropertyMap );
538 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
541 if( value.Get( isPre ) )
543 impl.EnablePreMultipliedAlpha( isPre );
551 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
553 Property::Value value;
555 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
559 ImageView& impl = GetImpl( imageview );
560 switch ( propertyIndex )
562 case Toolkit::ImageView::Property::IMAGE:
564 if ( !impl.mUrl.empty() )
568 else if( impl.mImage )
571 Scripting::CreatePropertyMap( impl.mImage, map );
577 Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
580 visual.CreatePropertyMap( map );
587 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
589 value = impl.IsPreMultipliedAlphaEnabled();
598 } // namespace Internal
599 } // namespace Toolkit