8f5ad93627311be23261f1478cc46ebead3cef99
[WebKit-https.git] / Source / WebCore / platform / animation / Animation.h
1 /*
2  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
3  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2003-2017 Apple Inc. All rights reserved.
6  * Copyright (C) 2006 Graham Dennis (graham.dennis@gmail.com)
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #pragma once
26
27 #include "CSSPropertyNames.h"
28 #include "RenderStyleConstants.h"
29 #include "StyleScope.h"
30 #include "TimingFunction.h"
31
32 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
33 #include "AnimationTrigger.h"
34 #endif
35
36 namespace WebCore {
37
38 class Animation : public RefCounted<Animation> {
39 public:
40     WEBCORE_EXPORT ~Animation();
41
42     static Ref<Animation> create() { return adoptRef(*new Animation); }
43     static Ref<Animation> create(const Animation& other) { return adoptRef(*new Animation(other)); }
44
45     bool isDelaySet() const { return m_delaySet; }
46     bool isDirectionSet() const { return m_directionSet; }
47     bool isDurationSet() const { return m_durationSet; }
48     bool isFillModeSet() const { return m_fillModeSet; }
49     bool isIterationCountSet() const { return m_iterationCountSet; }
50     bool isNameSet() const { return m_nameSet; }
51     bool isPlayStateSet() const { return m_playStateSet; }
52     bool isPropertySet() const { return m_propertySet; }
53     bool isTimingFunctionSet() const { return m_timingFunctionSet; }
54 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
55     bool isTriggerSet() const { return m_triggerSet; }
56 #endif
57
58     // Flags this to be the special "none" animation (animation-name: none)
59     bool isNoneAnimation() const { return m_isNone; }
60
61     // We can make placeholder Animation objects to keep the comma-separated lists
62     // of properties in sync. isValidAnimation means this is not a placeholder.
63     bool isValidAnimation() const { return !m_isNone && !m_name.isEmpty(); }
64
65     bool isEmpty() const
66     {
67 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
68         if (m_triggerSet)
69             return false;
70 #endif
71         return !m_directionSet && !m_durationSet && !m_fillModeSet
72             && !m_nameSet && !m_playStateSet && !m_iterationCountSet
73             && !m_delaySet && !m_timingFunctionSet && !m_propertySet;
74     }
75
76     bool isEmptyOrZeroDuration() const
77     {
78         return isEmpty() || (m_duration == 0 && m_delay <= 0);
79     }
80
81     void clearDelay() { m_delaySet = false; }
82     void clearDirection() { m_directionSet = false; }
83     void clearDuration() { m_durationSet = false; }
84     void clearFillMode() { m_fillModeSet = false; }
85     void clearIterationCount() { m_iterationCountSet = false; }
86     void clearName() { m_nameSet = false; }
87     void clearPlayState() { m_playStateSet = AnimPlayStatePlaying; }
88     void clearProperty() { m_propertySet = false; }
89     void clearTimingFunction() { m_timingFunctionSet = false; }
90 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
91     void clearTrigger() { m_triggerSet = false; }
92 #endif
93
94     void clearAll()
95     {
96         clearDelay();
97         clearDirection();
98         clearDuration();
99         clearFillMode();
100         clearIterationCount();
101         clearName();
102         clearPlayState();
103         clearProperty();
104         clearTimingFunction();
105 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
106         clearTrigger();
107 #endif
108     }
109
110     double delay() const { return m_delay; }
111
112     enum AnimationMode { AnimateAll, AnimateNone, AnimateSingleProperty };
113
114     enum AnimationDirection {
115         AnimationDirectionNormal,
116         AnimationDirectionAlternate,
117         AnimationDirectionReverse,
118         AnimationDirectionAlternateReverse
119     };
120     AnimationDirection direction() const { return static_cast<AnimationDirection>(m_direction); }
121     bool directionIsForwards() const { return m_direction == AnimationDirectionNormal || m_direction == AnimationDirectionAlternate; }
122
123     unsigned fillMode() const { return m_fillMode; }
124
125     double duration() const { return m_duration; }
126
127     enum { IterationCountInfinite = -1 };
128     double iterationCount() const { return m_iterationCount; }
129     const String& name() const { return m_name; }
130     Style::ScopeOrdinal nameStyleScopeOrdinal() const { return m_nameStyleScopeOrdinal; }
131     EAnimPlayState playState() const { return static_cast<EAnimPlayState>(m_playState); }
132     CSSPropertyID property() const { return m_property; }
133     TimingFunction* timingFunction() const { return m_timingFunction.get(); }
134     AnimationMode animationMode() const { return m_mode; }
135 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
136     AnimationTrigger* trigger() const { return m_trigger.get(); }
137 #endif
138
139     void setDelay(double c) { m_delay = c; m_delaySet = true; }
140     void setDirection(AnimationDirection d) { m_direction = d; m_directionSet = true; }
141     void setDuration(double d) { ASSERT(d >= 0); m_duration = d; m_durationSet = true; }
142     void setFillMode(unsigned f) { m_fillMode = f; m_fillModeSet = true; }
143     void setIterationCount(double c) { m_iterationCount = c; m_iterationCountSet = true; }
144     void setName(const String& name, Style::ScopeOrdinal scope = Style::ScopeOrdinal::Element)
145     {
146         m_name = name;
147         m_nameStyleScopeOrdinal = scope;
148         m_nameSet = true;
149     }
150     void setPlayState(EAnimPlayState d) { m_playState = d; m_playStateSet = true; }
151     void setProperty(CSSPropertyID t) { m_property = t; m_propertySet = true; }
152     void setTimingFunction(RefPtr<TimingFunction>&& function) { m_timingFunction = WTFMove(function); m_timingFunctionSet = true; }
153     void setAnimationMode(AnimationMode mode) { m_mode = mode; }
154 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
155     void setTrigger(RefPtr<AnimationTrigger>&& trigger) { m_trigger = WTFMove(trigger); m_triggerSet = true; }
156 #endif
157
158     void setIsNoneAnimation(bool n) { m_isNone = n; }
159
160     Animation& operator=(const Animation& o);
161
162     // return true if all members of this class match (excluding m_next)
163     bool animationsMatch(const Animation&, bool matchPlayStates = true) const;
164
165     // return true every Animation in the chain (defined by m_next) match 
166     bool operator==(const Animation& o) const { return animationsMatch(o); }
167     bool operator!=(const Animation& o) const { return !(*this == o); }
168
169     bool fillsBackwards() const { return m_fillModeSet && (m_fillMode == AnimationFillModeBackwards || m_fillMode == AnimationFillModeBoth); }
170     bool fillsForwards() const { return m_fillModeSet && (m_fillMode == AnimationFillModeForwards || m_fillMode == AnimationFillModeBoth); }
171
172 private:
173     WEBCORE_EXPORT Animation();
174     Animation(const Animation& o);
175     
176     String m_name;
177     Style::ScopeOrdinal m_nameStyleScopeOrdinal { Style::ScopeOrdinal::Element };
178     CSSPropertyID m_property;
179     AnimationMode m_mode;
180     double m_iterationCount;
181     double m_delay;
182     double m_duration;
183     RefPtr<TimingFunction> m_timingFunction;
184 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
185     RefPtr<AnimationTrigger> m_trigger;
186 #endif
187     unsigned m_direction : 2; // AnimationDirection
188     unsigned m_fillMode : 2;
189
190
191     unsigned m_playState : 2;
192
193     bool m_delaySet : 1;
194     bool m_directionSet : 1;
195     bool m_durationSet : 1;
196     bool m_fillModeSet : 1;
197     bool m_iterationCountSet : 1;
198     bool m_nameSet : 1;
199     bool m_playStateSet : 1;
200     bool m_propertySet : 1;
201     bool m_timingFunctionSet : 1;
202 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
203     bool m_triggerSet : 1;
204 #endif
205
206     bool m_isNone : 1;
207
208 public:
209     static double initialDelay() { return 0; }
210     static AnimationDirection initialDirection() { return AnimationDirectionNormal; }
211     static double initialDuration() { return 0; }
212     static unsigned initialFillMode() { return AnimationFillModeNone; }
213     static double initialIterationCount() { return 1.0; }
214     static const String& initialName();
215     static EAnimPlayState initialPlayState() { return AnimPlayStatePlaying; }
216     static CSSPropertyID initialProperty() { return CSSPropertyInvalid; }
217     static Ref<TimingFunction> initialTimingFunction() { return CubicBezierTimingFunction::create(); }
218 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
219     static Ref<AnimationTrigger> initialTrigger() { return AutoAnimationTrigger::create(); }
220 #endif
221 };
222
223 } // namespace WebCore