Made material design ink drop QUICK_ACTION animation more visible.

ui/views/animation/ink_drop_animation.cc

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/views/animation/ink_drop_animation.h"
 
 #include <algorithm>
 
 #include "base/command_line.h"
 #include "base/logging.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/base/ui_base_switches.h"
 #include "ui/compositor/callback_layer_animation_observer.h"
 #include "ui/compositor/layer.h"
 #include "ui/compositor/layer_animation_sequence.h"
 #include "ui/compositor/scoped_layer_animation_settings.h"
+#include "ui/gfx/geometry/point3_f.h"
 #include "ui/gfx/geometry/point_conversions.h"
+#include "ui/gfx/geometry/point_f.h"
+#include "ui/gfx/geometry/vector3d_f.h"
 #include "ui/gfx/transform_util.h"
 #include "ui/views/animation/ink_drop_animation_observer.h"
 #include "ui/views/animation/ink_drop_painted_layer_delegates.h"
 #include "ui/views/view.h"
 
 namespace {
 
 // The minimum scale factor to use when scaling rectangle layers. Smaller values
 // were causing visual anomalies.
 const float kMinimumRectScale = 0.0001f;
 
 // The minimum scale factor to use when scaling circle layers. Smaller values
 // were causing visual anomalies.
 const float kMinimumCircleScale = 0.001f;
 
 // The ink drop color.
 const SkColor kInkDropColor = SK_ColorBLACK;
 
 // The opacity of the ink drop when it is visible.
 const float kVisibleOpacity = 0.14f;
 
 // The opacity of the ink drop when it is not visible.
 const float kHiddenOpacity = 0.0f;
 
-// Durations for the different InkDropState animations in milliseconds.
-const int kHiddenStateAnimationDurationMs = 1;
-const int kActionPendingStateAnimationDurationMs = 500;
-const int kQuickActionStateAnimationDurationMs = 250;
-const int kSlowActionPendingStateAnimationDurationMs = 500;
-const int kSlowActionStateAnimationDurationMs = 250;
-const int kActivatedStateAnimationDurationMs = 125;
-const int kDeactivatedStateAnimationDurationMs = 250;
+// All the sub animations that are used to animate each of the InkDropStates.
+enum InkDropSubAnimations {
+  // The ACTION_PENDING animation has only one sub animation which animates to a
+  // |large_size_| circle at visible opacity.
+  ACTION_PENDING,
+
+  // The QUICK_ACTION animation consists of the two sub animations:
+  // QUICK_ACTION_VISIBLE, QUICK_ACTION_FADE_OUT. The final frame of the
+  // animation is a |large_size_| circle at hidden opacity.
+
+  // The portion of the QUICK_ACTION animation that is at visible opacity.
+  QUICK_ACTION_VISIBLE,
+
+  // The portion of the QUICK_ACTION animation that is at fading out to a hidden
+  // opacity.
+  QUICK_ACTION_FADE_OUT,
+
+  // The SLOW_ACTION_PENDING animation has only one sub animation which animates
+  // to a |small_size_| rounded rectangle at visible opacity.
+  SLOW_ACTION_PENDING,
+
+  // The SLOW_ACTION animation consists of the two sub animations:
+  // SLOW_ACTION_VISIBLE, SLOW_ACTION_FADE_OUT. The final frame of the
+  // animation is a |large_size_| rounded rectangle at hidden opacity.
+
+  // The portion of the SLOW_ACTION animation that is at visible opacity.
+  SLOW_ACTION_VISIBLE,
+
+  // The portion of the SLOW_ACTION animation that is fading out to a hidden
+  // opacity.
+  SLOW_ACTION_FADE_OUT,
+
+  // The ACTIVATED animation has only one sub animation which animates to a
+  // |small_size_| rounded rectangle at visible opacity.
+  ACTIVATED,
+
+  // The DEACTIVATED animation consists of the two sub animations:
+  // DEACTIVATED_VISIBLE, DEACTIVATED_FADE_OUT. The final frame of the
+  // animation is a |large_size_| rounded rectangle at hidden opacity.
+
+  // The portion of the DEACTIVATED animation that is at visible opacity.
+  DEACTIVATED_VISIBLE,
+
+  // The portion of the DEACTIVATED animation that is fading out to a hidden
+  // opacity.
+  DEACTIVATED_FADE_OUT,
+};
+
+// The time taken to animate the ACTION_PENDING animation.
+const int kActionPendingAnimationDurationMs = 500;
+
+// The time taken to animate the visible portion of the QUICK_ACTION animation.
+const int kQuickActionVisibleAnimationDurationMs = 200;
+
+// The time taken to animate the fade out portion of the QUICK_ACTION animation.
+const int kQuickActionFadeOutAnimationDurationMs = 100;
+
+// The time taken to animate the SLOW_ACTION_PENDING animation.
+const int kSlowActionPendingAnimationDurationMs = 100;
+
+// The time taken to animate the visible portion of the SLOW_ACTION animation.
+const int kSlowActionVisibleAnimationDurationMs = 150;
+
+// The time taken to animate the fade out portion of the SLOW_ACTION animation.
+const int kSlowActionFadeOutAnimationDurationMs = 100;
+
+// The time taken to animate the ACTIVATED animation.
+const int kActivatedAnimationDurationMs = 125;
+
+// The time taken to animate the visible portion of the DEACTIVATED animation.
+const int kDeactivatedVisibleAnimationDurationMs = 150;
+
+// The time taken to animate the fade out portion of the DEACTIVATED animation.
+const int kDeactivatedFadeOutAnimationDurationMs = 100;
 
 // A multiplicative factor used to slow down InkDropState animations.
 const int kSlowAnimationDurationFactor = 3;
 
 // Checks CommandLine switches to determine if the visual feedback should have
 // a fast animations speed.
 bool UseFastAnimations() {
   static bool fast =
       base::CommandLine::ForCurrentProcess()->GetSwitchValueASCII(
           (::switches::kMaterialDesignInkDropAnimationSpeed)) !=
       ::switches::kMaterialDesignInkDropAnimationSpeedSlow;
   return fast;
 }
 
 // Returns the InkDropState animation duration for the given |state|.
-base::TimeDelta GetAnimationDuration(views::InkDropState state) {
+base::TimeDelta GetAnimationDuration(InkDropSubAnimations state) {
   int duration = 0;
   switch (state) {
-    case views::InkDropState::HIDDEN:
-      duration = kHiddenStateAnimationDurationMs;
+    case ACTION_PENDING:
+      duration = kActionPendingAnimationDurationMs;
       break;
-    case views::InkDropState::ACTION_PENDING:
-      duration = kActionPendingStateAnimationDurationMs;
+    case QUICK_ACTION_VISIBLE:
+      duration = kQuickActionVisibleAnimationDurationMs;
       break;
-    case views::InkDropState::QUICK_ACTION:
-      duration = kQuickActionStateAnimationDurationMs;
+    case QUICK_ACTION_FADE_OUT:
+      duration = kQuickActionFadeOutAnimationDurationMs;
       break;
-    case views::InkDropState::SLOW_ACTION_PENDING:
-      duration = kSlowActionPendingStateAnimationDurationMs;
+    case SLOW_ACTION_PENDING:
+      duration = kSlowActionPendingAnimationDurationMs;
       break;
-    case views::InkDropState::SLOW_ACTION:
-      duration = kSlowActionStateAnimationDurationMs;
+    case SLOW_ACTION_VISIBLE:
+      duration = kSlowActionVisibleAnimationDurationMs;
       break;
-    case views::InkDropState::ACTIVATED:
-      duration = kActivatedStateAnimationDurationMs;
+    case SLOW_ACTION_FADE_OUT:
+      duration = kSlowActionFadeOutAnimationDurationMs;
       break;
-    case views::InkDropState::DEACTIVATED:
-      duration = kDeactivatedStateAnimationDurationMs;
+    case ACTIVATED:
+      duration = kActivatedAnimationDurationMs;
+      break;
+    case DEACTIVATED_VISIBLE:
+      duration = kDeactivatedVisibleAnimationDurationMs;
+      break;
+    case DEACTIVATED_FADE_OUT:
+      duration = kDeactivatedFadeOutAnimationDurationMs;
       break;
   }
-
   return base::TimeDelta::FromMilliseconds(
       (UseFastAnimations() ? 1 : kSlowAnimationDurationFactor) * duration);
 }
 
 // Calculates a Transform for a circle layer. The transform will be set up to
 // translate the |drawn_center_point| to the origin, scale, and then translate
 // to the target point defined by |target_center_x| and |target_center_y|.
 gfx::Transform CalculateCircleTransform(const gfx::Point& drawn_center_point,
                                         float scale,
                                         float target_center_x,
@@ skipping 97 matching lines @@
     case PAINTED_SHAPE_COUNT:
       NOTREACHED() << "The PAINTED_SHAPE_COUNT value should never be used.";
       return "PAINTED_SHAPE_COUNT";
   }
   return "UNKNOWN";
 }
 
 void InkDropAnimation::AnimateToStateInternal(
     InkDropState ink_drop_state,
     ui::LayerAnimationObserver* animation_observer) {
+  const InkDropState previous_ink_drop_state_ = ink_drop_state_;
   ink_drop_state_ = ink_drop_state;
 
   if (ink_drop_state_ == InkDropState::HIDDEN) {
     // Animating to the HIDDEN state doesn't actually use any
     // LayerAnimationSequences so we need to explicitly abort any running ones
     // so that observers receive an InkDropAnimationEnded() event for the
     // running animation prior to receiving an InkDropAnimationStarted() event
     // for the HIDDEN 'animation'.
     AbortAllAnimations();
-    root_layer_->SetVisible(false);
     SetStateToHidden();
     return;
   }
 
   InkDropTransforms transforms;
   root_layer_->SetVisible(true);
 
   switch (ink_drop_state_) {
     case InkDropState::HIDDEN:
       // This case is handled above in a short circuit return.
       break;
     case InkDropState::ACTION_PENDING:
+      AnimateToOpacity(kVisibleOpacity, GetAnimationDuration(ACTION_PENDING),
+                       ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
+                       animation_observer);
       CalculateCircleTransforms(large_size_, &transforms);
-      AnimateToTransforms(transforms, kVisibleOpacity,
-                          GetAnimationDuration(InkDropState::ACTION_PENDING),
+      AnimateToTransforms(transforms, GetAnimationDuration(ACTION_PENDING),
                           ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
                           animation_observer);
       break;
-    case InkDropState::QUICK_ACTION:
+    case InkDropState::QUICK_ACTION: {
+      float visible_duration_ratio = 1.0f;
+
+      // If the previous state is ACTION_PENDING we don't want the QUICK_ACTION
+      // to take the full duration because the expanding ripple noticably
+      // changes speed.
+      if (previous_ink_drop_state_ == InkDropState::ACTION_PENDING) {
+        GetCurrentTransforms(&transforms);
+        visible_duration_ratio =
+            visible_duration_ratio -
+            CalculateDistanceEstimateToQuickAction(transforms);
+      }
+
+      const base::TimeDelta visible_duration =
+          GetAnimationDuration(QUICK_ACTION_VISIBLE) * visible_duration_ratio;
+
+      ui::LayerAnimator::PreemptionStrategy fade_out_preemption_strategy =
+          ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET;
+
+      base::TimeDelta total_effective_duration =
+          GetAnimationDuration(QUICK_ACTION_FADE_OUT);
+
+      if (visible_duration.InMilliseconds() > 0) {
+        fade_out_preemption_strategy = ui::LayerAnimator::ENQUEUE_NEW_ANIMATION;
+        total_effective_duration += visible_duration;
+        AnimateToOpacity(kVisibleOpacity, visible_duration,
+                         ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
+                         animation_observer);
+      }
+
+      AnimateToOpacity(kHiddenOpacity,
+                       GetAnimationDuration(QUICK_ACTION_FADE_OUT),
+                       fade_out_preemption_strategy, animation_observer);
       CalculateCircleTransforms(large_size_, &transforms);
-      AnimateToTransforms(transforms, kHiddenOpacity,
-                          GetAnimationDuration(InkDropState::QUICK_ACTION),
+      AnimateToTransforms(transforms, total_effective_duration,
                           ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
                           animation_observer);
       break;
+    }
     case InkDropState::SLOW_ACTION_PENDING:
+      AnimateToOpacity(kVisibleOpacity,
+                       GetAnimationDuration(SLOW_ACTION_PENDING),
+                       ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
+                       animation_observer);
       CalculateRectTransforms(small_size_, small_corner_radius_, &transforms);
-      AnimateToTransforms(
-          transforms, kVisibleOpacity,
-          GetAnimationDuration(InkDropState::SLOW_ACTION_PENDING),
-          ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
-          animation_observer);
+      AnimateToTransforms(transforms, GetAnimationDuration(SLOW_ACTION_PENDING),
+                          ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
+                          animation_observer);
       break;
     case InkDropState::SLOW_ACTION:
+      AnimateToOpacity(kVisibleOpacity,
+                       GetAnimationDuration(SLOW_ACTION_VISIBLE),
+                       ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
+                       animation_observer);
+      AnimateToOpacity(
+          kHiddenOpacity, GetAnimationDuration(SLOW_ACTION_FADE_OUT),
+          ui::LayerAnimator::ENQUEUE_NEW_ANIMATION, animation_observer);
       CalculateRectTransforms(large_size_, large_corner_radius_, &transforms);
-      AnimateToTransforms(transforms, kHiddenOpacity,
-                          GetAnimationDuration(InkDropState::SLOW_ACTION),
+      AnimateToTransforms(transforms,
+                          GetAnimationDuration(SLOW_ACTION_VISIBLE) +
+                              GetAnimationDuration(SLOW_ACTION_FADE_OUT),
                           ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
                           animation_observer);
       break;
     case InkDropState::ACTIVATED:
+      AnimateToOpacity(kVisibleOpacity, GetAnimationDuration(ACTIVATED),
+                       ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
+                       animation_observer);
       CalculateRectTransforms(small_size_, small_corner_radius_, &transforms);
-      AnimateToTransforms(transforms, kVisibleOpacity,
-                          GetAnimationDuration(InkDropState::ACTIVATED),
+      AnimateToTransforms(transforms, GetAnimationDuration(ACTIVATED),
                           ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
                           animation_observer);
       break;
     case InkDropState::DEACTIVATED:
+      AnimateToOpacity(kVisibleOpacity,
+                       GetAnimationDuration(DEACTIVATED_VISIBLE),
+                       ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
+                       animation_observer);
+      AnimateToOpacity(
+          kHiddenOpacity, GetAnimationDuration(DEACTIVATED_FADE_OUT),
+          ui::LayerAnimator::ENQUEUE_NEW_ANIMATION, animation_observer);
       CalculateRectTransforms(large_size_, large_corner_radius_, &transforms);
-      AnimateToTransforms(transforms, kHiddenOpacity,
-                          GetAnimationDuration(InkDropState::DEACTIVATED),
+      AnimateToTransforms(transforms,
+                          GetAnimationDuration(DEACTIVATED_VISIBLE) +
+                              GetAnimationDuration(DEACTIVATED_FADE_OUT),
                           ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET,
                           animation_observer);
       break;
   }
 }
 
 void InkDropAnimation::AnimateToTransforms(
     const InkDropTransforms transforms,
-    float opacity,
     base::TimeDelta duration,
     ui::LayerAnimator::PreemptionStrategy preemption_strategy,
     ui::LayerAnimationObserver* animation_observer) {
-  ui::LayerAnimator* root_animator = root_layer_->GetAnimator();
-  ui::ScopedLayerAnimationSettings root_animation(root_animator);
-  root_animation.SetPreemptionStrategy(preemption_strategy);
-  ui::LayerAnimationElement* root_element =
-      ui::LayerAnimationElement::CreateOpacityElement(opacity, duration);
-  ui::LayerAnimationSequence* root_sequence =
-      new ui::LayerAnimationSequence(root_element);
-
-  if (animation_observer)
-    root_sequence->AddObserver(animation_observer);
-
-  root_animator->StartAnimation(root_sequence);
-
   for (int i = 0; i < PAINTED_SHAPE_COUNT; ++i) {
     ui::LayerAnimator* animator = painted_layers_[i]->GetAnimator();
     ui::ScopedLayerAnimationSettings animation(animator);
     animation.SetPreemptionStrategy(preemption_strategy);
     ui::LayerAnimationElement* element =
         ui::LayerAnimationElement::CreateTransformElement(transforms[i],
                                                           duration);
     ui::LayerAnimationSequence* sequence =
         new ui::LayerAnimationSequence(element);
 
     if (animation_observer)
       sequence->AddObserver(animation_observer);
 
     animator->StartAnimation(sequence);
   }
 }
 
 void InkDropAnimation::SetStateToHidden() {
   InkDropTransforms transforms;
   // Using a size of 0x0 creates visual anomalies.
   CalculateCircleTransforms(gfx::Size(1, 1), &transforms);
   SetTransforms(transforms);
   SetOpacity(kHiddenOpacity);
+  root_layer_->SetVisible(false);
 }
 
 void InkDropAnimation::SetTransforms(const InkDropTransforms transforms) {
   for (int i = 0; i < PAINTED_SHAPE_COUNT; ++i)
     painted_layers_[i]->SetTransform(transforms[i]);
 }
 
 void InkDropAnimation::SetOpacity(float opacity) {
   root_layer_->SetOpacity(opacity);
 }
 
+void InkDropAnimation::AnimateToOpacity(
+    float opacity,
+    base::TimeDelta duration,
+    ui::LayerAnimator::PreemptionStrategy preemption_strategy,
+    ui::LayerAnimationObserver* animation_observer) {
+  ui::LayerAnimator* animator = root_layer_->GetAnimator();
+  ui::ScopedLayerAnimationSettings animation_settings(animator);
+  animation_settings.SetPreemptionStrategy(preemption_strategy);
+  ui::LayerAnimationElement* animation_element =
+      ui::LayerAnimationElement::CreateOpacityElement(opacity, duration);
+  ui::LayerAnimationSequence* animation_sequence =
+      new ui::LayerAnimationSequence(animation_element);
+
+  if (animation_observer)
+    animation_sequence->AddObserver(animation_observer);
+
+  animator->StartAnimation(animation_sequence);
+}
+
 void InkDropAnimation::CalculateCircleTransforms(
     const gfx::Size& size,
     InkDropTransforms* transforms_out) const {
   CalculateRectTransforms(size, std::min(size.width(), size.height()) / 2.0f,
                           transforms_out);
 }
 
 void InkDropAnimation::CalculateRectTransforms(
     const gfx::Size& size,
     float corner_radius,
@@ skipping 41 matching lines @@
       std::max(kMinimumRectScale,
                (size.height() - 2.0f * corner_radius) / rect_delegate_height));
 
   (*transforms_out)[VERTICAL_RECT] = CalculateRectTransform(
       ToRoundedPoint(rect_layer_delegate_->GetCenterPoint()),
       std::max(kMinimumRectScale,
                (size.width() - 2.0f * corner_radius) / rect_delegate_width),
       std::max(kMinimumRectScale, size.height() / rect_delegate_height));
 }
 
-void InkDropAnimation::GetCurrentTansforms(
+void InkDropAnimation::GetCurrentTransforms(
     InkDropTransforms* transforms_out) const {
   for (int i = 0; i < PAINTED_SHAPE_COUNT; ++i)
-    (*transforms_out)[i] = painted_layers_[i]->GetTargetTransform();
+    (*transforms_out)[i] = painted_layers_[i]->transform();
 }
 
 void InkDropAnimation::AddPaintLayer(PaintedShape painted_shape) {
   ui::LayerDelegate* delegate = nullptr;
   switch (painted_shape) {
     case TOP_LEFT_CIRCLE:
     case TOP_RIGHT_CIRCLE:
     case BOTTOM_RIGHT_CIRCLE:
     case BOTTOM_LEFT_CIRCLE:
       delegate = circle_layer_delegate_.get();
@@ skipping 20 matching lines @@
 
   painted_layers_[painted_shape].reset(layer);
 }
 
 void InkDropAnimation::AbortAllAnimations() {
   root_layer_->GetAnimator()->AbortAllAnimations();
   for (int i = 0; i < PAINTED_SHAPE_COUNT; ++i)
     painted_layers_[i]->GetAnimator()->AbortAllAnimations();
 }
 
+float InkDropAnimation::CalculateDistanceEstimateToQuickAction(
+    const InkDropTransforms& transforms) const {
+  gfx::Point3F circle_center_point =
+      gfx::Point3F(circle_layer_delegate_->GetCenterPoint());
+
+  gfx::Point3F circle_top_point(
+      circle_center_point.x(),
+      circle_center_point.y() - circle_layer_delegate_->radius(), 0);
+
+  transforms[TOP_LEFT_CIRCLE].TransformPoint(&circle_center_point);
+  transforms[TOP_LEFT_CIRCLE].TransformPoint(&circle_top_point);
+
+  // Calculate the ratio of how far the transformed circle's center point is
+  // from the destination compared to how far it can be.
+  const float center_point_distance_estimate =
+      1.0f -
+      gfx::Vector3dF(circle_center_point.x(), circle_center_point.y(), 0)
+              .Length() /
+          (gfx::Vector3dF(static_cast<float>(large_size_.width()),
+                          static_cast<float>(large_size_.height()), 0)
+               .Length() /
+           2.0f);
+
+  // Calculate the ratio of how far the transformed circle's topmost point is
+  // from the destination compared to how far it can be.
+  const float top_point_distance_estimate =
+      circle_top_point.y() / (large_size_.height() / 2.0f);
+
+  return std::min(center_point_distance_estimate, top_point_distance_estimate);
+}
+
 void InkDropAnimation::AnimationStartedCallback(
     InkDropState ink_drop_state,
     const ui::CallbackLayerAnimationObserver& observer) {
   FOR_EACH_OBSERVER(InkDropAnimationObserver, observers_,
                     InkDropAnimationStarted(ink_drop_state));
 }
 
 bool InkDropAnimation::AnimationEndedCallback(
     InkDropState ink_drop_state,
     const ui::CallbackLayerAnimationObserver& observer) {
   FOR_EACH_OBSERVER(
       InkDropAnimationObserver, observers_,
       InkDropAnimationEnded(ink_drop_state,
                             observer.aborted_count()
                                 ? InkDropAnimationObserver::PRE_EMPTED
                                 : InkDropAnimationObserver::SUCCESS));
   return true;
 }
 
 }  // namespace views