cabb0ebfd19c06a13b193f978b1f29f7cec6b00d
[WebKit-https.git] / 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, 2005, 2006, 2007, 2008 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 #ifndef Animation_h
26 #define Animation_h
27
28 #include "PlatformString.h"
29 #include "TimingFunction.h"
30 #include <wtf/PassRefPtr.h>
31 #include <wtf/RefCounted.h>
32
33 namespace WebCore {
34
35 const int cAnimateNone = 0;
36 const int cAnimateAll = -2;
37
38 class Animation : public RefCounted<Animation> {
39 public:
40     ~Animation();
41
42     static PassRefPtr<Animation> create() { return adoptRef(new Animation); }
43     static PassRefPtr<Animation> create(const Animation* o) { return adoptRef(new Animation(*o)); }
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
55     // Flags this to be the special "none" animation (animation-name: none)
56     bool isNoneAnimation() const { return m_isNone; }
57     // We can make placeholder Animation objects to keep the comma-separated lists
58     // of properties in sync. isValidAnimation means this is not a placeholder.
59     bool isValidAnimation() const { return !m_isNone && !m_name.isEmpty(); }
60
61     bool isEmpty() const
62     {
63         return (!m_directionSet && !m_durationSet && !m_fillModeSet
64                 && !m_nameSet && !m_playStateSet && !m_iterationCountSet
65                 && !m_delaySet && !m_timingFunctionSet && !m_propertySet);
66     }
67
68     bool isEmptyOrZeroDuration() const
69     {
70         return isEmpty() || (m_duration == 0 && m_delay <= 0);
71     }
72
73     void clearDelay() { m_delaySet = false; }
74     void clearDirection() { m_directionSet = false; }
75     void clearDuration() { m_durationSet = false; }
76     void clearFillMode() { m_fillModeSet = false; }
77     void clearIterationCount() { m_iterationCountSet = false; }
78     void clearName() { m_nameSet = false; }
79     void clearPlayState() { m_playStateSet = AnimPlayStatePlaying; }
80     void clearProperty() { m_propertySet = false; }
81     void clearTimingFunction() { m_timingFunctionSet = false; }
82
83     double delay() const { return m_delay; }
84
85     enum AnimationDirection { AnimationDirectionNormal, AnimationDirectionAlternate };
86     AnimationDirection direction() const { return m_direction; }
87
88     unsigned fillMode() const { return m_fillMode; }
89
90     double duration() const { return m_duration; }
91
92     enum { IterationCountInfinite = -1 };
93     int iterationCount() const { return m_iterationCount; }
94     const String& name() const { return m_name; }
95     unsigned playState() const { return m_playState; }
96     int property() const { return m_property; }
97     const TimingFunction& timingFunction() const { return m_timingFunction; }
98
99     void setDelay(double c) { m_delay = c; m_delaySet = true; }
100     void setDirection(AnimationDirection d) { m_direction = d; m_directionSet = true; }
101     void setDuration(double d) { ASSERT(d >= 0); m_duration = d; m_durationSet = true; }
102     void setFillMode(unsigned f) { m_fillMode = f; m_fillModeSet = true; }
103     void setIterationCount(int c) { m_iterationCount = c; m_iterationCountSet = true; }
104     void setName(const String& n) { m_name = n; m_nameSet = true; }
105     void setPlayState(unsigned d) { m_playState = d; m_playStateSet = true; }
106     void setProperty(int t) { m_property = t; m_propertySet = true; }
107     void setTimingFunction(const TimingFunction& f) { m_timingFunction = f; m_timingFunctionSet = true; }
108
109     void setIsNoneAnimation(bool n) { m_isNone = n; }
110
111     Animation& operator=(const Animation& o);
112
113     // return true if all members of this class match (excluding m_next)
114     bool animationsMatch(const Animation*, bool matchPlayStates = true) const;
115
116     // return true every Animation in the chain (defined by m_next) match 
117     bool operator==(const Animation& o) const { return animationsMatch(&o); }
118     bool operator!=(const Animation& o) const { return !(*this == o); }
119
120     bool fillsBackwards() const { return m_fillModeSet && (m_fillMode == AnimationFillModeBackwards || m_fillMode == AnimationFillModeBoth); }
121     bool fillsForwards() const { return m_fillModeSet && (m_fillMode == AnimationFillModeForwards || m_fillMode == AnimationFillModeBoth); }
122
123 private:
124     Animation();
125     Animation(const Animation& o);
126     
127     String m_name;
128     int m_property;
129     int m_iterationCount;
130     double m_delay;
131     double m_duration;
132     TimingFunction m_timingFunction;
133     AnimationDirection m_direction : 1;
134     unsigned m_fillMode : 2;
135
136     unsigned m_playState     : 2;
137
138     bool m_delaySet          : 1;
139     bool m_directionSet      : 1;
140     bool m_durationSet       : 1;
141     bool m_fillModeSet       : 1;
142     bool m_iterationCountSet : 1;
143     bool m_nameSet           : 1;
144     bool m_playStateSet      : 1;
145     bool m_propertySet       : 1;
146     bool m_timingFunctionSet : 1;
147     
148     bool m_isNone            : 1;
149
150 public:
151     static float initialAnimationDelay() { return 0; }
152     static AnimationDirection initialAnimationDirection() { return AnimationDirectionNormal; }
153     static double initialAnimationDuration() { return 0; }
154     static unsigned initialAnimationFillMode() { return AnimationFillModeNone; }
155     static int initialAnimationIterationCount() { return 1; }
156     static String initialAnimationName() { return String("none"); }
157     static unsigned initialAnimationPlayState() { return AnimPlayStatePlaying; }
158     static int initialAnimationProperty() { return cAnimateAll; }
159     static TimingFunction initialAnimationTimingFunction() { return TimingFunction(); }
160 };
161
162 } // namespace WebCore
163
164 #endif // Animation_h