a8528fd9dce4b72b7aaa425268aa52e71971497b
[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 COMPUTER, 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 #if USE(ACCELERATED_COMPOSITING)
30
31 #include "Color.h"
32 #include "FloatPoint3D.h"
33 #include "TransformationMatrix.h"
34 #include <wtf/RefCounted.h>
35 #include <wtf/RetainPtr.h>
36 #include <wtf/Vector.h>
37
38 #if PLATFORM(MAC)
39 #ifdef __OBJC__
40 @class CAPropertyAnimation;
41 typedef CAPropertyAnimation* PlatformAnimationRef;
42 #else
43 typedef void* CAPropertyAnimation; // So the m_animation declaration works
44 typedef void* PlatformAnimationRef;
45 #endif
46 #elif PLATFORM(WIN)
47 typedef struct _CACFAnimation* CACFAnimationRef;
48 typedef CACFAnimationRef PlatformAnimationRef;
49 #endif
50
51 namespace WebCore {
52
53 class FloatRect;
54 class PlatformCAAnimation;
55 class TimingFunction;
56
57 class PlatformCAAnimation : public RefCounted<PlatformCAAnimation> {
58 public:
59     friend class PlatformCALayer;
60     
61     enum AnimationType { Basic, Keyframe };
62     enum FillModeType { NoFillMode, Forwards, Backwards, Both };
63     enum ValueFunctionType { NoValueFunction, RotateX, RotateY, RotateZ, ScaleX, ScaleY, ScaleZ, Scale, TranslateX, TranslateY, TranslateZ, Translate };
64
65     static PassRefPtr<PlatformCAAnimation> create(AnimationType, const String& keyPath);
66     static PassRefPtr<PlatformCAAnimation> create(PlatformAnimationRef);
67
68     ~PlatformCAAnimation();
69     
70     static bool supportsValueFunction();
71     
72     PassRefPtr<PlatformCAAnimation> copy() const;
73
74     PlatformAnimationRef platformAnimation() const;
75     
76     AnimationType animationType() const { return m_type; }
77     String keyPath() const;
78     
79     CFTimeInterval beginTime() const;
80     void setBeginTime(CFTimeInterval);
81     
82     CFTimeInterval duration() const;
83     void setDuration(CFTimeInterval);
84     
85     float speed() const;
86     void setSpeed(float);
87
88     CFTimeInterval timeOffset() const;
89     void setTimeOffset(CFTimeInterval);
90
91     float repeatCount() const;
92     void setRepeatCount(float);
93
94     bool autoreverses() const;
95     void setAutoreverses(bool);
96
97     FillModeType fillMode() const;
98     void setFillMode(FillModeType);
99     
100     void setTimingFunction(const TimingFunction*);
101     void copyTimingFunctionFrom(const PlatformCAAnimation*);
102
103     bool isRemovedOnCompletion() const;
104     void setRemovedOnCompletion(bool);
105
106     bool isAdditive() const;
107     void setAdditive(bool);
108
109     ValueFunctionType valueFunction() const;
110     void setValueFunction(ValueFunctionType);
111
112     // Basic-animation properties.
113     void setFromValue(float);
114     void setFromValue(const WebCore::TransformationMatrix&);
115     void setFromValue(const FloatPoint3D&);
116     void setFromValue(const WebCore::Color&);
117     void copyFromValueFrom(const PlatformCAAnimation*);
118
119     void setToValue(float);
120     void setToValue(const WebCore::TransformationMatrix&);
121     void setToValue(const FloatPoint3D&);
122     void setToValue(const WebCore::Color&);
123     void copyToValueFrom(const PlatformCAAnimation*);
124
125     // Keyframe-animation properties.
126     void setValues(const Vector<float>&);
127     void setValues(const Vector<WebCore::TransformationMatrix>&);
128     void setValues(const Vector<FloatPoint3D>&);
129     void setValues(const Vector<WebCore::Color>&);
130     void copyValuesFrom(const PlatformCAAnimation*);
131
132     void setKeyTimes(const Vector<float>&);
133     void copyKeyTimesFrom(const PlatformCAAnimation*);
134
135     void setTimingFunctions(const Vector<const TimingFunction*>&);
136     void copyTimingFunctionsFrom(const PlatformCAAnimation*);
137     
138 protected:
139     PlatformCAAnimation(AnimationType, const String& keyPath);
140     PlatformCAAnimation(PlatformAnimationRef);
141     
142 private:
143     AnimationType m_type;
144     
145 #if PLATFORM(MAC)
146     RetainPtr<CAPropertyAnimation> m_animation;
147 #elif PLATFORM(WIN)
148     RetainPtr<CACFAnimationRef> m_animation;
149 #endif
150 };
151
152 }
153
154 #endif // USE(ACCELERATED_COMPOSITING)
155
156 #endif // PlatformCAAnimation_h