1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_GFX_ANIMATION_SLIDE_ANIMATION_H_
#define UI_GFX_ANIMATION_SLIDE_ANIMATION_H_
#include <optional>
#include "base/memory/raw_ptr.h"
#include "ui/gfx/animation/linear_animation.h"
#include "ui/gfx/animation/tween.h"
namespace gfx {
// Slide Animation
//
// Used for reversible animations and as a general helper class. Typical usage:
//
// #include "ui/gfx/animation/slide_animation.h"
//
// class MyClass : public AnimationDelegate {
// public:
// MyClass() {
// animation_.SetSlideDuration(base::Milliseconds(500));
// }
//
// void OnMouseEntered(const ui::MouseEvent& event) {
// animation_.Show();
// }
//
// void OnMouseExited(const ui::MouseEvent& event) {
// animation_.Hide();
// }
//
// void AnimationProgressed(const Animation* animation) {
// CHECK_EQ(animation, &animation_);
// hover_image_.SetOpacity(animation_.GetCurrentValue());
// }
//
// private:
// SlideAnimation animation_{this};
// }
class ANIMATION_EXPORT SlideAnimation : public LinearAnimation {
public:
explicit SlideAnimation(AnimationDelegate* target);
SlideAnimation(const SlideAnimation&) = delete;
SlideAnimation& operator=(const SlideAnimation&) = delete;
~SlideAnimation() override;
// Set the animation to some state.
virtual void Reset(double value = 0);
// Begin a showing animation or reverse a hiding animation in progress.
// Animates GetCurrentValue() towards 1.
virtual void Show();
// Begin a hiding animation or reverse a showing animation in progress.
// Animates GetCurrentValue() towards 0.
virtual void Hide();
// Sets the time a slide will take. Note that this isn't actually
// the amount of time an animation will take as the current value of
// the slide is considered.
virtual void SetSlideDuration(base::TimeDelta duration);
base::TimeDelta GetSlideDuration() const { return slide_duration_; }
void SetTweenType(Tween::Type tween_type) { tween_type_ = tween_type; }
// Dampens the reduction in duration for an animation which starts partway.
// The default value of 1 has no effect.
void SetDampeningValue(double dampening_value);
double GetCurrentValue() const override;
// TODO(bruthig): Fix IsShowing() and IsClosing() to be consistent. e.g.
// IsShowing() will currently return true after the 'show' animation has been
// completed however IsClosing() will return false after the 'hide' animation
// has been completed.
bool IsShowing() const {
return direction_ == Direction::kShowing ||
(!direction_ && value_current_ == 1);
}
bool IsClosing() const {
return direction_ == Direction::kHiding && value_end_ < value_current_;
}
class TestApi;
private:
// Gets the duration based on the dampening factor and whether the animation
// is showing or hiding.
base::TimeDelta GetDuration();
enum class Direction {
kShowing,
kHiding,
};
// Implementation of Show() and Hide().
void BeginAnimating(Direction direction);
// Overridden from Animation.
void AnimateToState(double state) override;
raw_ptr<AnimationDelegate, DanglingUntriaged> target_;
Tween::Type tween_type_ = Tween::EASE_OUT;
// Current animation direction, or nullopt if not animating.
std::optional<Direction> direction_;
// Animation values. These are a layer on top of Animation::state_ to
// provide the reversability.
double value_start_ = 0;
double value_end_ = 0;
double value_current_ = 0;
// How long a hover in/out animation will last for. This can be overridden
// with SetSlideDuration().
base::TimeDelta slide_duration_ = base::Milliseconds(120);
// Dampens the reduction in duration for animations which start partway.
double dampening_value_ = 1.0;
};
} // namespace gfx
#endif // UI_GFX_ANIMATION_SLIDE_ANIMATION_H_
|
