Remove all uses of PassRefPtr in WTF
[WebKit-https.git] / Source / WebCore / platform / animation / TimingFunction.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 TimingFunction_h
26 #define TimingFunction_h
27
28 #include <wtf/PassRefPtr.h>
29 #include <wtf/RefCounted.h>
30 #include <wtf/RefPtr.h>
31
32 namespace WebCore {
33
34 class TimingFunction : public RefCounted<TimingFunction> {
35 public:
36
37     virtual PassRefPtr<TimingFunction> clone() const = 0;
38
39     enum TimingFunctionType {
40         LinearFunction, CubicBezierFunction, StepsFunction, SpringFunction
41     };
42     
43     virtual ~TimingFunction() { }
44
45     TimingFunctionType type() const { return m_type; }
46     
47     bool isLinearTimingFunction() const { return m_type == LinearFunction; }
48     bool isCubicBezierTimingFunction() const { return m_type == CubicBezierFunction; }
49     bool isStepsTimingFunction() const { return m_type == StepsFunction; }
50     bool isSpringTimingFunction() const { return m_type == SpringFunction; }
51     
52     virtual bool operator==(const TimingFunction& other) = 0;
53
54 protected:
55     TimingFunction(TimingFunctionType type)
56         : m_type(type)
57     {
58     }
59     
60     TimingFunctionType m_type;
61 };
62
63 class LinearTimingFunction final : public TimingFunction {
64 public:
65     static PassRefPtr<LinearTimingFunction> create()
66     {
67         return adoptRef(new LinearTimingFunction);
68     }
69     
70     virtual ~LinearTimingFunction() { }
71     
72     bool operator==(const TimingFunction& other) override
73     {
74         return other.isLinearTimingFunction();
75     }
76
77 private:
78     LinearTimingFunction()
79         : TimingFunction(LinearFunction)
80     {
81     }
82
83     PassRefPtr<TimingFunction> clone() const override
84     {
85         return adoptRef(new LinearTimingFunction);
86     }
87 };
88
89 class CubicBezierTimingFunction final : public TimingFunction {
90 public:
91     enum TimingFunctionPreset {
92         Ease,
93         EaseIn,
94         EaseOut,
95         EaseInOut,
96         Custom
97     };
98     
99     static PassRefPtr<CubicBezierTimingFunction> create(double x1, double y1, double x2, double y2)
100     {
101         return adoptRef(new CubicBezierTimingFunction(Custom, x1, y1, x2, y2));
102     }
103
104     static PassRefPtr<CubicBezierTimingFunction> create()
105     {
106         return adoptRef(new CubicBezierTimingFunction());
107     }
108     
109     static PassRefPtr<CubicBezierTimingFunction> create(TimingFunctionPreset preset)
110     {
111         switch (preset) {
112         case Ease:
113             return adoptRef(new CubicBezierTimingFunction());
114         case EaseIn:
115             return adoptRef(new CubicBezierTimingFunction(EaseIn, 0.42, 0.0, 1.0, 1.0));
116         case EaseOut:
117             return adoptRef(new CubicBezierTimingFunction(EaseOut, 0.0, 0.0, 0.58, 1.0));
118         case EaseInOut:
119             return adoptRef(new CubicBezierTimingFunction(EaseInOut, 0.42, 0.0, 0.58, 1.0));
120         default:
121             ASSERT_NOT_REACHED();
122             return 0;
123         }
124     }
125
126     virtual ~CubicBezierTimingFunction() { }
127     
128     bool operator==(const TimingFunction& other) override
129     {
130         if (other.isCubicBezierTimingFunction()) {
131             const CubicBezierTimingFunction* ctf = static_cast<const CubicBezierTimingFunction*>(&other);
132             if (m_timingFunctionPreset != Custom)
133                 return m_timingFunctionPreset == ctf->m_timingFunctionPreset;
134             
135             return m_x1 == ctf->m_x1 && m_y1 == ctf->m_y1 && m_x2 == ctf->m_x2 && m_y2 == ctf->m_y2;
136         }
137         return false;
138     }
139
140     double x1() const { return m_x1; }
141     double y1() const { return m_y1; }
142     double x2() const { return m_x2; }
143     double y2() const { return m_y2; }
144     
145     void setValues(double x1, double y1, double x2, double y2)
146     {
147         m_x1 = x1;
148         m_y1 = y1;
149         m_x2 = x2;
150         m_y2 = y2;
151     }
152     
153     TimingFunctionPreset timingFunctionPreset() const { return m_timingFunctionPreset; }
154     void setTimingFunctionPreset(TimingFunctionPreset preset) { m_timingFunctionPreset = preset; }
155     
156     static const CubicBezierTimingFunction* defaultTimingFunction()
157     {
158         static const CubicBezierTimingFunction* dtf = create().leakRef();
159         return dtf;
160     }
161
162     PassRefPtr<CubicBezierTimingFunction> createReversed() const
163     {
164         return create(1.0 - m_x2, 1.0 - m_y2, 1.0 - m_x1, 1.0 - m_y1);
165     }
166     
167 private:
168     explicit CubicBezierTimingFunction(TimingFunctionPreset preset = Ease, double x1 = 0.25, double y1 = 0.1, double x2 = 0.25, double y2 = 1.0)
169         : TimingFunction(CubicBezierFunction)
170         , m_x1(x1)
171         , m_y1(y1)
172         , m_x2(x2)
173         , m_y2(y2)
174         , m_timingFunctionPreset(preset)
175     {
176     }
177
178     PassRefPtr<TimingFunction> clone() const override
179     {
180         return adoptRef(new CubicBezierTimingFunction(m_timingFunctionPreset, m_x1, m_y1, m_x2, m_y2));
181     }
182
183     double m_x1;
184     double m_y1;
185     double m_x2;
186     double m_y2;
187     TimingFunctionPreset m_timingFunctionPreset;
188 };
189
190 class StepsTimingFunction final : public TimingFunction {
191 public:
192     
193     static PassRefPtr<StepsTimingFunction> create(int steps, bool stepAtStart)
194     {
195         return adoptRef(new StepsTimingFunction(steps, stepAtStart));
196     }
197     static PassRefPtr<StepsTimingFunction> create()
198     {
199         return adoptRef(new StepsTimingFunction(1, true));
200     }
201     
202     virtual ~StepsTimingFunction() { }
203     
204     bool operator==(const TimingFunction& other) override
205     {
206         if (other.isStepsTimingFunction()) {
207             const StepsTimingFunction* stf = static_cast<const StepsTimingFunction*>(&other);
208             return m_steps == stf->m_steps && m_stepAtStart == stf->m_stepAtStart;
209         }
210         return false;
211     }
212     
213     int numberOfSteps() const { return m_steps; }
214     void setNumberOfSteps(int steps) { m_steps = steps; }
215
216     bool stepAtStart() const { return m_stepAtStart; }
217     void setStepAtStart(bool stepAtStart) { m_stepAtStart = stepAtStart; }
218     
219 private:
220     StepsTimingFunction(int steps, bool stepAtStart)
221         : TimingFunction(StepsFunction)
222         , m_steps(steps)
223         , m_stepAtStart(stepAtStart)
224     {
225     }
226
227     PassRefPtr<TimingFunction> clone() const override
228     {
229         return adoptRef(new StepsTimingFunction(m_steps, m_stepAtStart));
230     }
231     
232     int m_steps;
233     bool m_stepAtStart;
234 };
235
236 class SpringTimingFunction final : public TimingFunction {
237 public:
238     static Ref<SpringTimingFunction> create(double mass, double stiffness, double damping, double initialVelocity)
239     {
240         return adoptRef(*new SpringTimingFunction(mass, stiffness, damping, initialVelocity));
241     }
242
243     static Ref<SpringTimingFunction> create()
244     {
245         // This create() function should only be used by the argument decoders, and it is expected that
246         // real values will be filled in using setValues().
247         return create(0, 0, 0, 0);
248     }
249     
250     bool operator==(const TimingFunction& other) override
251     {
252         if (other.isSpringTimingFunction()) {
253             const SpringTimingFunction& otherString = *static_cast<const SpringTimingFunction*>(&other);
254             return m_mass == otherString.m_mass && m_stiffness == otherString.m_stiffness && m_damping == otherString.m_damping && m_initialVelocity == otherString.m_initialVelocity;
255         }
256         return false;
257     }
258
259     double mass() const { return m_mass; }
260     double stiffness() const { return m_stiffness; }
261     double damping() const { return m_damping; }
262     double initialVelocity() const { return m_initialVelocity; }
263     
264     void setValues(double mass, double stiffness, double damping, double initialVelocity)
265     {
266         m_mass = mass;
267         m_stiffness = stiffness;
268         m_damping = damping;
269         m_initialVelocity = initialVelocity;
270     }
271
272 private:
273     explicit SpringTimingFunction(double mass, double stiffness, double damping, double initialVelocity)
274         : TimingFunction(SpringFunction)
275         , m_mass(mass)
276         , m_stiffness(stiffness)
277         , m_damping(damping)
278         , m_initialVelocity(initialVelocity)
279     {
280     }
281
282     PassRefPtr<TimingFunction> clone() const override
283     {
284         return adoptRef(new SpringTimingFunction(m_mass, m_stiffness, m_damping, m_initialVelocity));
285     }
286
287     double m_mass;
288     double m_stiffness;
289     double m_damping;
290     double m_initialVelocity;
291 };
292
293 class TextStream;
294 WEBCORE_EXPORT TextStream& operator<<(TextStream&, const TimingFunction&);
295
296 } // namespace WebCore
297
298 #endif // TimingFunction_h