Make the material design ripple effect more visible on a quick action (single click or single tap)

ui/views/animation/ink_drop_animation.h

 // 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.
 
 #ifndef UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_H_
 #define UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_H_
 
+#include <string>
+
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list.h"
 #include "base/time/time.h"
 #include "ui/compositor/layer_animator.h"
+#include "ui/gfx/animation/tween.h"
+#include "ui/gfx/geometry/point.h"
 #include "ui/gfx/geometry/size.h"
 #include "ui/gfx/transform.h"
 #include "ui/views/animation/ink_drop_state.h"
 #include "ui/views/views_export.h"
 
 namespace ui {
 class CallbackLayerAnimationObserver;
 class Layer;
 class LayerAnimationObserver;
 class LayerDelegate;
 }  // namespace ui
 
 namespace views {
 class CircleLayerDelegate;
 class InkDropAnimationObserver;
 class RectangleLayerDelegate;
 
 namespace test {
 class InkDropAnimationTestApi;
 }  // namespace test
 
 // An ink drop animation that smoothly animates between a circle and a rounded
 // rectangle of different sizes for each of the different InkDropStates. The
 // final frame for each InkDropState will be bounded by either a |large_size_|
 // rectangle or a |small_size_| rectangle.
 //
+// The valid InkDropState transitions are defined below:
+//
+//   {All InkDropStates}      => HIDDEN
+//   HIDDEN                   => ACTION_PENDING
+//   HIDDEN, ACTION_PENDING   => QUICK_ACTION
+//   ACTION_PENDING           => SLOW_ACTION_PENDING
+//   SLOW_ACTION_PENDING      => SLOW_ACTION
+//   {All InkDropStates}      => ACTIVATED
+//   {All InkDropStates}      => DEACTIVATED
+//
 // TODO(bruthig): Document the ink drop ripple on chromium.org and add a link to
 // it.
 class VIEWS_EXPORT InkDropAnimation {
  public:
+  // The opacity of the ink drop when it is visible.
+  static const float kVisibleOpacity;
+
+  // The opacity of the ink drop when it is not visible.
+  static const float kHiddenOpacity;
+
   InkDropAnimation(const gfx::Size& large_size,
                    int large_corner_radius,
                    const gfx::Size& small_size,
                    int small_corner_radius);
   ~InkDropAnimation();
 
   // The root Layer that can be added in to a Layer tree.
   ui::Layer* root_layer() { return root_layer_.get(); }
 
   InkDropState ink_drop_state() const { return ink_drop_state_; }
 
   void AddObserver(InkDropAnimationObserver* observer);
   void RemoveObserver(InkDropAnimationObserver* observer);
 
-  // Animates from the current |ink_drop_state_| to a new |ink_drop_state|. It
-  // is possible to animate from any |ink_drop_state_| to any new
-  // |ink_drop_state|. Note that some state transitions will also perform an
-  // implicit transition to the another state. e.g. AnimateToState(QUICK_ACTION)
-  // will implicitly transition to the HIDDEN state.
+  // Animates from the current |ink_drop_state_| to a new |ink_drop_state|.
   void AnimateToState(InkDropState ink_drop_state);
 
   // Sets the |center_point| of the ink drop layer relative to its parent Layer.
   void SetCenterPoint(const gfx::Point& center_point);
 
+  // Immediately aborts all in-progress animations and hides the ink drop.
+  // NOTE: This will NOT raise InkDropAnimation(Started|Ended) events for the
+  // state transition to HIDDEN!
+  void HideImmediately();
+
  private:
   friend class test::InkDropAnimationTestApi;
 
   // Enumeration of the different shapes that compose the ink drop.
   enum PaintedShape {
     TOP_LEFT_CIRCLE = 0,
     TOP_RIGHT_CIRCLE,
     BOTTOM_RIGHT_CIRCLE,
     BOTTOM_LEFT_CIRCLE,
     HORIZONTAL_RECT,
     VERTICAL_RECT,
     // The total number of shapes, not an actual shape.
     PAINTED_SHAPE_COUNT
   };
 
   // Returns a human readable string for the |painted_shape| value.
   static std::string ToLayerName(PaintedShape painted_shape);
 
   // Type that contains a gfx::Tansform for each of the layers required by the
   // ink drop.
   typedef gfx::Transform InkDropTransforms[PAINTED_SHAPE_COUNT];
 
-  // Animates the ripple to |ink_drop_state| and attaches |observer| to all
-  // LayerAnimationSequence's used.
+  // Animates the ripple to |ink_drop_state|. |observer| is added to all
+  // LayerAnimationSequence's used if not null.
   void AnimateToStateInternal(InkDropState ink_drop_state,
                               ui::LayerAnimationObserver* observer);
 
-  // Animates all of the painted shape layers to the specified |transforms| and
-  // |opacity|. The animation will use the given |duration| and
-  // |preemption_strategy|, and |observer| will be added to all
-  // LayerAnimationSequences.
+  // Animates all of the painted shape layers to the specified |transforms|. The
+  // animation will be configured with the given |duration|, |tween|, and
+  // |preemption_strategy| values. The |observer| will be added to all
+  // LayerAnimationSequences if not null.
   void AnimateToTransforms(
       const InkDropTransforms transforms,
-      float opacity,
       base::TimeDelta duration,
       ui::LayerAnimator::PreemptionStrategy preemption_strategy,
+      gfx::Tween::Type tween,
       ui::LayerAnimationObserver* observer);
 
   // Updates the Transforms and opacity to the HIDDEN state.
   void SetStateToHidden();
 
   // Sets the |transforms| on all of the shape layers. Note that this does not
   // perform any animation.
   void SetTransforms(const InkDropTransforms transforms);
 
+  // Gets the opacity of the ink drop.
+  float GetCurrentOpacity() const;
+
   // Sets the opacity of the ink drop.
   void SetOpacity(float opacity);
 
+  // Animates all of the painted shape layers to the specified |opacity|. The
+  // animation will be configured with the given |duration|, |tween|, and
+  // |preemption_strategy| values. The |observer| will be added to all
+  // LayerAnimationSequences if not null.
+  void AnimateToOpacity(
+      float opacity,
+      base::TimeDelta duration,
+      ui::LayerAnimator::PreemptionStrategy preemption_strategy,
+      gfx::Tween::Type tween,
+      ui::LayerAnimationObserver* observer);
+
   // Updates all of the Transforms in |transforms_out| for a circle of the given
   // |size|.
   void CalculateCircleTransforms(const gfx::Size& size,
                                  InkDropTransforms* transforms_out) const;
 
   // Updates all of the Transforms in |transforms_out| for a rounded rectangle
   // of the given |size| and |corner_radius|.
   void CalculateRectTransforms(const gfx::Size& size,
                                float corner_radius,
                                InkDropTransforms* transforms_out) const;
 
-  // Updates all of the Transforms in |transforms_out| to the current target
-  // Transforms of the Layers.
-  void GetCurrentTansforms(InkDropTransforms* transforms_out) const;
+  // Updates all of the Transforms in |transforms_out| to the current Transforms
+  // of the painted shape Layers.
+  void GetCurrentTransforms(InkDropTransforms* transforms_out) const;
 
   // Adds and configures a new |painted_shape| layer to |painted_layers_|.
   void AddPaintLayer(PaintedShape painted_shape);
 
   void AbortAllAnimations();
 
   // The Callback invoked when all of the animation sequences for the specific
   // |ink_drop_state| animation have started. |observer| is the
   // ui::CallbackLayerAnimationObserver which is notifying the callback.
   void AnimationStartedCallback(
@@ skipping 42 matching lines @@
 
   // List of observers to notify when animations have finished.
   base::ObserverList<InkDropAnimationObserver> observers_;
 
   DISALLOW_COPY_AND_ASSIGN(InkDropAnimation);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_H_