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
|
// Copyright 2011 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_ANIMATION_CONTAINER_H_
#define UI_GFX_ANIMATION_ANIMATION_CONTAINER_H_
#include <memory>
#include <utility>
#include "base/containers/flat_set.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/time/time.h"
#include "ui/gfx/animation/animation_export.h"
#include "ui/gfx/animation/animation_runner.h"
namespace gfx {
class AnimationContainerElement;
class AnimationContainerObserver;
// AnimationContainer is used by Animation to manage the underlying
// AnimationRunner. Internally each Animation creates a single
// AnimationContainer. You can group a set of Animations into the same
// AnimationContainer by way of Animation::SetContainer. Grouping a set of
// Animations into the same AnimationContainer ensures they all update and start
// at the same time.
//
// AnimationContainer is ref counted. Each Animation contained within the
// AnimationContainer own it.
class ANIMATION_EXPORT AnimationContainer
: public base::RefCounted<AnimationContainer> {
public:
AnimationContainer();
AnimationContainer(const AnimationContainer&) = delete;
AnimationContainer& operator=(const AnimationContainer&) = delete;
// Invoked by Animation when it needs to start. Starts the timer if necessary.
// NOTE: This is invoked by Animation for you, you shouldn't invoke this
// directly.
void Start(AnimationContainerElement* animation);
// Invoked by Animation when it needs to stop. If there are no more animations
// running the timer stops.
// NOTE: This is invoked by Animation for you, you shouldn't invoke this
// directly.
void Stop(AnimationContainerElement* animation);
void set_observer(AnimationContainerObserver* observer) {
observer_ = observer;
}
// The time the last animation ran at.
base::TimeTicks last_tick_time() const { return last_tick_time_; }
// Are there any timers running?
bool is_running() const { return !elements_.empty(); }
void SetAnimationRunner(std::unique_ptr<AnimationRunner> runner);
AnimationRunner* animation_runner_for_testing() { return runner_.get(); }
bool has_custom_animation_runner() const {
return has_custom_animation_runner_;
}
private:
friend class AnimationContainerTestApi;
friend class base::RefCounted<AnimationContainer>;
// This set is usually quite small so a flat_set is the most obvious choice.
// However, in extreme cases this can grow to 100s or even 1000s of elements.
// Since this set is duplicated on every call to 'Run' and indexed very
// frequently the cache locality of the vector is more important than the
// costlier (but rarer) insertion. Profiling shows that flat_set continues to
// perform best in these cases (up to 12x faster than std::set).
typedef base::flat_set<raw_ptr<AnimationContainerElement, CtnExperimental>>
Elements;
~AnimationContainer();
// Timer callback method.
void Run(base::TimeTicks current_time);
// Sets min_timer_interval_ and restarts the timer.
void SetMinTimerInterval(base::TimeDelta delta);
// Restarts the timer, assuming |elapsed| has already elapsed out of the timer
// interval.
void RestartTimer(base::TimeDelta elapsed);
// Returns the min timer interval of all the timers, and the count of timers
// at that interval.
std::pair<base::TimeDelta, size_t> GetMinIntervalAndCount() const;
// Represents one of two possible values:
// . If only a single animation has been started and the timer hasn't yet
// fired this is the time the animation was added.
// . The time the last animation ran at (::Run was invoked).
base::TimeTicks last_tick_time_ = base::TimeTicks::Now();
// Set of elements (animations) being managed.
Elements elements_;
// Minimum interval the timers run at, plus the number of timers that have
// been seen at that interval. The most common case is for all of the
// animations to run at 60Hz, in which case all of the intervals are the same.
// This acts as a cache of size 1, and when an animation stops and is removed
// it means that the linear scan for the new minimum timer can almost always
// be avoided.
base::TimeDelta min_timer_interval_;
size_t min_timer_interval_count_ = 0;
std::unique_ptr<AnimationRunner> runner_ =
AnimationRunner::CreateDefaultAnimationRunner();
bool has_custom_animation_runner_ = false;
raw_ptr<AnimationContainerObserver> observer_ = nullptr;
};
} // namespace gfx
#endif // UI_GFX_ANIMATION_ANIMATION_CONTAINER_H_
|
