/*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2024 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.
// EXTERNAL INCLUDES
#include <dali/devel-api/scripting/scripting.h>
+#include <dali/public-api/math/math-utils.h>
#include <dali/public-api/object/type-registry-helper.h>
#include <dali/public-api/object/type-registry.h>
// INTERNAL INCLUDES
-#include <dali-toolkit/devel-api/visuals/visual-actions-devel.h>
+#include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
#include <dali-toolkit/devel-api/controls/control-devel.h>
#include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
+#include <dali-toolkit/devel-api/visuals/visual-actions-devel.h>
#include <dali-toolkit/internal/controls/control/control-data-impl.h>
#include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
#include <dali-toolkit/internal/visuals/visual-base-impl.h>
{
const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
+constexpr float FULL_OPACITY = 1.0f;
+constexpr float LOW_OPACITY = 0.2f;
+constexpr float TRANSITION_EFFECT_SPEED = 0.3f;
+
+constexpr int PLACEHOLDER_DEPTH_INDEX = -2;
+constexpr int PREVIOUS_VISUAL_DEPTH_INDEX = -1;
+constexpr int CURRENT_VISUAL_DEPTH_INDEX = 0;
+
BaseHandle Create()
{
return Toolkit::ImageView::New();
DALI_TYPE_REGISTRATION_BEGIN(Toolkit::ImageView, Toolkit::Control, Create);
DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "image", MAP, IMAGE)
DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "preMultipliedAlpha", BOOLEAN, PRE_MULTIPLIED_ALPHA)
-
+DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "placeholderImage", STRING, PLACEHOLDER_IMAGE)
+DALI_PROPERTY_REGISTRATION(Toolkit, ImageView, "enableTransitionEffect", BOOLEAN, ENABLE_TRANSITION_EFFECT)
DALI_ANIMATABLE_PROPERTY_REGISTRATION_WITH_DEFAULT(Toolkit, ImageView, "pixelArea", Vector4(0.f, 0.f, 1.f, 1.f), PIXEL_AREA)
DALI_TYPE_REGISTRATION_END()
ImageView::ImageView(ControlBehaviour additionalBehaviour)
: Control(ControlBehaviour(CONTROL_BEHAVIOUR_DEFAULT | additionalBehaviour)),
mImageSize(),
+ mTransitionTargetAlpha(FULL_OPACITY),
mImageVisualPaddingSetByTransform(false),
- mImageViewPixelAreaSetByFittingMode(false)
+ mImageViewPixelAreaSetByFittingMode(false),
+ mTransitionEffect(false),
+ mNeedLazyFittingMode(false),
+ mImageReplaced(false)
{
}
Dali::Toolkit::Control handle(GetOwner());
handle.ResourceReadySignal().Connect(this, &ImageView::OnResourceReady);
- DevelControl::SetAccessibilityConstructor(Self(), [](Dali::Actor actor) {
- return std::unique_ptr<Dali::Accessibility::Accessible>(
- new DevelControl::ControlAccessible(actor, Dali::Accessibility::Role::IMAGE));
- });
+ Self().SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::IMAGE);
}
void ImageView::SetImage(const Property::Map& map)
{
+ if(mTransitionEffect && mVisual)
+ {
+ // Clear previous transition effect if it is playing
+ if(mPreviousVisual)
+ {
+ if(mTransitionAnimation)
+ {
+ if(mTransitionAnimation.GetState() == Animation::PLAYING)
+ {
+ // Hide placeholder
+ HidePlaceholderImage();
+ ClearTransitionAnimation();
+ }
+ }
+ }
+
+ // Enable transition effect for previous visual.
+ // This previous visual will be deleted when transition effect is done.
+ Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(*this);
+ controlDataImpl.EnableReadyTransitionOverriden(mVisual, true);
+ mPreviousVisual = mVisual;
+ }
+
// Comparing a property map is too expensive so just creating a new visual
mPropertyMap = map;
mUrl.clear();
+ mImageReplaced = true;
+
+ // keep alpha for transition effect
+ if(mTransitionEffect)
+ {
+ float alpha = FULL_OPACITY;
+ Property::Value* alphaValue = map.Find(Toolkit::Visual::Property::OPACITY);
+ if(alphaValue && alphaValue->Get(alpha))
+ {
+ mTransitionTargetAlpha = alpha;
+ }
+ }
+
+ if(!mVisual)
+ {
+ ShowPlaceholderImage();
+ }
+
Toolkit::Visual::Base visual = Toolkit::VisualFactory::Get().CreateVisual(mPropertyMap);
if(visual)
{
visualImpl.SetCustomShader(mShaderMap);
}
- DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
+ DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual, DepthIndex::CONTENT);
}
else
{
// 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& url, ImageDimensions size)
{
+ if(mTransitionEffect && mVisual)
+ {
+ // Clear previous transition effect if it is playing
+ if(mPreviousVisual)
+ {
+ if(mTransitionAnimation)
+ {
+ if(mTransitionAnimation.GetState() == Animation::PLAYING)
+ {
+ HidePlaceholderImage();
+ ClearTransitionAnimation();
+ }
+ }
+ }
+
+ // Enable transition effect for previous visual.
+ // This previous visual will be deleted when transition effect is done.
+ Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(*this);
+ controlDataImpl.EnableReadyTransitionOverriden(mVisual, true);
+ mPreviousVisual = mVisual;
+ }
+
// Don't bother comparing if we had a visual previously, just drop old visual and create new one
mUrl = url;
mImageSize = size;
mPropertyMap.Clear();
+ mImageReplaced = true;
+
+ if(!mVisual)
+ {
+ ShowPlaceholderImage();
+ }
+
// 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)
visualImpl.SetCustomShader(mShaderMap);
}
- DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
+ DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual, DepthIndex::CONTENT);
}
else
{
// Trigger a size negotiation request that may be needed when unregistering a visual.
RelayoutRequest();
}
-
// Signal that a Relayout may be needed
}
// Clear cached properties
mPropertyMap.Clear();
mUrl.clear();
+ mVisual.Reset();
// Unregister the exsiting visual
DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::IMAGE);
}
}
+void ImageView::SetPlaceholderUrl(const std::string& url)
+{
+ mPlaceholderUrl = url;
+ if(!url.empty())
+ {
+ mPlaceholderVisual.Reset();
+ CreatePlaceholderImage();
+ }
+ else
+ {
+ // Clear current placeholder image
+ Toolkit::Visual::Base visual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::PLACEHOLDER_IMAGE);
+ if(visual)
+ {
+ DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::PLACEHOLDER_IMAGE);
+ }
+
+ mPlaceholderVisual.Reset();
+ mPlaceholderUrl = url;
+ }
+}
+
+std::string ImageView::GetPlaceholderUrl() const
+{
+ return mPlaceholderUrl;
+}
+
+void ImageView::EnableTransitionEffect(bool effectEnable)
+{
+ mTransitionEffect = effectEnable;
+}
+
+bool ImageView::IsTransitionEffectEnabled() const
+{
+ return mTransitionEffect;
+}
+
Vector3 ImageView::GetNaturalSize()
{
if(mVisual)
Control::OnRelayout(size, container);
if(mVisual)
{
- Property::Map transformMap = Property::Map();
-
- Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
-
- bool zeroPadding = (padding == Extents());
-
- Vector2 naturalSize;
- mVisual.GetNaturalSize(naturalSize);
-
- 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)
+ // If Resource is not ready, fittingMode is not working well.
+ // in this case, imageview set the flag for working applyFittingMode again when the resource is ready
+ if(!IsResourceReady())
{
- std::swap(padding.start, padding.end);
+ mNeedLazyFittingMode = true;
}
- // remove padding from the size to know how much is left for the visual
- Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
- Vector2 finalOffset = Vector2(padding.start, padding.top);
-
- ApplyFittingMode(finalSize, naturalSize, finalOffset, zeroPadding, transformMap);
-
- mVisual.SetTransformAndSize(transformMap, size);
+ // Apply FittingMode using actor's size
+ ApplyFittingMode(size);
// mVisual is not updated util the resource is ready in the case of visual replacement.
// in this case, the Property Map must be initialized so that the previous value is not reused.
{
visual.SetTransformAndSize(Property::Map(), size);
}
+
+ if(!mTransitionEffect)
+ {
+ // we don't need placeholder anymore because visual is replaced. so hide placeholder.
+ HidePlaceholderImage();
+ }
}
}
void ImageView::OnResourceReady(Toolkit::Control control)
{
+ // In case of placeholder, we need to skip this call.
+ // TODO: In case of placeholder, it needs to be modified not to call OnResourceReady()
+ if(control.GetVisualResourceStatus(Toolkit::ImageView::Property::IMAGE) != Toolkit::Visual::ResourceStatus::READY)
+ {
+ return;
+ }
+
+ // Do transition effect if need.
+ if(mTransitionEffect)
+ {
+ // TODO: Consider about placeholder image is loaded failed
+ Toolkit::Visual::Base placeholderVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::PLACEHOLDER_IMAGE);
+ if(!placeholderVisual || control.GetVisualResourceStatus(Toolkit::ImageView::Property::PLACEHOLDER_IMAGE) == Toolkit::Visual::ResourceStatus::READY)
+ {
+ // when placeholder is disabled or ready placeholder and image, we need to transition effect
+ TransitionImageWithEffect();
+ }
+ }
+
// 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);
+
+ // Applying FittingMode again if it is not working well on OnRelayout().
+ if(mNeedLazyFittingMode)
+ {
+ const Vector2& size = Self().GetProperty(Dali::Actor::Property::SIZE).Get<Vector2>();
+ ApplyFittingMode(size);
+ mNeedLazyFittingMode = false;
+ }
+
// Signal that a Relayout may be needed
}
auto availableVisualSize = finalSize;
// scale to fit the padded area
- finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
- (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
+ finalSize = naturalSize * std::min((!Dali::EqualsZero(naturalSize.width) ? (availableVisualSize.width / naturalSize.width) : 0),
+ (!Dali::EqualsZero(naturalSize.height) ? (availableVisualSize.height / naturalSize.height) : 0));
// calculate final offset within the padded area
finalOffset += (availableVisualSize - finalSize) * .5f;
{
mImageViewPixelAreaSetByFittingMode = true;
auto availableVisualSize = finalSize;
- finalSize = naturalSize * std::max((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
- (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
+ finalSize = naturalSize * std::max((!Dali::EqualsZero(naturalSize.width) ? (availableVisualSize.width / naturalSize.width) : 0.0f),
+ (!Dali::EqualsZero(naturalSize.height) ? (availableVisualSize.height / naturalSize.height) : 0.0f));
auto originalOffset = finalOffset;
finalOffset += (availableVisualSize - finalSize) * .5f;
}
else
{
- finalSize = naturalSize * std::min((naturalSize.width ? (availableVisualSize.width / naturalSize.width) : 0),
- (naturalSize.height ? (availableVisualSize.height / naturalSize.height) : 0));
+ finalSize = naturalSize * std::min((!Dali::EqualsZero(naturalSize.width) ? (availableVisualSize.width / naturalSize.width) : 0.0f),
+ (!Dali::EqualsZero(naturalSize.height) ? (availableVisualSize.height / naturalSize.height) : 0.0f));
}
finalOffset += (availableVisualSize - finalSize) * .5f;
}
}
-void ImageView::ApplyFittingMode(Vector2 finalSize, Vector2 naturalSize, Vector2 finalOffset, bool zeroPadding, Property::Map& transformMap)
+void ImageView::ApplyFittingMode(const Vector2& size)
{
+ Property::Map transformMap = Property::Map();
+
+ Extents padding = Self().GetProperty<Extents>(Toolkit::Control::Property::PADDING);
+
+ bool zeroPadding = (padding == Extents());
+
+ 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);
+ }
+
+ // remove padding from the size to know how much is left for the visual
+ Vector2 finalSize = size - Vector2(padding.start + padding.end, padding.top + padding.bottom);
+ Vector2 finalOffset = Vector2(padding.start, padding.top);
+
Visual::FittingMode fittingMode = Toolkit::GetImplementation(mVisual).GetFittingMode();
// Reset PIXEL_AREA after using OVER_FIT_KEEP_ASPECT_RATIO
{
mImageVisualPaddingSetByTransform = true;
+ Vector2 naturalSize;
+ // NaturalSize will not be used for FILL fitting mode, which is default.
+ // Skip GetNaturalSize
+ if(fittingMode != Visual::FittingMode::FILL)
+ {
+ mVisual.GetNaturalSize(naturalSize);
+ }
+
// If FittingMode use FIT_WIDTH or FIT_HEIGTH, it need to change proper fittingMode
if(fittingMode == Visual::FittingMode::FIT_WIDTH)
{
.Add(Toolkit::Visual::Transform::Property::SIZE_POLICY,
Vector2(Toolkit::Visual::Transform::Policy::RELATIVE, Toolkit::Visual::Transform::Policy::RELATIVE));
}
+
+ mVisual.SetTransformAndSize(transformMap, size);
+}
+
+void ImageView::CreatePlaceholderImage()
+{
+ Property::Map propertyMap;
+ propertyMap.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE);
+ propertyMap.Insert(Toolkit::ImageVisual::Property::URL, mPlaceholderUrl);
+ //propertyMap.Insert(Toolkit::ImageVisual::Property::LOAD_POLICY, Toolkit::ImageVisual::LoadPolicy::IMMEDIATE); // TODO: need to enable this property
+ propertyMap.Insert(Toolkit::ImageVisual::Property::RELEASE_POLICY, Toolkit::ImageVisual::ReleasePolicy::DESTROYED);
+ propertyMap.Insert(Toolkit::DevelImageVisual::Property::ENABLE_BROKEN_IMAGE, false);
+ mPlaceholderVisual = Toolkit::VisualFactory::Get().CreateVisual(propertyMap);
+ if(mPlaceholderVisual)
+ {
+ mPlaceholderVisual.SetName("placeholder");
+ mPlaceholderVisual.SetDepthIndex(mPlaceholderVisual.GetDepthIndex() + PLACEHOLDER_DEPTH_INDEX);
+ }
+ else
+ {
+ DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::PLACEHOLDER_IMAGE);
+ mPlaceholderVisual.Reset();
+ }
+}
+
+void ImageView::ShowPlaceholderImage()
+{
+ if(mPlaceholderVisual)
+ {
+ DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::PLACEHOLDER_IMAGE, mPlaceholderVisual, false);
+ Actor self = Self();
+ Toolkit::GetImplementation(mPlaceholderVisual).SetOnScene(self);
+ }
+}
+
+void ImageView::HidePlaceholderImage()
+{
+ if(mPlaceholderVisual)
+ {
+ DevelControl::UnregisterVisual(*this, Toolkit::ImageView::Property::PLACEHOLDER_IMAGE);
+
+ // Hide placeholder
+ Actor self = Self();
+ Toolkit::GetImplementation(mPlaceholderVisual).SetOffScene(self);
+ }
+}
+
+void ImageView::TransitionImageWithEffect()
+{
+ Toolkit::ImageView handle = Toolkit::ImageView(GetOwner());
+
+ if(handle)
+ {
+ if(!mImageReplaced)
+ {
+ // If the image is not replaced, the transition effect is not required.
+ return;
+ }
+
+ if(mTransitionAnimation)
+ {
+ ClearTransitionAnimation();
+ }
+
+ // Control visual's depth for transition effect
+ if(mPreviousVisual)
+ {
+ mPreviousVisual.SetDepthIndex(mPreviousVisual.GetDepthIndex() + PREVIOUS_VISUAL_DEPTH_INDEX);
+ }
+
+ mTransitionAnimation = Animation::New(TRANSITION_EFFECT_SPEED);
+ mTransitionAnimation.SetEndAction(Animation::EndAction::DISCARD);
+ float destinationAlpha = (mTransitionTargetAlpha > LOW_OPACITY) ? mTransitionTargetAlpha : LOW_OPACITY;
+
+ // Transition current image
+ Toolkit::Visual::Base imageVisual = DevelControl::GetVisual(*this, Toolkit::ImageView::Property::IMAGE);
+ if(imageVisual)
+ {
+ Dali::KeyFrames fadeinKeyFrames = Dali::KeyFrames::New();
+ fadeinKeyFrames.Add(0.0f, LOW_OPACITY);
+ fadeinKeyFrames.Add(1.0f, destinationAlpha);
+ mTransitionAnimation.AnimateBetween(DevelControl::GetVisualProperty(handle, Toolkit::ImageView::Property::IMAGE, Toolkit::Visual::Property::OPACITY), fadeinKeyFrames, AlphaFunction::EASE_IN_OUT);
+ imageVisual.SetDepthIndex(imageVisual.GetDepthIndex() + CURRENT_VISUAL_DEPTH_INDEX);
+ }
+
+ // Play transition animation
+ mTransitionAnimation.FinishedSignal().Connect(this, &ImageView::OnTransitionAnimationFinishedCallback);
+ mTransitionAnimation.Play();
+ }
+}
+
+void ImageView::ClearTransitionAnimation()
+{
+ // Clear PreviousVisual
+ if(mPreviousVisual)
+ {
+ Actor self = Self();
+ Internal::Control::Impl& controlDataImpl = Internal::Control::Impl::Get(*this);
+ controlDataImpl.EnableReadyTransitionOverriden(mVisual, false);
+ Toolkit::GetImplementation(mPreviousVisual).SetOffScene(self);
+ mPreviousVisual.Reset();
+ }
+
+ if(mTransitionAnimation)
+ {
+ if(mTransitionAnimation.GetState() == Animation::PLAYING)
+ {
+ mTransitionAnimation.Stop();
+ }
+ mTransitionAnimation.FinishedSignal().Disconnect(this, &ImageView::OnTransitionAnimationFinishedCallback);
+ mTransitionAnimation.Clear();
+ mTransitionAnimation.Reset();
+
+ // After transition effect is cleared, we don't need transition effect until image is replaced.
+ mImageReplaced = false;
+ }
}
///////////////////////////////////////////////////////////
}
break;
}
+
+ case Toolkit::ImageView::Property::PLACEHOLDER_IMAGE:
+ {
+ std::string placeholderUrl;
+ if(value.Get(placeholderUrl))
+ {
+ impl.SetPlaceholderUrl(placeholderUrl);
+ }
+ break;
+ }
+
+ case Toolkit::ImageView::Property::ENABLE_TRANSITION_EFFECT:
+ {
+ bool transitionEffect;
+ if(value.Get(transitionEffect))
+ {
+ impl.EnableTransitionEffect(transitionEffect);
+ }
+ break;
+ }
}
}
}
value = impl.IsPreMultipliedAlphaEnabled();
break;
}
+
+ case Toolkit::ImageView::Property::PLACEHOLDER_IMAGE:
+ {
+ value = impl.GetPlaceholderUrl();
+ break;
+ }
+
+ case Toolkit::ImageView::Property::ENABLE_TRANSITION_EFFECT:
+ {
+ value = impl.IsTransitionEffectEnabled();
+ break;
+ }
}
}
return value;
}
+void ImageView::OnTransitionAnimationFinishedCallback(Animation& animation)
+{
+ // Hide placeholder
+ HidePlaceholderImage();
+ ClearTransitionAnimation();
+}
+
} // namespace Internal
} // namespace Toolkit
} // namespace Dali
projects / platform / core / uifw / dali-toolkit.git / blobdiff