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>
47 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
51 return Toolkit::ImageView::New();
54 // Setup properties, signals and actions using the type-registry.
55 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
56 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "reservedProperty01", STRING, RESERVED_PROPERTY_01 )
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 );
101 void ImageView::SetImage( const Property::Map& map )
103 // Comparing a property map is too expensive so just creating a new visual
107 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
110 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
116 if( !mShaderMap.Empty() )
118 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
119 visualImpl.SetCustomShader( mShaderMap );
122 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
126 // Unregister the exsiting visual
127 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
129 // Trigger a size negotiation request that may be needed when unregistering a visual.
133 // Signal that a Relayout may be needed
136 void ImageView::SetImage( const std::string& url, ImageDimensions size )
138 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
141 mPropertyMap.Clear();
143 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
144 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
152 if( !mShaderMap.Empty() )
154 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
155 visualImpl.SetCustomShader( mShaderMap );
158 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
162 // Unregister the exsiting visual
163 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
165 // Trigger a size negotiation request that may be needed when unregistering a visual.
169 // Signal that a Relayout may be needed
172 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
176 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
180 bool ImageView::IsPreMultipliedAlphaEnabled() const
184 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
189 void ImageView::SetDepthIndex( int depthIndex )
193 mVisual.SetDepthIndex( depthIndex );
197 Vector3 ImageView::GetNaturalSize()
201 Vector2 rendererNaturalSize;
202 mVisual.GetNaturalSize( rendererNaturalSize );
205 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
207 rendererNaturalSize.width += ( padding.start + padding.end );
208 rendererNaturalSize.height += ( padding.top + padding.bottom );
209 return Vector3( rendererNaturalSize );
212 // if no visual then use Control's natural size
213 return Control::GetNaturalSize();
216 float ImageView::GetHeightForWidth( float width )
219 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
223 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
227 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
231 float ImageView::GetWidthForHeight( float height )
234 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
238 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
242 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
246 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
248 Control::OnRelayout( size, container );
251 Property::Map transformMap = Property::Map();
253 Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
255 bool zeroPadding = ( padding == Extents() );
258 mVisual.GetNaturalSize( naturalSize );
260 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
261 Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
262 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
264 std::swap( padding.start, padding.end );
267 // remove padding from the size to know how much is left for the visual
268 Vector2 finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
269 Vector2 finalOffset = Vector2( padding.start, padding.top );
271 ApplyFittingMode( finalSize, naturalSize, finalOffset, zeroPadding , transformMap );
273 mVisual.SetTransformAndSize( transformMap, size );
275 // mVisual is not updated util the resource is ready in the case of visual replacement.
276 // in this case, the Property Map must be initialized so that the previous value is not reused.
277 // after mVisual is updated, the correct value will be reset.
278 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
279 if( visual && visual != mVisual )
281 visual.SetTransformAndSize( Property::Map(), size );
286 void ImageView::OnResourceReady( Toolkit::Control control )
288 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
289 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
290 // Signal that a Relayout may be needed
293 void ImageView::SetTransformMapForFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, Visual::FittingMode fittingMode, Property::Map& transformMap )
297 case Visual::FittingMode::FIT_KEEP_ASPECT_RATIO:
299 auto availableVisualSize = finalSize;
301 // scale to fit the padded area
302 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
303 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
305 // calculate final offset within the padded area
306 finalOffset += ( availableVisualSize - finalSize ) * .5f;
308 // populate the transform map
309 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
310 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
313 case Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO:
315 mImageViewPixelAreaSetByFittingMode = true;
316 auto availableVisualSize = finalSize;
317 finalSize = naturalSize * std::max( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
318 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
320 auto originalOffset = finalOffset;
321 finalOffset += ( availableVisualSize - finalSize ) * .5f;
323 float x = abs( (availableVisualSize.width - finalSize.width ) / finalSize.width )* .5f;
324 float y = abs( (availableVisualSize.height - finalSize.height ) / finalSize.height ) * .5f;
325 float widthRatio = 1.f - abs( (availableVisualSize.width - finalSize.width ) / finalSize.width );
326 float heightRatio = 1.f - abs( (availableVisualSize.height - finalSize.height ) / finalSize.height );
327 Vector4 pixelArea = Vector4( x, y, widthRatio, heightRatio);
328 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, pixelArea );
330 // populate the transform map
331 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, originalOffset )
332 .Add( Toolkit::Visual::Transform::Property::SIZE, availableVisualSize );
335 case Visual::FittingMode::CENTER:
337 auto availableVisualSize = finalSize;
338 if( availableVisualSize.width > naturalSize.width && availableVisualSize.height > naturalSize.height )
340 finalSize = naturalSize;
344 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
345 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
348 finalOffset += ( availableVisualSize - finalSize ) * .5f;
350 // populate the transform map
351 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
352 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
355 case Visual::FittingMode::FILL:
357 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
358 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize );
361 case Visual::FittingMode::FIT_WIDTH:
362 case Visual::FittingMode::FIT_HEIGHT:
364 // This FittingMode already converted
370 void ImageView::ApplyFittingMode( Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding , Property::Map& transformMap )
372 Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
374 // Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
375 if( mImageViewPixelAreaSetByFittingMode )
377 Self().SetProperty( Toolkit::ImageView::Property::PIXEL_AREA, FULL_TEXTURE_RECT );
378 mImageViewPixelAreaSetByFittingMode = false;
381 if( ( !zeroPadding ) || // If padding is not zero
382 ( fittingMode != Visual::FittingMode::FILL ) )
384 mImageVisualPaddingSetByTransform = true;
386 // If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
387 if( fittingMode == Visual::FittingMode::FIT_WIDTH )
389 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::FIT_KEEP_ASPECT_RATIO;
391 else if( fittingMode == Visual::FittingMode::FIT_HEIGHT )
393 fittingMode = ( finalSize.height / naturalSize.height ) < ( finalSize.width / naturalSize.width ) ? Visual::FittingMode::FIT_KEEP_ASPECT_RATIO : Visual::FittingMode::OVER_FIT_KEEP_ASPECT_RATIO;
396 SetTransformMapForFittingMode( finalSize, naturalSize, finalOffset, fittingMode, transformMap );
398 // Set extra value for applying transformMap
399 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
400 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
401 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
402 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
403 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
404 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
406 else if ( mImageVisualPaddingSetByTransform && zeroPadding ) // Reset offset to zero only if padding applied previously
408 mImageVisualPaddingSetByTransform = false;
409 // Reset the transform map
410 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2::ZERO )
411 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
412 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) )
413 .Add( Toolkit::Visual::Transform::Property::SIZE, Vector2::ONE )
414 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
415 Vector2( Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE ) );
419 ///////////////////////////////////////////////////////////
424 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
426 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
430 ImageView& impl = GetImpl( imageView );
433 case Toolkit::ImageView::Property::IMAGE:
435 std::string imageUrl;
437 if( value.Get( imageUrl ) )
439 impl.SetImage( imageUrl, ImageDimensions() );
441 // if its not a string then get a Property::Map from the property if possible.
444 map = value.GetMap();
447 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
448 // set image only if property map contains image information other than custom shader
449 if( map->Count() > 1u || !shaderValue )
451 impl.SetImage( *map );
453 // the property map contains only the custom shader
454 else if( ( map->Count() == 1u )&&( shaderValue ) )
456 Property::Map* shaderMap = shaderValue->GetMap();
459 impl.mShaderMap = *shaderMap;
461 if( !impl.mUrl.empty() )
463 impl.SetImage( impl.mUrl, impl.mImageSize );
465 else if( !impl.mPropertyMap.Empty() )
467 impl.SetImage( impl.mPropertyMap );
476 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
479 if( value.Get( isPre ) )
481 impl.EnablePreMultipliedAlpha( isPre );
489 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
491 Property::Value value;
493 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
497 ImageView& impl = GetImpl( imageview );
498 switch ( propertyIndex )
500 case Toolkit::ImageView::Property::IMAGE:
502 if ( !impl.mUrl.empty() )
509 Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
512 visual.CreatePropertyMap( map );
519 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
521 value = impl.IsPreMultipliedAlphaEnabled();
530 } // namespace Internal
531 } // namespace Toolkit