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( const Property::Map& map )
104 // Comparing a property map is too expensive so just creating a new visual
108 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
111 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
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 exsiting 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 std::string& url, ImageDimensions size )
139 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
142 mPropertyMap.Clear();
144 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
145 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
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::EnablePreMultipliedAlpha( bool preMultipled )
177 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
181 bool ImageView::IsPreMultipliedAlphaEnabled() const
185 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
190 void ImageView::SetDepthIndex( int depthIndex )
194 mVisual.SetDepthIndex( depthIndex );
198 Vector3 ImageView::GetNaturalSize()
202 Vector2 rendererNaturalSize;
203 mVisual.GetNaturalSize( rendererNaturalSize );
206 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
208 rendererNaturalSize.width += ( padding.start + padding.end );
209 rendererNaturalSize.height += ( padding.top + padding.bottom );
210 return Vector3( rendererNaturalSize );
213 // if no visual then use Control's natural size
214 return Control::GetNaturalSize();
217 float ImageView::GetHeightForWidth( float width )
220 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
224 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
228 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
232 float ImageView::GetWidthForHeight( float height )
235 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
239 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
243 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
247 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
249 Control::OnRelayout( size, container );
252 Property::Map transformMap = Property::Map();
254 Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
256 bool zeroPadding = ( padding == Extents() );
259 mVisual.GetNaturalSize( naturalSize );
261 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
262 Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
263 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
265 std::swap( padding.start, padding.end );
268 // remove padding from the size to know how much is left for the visual
269 Vector2 finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
270 Vector2 finalOffset = Vector2( padding.start, padding.top );
272 ApplyFittingMode( finalSize, naturalSize, finalOffset, zeroPadding , transformMap );
274 mVisual.SetTransformAndSize( transformMap, size );
276 // mVisual is not updated util the resource is ready in the case of visual replacement.
277 // in this case, the Property Map must be initialized so that the previous value is not reused.
278 // after mVisual is updated, the correct value will be reset.
279 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
280 if( visual && visual != mVisual )
282 visual.SetTransformAndSize( Property::Map(), size );
287 void ImageView::OnResourceReady( Toolkit::Control control )
289 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
290 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
291 // Signal that a Relayout may be needed
294 void ImageView::SetTransformMapForFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap )
298 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
300 auto availableVisualSize = finalSize;
302 // scale to fit the padded area
303 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
304 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
306 // calculate final offset within the padded area
307 finalOffset += ( availableVisualSize - finalSize ) * .5f;
309 // populate the transform map
310 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
311 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
314 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
316 mImageViewPixelAreaSetByFittingMode = true;
317 auto availableVisualSize = finalSize;
318 finalSize = naturalSize * std::max( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
319 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
321 auto originalOffset = finalOffset;
322 finalOffset += ( availableVisualSize - finalSize ) * .5f;
324 float x = abs( (availableVisualSize.width - finalSize.width ) / finalSize.width )* .5f;
325 float y = abs( (availableVisualSize.height - finalSize.height ) / finalSize.height ) * .5f;
326 float widthRatio = 1.f - abs( (availableVisualSize.width - finalSize.width ) / finalSize.width );
327 float heightRatio = 1.f - abs( (availableVisualSize.height - finalSize.height ) / finalSize.height );
328 Vector4 pixelArea = Vector4( x, y, widthRatio, heightRatio);
329 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, pixelArea );
331 // populate the transform map
332 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, originalOffset )
333 .Add( Toolkit::Visual::Transform::Property::SIZE, availableVisualSize );
336 case Visual::FittingMode::CENTER:
338 auto availableVisualSize = finalSize;
339 if( availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height )
341 finalSize = naturalSize;
345 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
346 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
349 finalOffset += ( availableVisualSize - finalSize ) * .5f;
351 // populate the transform map
352 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
353 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
356 case Visual::FittingMode::FILL:
358 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
359 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
362 case Visual::FittingMode::FIT_WIDTH:
363 case Visual::FittingMode::FIT_HEIGHT:
365 // This FittingMode already converted
371 void ImageView::ApplyFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding , Property::Map& transformMap )
373 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
375 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
376 if( mImageViewPixelAreaSetByFittingMode )
378 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT );
379 mImageViewPixelAreaSetByFittingMode = false;
382 if( ( !zeroPadding ) || // If padding is not zero
383 ( fittingMode != Visual::FittingMode::FILL ) )
385 mImageVisualPaddingSetByTransform = true;
387 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
388 if( fittingMode == Visual::FittingMode::FIT_WIDTH )
390 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
392 else if( fittingMode == Visual::FittingMode::FIT_HEIGHT )
394 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
397 SetTransformMapForFittingMode( finalSize, naturalSize, finalOffset, fittingMode, transformMap );
399 // Set extra value for applying transformMap
400 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
401 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
402 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
403 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
404 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
405 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
407 else if ( mImageVisualPaddingSetByTransform && zeroPadding ) // Reset offset to zero only if padding applied previously
409 mImageVisualPaddingSetByTransform = false;
410 // Reset the transform map
411 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO )
412 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
413 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) )
414 .Add( Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE )
415 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
416 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) );
420 ///////////////////////////////////////////////////////////
425 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
427 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
431 ImageView& impl = GetImpl( imageView );
434 case Toolkit::ImageView::Property::IMAGE:
436 std::string imageUrl;
438 if( value.Get( imageUrl ) )
440 impl.SetImage( imageUrl, ImageDimensions() );
442 // if its not a string then get a Property::Map from the property if possible.
445 map = value.GetMap();
448 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
449 // set image only if property map contains image information other than custom shader
450 if( map->Count() > 1u || !shaderValue )
452 impl.SetImage( *map );
454 // the property map contains only the custom shader
455 else if( ( map->Count() == 1u )&&( shaderValue ) )
457 Property::Map* shaderMap = shaderValue->GetMap();
460 impl.mShaderMap = *shaderMap;
462 if( !impl.mUrl.empty() )
464 impl.SetImage( impl.mUrl, impl.mImageSize );
466 else if( !impl.mPropertyMap.Empty() )
468 impl.SetImage( impl.mPropertyMap );
477 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
480 if( value.Get( isPre ) )
482 impl.EnablePreMultipliedAlpha( isPre );
490 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
492 Property::Value value;
494 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
498 ImageView& impl = GetImpl( imageview );
499 switch ( propertyIndex )
501 case Toolkit::ImageView::Property::IMAGE:
503 if ( !impl.mUrl.empty() )
510 Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
513 visual.CreatePropertyMap( map );
520 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
522 value = impl.IsPreMultipliedAlphaEnabled();
531 } // namespace Internal
532 } // namespace Toolkit