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 ) );
106 void ImageView::SetImage( const Property::Map& map )
108 // Comparing a property map is too expensive so just creating a new visual
112 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
115 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
121 if( !mShaderMap.Empty() )
123 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
124 visualImpl.SetCustomShader( mShaderMap );
127 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
131 // Unregister the exsiting visual
132 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
134 // Trigger a size negotiation request that may be needed when unregistering a visual.
138 // Signal that a Relayout may be needed
141 void ImageView::SetImage( const std::string& url, ImageDimensions size )
143 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
146 mPropertyMap.Clear();
148 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
149 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
157 if( !mShaderMap.Empty() )
159 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
160 visualImpl.SetCustomShader( mShaderMap );
163 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
167 // Unregister the exsiting visual
168 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
170 // Trigger a size negotiation request that may be needed when unregistering a visual.
174 // Signal that a Relayout may be needed
177 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
181 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
185 bool ImageView::IsPreMultipliedAlphaEnabled() const
189 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
194 void ImageView::SetDepthIndex( int depthIndex )
198 mVisual.SetDepthIndex( depthIndex );
202 Vector3 ImageView::GetNaturalSize()
206 Vector2 rendererNaturalSize;
207 mVisual.GetNaturalSize( rendererNaturalSize );
210 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
212 rendererNaturalSize.width += ( padding.start + padding.end );
213 rendererNaturalSize.height += ( padding.top + padding.bottom );
214 return Vector3( rendererNaturalSize );
217 // if no visual then use Control's natural size
218 return Control::GetNaturalSize();
221 float ImageView::GetHeightForWidth( float width )
224 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
228 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
232 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
236 float ImageView::GetWidthForHeight( float height )
239 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
243 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
247 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
251 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
253 Control::OnRelayout( size, container );
256 Property::Map transformMap = Property::Map();
258 Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
260 bool zeroPadding = ( padding == Extents() );
263 mVisual.GetNaturalSize( naturalSize );
265 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
266 Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
267 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
269 std::swap( padding.start, padding.end );
272 // remove padding from the size to know how much is left for the visual
273 Vector2 finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
274 Vector2 finalOffset = Vector2( padding.start, padding.top );
276 ApplyFittingMode( finalSize, naturalSize, finalOffset, zeroPadding , transformMap );
278 mVisual.SetTransformAndSize( transformMap, size );
280 // mVisual is not updated util the resource is ready in the case of visual replacement.
281 // in this case, the Property Map must be initialized so that the previous value is not reused.
282 // after mVisual is updated, the correct value will be reset.
283 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
284 if( visual && visual != mVisual )
286 visual.SetTransformAndSize( Property::Map(), size );
291 void ImageView::OnResourceReady( Toolkit::Control control )
293 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
294 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
295 // Signal that a Relayout may be needed
298 void ImageView::SetTransformMapForFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap )
302 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
304 auto availableVisualSize = finalSize;
306 // scale to fit the padded area
307 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
308 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
310 // calculate final offset within the padded area
311 finalOffset += ( availableVisualSize - finalSize ) * .5f;
313 // populate the transform map
314 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
315 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
318 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
320 mImageViewPixelAreaSetByFittingMode = true;
321 auto availableVisualSize = finalSize;
322 finalSize = naturalSize * std::max( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
323 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
325 auto originalOffset = finalOffset;
326 finalOffset += ( availableVisualSize - finalSize ) * .5f;
328 float x = abs( (availableVisualSize.width - finalSize.width ) / finalSize.width )* .5f;
329 float y = abs( (availableVisualSize.height - finalSize.height ) / finalSize.height ) * .5f;
330 float widthRatio = 1.f - abs( (availableVisualSize.width - finalSize.width ) / finalSize.width );
331 float heightRatio = 1.f - abs( (availableVisualSize.height - finalSize.height ) / finalSize.height );
332 Vector4 pixelArea = Vector4( x, y, widthRatio, heightRatio);
333 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, pixelArea );
335 // populate the transform map
336 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, originalOffset )
337 .Add( Toolkit::Visual::Transform::Property::SIZE, availableVisualSize );
340 case Visual::FittingMode::CENTER:
342 auto availableVisualSize = finalSize;
343 if( availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height )
345 finalSize = naturalSize;
349 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
350 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
353 finalOffset += ( availableVisualSize - finalSize ) * .5f;
355 // populate the transform map
356 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
357 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
360 case Visual::FittingMode::FILL:
362 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
363 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
366 case Visual::FittingMode::FIT_WIDTH:
367 case Visual::FittingMode::FIT_HEIGHT:
369 // This FittingMode already converted
375 void ImageView::ApplyFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding , Property::Map& transformMap )
377 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
379 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
380 if( mImageViewPixelAreaSetByFittingMode )
382 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT );
383 mImageViewPixelAreaSetByFittingMode = false;
386 if( ( !zeroPadding ) || // If padding is not zero
387 ( fittingMode != Visual::FittingMode::FILL ) )
389 mImageVisualPaddingSetByTransform = true;
391 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
392 if( fittingMode == Visual::FittingMode::FIT_WIDTH )
394 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
396 else if( fittingMode == Visual::FittingMode::FIT_HEIGHT )
398 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
401 SetTransformMapForFittingMode( finalSize, naturalSize, finalOffset, fittingMode, transformMap );
403 // Set extra value for applying transformMap
404 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
405 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
406 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
407 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
408 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
409 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
411 else if ( mImageVisualPaddingSetByTransform && zeroPadding ) // Reset offset to zero only if padding applied previously
413 mImageVisualPaddingSetByTransform = false;
414 // Reset the transform map
415 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO )
416 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
417 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) )
418 .Add( Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE )
419 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
420 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) );
424 ///////////////////////////////////////////////////////////
429 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
431 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
435 ImageView& impl = GetImpl( imageView );
438 case Toolkit::ImageView::Property::IMAGE:
440 std::string imageUrl;
441 const Property::Map* map;
442 if( value.Get( imageUrl ) )
444 impl.SetImage( imageUrl, ImageDimensions() );
446 // if its not a string then get a Property::Map from the property if possible.
449 map = value.GetMap();
452 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
453 // set image only if property map contains image information other than custom shader
454 if( map->Count() > 1u || !shaderValue )
456 impl.SetImage( *map );
458 // the property map contains only the custom shader
459 else if( ( map->Count() == 1u )&&( shaderValue ) )
461 Property::Map* shaderMap = shaderValue->GetMap();
464 impl.mShaderMap = *shaderMap;
466 if( !impl.mUrl.empty() )
468 impl.SetImage( impl.mUrl, impl.mImageSize );
470 else if( !impl.mPropertyMap.Empty() )
472 impl.SetImage( impl.mPropertyMap );
481 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
484 if( value.Get( isPre ) )
486 impl.EnablePreMultipliedAlpha( isPre );
494 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
496 Property::Value value;
498 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
502 ImageView& impl = GetImpl( imageview );
503 switch ( propertyIndex )
505 case Toolkit::ImageView::Property::IMAGE:
507 if ( !impl.mUrl.empty() )
514 Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
517 visual.CreatePropertyMap( map );
524 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
526 value = impl.IsPreMultipliedAlphaEnabled();
535 } // namespace Internal
536 } // namespace Toolkit