aa64ead6d665e258d90d0260faa91150b96dad6b
[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/WebLayer.h>
43 #include <wtf/HashMap.h>
44
45 namespace WebCore {
46
47 class LayerChromium;
48 class LinkHighlight;
49 class Path;
50
51 class GraphicsLayerChromium : public GraphicsLayer, public GraphicsContextPainter, public WebKit::WebAnimationDelegate {
52 public:
53     GraphicsLayerChromium(GraphicsLayerClient*);
54     virtual ~GraphicsLayerChromium();
55
56     virtual void setName(const String&);
57
58     virtual bool setChildren(const Vector<GraphicsLayer*>&);
59     virtual void addChild(GraphicsLayer*);
60     virtual void addChildAtIndex(GraphicsLayer*, int index);
61     virtual void addChildAbove(GraphicsLayer*, GraphicsLayer* sibling);
62     virtual void addChildBelow(GraphicsLayer*, GraphicsLayer* sibling);
63     virtual bool replaceChild(GraphicsLayer* oldChild, GraphicsLayer* newChild);
64
65     virtual void removeFromParent();
66
67     virtual void setPosition(const FloatPoint&);
68     virtual void setAnchorPoint(const FloatPoint3D&);
69     virtual void setSize(const FloatSize&);
70
71     virtual void setTransform(const TransformationMatrix&);
72
73     virtual void setChildrenTransform(const TransformationMatrix&);
74
75     virtual void setPreserves3D(bool);
76     virtual void setMasksToBounds(bool);
77     virtual void setDrawsContent(bool);
78     virtual void setContentsVisible(bool);
79     virtual void setMaskLayer(GraphicsLayer*);
80
81     virtual void setBackgroundColor(const Color&);
82     virtual void clearBackgroundColor();
83
84     virtual void setContentsOpaque(bool);
85     virtual void setBackfaceVisibility(bool);
86
87     virtual void setReplicatedByLayer(GraphicsLayer*);
88
89     virtual void setOpacity(float);
90
91     // Returns true if filter can be rendered by the compositor
92     virtual bool setFilters(const FilterOperations&);
93     void setBackgroundFilters(const FilterOperations&);
94
95     virtual void setNeedsDisplay();
96     virtual void setNeedsDisplayInRect(const FloatRect&);
97     virtual void setContentsNeedsDisplay();
98
99     virtual void setContentsRect(const IntRect&);
100
101     virtual void setContentsToImage(Image*);
102     virtual void setContentsToMedia(PlatformLayer*);
103     virtual void setContentsToCanvas(PlatformLayer*);
104     virtual bool hasContentsLayer() const { return !m_contentsLayer.isNull(); }
105
106     virtual bool addAnimation(const KeyframeValueList&, const IntSize& boxSize, const Animation*, const String&, double timeOffset);
107     virtual void pauseAnimation(const String& animationName, double timeOffset);
108     virtual void removeAnimation(const String& animationName);
109     virtual void suspendAnimations(double wallClockTime);
110     virtual void resumeAnimations();
111
112     virtual void addLinkHighlight(const Path&);
113     virtual void didFinishLinkHighlight();
114
115     virtual PlatformLayer* platformLayer() const;
116
117     virtual void setDebugBackgroundColor(const Color&);
118     virtual void setDebugBorder(const Color&, float borderWidth);
119     virtual void deviceOrPageScaleFactorChanged();
120
121     // GraphicsContextPainter implementation.
122     virtual void paint(GraphicsContext&, const IntRect& clip) OVERRIDE;
123
124     // WebAnimationDelegate implementation.
125     virtual void notifyAnimationStarted(double startTime) OVERRIDE;
126     virtual void notifyAnimationFinished(double finishTime) OVERRIDE;
127
128     // Exposed for tests.
129     WebKit::WebLayer contentsLayer() const { return m_contentsLayer; }
130     float contentsScale() const;
131
132 private:
133     virtual void willBeDestroyed();
134
135     WebKit::WebLayer primaryLayer() const;
136
137     void updateNames();
138     void updateChildList();
139     void updateLayerPosition();
140     void updateLayerSize();
141     void updateAnchorPoint();
142     void updateTransform();
143     void updateChildrenTransform();
144     void updateMasksToBounds();
145     void updateLayerPreserves3D();
146     void updateLayerIsDrawable();
147     void updateLayerBackgroundColor();
148
149     void updateContentsImage();
150     void updateContentsVideo();
151     void updateContentsRect();
152     void updateContentsScale();
153
154     void setupContentsLayer(WebKit::WebLayer);
155
156     int mapAnimationNameToId(const String& animationName);
157
158     String m_nameBase;
159
160     WebKit::WebContentLayer m_layer;
161     WebKit::WebLayer m_transformLayer;
162     WebKit::WebLayer m_contentsLayer;
163
164     OwnPtr<OpaqueRectTrackingContentLayerDelegate> m_opaqueRectTrackingContentLayerDelegate;
165
166     enum ContentsLayerPurpose {
167         NoContentsLayer = 0,
168         ContentsLayerForImage,
169         ContentsLayerForVideo,
170         ContentsLayerForCanvas,
171     };
172
173     ContentsLayerPurpose m_contentsLayerPurpose;
174     bool m_contentsLayerHasBackgroundColor : 1;
175     bool m_inSetChildren;
176     bool m_pageScaleChanged;
177
178     RefPtr<LinkHighlight> m_linkHighlight;
179
180     typedef HashMap<String, int> AnimationIdMap;
181     AnimationIdMap m_animationIdMap;
182 };
183
184 } // namespace WebCore
185
186 #endif // USE(ACCELERATED_COMPOSITING)
187
188 #endif