CSS Animations with triggers should map scroll position to duration
[WebKit-https.git] / Source / WebCore / page / animation / AnimationControllerPrivate.h
1 /*
2  * Copyright (C) 2009 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef AnimationControllerPrivate_h
30 #define AnimationControllerPrivate_h
31
32 #include "AnimationBase.h"
33 #include "CSSPropertyNames.h"
34 #include "Timer.h"
35 #include <wtf/HashMap.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/Vector.h>
40 #include <wtf/text/AtomicString.h>
41 #include <wtf/text/WTFString.h>
42
43 namespace WebCore {
44
45 class AnimationBase;
46 class CompositeAnimation;
47 class Document;
48 class Element;
49 class Frame;
50 class RenderElement;
51 class RenderStyle;
52
53 enum SetChanged {
54     DoNotCallSetChanged = 0,
55     CallSetChanged = 1
56 };
57
58 class AnimationControllerPrivate {
59     WTF_MAKE_NONCOPYABLE(AnimationControllerPrivate); WTF_MAKE_FAST_ALLOCATED;
60 public:
61     explicit AnimationControllerPrivate(Frame&);
62     ~AnimationControllerPrivate();
63
64     // Returns the time until the next animation needs to be serviced, or -1 if there are none.
65     double updateAnimations(SetChanged callSetChanged = DoNotCallSetChanged);
66     void updateAnimationTimer(SetChanged callSetChanged = DoNotCallSetChanged);
67
68     CompositeAnimation& ensureCompositeAnimation(RenderElement&);
69     bool clear(RenderElement&);
70
71     void updateStyleIfNeededDispatcherFired();
72     void startUpdateStyleIfNeededDispatcher();
73     void addEventToDispatch(PassRefPtr<Element> element, const AtomicString& eventType, const String& name, double elapsedTime);
74     void addElementChangeToDispatch(Ref<Element>&&);
75
76     bool hasAnimations() const { return !m_compositeAnimations.isEmpty(); }
77
78     bool isSuspended() const { return m_isSuspended; }
79     void suspendAnimations();
80     void resumeAnimations();
81 #if ENABLE(REQUEST_ANIMATION_FRAME)
82     void animationFrameCallbackFired();
83 #endif
84
85     void suspendAnimationsForDocument(Document*);
86     void resumeAnimationsForDocument(Document*);
87     void startAnimationsIfNotSuspended(Document*);
88
89     bool isRunningAnimationOnRenderer(RenderElement&, CSSPropertyID, AnimationBase::RunningState) const;
90     bool isRunningAcceleratedAnimationOnRenderer(RenderElement&, CSSPropertyID, AnimationBase::RunningState) const;
91
92     bool pauseAnimationAtTime(RenderElement*, const AtomicString& name, double t);
93     bool pauseTransitionAtTime(RenderElement*, const String& property, double t);
94     unsigned numberOfActiveAnimations(Document*) const;
95
96     PassRefPtr<RenderStyle> getAnimatedStyleForRenderer(RenderElement&);
97
98     bool computeExtentOfAnimation(RenderElement&, LayoutRect&) const;
99
100     double beginAnimationUpdateTime();
101     void setBeginAnimationUpdateTime(double t) { m_beginAnimationUpdateTime = t; }
102     
103     void beginAnimationUpdate();
104     void endAnimationUpdate();
105     void receivedStartTimeResponse(double);
106     
107     void addToAnimationsWaitingForStyle(AnimationBase*);
108     void removeFromAnimationsWaitingForStyle(AnimationBase*);
109
110     void addToAnimationsWaitingForStartTimeResponse(AnimationBase*, bool willGetResponse);
111     void removeFromAnimationsWaitingForStartTimeResponse(AnimationBase*);
112
113     void animationWillBeRemoved(AnimationBase*);
114
115     void updateAnimationTimerForRenderer(RenderElement&);
116
117     bool allowsNewAnimationsWhileSuspended() const { return m_allowsNewAnimationsWhileSuspended; }
118     void setAllowsNewAnimationsWhileSuspended(bool);
119
120 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
121     void scrollWasUpdated();
122     float scrollPosition() const { return m_scrollPosition; }
123 #endif
124
125 private:
126     void animationTimerFired();
127
128     void styleAvailable();
129     void fireEventsAndUpdateStyle();
130     void startTimeResponse(double t);
131
132     HashMap<RenderElement*, RefPtr<CompositeAnimation>> m_compositeAnimations;
133     Timer m_animationTimer;
134     Timer m_updateStyleIfNeededDispatcher;
135     Frame& m_frame;
136     
137     class EventToDispatch {
138     public:
139         RefPtr<Element> element;
140         AtomicString eventType;
141         String name;
142         double elapsedTime;
143     };
144     
145     Vector<EventToDispatch> m_eventsToDispatch;
146     Vector<Ref<Element>> m_elementChangesToDispatch;
147     
148     double m_beginAnimationUpdateTime;
149
150     typedef HashSet<RefPtr<AnimationBase>> WaitingAnimationsSet;
151     WaitingAnimationsSet m_animationsWaitingForStyle;
152     WaitingAnimationsSet m_animationsWaitingForStartTimeResponse;
153
154     int m_beginAnimationUpdateCount;
155
156     bool m_waitingForAsyncStartNotification;
157     bool m_isSuspended;
158
159     // Used to flag whether we should revert to previous buggy
160     // behavior of allowing new transitions and animations to
161     // run even when this object is suspended.
162     bool m_allowsNewAnimationsWhileSuspended;
163
164 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
165     float m_scrollPosition = 0;
166 #endif
167 };
168
169 } // namespace WebCore
170
171 #endif // AnimationControllerPrivate_h