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/devel-api/visuals/visual-properties-devel.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 ) ),
68 mRelayoutRequired(true)
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 Toolkit::DevelControl::ResourceReadySignal( handle ).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 );
111 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
114 void ImageView::SetImage( const Property::Map& map )
116 // Comparing a property map is too expensive so just creating a new visual
120 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
121 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
127 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
130 void ImageView::SetImage( const std::string& url, ImageDimensions size )
132 // Don't bother comparing if we had a visual previously, just drop old visual and create new one
135 mPropertyMap.Clear();
137 // Don't set mVisual until it is ready and shown. Getters will still use current visual.
138 Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
144 DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
147 Image ImageView::GetImage() const
152 void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
156 Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
160 bool ImageView::IsPreMultipliedAlphaEnabled() const
164 return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
169 void ImageView::SetDepthIndex( int depthIndex )
173 mVisual.SetDepthIndex( depthIndex );
177 void ImageView::OnStageConnection( int depth )
181 mImage.UploadedSignal().Emit( mImage );
184 Dali::ResourceImage resourceImage = Dali::ResourceImage::DownCast( mImage );
187 resourceImage.LoadingFinishedSignal().Emit( resourceImage );
190 Control::OnStageConnection( depth ); // Enabled visuals will be put on stage
193 Vector3 ImageView::GetNaturalSize()
197 Vector2 rendererNaturalSize;
198 mVisual.GetNaturalSize( rendererNaturalSize );
199 return Vector3( rendererNaturalSize );
202 // if no visual then use Control's natural size
203 return Control::GetNaturalSize();
206 float ImageView::GetHeightForWidth( float width )
210 return mVisual.GetHeightForWidth( width );
214 return Control::GetHeightForWidth( width );
218 float ImageView::GetWidthForHeight( float height )
222 return mVisual.GetWidthForHeight( height );
226 return Control::GetWidthForHeight( height );
230 void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
232 Control::OnRelayout( size, container );
234 // If visual is being replaced then mVisual will be the replacement visual even if not ready.
235 mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
239 // Pass in an empty map which uses default transform values meaning our visual fills the control
240 // Should provide a transform that handles aspect ratio according to image size
241 mVisual.SetTransformAndSize( Property::Map(), size );
245 void ImageView::OnResourceReady( Toolkit::Control control )
247 if( mRelayoutRequired)
249 mRelayoutRequired = false;
254 ///////////////////////////////////////////////////////////
259 void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
261 Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
265 ImageView& impl = GetImpl( imageView );
268 case Toolkit::ImageView::Property::RESOURCE_URL:
270 std::string imageUrl;
271 if( value.Get( imageUrl ) )
273 impl.SetImage( imageUrl, ImageDimensions() );
278 case Toolkit::ImageView::Property::IMAGE:
280 std::string imageUrl;
282 if( value.Get( imageUrl ) )
284 impl.SetImage( imageUrl, ImageDimensions() );
286 // if its not a string then get a Property::Map from the property if possible.
289 map = value.GetMap();
292 Property::Value* shaderValue = map->Find( Toolkit::DevelVisual::Property::SHADER, CUSTOM_SHADER );
293 // set image only if property map contains image information other than custom shader
294 if( map->Count() > 1u || !shaderValue )
296 impl.SetImage( *map );
298 // the property map contains only the custom shader
299 else if( ( impl.mVisual )&&( map->Count() == 1u )&&( shaderValue ) )
301 Property::Map* shaderMap = shaderValue->GetMap();
304 Internal::Visual::Base& visual = Toolkit::GetImplementation( impl.mVisual );
305 visual.SetCustomShader( *shaderMap );
306 if( imageView.OnStage() )
308 // force to create new core renderer to use the newly set shader
309 visual.SetOffStage( imageView );
310 visual.SetOnStage( imageView );
319 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
322 if( value.Get( isPre ) )
324 impl.EnablePreMultipliedAlpha( isPre );
332 Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
334 Property::Value value;
336 Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
340 ImageView& impl = GetImpl( imageview );
341 switch ( propertyIndex )
343 case Toolkit::ImageView::Property::RESOURCE_URL:
345 if ( !impl.mUrl.empty() )
352 case Toolkit::ImageView::Property::IMAGE:
354 if ( !impl.mUrl.empty() )
358 else if( impl.mImage )
361 Scripting::CreatePropertyMap( impl.mImage, map );
364 else if( !impl.mPropertyMap.Empty() )
366 value = impl.mPropertyMap;
371 case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
373 value = impl.IsPreMultipliedAlphaEnabled();
382 } // namespace Internal
383 } // namespace Toolkit