-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// CLASS HEADER
+#include "image-view-impl.h"
+
+// EXTERNAL INCLUDES
+#include <dali/public-api/images/resource-image.h>
+#include <dali/public-api/object/type-registry.h>
+#include <dali/public-api/object/type-registry-helper.h>
+#include <dali/devel-api/scripting/scripting.h>
+
+// INTERNAL INCLUDES
+#include <dali-toolkit/public-api/controls/image-view/image-view.h>
+#include <dali-toolkit/devel-api/controls/control-devel.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
+#include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
+#include <dali-toolkit/internal/visuals/visual-string-constants.h>
+#include <dali-toolkit/internal/visuals/visual-base-impl.h>
+#include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
-#include <dali-toolkit/internal/controls/image-view/image-view-impl.h>
-#include <dali-toolkit/public-api/shader-effects/distance-field-effect.h>
+namespace Dali
+{
-using namespace Dali;
+namespace Toolkit
+{
+
+namespace Internal
+{
namespace
{
-//Type registration
+
BaseHandle Create()
{
return Toolkit::ImageView::New();
}
-TypeRegistration mType( typeid(Toolkit::ImageView), typeid(Toolkit::Control), Create );
-
- /**
- * CameraDetailConstraint, generates detail value
- * based on camera's position and ImageView's position.
- */
- struct CameraDetailConstraint
- {
- CameraDetailConstraint(float detailFactor)
- : mDetailFactor(detailFactor)
- {
- }
+// Setup properties, signals and actions using the type-registry.
+DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ImageView, Toolkit::Control, Create );
+DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "resourceUrl", STRING, RESOURCE_URL )
+DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "image", MAP, IMAGE )
+DALI_PROPERTY_REGISTRATION( Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA )
- float operator()(const float& current,
- const PropertyInput& propertyTargetPosition,
- const PropertyInput& propertySourcePosition)
- {
- const Vector3& targetPosition = propertyTargetPosition.GetVector3();
- const Vector3& sourcePosition = propertySourcePosition.GetVector3();
- const float distance = (targetPosition - sourcePosition).Length();
- const float detail = mDetailFactor / distance;
+DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT( Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA )
+DALI_TYPE_REGISTRATION_END()
- return detail;
- }
+} // anonymous namespace
- const float mDetailFactor;
- };
-
-} // unnamed namespace
-
-namespace Dali
-{
+using namespace Dali;
-namespace Toolkit
+ImageView::ImageView()
+: Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
+ mImageSize()
{
+}
-namespace Internal
+ImageView::~ImageView()
{
+}
-///////////////////////////////////////////////////////////////////////////////////////////////////
-// ImageView
-///////////////////////////////////////////////////////////////////////////////////////////////////
-
-Dali::Toolkit::ImageView ImageView::New()
+Toolkit::ImageView ImageView::New()
{
- // Create the implementation
- ImageViewPtr imageView(new ImageView());
+ ImageView* impl = new ImageView();
- // Pass ownership to CustomActor via derived handle
- Dali::Toolkit::ImageView handle(*imageView);
+ Toolkit::ImageView handle = Toolkit::ImageView( *impl );
// Second-phase init of the implementation
// This can only be done after the CustomActor connection has been made...
- imageView->Initialize();
+ impl->Initialize();
return handle;
}
-ImageView::ImageView()
-: ControlImpl(true)
+/////////////////////////////////////////////////////////////
+
+void ImageView::OnInitialize()
{
+ // ImageView can relayout in the OnImageReady, alternative to a signal would be to have a upcall from the Control to ImageView
+ Dali::Toolkit::Control handle( GetOwner() );
+ handle.ResourceReadySignal().Connect( this, &ImageView::OnResourceReady );
}
-void ImageView::Initialize()
+void ImageView::SetImage( Image image )
{
- Actor self = Self();
- // Register property that represents the level of detail.
- mPropertyDetail = self.RegisterProperty(Toolkit::ImageView::DETAIL_PROPERTY_NAME, 0.0f);
+ // Don't bother comparing if we had a visual previously, just drop old visual and create new one
+ mImage = image;
+ mUrl.clear();
+ mPropertyMap.Clear();
+
+ Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( image );
+ if( visual )
+ {
+ if( !mVisual )
+ {
+ mVisual = visual;
+ }
+
+ if( !mShaderMap.Empty() )
+ {
+ Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
+ visualImpl.SetCustomShader( mShaderMap );
+ }
+
+ DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
+ }
+ else
+ {
+ // Unregister the existing visual
+ DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
+
+ // Trigger a size negotiation request that may be needed when unregistering a visual.
+ RelayoutRequest();
+ }
- // Create an empty image actor, filling the entire size of this ImageView.
- Image emptyImage;
- mImageActor = ImageActor::New( emptyImage );
- self.Add( mImageActor );
- mImageActor.ApplyConstraint( Constraint::New<Vector3>( Actor::SIZE, ParentSource( Actor::SIZE ), EqualToConstraint() ) );
- mImageActor.SetParentOrigin( ParentOrigin::CENTER );
+ // Signal that a Relayout may be needed
}
-ImageView::~ImageView()
+void ImageView::SetImage( const Property::Map& map )
{
+ // Comparing a property map is too expensive so just creating a new visual
+ mPropertyMap = map;
+ mUrl.clear();
+ mImage.Reset();
+
+ Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( mPropertyMap );
+ if( visual )
+ {
+ // Don't set mVisual until it is ready and shown. Getters will still use current visual.
+ if( !mVisual )
+ {
+ mVisual = visual;
+ }
+
+ if( !mShaderMap.Empty() )
+ {
+ Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
+ visualImpl.SetCustomShader( mShaderMap );
+ }
+
+ DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
+ }
+ else
+ {
+ // Unregister the exsiting visual
+ DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
+ // Trigger a size negotiation request that may be needed when unregistering a visual.
+ RelayoutRequest();
+ }
+
+ // Signal that a Relayout may be needed
}
-void ImageView::SetImage(const std::string& filename, ImageType type, float min, float max)
+void ImageView::SetImage( const std::string& url, ImageDimensions size )
{
- switch(type)
+ // Don't bother comparing if we had a visual previously, just drop old visual and create new one
+ mUrl = url;
+ mImageSize = size;
+ mImage.Reset();
+ mPropertyMap.Clear();
+
+ // Don't set mVisual until it is ready and shown. Getters will still use current visual.
+ Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual( url, size );
+ if( visual )
{
- case Toolkit::ImageView::BitmapType:
+ if( !mVisual )
{
- SetImageBitmap(filename, min, max);
- break;
+ mVisual = visual;
}
- case Toolkit::ImageView::DistanceFieldType:
+
+ if( !mShaderMap.Empty() )
{
- SetImageDistanceField(filename);
- break;
+ Internal::Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
+ visualImpl.SetCustomShader( mShaderMap );
}
+
+ DevelControl::RegisterVisual( *this, Toolkit::ImageView::Property::IMAGE, visual );
+ }
+ else
+ {
+ // Unregister the exsiting visual
+ DevelControl::UnregisterVisual( *this, Toolkit::ImageView::Property::IMAGE );
+
+ // Trigger a size negotiation request that may be needed when unregistering a visual.
+ RelayoutRequest();
}
+
+ // Signal that a Relayout may be needed
}
-void ImageView::SetImageBitmap(const std::string& filename, float min, float max)
+Image ImageView::GetImage() const
{
- int minLevel = ceilf(logf(min) / logf(2.0f));
- int maxLevel = ceilf(logf(max) / logf(2.0f));
+ return mImage;
+}
- ImageAttributes attributes;
- const Vector3 size = Self().GetCurrentSize();
+void ImageView::EnablePreMultipliedAlpha( bool preMultipled )
+{
+ if( mVisual )
+ {
+ Toolkit::GetImplementation( mVisual ).EnablePreMultipliedAlpha( preMultipled );
+ }
+}
- if(minLevel==maxLevel)
- { // Single image detail level, no need for any notifications.
- const float detail = powf(2.0f, maxLevel);
- attributes.SetSize( size.x * detail, size.y * detail );
- Image image = Image::New( filename, attributes);
- mImageActor.SetImage( image );
+bool ImageView::IsPreMultipliedAlphaEnabled() const
+{
+ if( mVisual )
+ {
+ return Toolkit::GetImplementation( mVisual ).IsPreMultipliedAlphaEnabled();
}
- else
- { // Multi image detail level...
- for( int level = minLevel; level <= maxLevel; level++)
- {
- const float minDetail = powf(2.0f, level - 1);
- const float maxDetail = powf(2.0f, level);
- ImageRequest req(filename, size.x * maxDetail, size.y * maxDetail );
+ return false;
+}
- if(level==minLevel)
- {
- AddImage(req, LessThanCondition(maxDetail) );
- }
- else if(level==maxLevel)
- {
- AddImage(req, GreaterThanCondition(minDetail) );
- }
- else
- {
- AddImage(req, InsideCondition(minDetail, maxDetail) );
- }
- }
+void ImageView::SetDepthIndex( int depthIndex )
+{
+ if( mVisual )
+ {
+ mVisual.SetDepthIndex( depthIndex );
}
}
-void ImageView::SetImageDistanceField(const std::string& filename)
+Vector3 ImageView::GetNaturalSize()
{
- ImageAttributes attributes = Dali::ImageAttributes::NewDistanceField(1.0f, 1);
- const Vector3 size = Self().GetCurrentSize();
+ if( mVisual )
+ {
+ Vector2 rendererNaturalSize;
+ mVisual.GetNaturalSize( rendererNaturalSize );
- attributes.SetSize( size.x, size.y );
- Image image = Image::NewDistanceField(filename, attributes);
- mImageActor.SetImage( image );
+ Extents padding;
+ padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
- DistanceFieldEffect effect = DistanceFieldEffect::New();
- Self().SetShaderEffect( effect );
+ rendererNaturalSize.width += ( padding.start + padding.end );
+ rendererNaturalSize.height += ( padding.top + padding.bottom );
+ return Vector3( rendererNaturalSize );
+ }
+
+ // if no visual then use Control's natural size
+ return Control::GetNaturalSize();
}
-void ImageView::SetImage(Image image)
+float ImageView::GetHeightForWidth( float width )
{
- mImageActor.SetImage( image );
+ Extents padding;
+ padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+ if( mVisual )
+ {
+ return mVisual.GetHeightForWidth( width ) + padding.top + padding.bottom;
+ }
+ else
+ {
+ return Control::GetHeightForWidth( width ) + padding.top + padding.bottom;
+ }
}
-void ImageView::AddImage(ImageRequest& req, PropertyCondition condition)
+float ImageView::GetWidthForHeight( float height )
{
- Actor self = Self();
+ Extents padding;
+ padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+
+ if( mVisual )
+ {
+ return mVisual.GetWidthForHeight( height ) + padding.start + padding.end;
+ }
+ else
+ {
+ return Control::GetWidthForHeight( height ) + padding.start + padding.end;
+ }
+}
+
+void ImageView::OnRelayout( const Vector2& size, RelayoutContainer& container )
+{
+ Control::OnRelayout( size, container );
+
+ if( mVisual )
+ {
+ Property::Map transformMap = Property::Map();
+
+ Extents padding = Self().GetProperty<Extents>( Toolkit::Control::Property::PADDING );
+ const Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
+
+ if( ( padding != Extents() ) || // If padding is not zero
+ ( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ) )
+ {
+ Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
+ Self().GetProperty( Dali::Actor::Property::LAYOUT_DIRECTION ).Get<int>() );
+
+ if( Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection )
+ {
+ std::swap( padding.start, padding.end );
+ }
+
+ auto finalOffset = Vector2( padding.start, padding.top );
+
+ // remove padding from the size to know how much is left for the visual
+ auto finalSize = size - Vector2( padding.start + padding.end, padding.top + padding.bottom );
+
+ // Should provide a transform that handles aspect ratio according to image size
+ if( fittingMode == Visual::FittingMode::FIT_KEEP_ASPECT_RATIO )
+ {
+ auto availableVisualSize = finalSize;
- PropertyNotification notification = self.AddPropertyNotification( mPropertyDetail, condition );
+ Vector2 naturalSize;
+ mVisual.GetNaturalSize( naturalSize );
- notification.NotifySignal().Connect( this, &ImageView::OnDetailChange );
+ // scale to fit the padded area
+ finalSize = naturalSize * std::min( ( naturalSize.width ? ( availableVisualSize.width / naturalSize.width ) : 0 ),
+ ( naturalSize.height ? ( availableVisualSize.height / naturalSize.height ) : 0 ) );
- mNotifications[notification] = req;
+ // calculate final offset within the padded area
+ finalOffset += ( availableVisualSize - finalSize ) * .5f;
+ }
+
+ // populate the transform map
+ transformMap.Add( Toolkit::Visual::Transform::Property::OFFSET, finalOffset )
+ .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY,
+ Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
+ .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
+ .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN )
+ .Add( Toolkit::Visual::Transform::Property::SIZE, finalSize )
+ .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY,
+ Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
+ }
+
+ mVisual.SetTransformAndSize( transformMap, size );
+ }
}
-void ImageView::SetDetail(float detail)
+void ImageView::OnResourceReady( Toolkit::Control control )
{
- Self().SetProperty( mPropertyDetail, detail );
+ // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
+ mVisual = DevelControl::GetVisual( *this, Toolkit::ImageView::Property::IMAGE );
+ // Signal that a Relayout may be needed
}
-void ImageView::SetCameraActor(CameraActor camera, float detailFactor)
+///////////////////////////////////////////////////////////
+//
+// Properties
+//
+
+void ImageView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
{
- Constraint constraint = Constraint::New<float>( mPropertyDetail,
- LocalSource( Actor::WORLD_POSITION ),
- Source( camera, Actor::WORLD_POSITION ),
- CameraDetailConstraint(detailFactor));
- Self().RemoveConstraints();
- Self().ApplyConstraint(constraint);
+ Toolkit::ImageView imageView = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
+
+ if ( imageView )
+ {
+ ImageView& impl = GetImpl( imageView );
+ switch ( index )
+ {
+ case Toolkit::ImageView::Property::RESOURCE_URL:
+ {
+ std::string imageUrl;
+ if( value.Get( imageUrl ) )
+ {
+ impl.SetImage( imageUrl, ImageDimensions() );
+ }
+ break;
+ }
+
+ case Toolkit::ImageView::Property::IMAGE:
+ {
+ std::string imageUrl;
+ Property::Map* map;
+ if( value.Get( imageUrl ) )
+ {
+ impl.SetImage( imageUrl, ImageDimensions() );
+ }
+ // if its not a string then get a Property::Map from the property if possible.
+ else
+ {
+ map = value.GetMap();
+ if( map )
+ {
+ Property::Value* shaderValue = map->Find( Toolkit::Visual::Property::SHADER, CUSTOM_SHADER );
+ // set image only if property map contains image information other than custom shader
+ if( map->Count() > 1u || !shaderValue )
+ {
+ impl.SetImage( *map );
+ }
+ // the property map contains only the custom shader
+ else if( ( map->Count() == 1u )&&( shaderValue ) )
+ {
+ Property::Map* shaderMap = shaderValue->GetMap();
+ if( shaderMap )
+ {
+ impl.mShaderMap = *shaderMap;
+
+ if( !impl.mUrl.empty() )
+ {
+ impl.SetImage( impl.mUrl, impl.mImageSize );
+ }
+ else if( impl.mImage )
+ {
+ impl.SetImage( impl.mImage );
+ }
+ else if( !impl.mPropertyMap.Empty() )
+ {
+ impl.SetImage( impl.mPropertyMap );
+ }
+ }
+ }
+ }
+ }
+ break;
+ }
+
+ case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
+ {
+ bool isPre;
+ if( value.Get( isPre ) )
+ {
+ impl.EnablePreMultipliedAlpha( isPre );
+ }
+ break;
+ }
+ }
+ }
}
-void ImageView::OnDetailChange( PropertyNotification& notification )
+Property::Value ImageView::GetProperty( BaseObject* object, Property::Index propertyIndex )
{
- ImageRequest& req = mNotifications[notification];
- Image image = Image::New( req.mFilename, req.mAttributes );
- mImageActor.SetImage( image );
+ Property::Value value;
+
+ Toolkit::ImageView imageview = Toolkit::ImageView::DownCast( Dali::BaseHandle( object ) );
+
+ if ( imageview )
+ {
+ ImageView& impl = GetImpl( imageview );
+ switch ( propertyIndex )
+ {
+ case Toolkit::ImageView::Property::RESOURCE_URL:
+ {
+ if ( !impl.mUrl.empty() )
+ {
+ value = impl.mUrl;
+ }
+ break;
+ }
+
+ case Toolkit::ImageView::Property::IMAGE:
+ {
+ if ( !impl.mUrl.empty() )
+ {
+ value = impl.mUrl;
+ }
+ else if( impl.mImage )
+ {
+ Property::Map map;
+ Scripting::CreatePropertyMap( impl.mImage, map );
+ value = map;
+ }
+ else
+ {
+ Property::Map map;
+ Toolkit::Visual::Base visual = DevelControl::GetVisual( impl, Toolkit::ImageView::Property::IMAGE );
+ if( visual )
+ {
+ visual.CreatePropertyMap( map );
+ }
+ value = map;
+ }
+ break;
+ }
+
+ case Toolkit::ImageView::Property::PRE_MULTIPLIED_ALPHA:
+ {
+ value = impl.IsPreMultipliedAlphaEnabled();
+ break;
+ }
+ }
+ }
+
+ return value;
}
} // namespace Internal
-
} // namespace Toolkit
-
} // namespace Dali