be43a9946a486a8402d9a725d9b6d8aa7ee66192
[WebKit-https.git] / Source / WebCore / platform / graphics / ca / cocoa / PlatformCAAnimationCocoa.h
1 /*
2  * Copyright (C) 2014 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 PlatformCAAnimationCocoa_h
27 #define PlatformCAAnimationCocoa_h
28
29 #include "PlatformCAAnimation.h"
30
31 #include <wtf/RetainPtr.h>
32
33 OBJC_CLASS CAMediaTimingFunction;
34 OBJC_CLASS CAAnimation;
35 OBJC_CLASS CAPropertyAnimation;
36 OBJC_CLASS NSString;
37
38 typedef CAPropertyAnimation* PlatformAnimationRef;
39
40 namespace WebCore {
41
42 WEBCORE_EXPORT NSString* toCAFillModeType(PlatformCAAnimation::FillModeType);
43 WEBCORE_EXPORT NSString* toCAValueFunctionType(PlatformCAAnimation::ValueFunctionType);
44 WEBCORE_EXPORT CAMediaTimingFunction* toCAMediaTimingFunction(const TimingFunction*, bool reverse);
45
46 bool hasExplicitBeginTime(CAAnimation *);
47 void setHasExplicitBeginTime(CAAnimation *, bool);
48
49 class PlatformCAAnimationCocoa final : public PlatformCAAnimation {
50 public:
51     static PassRefPtr<PlatformCAAnimation> create(AnimationType, const String& keyPath);
52     WEBCORE_EXPORT static PassRefPtr<PlatformCAAnimation> create(PlatformAnimationRef);
53
54     virtual ~PlatformCAAnimationCocoa();
55
56     bool isPlatformCAAnimationCocoa() const override { return true; }
57
58     PassRefPtr<PlatformCAAnimation> copy() const override;
59
60     PlatformAnimationRef platformAnimation() const;
61     
62     String keyPath() const override;
63     
64     CFTimeInterval beginTime() const override;
65     void setBeginTime(CFTimeInterval) override;
66     
67     CFTimeInterval duration() const override;
68     void setDuration(CFTimeInterval) override;
69     
70     float speed() const override;
71     void setSpeed(float) override;
72
73     CFTimeInterval timeOffset() const override;
74     void setTimeOffset(CFTimeInterval) override;
75
76     float repeatCount() const override;
77     void setRepeatCount(float) override;
78
79     bool autoreverses() const override;
80     void setAutoreverses(bool) override;
81
82     FillModeType fillMode() const override;
83     void setFillMode(FillModeType) override;
84     
85     void setTimingFunction(const TimingFunction*, bool reverse = false) override;
86     void copyTimingFunctionFrom(const PlatformCAAnimation&) override;
87
88     bool isRemovedOnCompletion() const override;
89     void setRemovedOnCompletion(bool) override;
90
91     bool isAdditive() const override;
92     void setAdditive(bool) override;
93
94     ValueFunctionType valueFunction() const override;
95     void setValueFunction(ValueFunctionType) override;
96
97     // Basic-animation properties.
98     void setFromValue(float) override;
99     void setFromValue(const WebCore::TransformationMatrix&) override;
100     void setFromValue(const FloatPoint3D&) override;
101     void setFromValue(const WebCore::Color&) override;
102     void setFromValue(const FilterOperation*, int internalFilterPropertyIndex) override;
103     void copyFromValueFrom(const PlatformCAAnimation&) override;
104
105     void setToValue(float) override;
106     void setToValue(const WebCore::TransformationMatrix&) override;
107     void setToValue(const FloatPoint3D&) override;
108     void setToValue(const WebCore::Color&) override;
109     void setToValue(const FilterOperation*, int internalFilterPropertyIndex) override;
110     void copyToValueFrom(const PlatformCAAnimation&) override;
111
112     // Keyframe-animation properties.
113     void setValues(const Vector<float>&) override;
114     void setValues(const Vector<WebCore::TransformationMatrix>&) override;
115     void setValues(const Vector<FloatPoint3D>&) override;
116     void setValues(const Vector<WebCore::Color>&) override;
117     void setValues(const Vector<RefPtr<FilterOperation>>&, int internalFilterPropertyIndex) override;
118     void copyValuesFrom(const PlatformCAAnimation&) override;
119
120     void setKeyTimes(const Vector<float>&) override;
121     void copyKeyTimesFrom(const PlatformCAAnimation&) override;
122
123     void setTimingFunctions(const Vector<const TimingFunction*>&, bool reverse = false) override;
124     void copyTimingFunctionsFrom(const PlatformCAAnimation&) override;
125
126 protected:
127     PlatformCAAnimationCocoa(AnimationType, const String& keyPath);
128     PlatformCAAnimationCocoa(PlatformAnimationRef);
129
130 private:
131     RetainPtr<CAPropertyAnimation> m_animation;
132 };
133
134 } // namespace WebCore
135
136 SPECIALIZE_TYPE_TRAITS_CAANIMATION(WebCore::PlatformCAAnimationCocoa, isPlatformCAAnimationCocoa())
137
138 #endif // PlatformCAAnimationCocoa_h