2 * Copyright (c) 2019 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>
50 return Toolkit::ImageView::New();
53 // Setup properties, signals and actions using the type-registry.
54 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
55 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "resourceUrl", STRING, RESOURCE_URL )
56 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
57 DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
59 DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA )
60 DALI_TYPE_REGISTRATION_END()
62 } // anonymous namespace
66 ImageView::ImageView()
67 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
72 ImageView::~ImageView()
76 Toolkit::ImageView ImageView::New()
78 ImageView* impl = new ImageView();
80 Toolkit::ImageView handle = Toolkit::ImageView( *impl );
82 // Second-phase init of the implementation
83 // This can only be done after the CustomActor connection has been made...
89 /////////////////////////////////////////////////////////////
91 void ImageView::OnInitialize()
93 // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
94 Dali::Toolkit::Control handle( GetOwner() );
95 handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
98 void ImageView::SetImage( Image image )
100 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
103 mPropertyMap.Clear();
105 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
113 if( !mShaderMap.Empty() )
115 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
116 visualImpl.SetCustomShader( mShaderMap );
119 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
123 // Unregister the existing visual
124 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
126 // Trigger a size negotiation request that may be needed when unregistering a visual.
130 // Signal that a Relayout may be needed
133 void ImageView::SetImage( const Property::Map& map )
135 // Comparing a property map is too expensive so just creating a new visual
140 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
143 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
149 if( !mShaderMap.Empty() )
151 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
152 visualImpl.SetCustomShader( mShaderMap );
155 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
159 // Unregister the exsiting visual
160 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
162 // Trigger a size negotiation request that may be needed when unregistering a visual.
166 // Signal that a Relayout may be needed
169 void ImageView::SetImage( const std::string& url, ImageDimensions size )
171 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
175 mPropertyMap.Clear();
177 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
178 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
186 if( !mShaderMap.Empty() )
188 Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
189 visualImpl.SetCustomShader( mShaderMap );
192 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
196 // Unregister the exsiting visual
197 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
199 // Trigger a size negotiation request that may be needed when unregistering a visual.
203 // Signal that a Relayout may be needed
206 Image ImageView::GetImage() const
211 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
215 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
219 bool ImageView::IsPreMultipliedAlphaEnabled() const
223 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
228 void ImageView::SetDepthIndex( int depthIndex )
232 mVisual.SetDepthIndex( depthIndex );
236 void ImageView::OnStageConnection( int depth )
240 mImage.UploadedSignal().Emit( mImage );
243 Dali::ResourceImage resourceImage = Dali::ResourceImage::DownCast( mImage );
246 resourceImage.LoadingFinishedSignal().Emit( resourceImage );
249 Control::OnStageConnection( depth ); // Enabled visuals will be put on stage
252 Vector3 ImageView::GetNaturalSize()
256 Vector2 rendererNaturalSize;
257 mVisual.GetNaturalSize( rendererNaturalSize );
260 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
262 rendererNaturalSize.width += ( padding.start + padding.end );
263 rendererNaturalSize.height += ( padding.top + padding.bottom );
264 return Vector3( rendererNaturalSize );
267 // if no visual then use Control's natural size
268 return Control::GetNaturalSize();
271 float ImageView::GetHeightForWidth( float width )
274 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
278 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
282 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
286 float ImageView::GetWidthForHeight( float height )
289 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
293 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
297 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
301 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
303 Control::OnRelayout( size, container );
307 Property::Map transformMap = Property::Map();
309 Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
310 const Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
312 if( ( padding != Extents() ) || // If padding is not zero
313 ( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ) )
315 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
316 Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
318 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
320 std::swap( padding.start, padding.end );
323 auto finalOffset = Vector2( padding.start, padding.top );
325 // remove padding from the size to know how much is left for the visual
326 auto finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
328 // Should provide a transform that handles aspect ratio according to image size
329 if( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO )
331 auto availableVisualSize = finalSize;
334 mVisual.GetNaturalSize( naturalSize );
336 // scale to fit the padded area
337 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
338 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
340 // calculate final offset within the padded area
341 finalOffset += ( availableVisualSize - finalSize ) * .5f;
344 // populate the transform map
345 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
346 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
347 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
348 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
349 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
350 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize )
351 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
352 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
355 mVisual.SetTransformAndSize( transformMap, size );
359 void ImageView::OnResourceReady( Toolkit::Control control )
361 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
362 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
363 // Signal that a Relayout may be needed
366 ///////////////////////////////////////////////////////////
371 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
373 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
377 ImageView& impl = GetImpl( imageView );
380 case Toolkit::ImageView::Property::RESOURCE_URL:
382 std::string imageUrl;
383 if( value.Get( imageUrl ) )
385 impl.SetImage( imageUrl, ImageDimensions() );
390 case Toolkit::ImageView::Property::IMAGE:
392 std::string imageUrl;
394 if( value.Get( imageUrl ) )
396 impl.SetImage( imageUrl, ImageDimensions() );
398 // if its not a string then get a Property::Map from the property if possible.
401 map = value.GetMap();
404 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
405 // set image only if property map contains image information other than custom shader
406 if( map->Count() > 1u || !shaderValue )
408 impl.SetImage( *map );
410 // the property map contains only the custom shader
411 else if( ( map->Count() == 1u )&&( shaderValue ) )
413 Property::Map* shaderMap = shaderValue->GetMap();
416 impl.mShaderMap = *shaderMap;
418 if( !impl.mUrl.empty() )
420 impl.SetImage( impl.mUrl, impl.mImageSize );
422 else if( impl.mImage )
424 impl.SetImage( impl.mImage );
426 else if( !impl.mPropertyMap.Empty() )
428 impl.SetImage( impl.mPropertyMap );
437 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
440 if( value.Get( isPre ) )
442 impl.EnablePreMultipliedAlpha( isPre );
450 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
452 Property::Value value;
454 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
458 ImageView& impl = GetImpl( imageview );
459 switch ( propertyIndex )
461 case Toolkit::ImageView::Property::RESOURCE_URL:
463 if ( !impl.mUrl.empty() )
470 case Toolkit::ImageView::Property::IMAGE:
472 if ( !impl.mUrl.empty() )
476 else if( impl.mImage )
479 Scripting::CreatePropertyMap( impl.mImage, map );
485 Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
488 visual.CreatePropertyMap( map );
495 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
497 value = impl.IsPreMultipliedAlphaEnabled();
506 } // namespace Internal
507 } // namespace Toolkit