[dali_2.3.24] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / image-view / image-view-impl.cpp
index 5c522ba..a59ac36 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 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.
@@ -25,6 +25,7 @@
 #include <dali/public-api/object/type-registry.h>
 
 // INTERNAL INCLUDES
+#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>
@@ -45,10 +46,14 @@ namespace
 {
 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 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();
@@ -74,7 +79,8 @@ ImageView::ImageView(ControlBehaviour additionalBehaviour)
   mImageVisualPaddingSetByTransform(false),
   mImageViewPixelAreaSetByFittingMode(false),
   mTransitionEffect(false),
-  mNeedLazyFittingMode(false)
+  mNeedLazyFittingMode(false),
+  mImageReplaced(false)
 {
 }
 
@@ -117,7 +123,8 @@ void ImageView::SetImage(const Property::Map& map)
       {
         if(mTransitionAnimation.GetState() == Animation::PLAYING)
         {
-          mTransitionAnimation.Stop();
+          // Hide placeholder
+          HidePlaceholderImage();
           ClearTransitionAnimation();
         }
       }
@@ -134,6 +141,8 @@ void ImageView::SetImage(const Property::Map& map)
   mPropertyMap = map;
   mUrl.clear();
 
+  mImageReplaced = true;
+
   // keep alpha for transition effect
   if(mTransitionEffect)
   {
@@ -165,7 +174,7 @@ void ImageView::SetImage(const Property::Map& map)
       visualImpl.SetCustomShader(mShaderMap);
     }
 
-    DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
+    DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual, DepthIndex::CONTENT);
   }
   else
   {
@@ -175,7 +184,6 @@ void ImageView::SetImage(const Property::Map& map)
     // Trigger a size negotiation request that may be needed when unregistering a visual.
     RelayoutRequest();
   }
-
   // Signal that a Relayout may be needed
 }
 
@@ -190,7 +198,7 @@ void ImageView::SetImage(const std::string& url, ImageDimensions size)
       {
         if(mTransitionAnimation.GetState() == Animation::PLAYING)
         {
-          mTransitionAnimation.Stop();
+          HidePlaceholderImage();
           ClearTransitionAnimation();
         }
       }
@@ -208,6 +216,8 @@ void ImageView::SetImage(const std::string& url, ImageDimensions size)
   mImageSize = size;
   mPropertyMap.Clear();
 
+  mImageReplaced = true;
+
   if(!mVisual)
   {
     ShowPlaceholderImage();
@@ -228,7 +238,7 @@ void ImageView::SetImage(const std::string& url, ImageDimensions size)
       visualImpl.SetCustomShader(mShaderMap);
     }
 
-    DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual);
+    DevelControl::RegisterVisual(*this, Toolkit::ImageView::Property::IMAGE, visual, DepthIndex::CONTENT);
   }
   else
   {
@@ -238,7 +248,6 @@ void ImageView::SetImage(const std::string& url, ImageDimensions size)
     // Trigger a size negotiation request that may be needed when unregistering a visual.
     RelayoutRequest();
   }
-
   // Signal that a Relayout may be needed
 }
 
@@ -390,6 +399,12 @@ void ImageView::OnRelayout(const Vector2& size, RelayoutContainer& container)
     {
       visual.SetTransformAndSize(Property::Map(), size);
     }
+
+    if(!mTransitionEffect)
+    {
+      // we don't need placeholder anymore because visual is replaced. so hide placeholder.
+      HidePlaceholderImage();
+    }
   }
 }
 
@@ -445,15 +460,6 @@ void ImageView::OnResourceReady(Toolkit::Control control)
       // when placeholder is disabled or ready placeholder and image, we need to transition effect
       TransitionImageWithEffect();
     }
-    else
-    {
-      ClearTransitionAnimation();
-    }
-  }
-  else
-  {
-    // we don't need placeholder anymore because visual is replaced. so hide placeholder.
-    HidePlaceholderImage();
   }
 
   // Visual ready so update visual attached to this ImageView, following call to RelayoutRequest will use this visual.
@@ -556,7 +562,7 @@ void ImageView::ApplyFittingMode(const Vector2& size)
   bool zeroPadding = (padding == Extents());
 
   Dali::LayoutDirection::Type layoutDirection = static_cast<Dali::LayoutDirection::Type>(
-  Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
+    Self().GetProperty(Dali::Actor::Property::LAYOUT_DIRECTION).Get<int>());
   if(Dali::LayoutDirection::RIGHT_TO_LEFT == layoutDirection)
   {
     std::swap(padding.start, padding.end);
@@ -635,6 +641,7 @@ void ImageView::CreatePlaceholderImage()
   if(mPlaceholderVisual)
   {
     mPlaceholderVisual.SetName("placeholder");
+    mPlaceholderVisual.SetDepthIndex(mPlaceholderVisual.GetDepthIndex() + PLACEHOLDER_DEPTH_INDEX);
   }
   else
   {
@@ -671,6 +678,23 @@ void ImageView::TransitionImageWithEffect()
 
   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;
@@ -682,7 +706,8 @@ void ImageView::TransitionImageWithEffect()
       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);
+      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
@@ -693,9 +718,6 @@ void ImageView::TransitionImageWithEffect()
 
 void ImageView::ClearTransitionAnimation()
 {
-  // Hide placeholder
-  HidePlaceholderImage();
-
   // Clear PreviousVisual
   if(mPreviousVisual)
   {
@@ -708,8 +730,16 @@ void ImageView::ClearTransitionAnimation()
 
   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;
   }
 }
 
@@ -871,6 +901,8 @@ Property::Value ImageView::GetProperty(BaseObject* object, Property::Index prope
 
 void ImageView::OnTransitionAnimationFinishedCallback(Animation& animation)
 {
+  // Hide placeholder
+  HidePlaceholderImage();
   ClearTransitionAnimation();
 }