Stop using PassRefPtr in platform/graphics
[WebKit-https.git] / Source / WebCore / platform / graphics / ca / PlatformCAAnimation.h
1 /*
2  * Copyright (C) 2010 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 #ifndef PlatformCAAnimation_h
27 #define PlatformCAAnimation_h
28
29 #include "Color.h"
30 #include "FilterOperation.h"
31 #include "FloatPoint3D.h"
32 #include "TransformationMatrix.h"
33 #include <wtf/RefCounted.h>
34 #include <wtf/TypeCasts.h>
35 #include <wtf/Vector.h>
36
37 namespace WebCore {
38
39 class FloatRect;
40 class TimingFunction;
41
42 class PlatformCAAnimation : public RefCounted<PlatformCAAnimation> {
43 public:
44     enum AnimationType { Basic, Keyframe, Spring };
45     enum FillModeType { NoFillMode, Forwards, Backwards, Both };
46     enum ValueFunctionType { NoValueFunction, RotateX, RotateY, RotateZ, ScaleX, ScaleY, ScaleZ, Scale, TranslateX, TranslateY, TranslateZ, Translate };
47
48     virtual ~PlatformCAAnimation() { }
49
50     virtual bool isPlatformCAAnimationCocoa() const { return false; }
51     virtual bool isPlatformCAAnimationWin() const { return false; }
52     virtual bool isPlatformCAAnimationRemote() const { return false; }
53     
54     virtual Ref<PlatformCAAnimation> copy() const = 0;
55     
56     AnimationType animationType() const { return m_type; }
57     virtual String keyPath() const = 0;
58     
59     virtual CFTimeInterval beginTime() const = 0;
60     virtual void setBeginTime(CFTimeInterval) = 0;
61     
62     virtual CFTimeInterval duration() const = 0;
63     virtual void setDuration(CFTimeInterval) = 0;
64     
65     virtual float speed() const = 0;
66     virtual void setSpeed(float) = 0;
67
68     virtual CFTimeInterval timeOffset() const = 0;
69     virtual void setTimeOffset(CFTimeInterval) = 0;
70
71     virtual float repeatCount() const = 0;
72     virtual void setRepeatCount(float) = 0;
73
74     virtual bool autoreverses() const = 0;
75     virtual void setAutoreverses(bool) = 0;
76
77     virtual FillModeType fillMode() const = 0;
78     virtual void setFillMode(FillModeType) = 0;
79     
80     virtual void setTimingFunction(const TimingFunction*, bool reverse = false) = 0;
81     virtual void copyTimingFunctionFrom(const PlatformCAAnimation&) = 0;
82
83     virtual bool isRemovedOnCompletion() const = 0;
84     virtual void setRemovedOnCompletion(bool) = 0;
85
86     virtual bool isAdditive() const = 0;
87     virtual void setAdditive(bool) = 0;
88
89     virtual ValueFunctionType valueFunction() const = 0;
90     virtual void setValueFunction(ValueFunctionType) = 0;
91
92     // Basic-animation properties.
93     virtual void setFromValue(float) = 0;
94     virtual void setFromValue(const WebCore::TransformationMatrix&) = 0;
95     virtual void setFromValue(const FloatPoint3D&) = 0;
96     virtual void setFromValue(const WebCore::Color&) = 0;
97     virtual void setFromValue(const FilterOperation*, int internalFilterPropertyIndex) = 0;
98     virtual void copyFromValueFrom(const PlatformCAAnimation&) = 0;
99
100     virtual void setToValue(float) = 0;
101     virtual void setToValue(const WebCore::TransformationMatrix&) = 0;
102     virtual void setToValue(const FloatPoint3D&) = 0;
103     virtual void setToValue(const WebCore::Color&) = 0;
104     virtual void setToValue(const FilterOperation*, int internalFilterPropertyIndex) = 0;
105     virtual void copyToValueFrom(const PlatformCAAnimation&) = 0;
106
107     // Keyframe-animation properties.
108     virtual void setValues(const Vector<float>&) = 0;
109     virtual void setValues(const Vector<WebCore::TransformationMatrix>&) = 0;
110     virtual void setValues(const Vector<FloatPoint3D>&) = 0;
111     virtual void setValues(const Vector<WebCore::Color>&) = 0;
112     virtual void setValues(const Vector<RefPtr<FilterOperation>>&, int internalFilterPropertyIndex) = 0;
113     virtual void copyValuesFrom(const PlatformCAAnimation&) = 0;
114
115     virtual void setKeyTimes(const Vector<float>&) = 0;
116     virtual void copyKeyTimesFrom(const PlatformCAAnimation&) = 0;
117
118     virtual void setTimingFunctions(const Vector<const TimingFunction*>&, bool reverse = false) = 0;
119     virtual void copyTimingFunctionsFrom(const PlatformCAAnimation&) = 0;
120
121     void setActualStartTimeIfNeeded(CFTimeInterval t)
122     {
123         if (beginTime() <= 0)
124             setBeginTime(t);
125     }
126
127     bool isBasicAnimation() const;
128     
129 protected:
130     PlatformCAAnimation(AnimationType type = Basic)
131         : m_type(type)
132     {
133     }
134
135     void setType(AnimationType type) { m_type = type; }
136
137 private:
138     AnimationType m_type;
139 };
140
141 WEBCORE_EXPORT TextStream& operator<<(TextStream&, PlatformCAAnimation::AnimationType);
142 WEBCORE_EXPORT TextStream& operator<<(TextStream&, PlatformCAAnimation::FillModeType);
143 WEBCORE_EXPORT TextStream& operator<<(TextStream&, PlatformCAAnimation::ValueFunctionType);
144
145 } // namespace WebCore
146
147 #define SPECIALIZE_TYPE_TRAITS_CAANIMATION(ToValueTypeName, predicate) \
148 SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
149     static bool isType(const WebCore::PlatformCAAnimation& animation) { return animation.predicate; } \
150 SPECIALIZE_TYPE_TRAITS_END()
151
152 #endif // PlatformCAAnimation_h