/*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include "image-view-impl.h"
// EXTERNAL INCLUDES
-#include <dali/public-api/images/resource-image.h>
#include <dali/public-api/object/type-registry.h>
#include <dali/public-api/object/type-registry-helper.h>
#include <dali/devel-api/scripting/scripting.h>
// INTERNAL INCLUDES
#include <dali-toolkit/public-api/controls/image-view/image-view.h>
#include <dali-toolkit/devel-api/controls/control-devel.h>
-#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
#include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
#include <dali-toolkit/internal/visuals/visual-string-constants.h>
#include <dali-toolkit/internal/visuals/visual-base-impl.h>
namespace
{
+const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
+
BaseHandle Create()
{
return Toolkit::ImageView::New();
// Setup properties, signals and actions using the type-registry.
DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
-DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "resourceUrl", STRING, RESOURCE_URL )
DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
using namespace Dali;
ImageView::ImageView()
-: Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) )
+: Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
+ mImageSize(),
+ mImageVisualPaddingSetByTransform( false ),
+ mImageViewPixelAreaSetByFittingMode( false )
{
}
{
// ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
Dali::Toolkit::Control handle( GetOwner() );
- Toolkit::DevelControl::ResourceReadySignal( handle ).Connect( this, &ImageView::OnResourceReady );
-}
-
-void ImageView::SetImage( Image image )
-{
- // Don't bother comparing if we had a visual previously, just drop old visual and create new one
- mImage = image;
- mUrl.clear();
- mPropertyMap.Clear();
-
- Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
- if (!mVisual)
- {
- mVisual = visual;
- }
-
- DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
+ handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
}
void ImageView::SetImage( const Property::Map& map )
// Comparing a property map is too expensive so just creating a new visual
mPropertyMap = map;
mUrl.clear();
- mImage.Reset();
+
Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
- // Don't set mVisual until it is ready and shown. Getters will still use current visual.
- if (!mVisual)
+ if( visual )
+ {
+ // Don't set mVisual until it is ready and shown. Getters will still use current visual.
+ if( !mVisual )
+ {
+ mVisual = visual;
+ }
+
+ if( !mShaderMap.Empty() )
+ {
+ Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
+ visualImpl.SetCustomShader( mShaderMap );
+ }
+
+ DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
+ }
+ else
{
- mVisual = visual;
+ // Unregister the exsiting visual
+ DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
+
+ // Trigger a size negotiation request that may be needed when unregistering a visual.
+ RelayoutRequest();
}
- DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
+ // Signal that a Relayout may be needed
}
void ImageView::SetImage( const std::string& url, ImageDimensions size )
{
// Don't bother comparing if we had a visual previously, just drop old visual and create new one
mUrl = url;
- mImage.Reset();
+ mImageSize = size;
mPropertyMap.Clear();
// Don't set mVisual until it is ready and shown. Getters will still use current visual.
Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
- if (!mVisual)
+ if( visual )
{
- mVisual = visual;
+ if( !mVisual )
+ {
+ mVisual = visual;
+ }
+
+ if( !mShaderMap.Empty() )
+ {
+ Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
+ visualImpl.SetCustomShader( mShaderMap );
+ }
+
+ DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
}
+ else
+ {
+ // Unregister the exsiting visual
+ DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
- DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
-}
+ // Trigger a size negotiation request that may be needed when unregistering a visual.
+ RelayoutRequest();
+ }
-Image ImageView::GetImage() const
-{
- return mImage;
+ // Signal that a Relayout may be needed
}
void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
{
Vector2 rendererNaturalSize;
mVisual.GetNaturalSize( rendererNaturalSize );
+
+ Extents padding;
+ padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+ rendererNaturalSize.width += ( padding.start + padding.end );
+ rendererNaturalSize.height += ( padding.top + padding.bottom );
return Vector3( rendererNaturalSize );
}
float ImageView::GetHeightForWidth( float width )
{
+ Extents padding;
+ padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
if( mVisual )
{
- return mVisual.GetHeightForWidth( width );
+ return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
}
else
{
- return Control::GetHeightForWidth( width );
+ return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
}
}
float ImageView::GetWidthForHeight( float height )
{
+ Extents padding;
+ padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
if( mVisual )
{
- return mVisual.GetWidthForHeight( height );
+ return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
}
else
{
- return Control::GetWidthForHeight( height );
+ return Control::GetWidthForHeight( height ) + padding.start + padding.end;
}
}
void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
{
Control::OnRelayout( size, container );
+ if( mVisual )
+ {
+ Property::Map transformMap = Property::Map();
+
+ Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+ bool zeroPadding = ( padding == Extents() );
+
+ Vector2 naturalSize;
+ mVisual.GetNaturalSize( naturalSize );
+
+ Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
+ Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
+ if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
+ {
+ std::swap( padding.start, padding.end );
+ }
+
+ // remove padding from the size to know how much is left for the visual
+ Vector2 finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
+ Vector2 finalOffset = Vector2( padding.start, padding.top );
+
+ ApplyFittingMode( finalSize, naturalSize, finalOffset, zeroPadding , transformMap );
+
+ mVisual.SetTransformAndSize( transformMap, size );
- // If visual is being replaced then mVisual will be the replacement visual even if not ready.
+ // mVisual is not updated util the resource is ready in the case of visual replacement.
+ // in this case, the Property Map must be initialized so that the previous value is not reused.
+ // after mVisual is updated, the correct value will be reset.
+ Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
+ if( visual && visual != mVisual )
+ {
+ visual.SetTransformAndSize( Property::Map(), size );
+ }
+ }
+}
+
+void ImageView::OnResourceReady( Toolkit::Control control )
+{
+ // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
+ // Signal that a Relayout may be needed
+}
- if( mVisual )
+void ImageView::SetTransformMapForFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap )
+{
+ switch(fittingMode)
{
- // Pass in an empty map which uses default transform values meaning our visual fills the control
- // Should provide a transform that handles aspect ratio according to image size
- mVisual.SetTransformAndSize( Property::Map(), size );
+ case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
+ {
+ auto availableVisualSize = finalSize;
+
+ // scale to fit the padded area
+ finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
+ ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
+
+ // calculate final offset within the padded area
+ finalOffset += ( availableVisualSize - finalSize ) * .5f;
+
+ // populate the transform map
+ transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
+ .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
+ break;
+ }
+ case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
+ {
+ mImageViewPixelAreaSetByFittingMode = true;
+ auto availableVisualSize = finalSize;
+ finalSize = naturalSize * std::max( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
+ ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
+
+ auto originalOffset = finalOffset;
+ finalOffset += ( availableVisualSize - finalSize ) * .5f;
+
+ float x = abs( (availableVisualSize.width - finalSize.width ) / finalSize.width )* .5f;
+ float y = abs( (availableVisualSize.height - finalSize.height ) / finalSize.height ) * .5f;
+ float widthRatio = 1.f - abs( (availableVisualSize.width - finalSize.width ) / finalSize.width );
+ float heightRatio = 1.f - abs( (availableVisualSize.height - finalSize.height ) / finalSize.height );
+ Vector4 pixelArea = Vector4( x, y, widthRatio, heightRatio);
+ Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, pixelArea );
+
+ // populate the transform map
+ transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, originalOffset )
+ .Add( Toolkit::Visual::Transform::Property::SIZE, availableVisualSize );
+ break;
+ }
+ case Visual::FittingMode::CENTER:
+ {
+ auto availableVisualSize = finalSize;
+ if( availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height )
+ {
+ finalSize = naturalSize;
+ }
+ else
+ {
+ finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
+ ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
+ }
+
+ finalOffset += ( availableVisualSize - finalSize ) * .5f;
+
+ // populate the transform map
+ transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
+ .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
+ break;
+ }
+ case Visual::FittingMode::FILL:
+ {
+ transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
+ .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
+ break;
+ }
+ case Visual::FittingMode::FIT_WIDTH:
+ case Visual::FittingMode::FIT_HEIGHT:
+ {
+ // This FittingMode already converted
+ break;
+ }
}
}
-void ImageView::OnResourceReady( Toolkit::Control control )
+void ImageView::ApplyFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding , Property::Map& transformMap )
{
+ Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
+
+ // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
+ if( mImageViewPixelAreaSetByFittingMode )
+ {
+ Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT );
+ mImageViewPixelAreaSetByFittingMode = false;
+ }
+
+ if( ( !zeroPadding ) || // If padding is not zero
+ ( fittingMode != Visual::FittingMode::FILL ) )
+ {
+ mImageVisualPaddingSetByTransform = true;
+
+ // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
+ if( fittingMode == Visual::FittingMode::FIT_WIDTH )
+ {
+ fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
+ }
+ else if( fittingMode == Visual::FittingMode::FIT_HEIGHT )
+ {
+ fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
+ }
+
+ SetTransformMapForFittingMode( finalSize, naturalSize, finalOffset, fittingMode, transformMap );
+
+ // Set extra value for applying transformMap
+ transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
+ Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+ .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
+ .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
+ .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
+ Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
+ }
+ else if ( mImageVisualPaddingSetByTransform && zeroPadding ) // Reset offset to zero only if padding applied previously
+ {
+ mImageVisualPaddingSetByTransform = false;
+ // Reset the transform map
+ transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO )
+ .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
+ Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) )
+ .Add( Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE )
+ .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
+ Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) );
+ }
}
///////////////////////////////////////////////////////////
ImageView& impl = GetImpl( imageView );
switch ( index )
{
- case Toolkit::ImageView::Property::RESOURCE_URL:
- {
- std::string imageUrl;
- if( value.Get( imageUrl ) )
- {
- impl.SetImage( imageUrl, ImageDimensions() );
- }
- break;
- }
-
case Toolkit::ImageView::Property::IMAGE:
{
std::string imageUrl;
- Property::Map* map;
+ const Property::Map* map;
if( value.Get( imageUrl ) )
{
impl.SetImage( imageUrl, ImageDimensions() );
map = value.GetMap();
if( map )
{
- Property::Value* shaderValue = map->Find( Toolkit::DevelVisual::Property::SHADER, CUSTOM_SHADER );
+ Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
// set image only if property map contains image information other than custom shader
if( map->Count() > 1u || !shaderValue )
{
impl.SetImage( *map );
}
// the property map contains only the custom shader
- else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
+ else if( ( map->Count() == 1u )&&( shaderValue ) )
{
Property::Map* shaderMap = shaderValue->GetMap();
if( shaderMap )
{
- Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
- visual.SetCustomShader( *shaderMap );
- if( imageView.OnStage() )
+ impl.mShaderMap = *shaderMap;
+
+ if( !impl.mUrl.empty() )
{
- // force to create new core renderer to use the newly set shader
- visual.SetOffStage( imageView );
- visual.SetOnStage( imageView );
+ impl.SetImage( impl.mUrl, impl.mImageSize );
+ }
+ else if( !impl.mPropertyMap.Empty() )
+ {
+ impl.SetImage( impl.mPropertyMap );
}
}
}
ImageView& impl = GetImpl( imageview );
switch ( propertyIndex )
{
- case Toolkit::ImageView::Property::RESOURCE_URL:
- {
- if ( !impl.mUrl.empty() )
- {
- value = impl.mUrl;
- }
- break;
- }
-
case Toolkit::ImageView::Property::IMAGE:
{
if ( !impl.mUrl.empty() )
{
value = impl.mUrl;
}
- else if( impl.mImage )
+ else
{
Property::Map map;
- Scripting::CreatePropertyMap( impl.mImage, map );
+ Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
+ if( visual )
+ {
+ visual.CreatePropertyMap( map );
+ }
value = map;
}
- else if( !impl.mPropertyMap.Empty() )
- {
- value = impl.mPropertyMap;
- }
break;
}