[Web Animations] Enqueue and dispatch animation events
[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 "ActiveDOMObject.h"
29 #include "EventTarget.h"
30 #include "ExceptionOr.h"
31 #include <wtf/Forward.h>
32 #include <wtf/Optional.h>
33 #include <wtf/Ref.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/RefPtr.h>
36 #include <wtf/Seconds.h>
37
38 namespace WebCore {
39
40 class AnimationEffect;
41 class AnimationPlaybackEvent;
42 class AnimationTimeline;
43 class Document;
44 class RenderStyle;
45
46 class WebAnimation final : public RefCounted<WebAnimation>, public EventTargetWithInlineData, public ActiveDOMObject {
47 public:
48     static Ref<WebAnimation> create(Document&, AnimationEffect*, AnimationTimeline*);
49     ~WebAnimation();
50
51     AnimationEffect* effect() const { return m_effect.get(); }
52     void setEffect(RefPtr<AnimationEffect>&&);
53     AnimationTimeline* timeline() const { return m_timeline.get(); }
54     void setTimeline(RefPtr<AnimationTimeline>&&);
55
56     std::optional<double> bindingsStartTime() const;
57     void setBindingsStartTime(std::optional<double>);
58     std::optional<Seconds> startTime() const;
59     void setStartTime(std::optional<Seconds>);
60
61     std::optional<double> bindingsCurrentTime() const;
62     ExceptionOr<void> setBindingsCurrentTime(std::optional<double>);
63     std::optional<Seconds> currentTime() const;
64     void setCurrentTime(std::optional<Seconds>);
65
66     double playbackRate() const { return m_playbackRate; }
67     void setPlaybackRate(double);
68
69     Seconds timeToNextRequiredTick(Seconds) const;
70     void resolve(RenderStyle&);
71     void acceleratedRunningStateDidChange();
72     void startOrStopAccelerated();
73
74     String description();
75
76     using RefCounted::ref;
77     using RefCounted::deref;
78
79 private:
80     explicit WebAnimation(Document&);
81
82     void enqueueAnimationPlaybackEvent(const AtomicString&, std::optional<Seconds>, std::optional<Seconds>);
83     
84     RefPtr<AnimationEffect> m_effect;
85     RefPtr<AnimationTimeline> m_timeline;
86     std::optional<Seconds> m_startTime;
87     double m_playbackRate { 1 };
88     bool m_isStopped { false };
89
90     // ActiveDOMObject.
91     const char* activeDOMObjectName() const final;
92     bool canSuspendForDocumentSuspension() const final;
93     void stop() final;
94
95     // EventTarget
96     EventTargetInterface eventTargetInterface() const final { return WebAnimationEventTargetInterfaceType; }
97     void refEventTarget() final { ref(); }
98     void derefEventTarget() final { deref(); }
99     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
100 };
101
102 } // namespace WebCore