ae9c28d930cedd3b16dcea6759e12458c9a320c9
[WebKit-https.git] / Source / WebCore / animation / WebAnimation.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "ExceptionOr.h"
29 #include <wtf/Forward.h>
30 #include <wtf/Optional.h>
31 #include <wtf/Ref.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34 #include <wtf/Seconds.h>
35
36 namespace WebCore {
37
38 class AnimationEffect;
39 class AnimationTimeline;
40 class Document;
41 class RenderStyle;
42
43 class WebAnimation final : public RefCounted<WebAnimation> {
44 public:
45     static Ref<WebAnimation> create(Document&, AnimationEffect*, AnimationTimeline*);
46     ~WebAnimation();
47
48     AnimationEffect* effect() const { return m_effect.get(); }
49     void setEffect(RefPtr<AnimationEffect>&&);
50     AnimationTimeline* timeline() const { return m_timeline.get(); }
51     void setTimeline(RefPtr<AnimationTimeline>&&);
52
53     std::optional<double> bindingsStartTime() const;
54     void setBindingsStartTime(std::optional<double>);
55     std::optional<Seconds> startTime() const;
56     void setStartTime(std::optional<Seconds>);
57
58     std::optional<double> bindingsCurrentTime() const;
59     ExceptionOr<void> setBindingsCurrentTime(std::optional<double>);
60     std::optional<Seconds> currentTime() const;
61     void setCurrentTime(std::optional<Seconds>);
62
63     double playbackRate() const { return m_playbackRate; }
64     void setPlaybackRate(double);
65
66     Seconds timeToNextRequiredTick(Seconds) const;
67     void resolve(RenderStyle&);
68     void acceleratedRunningStateDidChange();
69     void startOrStopAccelerated();
70
71     String description();
72
73 private:
74     WebAnimation();
75
76     RefPtr<AnimationEffect> m_effect;
77     RefPtr<AnimationTimeline> m_timeline;
78     std::optional<Seconds> m_startTime;
79     double m_playbackRate { 1 };
80 };
81
82 } // namespace WebCore