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/object/type-registry.h>
23 #include <dali/public-api/object/type-registry-helper.h>
24 #include <dali/devel-api/scripting/scripting.h>
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>
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, "image", MAP, IMAGE )
58 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
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()
63 } // anonymous namespace
67 ImageView::ImageView()
68 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
70 mImageVisualPaddingSetByTransform( false ),
71 mImageViewPixelAreaSetByFittingMode( false )
75 ImageView::~ImageView()
79 Toolkit::ImageView ImageView::New()
81 ImageView* impl = new ImageView();
83 Toolkit::ImageView handle = Toolkit::ImageView( *impl );
85 // Second-phase init of the implementation
86 // This can only be done after the CustomActor connection has been made...
92 /////////////////////////////////////////////////////////////
94 void ImageView::OnInitialize()
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 );
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 ) );
105 //Enable highightability
106 Self().SetProperty( Toolkit::DevelControl::Property::ACCESSIBILITY_HIGHLIGHTABLE, true );
110 void ImageView::SetImage( const Property::Map& map )
112 // Comparing a property map is too expensive so just creating a new visual
116 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
119 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
125 if( !mShaderMap.Empty() )
127 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
128 visualImpl.SetCustomShader( mShaderMap );
131 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
135 // Unregister the exsiting visual
136 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
138 // Trigger a size negotiation request that may be needed when unregistering a visual.
142 // Signal that a Relayout may be needed
145 void ImageView::SetImage( const std::string& url, ImageDimensions size )
147 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
150 mPropertyMap.Clear();
152 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
153 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
161 if( !mShaderMap.Empty() )
163 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
164 visualImpl.SetCustomShader( mShaderMap );
167 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
171 // Unregister the exsiting visual
172 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
174 // Trigger a size negotiation request that may be needed when unregistering a visual.
178 // Signal that a Relayout may be needed
181 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
185 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
189 bool ImageView::IsPreMultipliedAlphaEnabled() const
193 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
198 void ImageView::SetDepthIndex( int depthIndex )
202 mVisual.SetDepthIndex( depthIndex );
206 Vector3 ImageView::GetNaturalSize()
210 Vector2 rendererNaturalSize;
211 mVisual.GetNaturalSize( rendererNaturalSize );
214 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
216 rendererNaturalSize.width += ( padding.start + padding.end );
217 rendererNaturalSize.height += ( padding.top + padding.bottom );
218 return Vector3( rendererNaturalSize );
221 // if no visual then use Control's natural size
222 return Control::GetNaturalSize();
225 float ImageView::GetHeightForWidth( float width )
228 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
232 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
236 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
240 float ImageView::GetWidthForHeight( float height )
243 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
247 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
251 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
255 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
257 Control::OnRelayout( size, container );
260 Property::Map transformMap = Property::Map();
262 Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
264 bool zeroPadding = ( padding == Extents() );
267 mVisual.GetNaturalSize( naturalSize );
269 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
270 Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
271 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
273 std::swap( padding.start, padding.end );
276 // remove padding from the size to know how much is left for the visual
277 Vector2 finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
278 Vector2 finalOffset = Vector2( padding.start, padding.top );
280 ApplyFittingMode( finalSize, naturalSize, finalOffset, zeroPadding , transformMap );
282 mVisual.SetTransformAndSize( transformMap, size );
284 // mVisual is not updated util the resource is ready in the case of visual replacement.
285 // in this case, the Property Map must be initialized so that the previous value is not reused.
286 // after mVisual is updated, the correct value will be reset.
287 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
288 if( visual && visual != mVisual )
290 visual.SetTransformAndSize( Property::Map(), size );
295 void ImageView::OnResourceReady( Toolkit::Control control )
297 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
298 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
299 // Signal that a Relayout may be needed
302 void ImageView::SetTransformMapForFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap )
306 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
308 auto availableVisualSize = finalSize;
310 // scale to fit the padded area
311 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
312 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
314 // calculate final offset within the padded area
315 finalOffset += ( availableVisualSize - finalSize ) * .5f;
317 // populate the transform map
318 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
319 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
322 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
324 mImageViewPixelAreaSetByFittingMode = true;
325 auto availableVisualSize = finalSize;
326 finalSize = naturalSize * std::max( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
327 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
329 auto originalOffset = finalOffset;
330 finalOffset += ( availableVisualSize - finalSize ) * .5f;
332 float x = abs( (availableVisualSize.width - finalSize.width ) / finalSize.width )* .5f;
333 float y = abs( (availableVisualSize.height - finalSize.height ) / finalSize.height ) * .5f;
334 float widthRatio = 1.f - abs( (availableVisualSize.width - finalSize.width ) / finalSize.width );
335 float heightRatio = 1.f - abs( (availableVisualSize.height - finalSize.height ) / finalSize.height );
336 Vector4 pixelArea = Vector4( x, y, widthRatio, heightRatio);
337 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, pixelArea );
339 // populate the transform map
340 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, originalOffset )
341 .Add( Toolkit::Visual::Transform::Property::SIZE, availableVisualSize );
344 case Visual::FittingMode::CENTER:
346 auto availableVisualSize = finalSize;
347 if( availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height )
349 finalSize = naturalSize;
353 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
354 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
357 finalOffset += ( availableVisualSize - finalSize ) * .5f;
359 // populate the transform map
360 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
361 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
364 case Visual::FittingMode::FILL:
366 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
367 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
370 case Visual::FittingMode::FIT_WIDTH:
371 case Visual::FittingMode::FIT_HEIGHT:
373 // This FittingMode already converted
379 void ImageView::ApplyFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding , Property::Map& transformMap )
381 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
383 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
384 if( mImageViewPixelAreaSetByFittingMode )
386 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT );
387 mImageViewPixelAreaSetByFittingMode = false;
390 if( ( !zeroPadding ) || // If padding is not zero
391 ( fittingMode != Visual::FittingMode::FILL ) )
393 mImageVisualPaddingSetByTransform = true;
395 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
396 if( fittingMode == Visual::FittingMode::FIT_WIDTH )
398 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
400 else if( fittingMode == Visual::FittingMode::FIT_HEIGHT )
402 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
405 SetTransformMapForFittingMode( finalSize, naturalSize, finalOffset, fittingMode, transformMap );
407 // Set extra value for applying transformMap
408 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
409 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
410 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
411 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
412 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
413 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
415 else if ( mImageVisualPaddingSetByTransform && zeroPadding ) // Reset offset to zero only if padding applied previously
417 mImageVisualPaddingSetByTransform = false;
418 // Reset the transform map
419 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO )
420 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
421 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) )
422 .Add( Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE )
423 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
424 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) );
428 ///////////////////////////////////////////////////////////
433 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
435 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
439 ImageView& impl = GetImpl( imageView );
442 case Toolkit::ImageView::Property::IMAGE:
444 std::string imageUrl;
445 const Property::Map* map;
446 if( value.Get( imageUrl ) )
448 impl.SetImage( imageUrl, ImageDimensions() );
450 // if its not a string then get a Property::Map from the property if possible.
453 map = value.GetMap();
456 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
457 // set image only if property map contains image information other than custom shader
458 if( map->Count() > 1u || !shaderValue )
460 impl.SetImage( *map );
462 // the property map contains only the custom shader
463 else if( ( map->Count() == 1u )&&( shaderValue ) )
465 Property::Map* shaderMap = shaderValue->GetMap();
468 impl.mShaderMap = *shaderMap;
470 if( !impl.mUrl.empty() )
472 impl.SetImage( impl.mUrl, impl.mImageSize );
474 else if( !impl.mPropertyMap.Empty() )
476 impl.SetImage( impl.mPropertyMap );
485 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
488 if( value.Get( isPre ) )
490 impl.EnablePreMultipliedAlpha( isPre );
498 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
500 Property::Value value;
502 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
506 ImageView& impl = GetImpl( imageview );
507 switch ( propertyIndex )
509 case Toolkit::ImageView::Property::IMAGE:
511 if ( !impl.mUrl.empty() )
518 Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
521 visual.CreatePropertyMap( map );
528 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
530 value = impl.IsPreMultipliedAlphaEnabled();
539 } // namespace Internal
540 } // namespace Toolkit