ui/views/animation/ink_drop_animation.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_H_
   6 #define UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_H_
   7
   8 #include "base/macros.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "base/time/time.h"
  11 #include "ui/compositor/layer_animator.h"
  12 #include "ui/gfx/geometry/size.h"
  13 #include "ui/gfx/geometry/size_f.h"
  14 #include "ui/gfx/transform.h"
  15 #include "ui/views/animation/ink_drop_state.h"
  16 #include "ui/views/views_export.h"
  17
  18 namespace ui {
  19 class Layer;
  20 class LayerDelegate;
  21 }  // namespace ui
  22
  23 namespace views {
  24 class CircleLayerDelegate;
  25 class RectangleLayerDelegate;
  26
  27 namespace test {
  28 class InkDropAnimationTestApi;
  29 }  // namespace test
  30
  31 // An ink drop animation that smoothly animates between a circle and a rounded
  32 // rectangle of different sizes for each of the different InkDropStates. The
  33 // final frame for each InkDropState will be bounded by either a |large_size_|
  34 // rectangle or a |small_size_| rectangle.
  35 //
  36 // TODO(bruthig): Document the ink drop ripple on chromium.org and add a link to
  37 // it.
  38 class VIEWS_EXPORT InkDropAnimation {
  39  public:
  40   InkDropAnimation(const gfx::Size& large_size,
  41                    int large_corner_radius,
  42                    const gfx::Size& small_size,
  43                    int small_corner_radius);
  44   ~InkDropAnimation();
  45
  46   // The root Layer that can be added in to a Layer tree.
  47   ui::Layer* root_layer() { return root_layer_.get(); }
  48
  49   InkDropState ink_drop_state() const { return ink_drop_state_; }
  50
  51   // Animates from the current |ink_drop_state_| to a new |ink_drop_state|. It
  52   // is possible to animate from any |ink_drop_state_| to any new
  53   // |ink_drop_state|. Note that some state transitions will also perform an
  54   // implicit transition to the another state. e.g. AnimateToState(QUICK_ACTION)
  55   // will implicitly transition to the HIDDEN state.
  56   void AnimateToState(InkDropState ink_drop_state);
  57
  58   // Sets the |center_point| of the ink drop layer relative to its parent Layer.
  59   void SetCenterPoint(const gfx::Point& center_point);
  60
  61  private:
  62   friend class test::InkDropAnimationTestApi;
  63
  64   // Enumeration of the different shapes that compose the ink drop.
  65   enum PaintedShape {
  66     TOP_LEFT_CIRCLE = 0,
  67     TOP_RIGHT_CIRCLE,
  68     BOTTOM_RIGHT_CIRCLE,
  69     BOTTOM_LEFT_CIRCLE,
  70     HORIZONTAL_RECT,
  71     VERTICAL_RECT,
  72     // The total number of shapes, not an actual shape.
  73     PAINTED_SHAPE_COUNT
  74   };
  75
  76   // Type that contains a gfx::Tansform for each of the layers required by the
  77   // ink drop.
  78   typedef gfx::Transform InkDropTransforms[PAINTED_SHAPE_COUNT];
  79
  80   // Animates all of the painted shape layers to the specified |transforms| and
  81   // |opacity|.
  82   void AnimateToTransforms(
  83       const InkDropTransforms transforms,
  84       float opacity,
  85       base::TimeDelta duration,
  86       ui::LayerAnimator::PreemptionStrategy preemption_strategy);
  87
  88   // Resets the Transforms on all the owned Layers to a minimum size.
  89   void ResetTransformsToMinSize();
  90
  91   // Sets the |transforms| on all of the shape layers. Note that this does not
  92   // perform any animation.
  93   void SetTransforms(const InkDropTransforms transforms);
  94
  95   // Sets the opacity of the ink drop.
  96   void SetOpacity(float opacity);
  97
  98   // Updates all of the Transforms in |transforms_out| for a circle of the given
  99   // |size|.
 100   void CalculateCircleTransforms(const gfx::SizeF& size,
 101                                  InkDropTransforms* transforms_out) const;
 102
 103   // Updates all of the Transforms in |transforms_out| for a rounded rectangle
 104   // of the given |size| and |corner_radius|.
 105   void CalculateRectTransforms(const gfx::SizeF& size,
 106                                float corner_radius,
 107                                InkDropTransforms* transforms_out) const;
 108
 109   // Updates all of the Transforms in |transforms_out| to the current target
 110   // Transforms of the Layers.
 111   void GetCurrentTansforms(InkDropTransforms* transforms_out) const;
 112
 113   // Adds and configures a new |painted_shape| layer to |painted_layers_|.
 114   void AddPaintLayer(PaintedShape painted_shape);
 115
 116   // Maximum size that an ink drop will be drawn to for any InkDropState whose
 117   // final frame should be large.
 118   gfx::Size large_size_;
 119
 120   // Corner radius used to draw the rounded rectangles corner for any
 121   // InkDropState whose final frame should be large.
 122   int large_corner_radius_;
 123
 124   // Maximum size that an ink drop will be drawn to for any InkDropState whose
 125   // final frame should be small.
 126   gfx::Size small_size_;
 127
 128   // Corner radius used to draw the rounded rectangles corner for any
 129   // InkDropState whose final frame should be small.
 130   int small_corner_radius_;
 131
 132   // ui::LayerDelegate to paint circles for all the circle layers.
 133   scoped_ptr<CircleLayerDelegate> circle_layer_delegate_;
 134
 135   // ui::LayerDelegate to paint rectangles for all the rectangle layers.
 136   scoped_ptr<RectangleLayerDelegate> rect_layer_delegate_;
 137
 138   // The root layer that parents the animating layers. The root layer is used to
 139   // manipulate opacity and location, and its children are used to manipulate
 140   // the different painted shapes that compose the ink drop.
 141   scoped_ptr<ui::Layer> root_layer_;
 142
 143   // ui::Layers for all of the painted shape layers that compose the ink drop.
 144   scoped_ptr<ui::Layer> painted_layers_[PAINTED_SHAPE_COUNT];
 145
 146   // The current ink drop state.
 147   InkDropState ink_drop_state_;
 148
 149   DISALLOW_COPY_AND_ASSIGN(InkDropAnimation);
 150 };
 151
 152 }  // namespace views
 153
 154 #endif  // UI_VIEWS_ANIMATION_INK_DROP_ANIMATION_H_