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
130
131
132
133
134
135
136
|
// Copyright 2018 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_VIEWS_CONTROLS_ANIMATED_IMAGE_VIEW_H_
#define UI_VIEWS_CONTROLS_ANIMATED_IMAGE_VIEW_H_
#include <memory>
#include <optional>
#include <utility>
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/compositor/compositor_animation_observer.h"
#include "ui/gfx/geometry/vector2d.h"
#include "ui/lottie/animation.h"
#include "ui/views/controls/image_view_base.h"
#include "ui/views/metadata/view_factory.h"
#include "ui/views/views_export.h"
namespace gfx {
class Canvas;
}
namespace ui {
class Compositor;
}
namespace views {
/////////////////////////////////////////////////////////////////////////////
//
// AnimatedImageView class.
//
// An AnimatedImageView can display a skia vector animation. The animation paint
// size can be set via SetImageSize. The animation is stopped by default.
// Use this over AnimatedIconView if you want to play a skottie animation file.
//
/////////////////////////////////////////////////////////////////////////////
class VIEWS_EXPORT AnimatedImageView : public ImageViewBase,
public ui::CompositorAnimationObserver {
METADATA_HEADER(AnimatedImageView, ImageViewBase)
public:
enum class State {
kPlaying, // The animation is currently playing.
kStopped // The animation is stopped and paint will raster the first
// frame.
};
AnimatedImageView();
AnimatedImageView(const AnimatedImageView&) = delete;
AnimatedImageView& operator=(const AnimatedImageView&) = delete;
~AnimatedImageView() override;
// Set the animated image that should be displayed. Setting an animated image
// will result in stopping the current animation.
void SetAnimatedImage(std::unique_ptr<lottie::Animation> animated_image);
// Plays the animation. If a null |playback_config| is provided, the default
// one is used.
void Play(std::optional<lottie::Animation::PlaybackConfig> playback_config =
std::nullopt);
// Stops any animation and resets it to the start frame.
void Stop();
// May return null if SetAnimatedImage() has not been called.
lottie::Animation* animated_image() { return animated_image_.get(); }
// Sets additional translation that will be applied to all future rendered
// animation frames. The term "additional" is used because the provided
// translation is applied on top of the translation that ImageViewBase already
// applies to align the animation appropriately within the view's boundaries.
//
// Note this is not the same as translating the entire View. This only
// translates the animation within the existing content bounds of the View. By
// default, there is no additional translation.
void SetAdditionalTranslation(gfx::Vector2d additional_translation) {
additional_translation_ = std::move(additional_translation);
}
State state() const { return state_; }
lottie::Animation* GetAnimatedImageForTesting() {
return animated_image_.get();
}
private:
// Overridden from View:
void OnPaint(gfx::Canvas* canvas) override;
void NativeViewHierarchyChanged() override;
void AddedToWidget() override;
void RemovedFromWidget() override;
// Overridden from ui::CompositorAnimationObserver:
void OnAnimationStep(base::TimeTicks timestamp) override;
void OnCompositingShuttingDown(ui::Compositor* compositor) override;
// Overridden from ImageViewBase:
gfx::Size GetImageSize() const override;
void DoPlay(lottie::Animation::PlaybackConfig playback_config);
void SetCompositorFromWidget();
void ClearCurrentCompositor();
// The current state of the animation.
State state_ = State::kStopped;
// playback_config_ stores the config while the object is waiting to be added
// to a widget.
std::unique_ptr<lottie::Animation::PlaybackConfig> playback_config_;
// The compositor associated with the widget of this view.
raw_ptr<ui::Compositor> compositor_ = nullptr;
// The most recent timestamp at which a paint was scheduled for this view.
base::TimeTicks previous_timestamp_;
// The underlying lottie animation.
std::unique_ptr<lottie::Animation> animated_image_;
gfx::Vector2d additional_translation_;
};
BEGIN_VIEW_BUILDER(VIEWS_EXPORT, AnimatedImageView, ImageViewBase)
VIEW_BUILDER_PROPERTY(std::unique_ptr<lottie::Animation>, AnimatedImage)
VIEW_BUILDER_PROPERTY(gfx::Vector2d, AdditionalTranslation)
END_VIEW_BUILDER
} // namespace views
DEFINE_VIEW_BUILDER(VIEWS_EXPORT, AnimatedImageView)
#endif // UI_VIEWS_CONTROLS_ANIMATED_IMAGE_VIEW_H_
|
