2 * Copyright (c) 2017 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.
124 void ImageView::SetImage( const Property::Map& map )
126 // Comparing a property map is too expensive so just creating a new visual
131 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
134 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
140 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
144 // Unregister the exsiting visual
145 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
147 // Trigger a size negotiation request that may be needed when unregistering a visual.
152 void ImageView::SetImage( const std::string& url, ImageDimensions size )
154 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
157 mPropertyMap.Clear();
159 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
160 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
168 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
172 // Unregister the exsiting visual
173 DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
175 // Trigger a size negotiation request that may be needed when unregistering a visual.
180 Image ImageView::GetImage() const
185 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
189 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
193 bool ImageView::IsPreMultipliedAlphaEnabled() const
197 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
202 void ImageView::SetDepthIndex( int depthIndex )
206 mVisual.SetDepthIndex( depthIndex );
210 void ImageView::OnStageConnection( int depth )
214 mImage.UploadedSignal().Emit( mImage );
217 Dali::ResourceImage resourceImage = Dali::ResourceImage::DownCast( mImage );
220 resourceImage.LoadingFinishedSignal().Emit( resourceImage );
223 Control::OnStageConnection( depth ); // Enabled visuals will be put on stage
226 Vector3 ImageView::GetNaturalSize()
230 Vector2 rendererNaturalSize;
231 mVisual.GetNaturalSize( rendererNaturalSize );
234 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
236 rendererNaturalSize.width += ( padding.start + padding.end );
237 rendererNaturalSize.height += ( padding.top + padding.bottom );
238 return Vector3( rendererNaturalSize );
241 // if no visual then use Control's natural size
242 return Control::GetNaturalSize();
245 float ImageView::GetHeightForWidth( float width )
248 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
252 return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
256 return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
260 float ImageView::GetWidthForHeight( float height )
263 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
267 return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
271 return Control::GetWidthForHeight( height ) + padding.start + padding.end;
275 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
277 Control::OnRelayout( size, container );
282 padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
284 Property::Map transformMap = Property::Map();
286 if( ( padding.start != 0 ) || ( padding.end != 0 ) || ( padding.top != 0 ) || ( padding.bottom != 0 ) )
288 transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( padding.start, padding.top ) )
289 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
290 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
291 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
294 // Should provide a transform that handles aspect ratio according to image size
295 mVisual.SetTransformAndSize( transformMap, size );
299 void ImageView::OnResourceReady( Toolkit::Control control )
301 // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
302 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
305 ///////////////////////////////////////////////////////////
310 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
312 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
316 ImageView& impl = GetImpl( imageView );
319 case Toolkit::ImageView::Property::RESOURCE_URL:
321 std::string imageUrl;
322 if( value.Get( imageUrl ) )
324 impl.SetImage( imageUrl, ImageDimensions() );
329 case Toolkit::ImageView::Property::IMAGE:
331 std::string imageUrl;
333 if( value.Get( imageUrl ) )
335 impl.SetImage( imageUrl, ImageDimensions() );
337 // if its not a string then get a Property::Map from the property if possible.
340 map = value.GetMap();
343 Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
344 // set image only if property map contains image information other than custom shader
345 if( map->Count() > 1u || !shaderValue )
347 impl.SetImage( *map );
349 // the property map contains only the custom shader
350 else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
352 Property::Map* shaderMap = shaderValue->GetMap();
355 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
356 visual.SetCustomShader( *shaderMap );
357 if( imageView.OnStage() )
359 // force to create new core renderer to use the newly set shader
360 visual.SetOffStage( imageView );
361 visual.SetOnStage( imageView );
370 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
373 if( value.Get( isPre ) )
375 impl.EnablePreMultipliedAlpha( isPre );
383 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
385 Property::Value value;
387 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
391 ImageView& impl = GetImpl( imageview );
392 switch ( propertyIndex )
394 case Toolkit::ImageView::Property::RESOURCE_URL:
396 if ( !impl.mUrl.empty() )
403 case Toolkit::ImageView::Property::IMAGE:
405 if ( !impl.mUrl.empty() )
409 else if( impl.mImage )
412 Scripting::CreatePropertyMap( impl.mImage, map );
415 else if( !impl.mPropertyMap.Empty() )
417 value = impl.mPropertyMap;
422 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
424 value = impl.IsPreMultipliedAlphaEnabled();
433 } // namespace Internal
434 } // namespace Toolkit