Add animationDidEnd callbacks on GraphicsLayer
[WebKit-https.git] / Source / WebCore / platform / graphics / ca / mac / PlatformCALayerMac.h
1 /*
2  * Copyright (C) 2010, 2013 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 PlatformCALayerMac_h
27 #define PlatformCALayerMac_h
28
29 #include "PlatformCALayer.h"
30
31 OBJC_CLASS NSObject;
32
33 namespace WebCore {
34
35 class PlatformCALayerMac final : public PlatformCALayer {
36 public:
37     static PassRefPtr<PlatformCALayer> create(LayerType, PlatformCALayerClient*);
38     
39     // This function passes the layer as a void* rather than a PlatformLayer because PlatformLayer
40     // is defined differently for Obj C and C++. This allows callers from both languages.
41     static PassRefPtr<PlatformCALayer> create(void* platformLayer, PlatformCALayerClient*);
42
43     WEBCORE_EXPORT static LayerType layerTypeForPlatformLayer(PlatformLayer*);
44
45     ~PlatformCALayerMac();
46
47     virtual void setOwner(PlatformCALayerClient*) override;
48
49     virtual void setNeedsDisplay() override;
50     virtual void setNeedsDisplayInRect(const FloatRect& dirtyRect) override;
51
52     virtual void copyContentsFromLayer(PlatformCALayer*) override;
53
54     virtual PlatformCALayer* superlayer() const override;
55     virtual void removeFromSuperlayer() override;
56     virtual void setSublayers(const PlatformCALayerList&) override;
57     virtual void removeAllSublayers() override;
58     virtual void appendSublayer(PlatformCALayer*) override;
59     virtual void insertSublayer(PlatformCALayer*, size_t index) override;
60     virtual void replaceSublayer(PlatformCALayer* reference, PlatformCALayer*) override;
61     virtual const PlatformCALayerList* customSublayers() const override { return m_customSublayers.get(); }
62     virtual void adoptSublayers(PlatformCALayer* source) override;
63
64     virtual void addAnimationForKey(const String& key, PlatformCAAnimation*) override;
65     virtual void removeAnimationForKey(const String& key) override;
66     virtual PassRefPtr<PlatformCAAnimation> animationForKey(const String& key) override;
67     virtual void animationStarted(const String& key, CFTimeInterval beginTime) override;
68     virtual void animationEnded(const String& key) override;
69
70     virtual void setMask(PlatformCALayer*) override;
71
72     virtual bool isOpaque() const override;
73     virtual void setOpaque(bool) override;
74
75     virtual FloatRect bounds() const override;
76     virtual void setBounds(const FloatRect&) override;
77
78     virtual FloatPoint3D position() const override;
79     virtual void setPosition(const FloatPoint3D&) override;
80
81     virtual FloatPoint3D anchorPoint() const override;
82     virtual void setAnchorPoint(const FloatPoint3D&) override;
83
84     virtual TransformationMatrix transform() const override;
85     virtual void setTransform(const TransformationMatrix&) override;
86
87     virtual TransformationMatrix sublayerTransform() const override;
88     virtual void setSublayerTransform(const TransformationMatrix&) override;
89
90     virtual void setHidden(bool) override;
91
92     WEBCORE_EXPORT virtual void setGeometryFlipped(bool) override;
93
94     virtual bool isDoubleSided() const override;
95     virtual void setDoubleSided(bool) override;
96
97     virtual bool masksToBounds() const override;
98     virtual void setMasksToBounds(bool) override;
99
100     virtual bool acceleratesDrawing() const override;
101     virtual void setAcceleratesDrawing(bool) override;
102
103     virtual CFTypeRef contents() const override;
104     virtual void setContents(CFTypeRef) override;
105
106     virtual void setContentsRect(const FloatRect&) override;
107
108     virtual void setMinificationFilter(FilterType) override;
109     virtual void setMagnificationFilter(FilterType) override;
110
111     virtual Color backgroundColor() const override;
112     virtual void setBackgroundColor(const Color&) override;
113
114     virtual void setBorderWidth(float) override;
115
116     virtual void setBorderColor(const Color&) override;
117
118     virtual float opacity() const override;
119     virtual void setOpacity(float) override;
120
121 #if ENABLE(CSS_FILTERS)
122     virtual void setFilters(const FilterOperations&) override;
123     WEBCORE_EXPORT static bool filtersCanBeComposited(const FilterOperations&);
124     virtual void copyFiltersFrom(const PlatformCALayer*) override;
125 #endif
126
127 #if ENABLE(CSS_COMPOSITING)
128     virtual void setBlendMode(BlendMode) override;
129 #endif
130
131     virtual void setName(const String&) override;
132
133     virtual void setSpeed(float) override;
134
135     virtual void setTimeOffset(CFTimeInterval) override;
136
137     virtual float contentsScale() const override;
138     virtual void setContentsScale(float) override;
139
140     virtual void setEdgeAntialiasingMask(unsigned) override;
141
142     virtual GraphicsLayer::CustomAppearance customAppearance() const override { return m_customAppearance; }
143     virtual void updateCustomAppearance(GraphicsLayer::CustomAppearance) override;
144
145     virtual GraphicsLayer::CustomBehavior customBehavior() const override { return m_customBehavior; }
146     virtual void updateCustomBehavior(GraphicsLayer::CustomBehavior) override;
147
148     virtual TiledBacking* tiledBacking() override;
149
150     virtual PassRefPtr<PlatformCALayer> clone(PlatformCALayerClient* owner) const override;
151
152     virtual PassRefPtr<PlatformCALayer> createCompatibleLayer(PlatformCALayer::LayerType, PlatformCALayerClient*) const override;
153
154     virtual void enumerateRectsBeingDrawn(CGContextRef, void (^block)(CGRect)) override;
155
156 private:
157     PlatformCALayerMac(LayerType, PlatformCALayerClient* owner);
158     PlatformCALayerMac(PlatformLayer*, PlatformCALayerClient* owner);
159
160     void commonInit();
161
162     virtual bool isPlatformCALayerMac() const override { return true; }
163
164     bool requiresCustomAppearanceUpdateOnBoundsChange() const;
165
166     RetainPtr<NSObject> m_delegate;
167     std::unique_ptr<PlatformCALayerList> m_customSublayers;
168     GraphicsLayer::CustomAppearance m_customAppearance;
169     GraphicsLayer::CustomBehavior m_customBehavior;
170 };
171
172 PLATFORM_CALAYER_TYPE_CASTS(PlatformCALayerMac, isPlatformCALayerMac())
173
174 } // namespace WebCore
175
176 #endif // PlatformCALayerMac_h