2 * Copyright (c) 2018 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 ) )
71 ImageView::~ImageView()
75 Toolkit::ImageView ImageView::New()
77 ImageView* impl = new ImageView();
79 Toolkit::ImageView handle = Toolkit::ImageView( *impl );
81 // Second-phase init of the implementation
82 // This can only be done after the CustomActor connection has been made...
88 /////////////////////////////////////////////////////////////
90 void ImageView::OnInitialize()
92 // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
93 Dali::Toolkit::Control handle( GetOwner() );
94 handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
97 void ImageView::SetImage( Image image )
99 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
102 mPropertyMap.Clear();
104 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
112 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
116 // Unregister the exsiting visual
117 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
119 // Trigger a size negotiation request that may be needed when unregistering a visual.
123 Toolkit::DevelControl::RequestLayout( *this );
126 void ImageView::SetImage( const Property::Map& map )
128 // Comparing a property map is too expensive so just creating a new visual
133 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
136 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
142 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
146 // Unregister the exsiting visual
147 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
149 // Trigger a size negotiation request that may be needed when unregistering a visual.
153 Toolkit::DevelControl::RequestLayout( *this );
156 void ImageView::SetImage( const std::string& url, ImageDimensions size )
158 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
161 mPropertyMap.Clear();
163 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
164 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
172 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
176 // Unregister the exsiting visual
177 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
179 // Trigger a size negotiation request that may be needed when unregistering a visual.
183 Toolkit::DevelControl::RequestLayout( *this );
186 Image ImageView::GetImage() const
191 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
195 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
199 bool ImageView::IsPreMultipliedAlphaEnabled() const
203 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
208 void ImageView::SetDepthIndex( int depthIndex )
212 mVisual.SetDepthIndex( depthIndex );
216 void ImageView::OnStageConnection( int depth )
220 mImage.UploadedSignal().Emit( mImage );
223 Dali::ResourceImage resourceImage = Dali::ResourceImage::DownCast( mImage );
226 resourceImage.LoadingFinishedSignal().Emit( resourceImage );
229 Control::OnStageConnection( depth ); // Enabled visuals will be put on stage
232 Vector3 ImageView::GetNaturalSize()
236 Vector2 rendererNaturalSize;
237 mVisual.GetNaturalSize( rendererNaturalSize );
240 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
242 rendererNaturalSize.width += ( padding.start + padding.end );
243 rendererNaturalSize.height += ( padding.top + padding.bottom );
244 return Vector3( rendererNaturalSize );
247 // if no visual then use Control's natural size
248 return Control::GetNaturalSize();
251 float ImageView::GetHeightForWidth( float width )
254 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
258 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
262 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
266 float ImageView::GetWidthForHeight( float height )
269 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
273 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
277 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
281 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
283 Control::OnRelayout( size, container );
287 Property::Map transformMap = Property::Map();
289 Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
290 const Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
292 if( ( padding != Extents() ) || // If padding is not zero
293 ( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ) )
295 Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
296 Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
298 if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
300 std::swap( padding.start, padding.end );
303 auto finalOffset = Vector2( padding.start, padding.top );
305 // remove padding from the size to know how much is left for the visual
306 auto finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
308 // Should provide a transform that handles aspect ratio according to image size
309 if( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO )
311 auto availableVisualSize = finalSize;
314 mVisual.GetNaturalSize( naturalSize );
316 // scale to fit the padded area
317 finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
318 ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
320 // calculate final offset within the padded area
321 finalOffset += ( availableVisualSize - finalSize ) * .5f;
324 // populate the transform map
325 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
326 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
327 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
328 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
329 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
330 .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize )
331 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
332 Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
335 mVisual.SetTransformAndSize( transformMap, size );
339 void ImageView::OnResourceReady( Toolkit::Control control )
341 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
342 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
343 Toolkit::DevelControl::RequestLayout( *this );
346 ///////////////////////////////////////////////////////////
351 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
353 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
357 ImageView& impl = GetImpl( imageView );
360 case Toolkit::ImageView::Property::RESOURCE_URL:
362 std::string imageUrl;
363 if( value.Get( imageUrl ) )
365 impl.SetImage( imageUrl, ImageDimensions() );
370 case Toolkit::ImageView::Property::IMAGE:
372 std::string imageUrl;
374 if( value.Get( imageUrl ) )
376 impl.SetImage( imageUrl, ImageDimensions() );
378 // if its not a string then get a Property::Map from the property if possible.
381 map = value.GetMap();
384 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
385 // set image only if property map contains image information other than custom shader
386 if( map->Count() > 1u || !shaderValue )
388 impl.SetImage( *map );
390 // the property map contains only the custom shader
391 else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
393 Property::Map* shaderMap = shaderValue->GetMap();
396 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
397 visual.SetCustomShader( *shaderMap );
398 if( imageView.OnStage() )
400 // force to create new core renderer to use the newly set shader
401 visual.SetOffStage( imageView );
402 visual.SetOnStage( imageView );
411 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
414 if( value.Get( isPre ) )
416 impl.EnablePreMultipliedAlpha( isPre );
424 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
426 Property::Value value;
428 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
432 ImageView& impl = GetImpl( imageview );
433 switch ( propertyIndex )
435 case Toolkit::ImageView::Property::RESOURCE_URL:
437 if ( !impl.mUrl.empty() )
444 case Toolkit::ImageView::Property::IMAGE:
446 if ( !impl.mUrl.empty() )
450 else if( impl.mImage )
453 Scripting::CreatePropertyMap( impl.mImage, map );
456 else if( !impl.mPropertyMap.Empty() )
458 value = impl.mPropertyMap;
463 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
465 value = impl.IsPreMultipliedAlphaEnabled();
474 } // namespace Internal
475 } // namespace Toolkit