Unreviewed, rolling out r126169.
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / GraphicsLayerChromium.h
1 /*
2  * Copyright (C) 2010 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef GraphicsLayerChromium_h
32 #define GraphicsLayerChromium_h
33
34 #if USE(ACCELERATED_COMPOSITING)
35
36 #include "GraphicsContext.h"
37 #include "GraphicsLayer.h"
38 #include "OpaqueRectTrackingContentLayerDelegate.h"
39
40 #include <public/WebAnimationDelegate.h>
41 #include <public/WebContentLayer.h>
42 #include <public/WebImageLayer.h>
43 #include <public/WebLayer.h>
44 #include <wtf/HashMap.h>
45
46 namespace WebCore {
47
48 class LayerChromium;
49 class LinkHighlight;
50 class Path;
51
52 class GraphicsLayerChromium : public GraphicsLayer, public GraphicsContextPainter, public WebKit::WebAnimationDelegate {
53 public:
54     GraphicsLayerChromium(GraphicsLayerClient*);
55     virtual ~GraphicsLayerChromium();
56
57     virtual void setName(const String&);
58
59     virtual bool setChildren(const Vector<GraphicsLayer*>&);
60     virtual void addChild(GraphicsLayer*);
61     virtual void addChildAtIndex(GraphicsLayer*, int index);
62     virtual void addChildAbove(GraphicsLayer*, GraphicsLayer* sibling);
63     virtual void addChildBelow(GraphicsLayer*, GraphicsLayer* sibling);
64     virtual bool replaceChild(GraphicsLayer* oldChild, GraphicsLayer* newChild);
65
66     virtual void removeFromParent();
67
68     virtual void setPosition(const FloatPoint&);
69     virtual void setAnchorPoint(const FloatPoint3D&);
70     virtual void setSize(const FloatSize&);
71
72     virtual void setTransform(const TransformationMatrix&);
73
74     virtual void setChildrenTransform(const TransformationMatrix&);
75
76     virtual void setPreserves3D(bool);
77     virtual void setMasksToBounds(bool);
78     virtual void setDrawsContent(bool);
79     virtual void setContentsVisible(bool);
80     virtual void setMaskLayer(GraphicsLayer*);
81
82     virtual void setBackgroundColor(const Color&);
83     virtual void clearBackgroundColor();
84
85     virtual void setContentsOpaque(bool);
86     virtual void setBackfaceVisibility(bool);
87
88     virtual void setReplicatedByLayer(GraphicsLayer*);
89
90     virtual void setOpacity(float);
91
92     // Returns true if filter can be rendered by the compositor
93     virtual bool setFilters(const FilterOperations&);
94     void setBackgroundFilters(const FilterOperations&);
95
96     virtual void setNeedsDisplay();
97     virtual void setNeedsDisplayInRect(const FloatRect&);
98     virtual void setContentsNeedsDisplay();
99
100     virtual void setContentsRect(const IntRect&);
101
102     virtual void setContentsToImage(Image*);
103     virtual void setContentsToMedia(PlatformLayer*);
104     virtual void setContentsToCanvas(PlatformLayer*);
105     virtual bool hasContentsLayer() const { return m_contentsLayer; }
106
107     virtual bool addAnimation(const KeyframeValueList&, const IntSize& boxSize, const Animation*, const String&, double timeOffset);
108     virtual void pauseAnimation(const String& animationName, double timeOffset);
109     virtual void removeAnimation(const String& animationName);
110     virtual void suspendAnimations(double wallClockTime);
111     virtual void resumeAnimations();
112
113     virtual void addLinkHighlight(const Path&);
114     virtual void didFinishLinkHighlight();
115
116     virtual PlatformLayer* platformLayer() const;
117
118     virtual void setDebugBackgroundColor(const Color&);
119     virtual void setDebugBorder(const Color&, float borderWidth);
120     virtual void deviceOrPageScaleFactorChanged();
121
122     // GraphicsContextPainter implementation.
123     virtual void paint(GraphicsContext&, const IntRect& clip) OVERRIDE;
124
125     // WebAnimationDelegate implementation.
126     virtual void notifyAnimationStarted(double startTime) OVERRIDE;
127     virtual void notifyAnimationFinished(double finishTime) OVERRIDE;
128
129     WebKit::WebContentLayer* contentLayer() const { return m_layer.get(); }
130
131     // Exposed for tests.
132     WebKit::WebLayer* contentsLayer() const { return m_contentsLayer; }
133     float contentsScale() const;
134
135 private:
136     void updateNames();
137     void updateChildList();
138     void updateLayerPosition();
139     void updateLayerSize();
140     void updateAnchorPoint();
141     void updateTransform();
142     void updateChildrenTransform();
143     void updateMasksToBounds();
144     void updateLayerPreserves3D();
145     void updateLayerIsDrawable();
146     void updateLayerBackgroundColor();
147
148     void updateContentsImage();
149     void updateContentsVideo();
150     void updateContentsRect();
151     void updateContentsScale();
152
153     enum ContentsLayerPurpose {
154         NoContentsLayer = 0,
155         ContentsLayerForImage,
156         ContentsLayerForVideo,
157         ContentsLayerForCanvas,
158     };
159
160     void setContentsTo(ContentsLayerPurpose, WebKit::WebLayer*);
161     void setupContentsLayer(WebKit::WebLayer*);
162
163     int mapAnimationNameToId(const String& animationName);
164
165     String m_nameBase;
166
167     OwnPtr<WebKit::WebContentLayer> m_layer;
168     OwnPtr<WebKit::WebLayer> m_transformLayer;
169     OwnPtr<WebKit::WebImageLayer> m_imageLayer;
170     WebKit::WebLayer* m_contentsLayer;
171     // We don't have ownership of m_contentsLayer, but we do want to know if a given layer is the
172     // same as our current layer in setContentsTo(). Since m_contentsLayer may be deleted at this point,
173     // we stash an ID away when we know m_contentsLayer is alive and use that for comparisons from that point
174     // on.
175     int m_contentsLayerId;
176
177     OwnPtr<OpaqueRectTrackingContentLayerDelegate> m_opaqueRectTrackingContentLayerDelegate;
178
179     ContentsLayerPurpose m_contentsLayerPurpose;
180     bool m_contentsLayerHasBackgroundColor : 1;
181     bool m_inSetChildren;
182     bool m_pageScaleChanged;
183
184     typedef HashMap<String, int> AnimationIdMap;
185     AnimationIdMap m_animationIdMap;
186 };
187
188 } // namespace WebCore
189
190 #endif // USE(ACCELERATED_COMPOSITING)
191
192 #endif