1/*
2 * Copyright (C) 2011 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
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef WebLayer_h
27#define WebLayer_h
28
29#include "WebAnimation.h"
30#include "WebBlendMode.h"
31#include "WebColor.h"
32#include "WebCommon.h"
33#include "WebCompositingReasons.h"
34#include "WebPoint.h"
35#include "WebRect.h"
36#include "WebString.h"
37#include "WebVector.h"
38
39class SkMatrix44;
40class SkImageFilter;
41
42namespace blink {
43class WebAnimationDelegate;
44class WebFilterOperations;
45class WebLayerClient;
46class WebLayerScrollClient;
47struct WebFloatPoint;
48struct WebFloatRect;
49struct WebLayerPositionConstraint;
50struct WebSize;
51
52class WebLayer {
53public:
54    virtual ~WebLayer() { }
55
56    // Returns a positive ID that will be unique across all WebLayers allocated in this process.
57    virtual int id() const = 0;
58
59    // Sets a region of the layer as invalid, i.e. needs to update its content.
60    virtual void invalidateRect(const WebFloatRect&) = 0;
61
62    // Sets the entire layer as invalid, i.e. needs to update its content.
63    virtual void invalidate() = 0;
64
65    // These functions do not take ownership of the WebLayer* parameter.
66    virtual void addChild(WebLayer*) = 0;
67    virtual void insertChild(WebLayer*, size_t index) = 0;
68    virtual void replaceChild(WebLayer* reference, WebLayer* newLayer) = 0;
69    virtual void removeFromParent() = 0;
70    virtual void removeAllChildren() = 0;
71
72    virtual void setAnchorPoint(const WebFloatPoint&) = 0;
73    virtual WebFloatPoint anchorPoint() const = 0;
74
75    virtual void setAnchorPointZ(float) = 0;
76    virtual float anchorPointZ() const = 0;
77
78    virtual void setBounds(const WebSize&) = 0;
79    virtual WebSize bounds() const = 0;
80
81    virtual void setMasksToBounds(bool) = 0;
82    virtual bool masksToBounds() const = 0;
83
84    virtual void setMaskLayer(WebLayer*) = 0;
85    virtual void setReplicaLayer(WebLayer*) = 0;
86
87    virtual void setOpacity(float) = 0;
88    virtual float opacity() const = 0;
89
90    virtual void setBlendMode(WebBlendMode) = 0;
91    virtual WebBlendMode blendMode() const = 0;
92
93    virtual void setIsRootForIsolatedGroup(bool) = 0;
94    virtual bool isRootForIsolatedGroup() = 0;
95
96    virtual void setOpaque(bool) = 0;
97    virtual bool opaque() const = 0;
98
99    virtual void setPosition(const WebFloatPoint&) = 0;
100    virtual WebFloatPoint position() const = 0;
101
102    virtual void setSublayerTransform(const SkMatrix44&) = 0;
103    virtual SkMatrix44 sublayerTransform() const = 0;
104
105    virtual void setTransform(const SkMatrix44&) = 0;
106    virtual SkMatrix44 transform() const = 0;
107
108    // Sets whether the layer draws its content when compositing.
109    virtual void setDrawsContent(bool) = 0;
110    virtual bool drawsContent() const = 0;
111
112    virtual void setPreserves3D(bool) = 0;
113
114    // Mark that this layer should use its parent's transform and double-sided
115    // properties in determining this layer's backface visibility instead of
116    // using its own properties. If this property is set, this layer must
117    // have a parent, and the parent may not have this property set.
118    // Note: This API is to work around issues with visibility the handling of
119    // WebKit layers that have a contents layer (canvas, plugin, WebGL, video,
120    // etc).
121    virtual void setUseParentBackfaceVisibility(bool) = 0;
122
123    virtual void setBackgroundColor(WebColor) = 0;
124    virtual WebColor backgroundColor() const = 0;
125
126    // Clear the filters in use by passing in a newly instantiated
127    // WebFilterOperations object.
128    virtual void setFilters(const WebFilterOperations&) = 0;
129
130    // Apply filters to pixels that show through the background of this layer.
131    // Note: These filters are only possible on layers that are drawn directly
132    // to a root render surface with an opaque background. This means if an
133    // ancestor of the background-filtered layer sets certain properties
134    // (opacity, transforms), it may conflict and hide the background filters.
135    virtual void setBackgroundFilters(const WebFilterOperations&) = 0;
136
137    // Provides a bitfield that describe why this composited layer was created.
138    virtual void setCompositingReasons(WebCompositingReasons) = 0;
139
140    // An animation delegate is notified when animations are started and
141    // stopped. The WebLayer does not take ownership of the delegate, and it is
142    // the responsibility of the client to reset the layer's delegate before
143    // deleting the delegate.
144    virtual void setAnimationDelegate(WebAnimationDelegate*) = 0;
145
146
147    // Returns false if the animation cannot be added.
148    // Takes ownership of the WebAnimation object.
149    virtual bool addAnimation(WebAnimation*) = 0;
150
151    // Removes all animations with the given id.
152    virtual void removeAnimation(int animationId) = 0;
153
154    // Removes all animations with the given id targeting the given property.
155    virtual void removeAnimation(int animationId, WebAnimation::TargetProperty) = 0;
156
157    // Pauses all animations with the given id.
158    virtual void pauseAnimation(int animationId, double timeOffset) = 0;
159
160    // Returns true if this layer has any active animations - useful for tests.
161    virtual bool hasActiveAnimation() = 0;
162
163    // If a scroll parent is set, this layer will inherit its parent's scroll
164    // delta and offset even though it will not be a descendant of the scroll
165    // in the layer hierarchy.
166    virtual void setScrollParent(WebLayer*) = 0;
167
168    // A layer will not respect any clips established by layers between it and
169    // its nearest clipping ancestor. Note, the clip parent must be an ancestor.
170    // This is not a requirement of the scroll parent.
171    virtual void setClipParent(WebLayer*) = 0;
172
173    // Scrolling
174    virtual void setScrollPosition(WebPoint) = 0;
175    virtual WebPoint scrollPosition() const = 0;
176
177    virtual void setMaxScrollPosition(WebSize) = 0;
178    virtual WebSize maxScrollPosition() const = 0;
179
180    virtual void setScrollable(bool) = 0;
181    virtual bool scrollable() const = 0;
182
183    virtual void setUserScrollable(bool horizontal, bool vertical) = 0;
184    virtual bool userScrollableHorizontal() const = 0;
185    virtual bool userScrollableVertical() const = 0;
186
187    virtual void setHaveWheelEventHandlers(bool) = 0;
188    virtual bool haveWheelEventHandlers() const = 0;
189
190    virtual void setShouldScrollOnMainThread(bool) = 0;
191    virtual bool shouldScrollOnMainThread() const = 0;
192
193    virtual void setNonFastScrollableRegion(const WebVector<WebRect>&) = 0;
194    virtual WebVector<WebRect> nonFastScrollableRegion() const = 0;
195
196    virtual void setTouchEventHandlerRegion(const WebVector<WebRect>&) = 0;
197    virtual WebVector<WebRect> touchEventHandlerRegion() const = 0;
198
199    virtual void setIsContainerForFixedPositionLayers(bool) = 0;
200    virtual bool isContainerForFixedPositionLayers() const = 0;
201
202    // This function sets layer position constraint. The constraint will be used
203    // to adjust layer position during threaded scrolling.
204    virtual void setPositionConstraint(const WebLayerPositionConstraint&) = 0;
205    virtual WebLayerPositionConstraint positionConstraint() const = 0;
206
207    // The scroll client is notified when the scroll position of the WebLayer
208    // changes. Only a single scroll client can be set for a WebLayer at a time.
209    // The WebLayer does not take ownership of the scroll client, and it is the
210    // responsibility of the client to reset the layer's scroll client before
211    // deleting the scroll client.
212    virtual void setScrollClient(WebLayerScrollClient*) = 0;
213
214    // Forces this layer to use a render surface. There is no benefit in doing
215    // so, but this is to facilitate benchmarks and tests.
216    virtual void setForceRenderSurface(bool) = 0;
217
218    // True if the layer is not part of a tree attached to a WebLayerTreeView.
219    virtual bool isOrphan() const = 0;
220
221    virtual void setWebLayerClient(WebLayerClient*) = 0;
222};
223
224} // namespace blink
225
226#endif // WebLayer_h
227