Enhance the material design ripple API so the ripple's state can be controlled by it's owning View.

ui/views/animation/ink_drop_animation_controller_impl.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_CONTROLLER_H_
-#define UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_CONTROLLER_H_
+#ifndef UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_CONTROLLER_IMPL_H_
+#define UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_CONTROLLER_IMPL_H_
 
 #include "base/memory/scoped_ptr.h"
 #include "base/time/time.h"
+#include "ui/compositor/layer_owner.h"
 #include "ui/events/event_handler.h"
+#include "ui/gfx/geometry/rect.h"
+#include "ui/gfx/geometry/size.h"
+#include "ui/views/animation/ink_drop_animation_controller.h"
 #include "ui/views/views_export.h"
 
 namespace ui {
 class Layer;
 }
 
 namespace views {
 class AppearAnimationObserver;
 class InkDropDelegate;
+class InkDropHost;
 class View;
 
-// Controls an animation which can be associated to a ui::Layer backed View.
-// It sets itself as the pre-target handler for the supplied view, providing
-// animations for user interactions. The events will not be consumed.
-//
-// The supplied views::View will be forced to have a layer, and this controller
-// will add child layers to that.
-class VIEWS_EXPORT InkDropAnimationController : public ui::EventHandler {
+// Controls an ink drop animation which is hosted by an InkDropHost.
+class VIEWS_EXPORT InkDropAnimationControllerImpl
+    : public InkDropAnimationController {
  public:
-  explicit InkDropAnimationController(View* view);
-  ~InkDropAnimationController() override;
+  // Constructs an ink drop controller that will attach the ink drop to the
+  // given |ink_drop_host|.
+  explicit InkDropAnimationControllerImpl(InkDropHost* ink_drop_host);
+  ~InkDropAnimationControllerImpl() override;
+
+  // InkDropAnimationController:
+  void AnimateToState(InkDropState state) override;
+  void SetInkDropSize(const gfx::Size& size) override;
+  gfx::Rect GetInkDropBounds() const override;
+  void SetInkDropBounds(const gfx::Rect& bounds) override;
 
  private:
   // Starts the animation of a touch event.
   void AnimateTapDown();
 
   // Schedules the hide animation of |ink_drop_layer_| for once its current
   // animation has completed. If |ink_drop_layer_| is not animating, the hide
   // animation begins immediately.
   void AnimateHide();
 
   // Starts the animation of a long press, and cancels hiding |ink_drop_layer_|
   // until the long press has completed.
   void AnimateLongPress();
 
   // Starts the showing animation on |layer|, with a |duration| in milliseconds.
   void AnimateShow(ui::Layer* layer,
                    AppearAnimationObserver* observer,
-                   bool circle,
                    base::TimeDelta duration);
 
   // Sets the bounds for |layer|.
-  void SetLayerBounds(ui::Layer* layer, bool circle, int width, int height);
+  void SetLayerBounds(ui::Layer* layer);
 
-  // Initializes |layer| and attaches it to |parent|.
-  void SetupAnimationLayer(ui::Layer* parent,
-                           ui::Layer* layer,
-                           InkDropDelegate* delegate);
+  // Initializes |layer|'s properties.
+  void SetupAnimationLayer(ui::Layer* layer, InkDropDelegate* delegate);
 
-  // ui::EventHandler:
-  void OnGestureEvent(ui::GestureEvent* event) override;
+  InkDropHost* ink_drop_host_;
 
-  // The layer for animating a user touch. Added as a child to |view_|'s layer.
-  // It will be stacked underneath.
-  scoped_ptr<ui::Layer> ink_drop_layer_;
+  // Owner of the root layer that parents the animating layers.
+  ui::LayerOwner root_layer_owner_;
+
+  // Owner of the layer used for animating a user touch.
+  ui::LayerOwner ink_drop_layer_owner_;
 
   // ui::LayerDelegate responsible for painting to |ink_drop_layer_|.
   scoped_ptr<InkDropDelegate> ink_drop_delegate_;
 
   // ui::ImplicitAnimationObserver which observes |ink_drop_layer_| and can be
   // used to automatically trigger a hide animation upon completion.
   scoped_ptr<AppearAnimationObserver> appear_animation_observer_;
 
-  // The layer for animating a long press. Added as a child to |view_|'s layer.
-  // It will be stacked underneath.
-  scoped_ptr<ui::Layer> long_press_layer_;
+  // Owner of the layer used for animating a long press.
+  ui::LayerOwner long_press_layer_owner_;

[sadrul, 2015/08/18 17:51:49]

Is there a reason to not use scoped_ptr<Layer> for these?

[bruthig, 2015/08/18 19:04:38]

Yes, ScreenRotationAnimator creates a copy of all the layers and if these were
scoped_ptr<Layer>'s then they would become stale/invalid every time the screen
rotated.

[sadrul, 2015/08/18 19:52:38]

That sounds odd (and a buggy behaviour; ScreenRotationAnimator should not
invalidate layers owned by someone else (or if it does, it needs a mechanism to
notify the owners)). Looking at window_util.cc:CloneChildren(), it looks like
that should not be the case though (i.e. since it seems to skip over the Layers
that don't have LayerOwners?)

[bruthig, 2015/08/18 20:58:04]

Hmm, you are right, I was mistaken.  I've changed them to scoped_ptr<Layer>'s.

 
   // ui::LayerDelegate responsible for painting to |long_press_layer_|.
   scoped_ptr<InkDropDelegate> long_press_delegate_;
 
   // ui::ImplicitAnimationObserver which observers |long_press_layer_| and can
   // be used to automatically trigger a hide animation upon completion.
   scoped_ptr<AppearAnimationObserver> long_press_animation_observer_;
 
-  // The View for which InkDropAnimationController is a PreTargetHandler.
-  View* view_;
+  // The bounds of the ink drop layers. Defined in the coordinate space of the
+  // parent ui::Layer that the ink drop layers were added to.
+  gfx::Rect ink_drop_bounds_;
 
-  DISALLOW_COPY_AND_ASSIGN(InkDropAnimationController);
+  DISALLOW_COPY_AND_ASSIGN(InkDropAnimationControllerImpl);
 };
 
 }  // namespace views
 
-#endif  // UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_CONTROLLER_H_
+#endif  // UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_CONTROLLER_IMPL_H_