2 * Copyright (C) 2011 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
29 #include "WebAnimation.h"
30 #include "WebBlendMode.h"
32 #include "WebCommon.h"
36 #include "WebString.h"
37 #include "WebVector.h"
43 class WebAnimationDelegate;
44 class WebFilterOperations;
46 class WebLayerScrollClient;
49 struct WebLayerPositionConstraint;
53 virtual ~WebLayer() { }
55 // Returns a positive ID that will be unique across all WebLayers allocated in this process.
56 virtual int id() const = 0;
58 // Sets a region of the layer as invalid, i.e. needs to update its content.
59 virtual void invalidateRect(const WebFloatRect&) = 0;
61 // Sets the entire layer as invalid, i.e. needs to update its content.
62 virtual void invalidate() = 0;
64 // These functions do not take ownership of the WebLayer* parameter.
65 virtual void addChild(WebLayer*) = 0;
66 virtual void insertChild(WebLayer*, size_t index) = 0;
67 virtual void replaceChild(WebLayer* reference, WebLayer* newLayer) = 0;
68 virtual void removeFromParent() = 0;
69 virtual void removeAllChildren() = 0;
71 virtual void setAnchorPoint(const WebFloatPoint&) = 0;
72 virtual WebFloatPoint anchorPoint() const = 0;
74 virtual void setAnchorPointZ(float) = 0;
75 virtual float anchorPointZ() const = 0;
77 virtual void setBounds(const WebSize&) = 0;
78 virtual WebSize bounds() const = 0;
80 virtual void setMasksToBounds(bool) = 0;
81 virtual bool masksToBounds() const = 0;
83 virtual void setMaskLayer(WebLayer*) = 0;
84 virtual void setReplicaLayer(WebLayer*) = 0;
86 virtual void setOpacity(float) = 0;
87 virtual float opacity() const = 0;
89 virtual void setBlendMode(WebBlendMode) = 0;
90 virtual WebBlendMode blendMode() const = 0;
92 virtual void setIsRootForIsolatedGroup(bool) = 0;
93 virtual bool isRootForIsolatedGroup() = 0;
95 virtual void setOpaque(bool) = 0;
96 virtual bool opaque() const = 0;
98 virtual void setPosition(const WebFloatPoint&) = 0;
99 virtual WebFloatPoint position() const = 0;
101 virtual void setSublayerTransform(const SkMatrix44&) = 0;
102 virtual SkMatrix44 sublayerTransform() const = 0;
104 virtual void setTransform(const SkMatrix44&) = 0;
105 virtual SkMatrix44 transform() const = 0;
107 // Sets whether the layer draws its content when compositing.
108 virtual void setDrawsContent(bool) = 0;
109 virtual bool drawsContent() const = 0;
111 virtual void setPreserves3D(bool) = 0;
113 // Mark that this layer should use its parent's transform and double-sided
114 // properties in determining this layer's backface visibility instead of
115 // using its own properties. If this property is set, this layer must
116 // have a parent, and the parent may not have this property set.
117 // Note: This API is to work around issues with visibility the handling of
118 // WebKit layers that have a contents layer (canvas, plugin, WebGL, video,
120 virtual void setUseParentBackfaceVisibility(bool) = 0;
122 virtual void setBackgroundColor(WebColor) = 0;
123 virtual WebColor backgroundColor() const = 0;
125 // Clear the filters in use by passing in a newly instantiated
126 // WebFilterOperations object.
127 virtual void setFilters(const WebFilterOperations&) = 0;
129 // Apply filters to pixels that show through the background of this layer.
130 // Note: These filters are only possible on layers that are drawn directly
131 // to a root render surface with an opaque background. This means if an
132 // ancestor of the background-filtered layer sets certain properties
133 // (opacity, transforms), it may conflict and hide the background filters.
134 virtual void setBackgroundFilters(const WebFilterOperations&) = 0;
136 // An animation delegate is notified when animations are started and
137 // stopped. The WebLayer does not take ownership of the delegate, and it is
138 // the responsibility of the client to reset the layer's delegate before
139 // deleting the delegate.
140 virtual void setAnimationDelegate(WebAnimationDelegate*) = 0;
143 // Returns false if the animation cannot be added.
144 // Takes ownership of the WebAnimation object.
145 virtual bool addAnimation(WebAnimation*) = 0;
147 // Removes all animations with the given id.
148 virtual void removeAnimation(int animationId) = 0;
150 // Removes all animations with the given id targeting the given property.
151 virtual void removeAnimation(int animationId, WebAnimation::TargetProperty) = 0;
153 // Pauses all animations with the given id.
154 virtual void pauseAnimation(int animationId, double timeOffset) = 0;
156 // Returns true if this layer has any active animations - useful for tests.
157 virtual bool hasActiveAnimation() = 0;
159 // If a scroll parent is set, this layer will inherit its parent's scroll
160 // delta and offset even though it will not be a descendant of the scroll
161 // in the layer hierarchy.
162 virtual void setScrollParent(WebLayer*) = 0;
164 // A layer will not respect any clips established by layers between it and
165 // its nearest clipping ancestor. Note, the clip parent must be an ancestor.
166 // This is not a requirement of the scroll parent.
167 virtual void setClipParent(WebLayer*) = 0;
170 virtual void setScrollPosition(WebPoint) = 0;
171 virtual WebPoint scrollPosition() const = 0;
173 virtual WebSize maxScrollPosition() const = 0;
175 // To set a WebLayer as scrollable we must specify the corresponding clip layer.
176 // TODO(wjmaclean) Make this pure virtual once https://codereview.chromium.org/23983047 lands.
177 virtual void setScrollClipLayer(WebLayer*) { }
178 virtual bool scrollable() const = 0;
180 virtual void setUserScrollable(bool horizontal, bool vertical) = 0;
181 virtual bool userScrollableHorizontal() const = 0;
182 virtual bool userScrollableVertical() const = 0;
184 virtual void setHaveWheelEventHandlers(bool) = 0;
185 virtual bool haveWheelEventHandlers() const = 0;
187 virtual void setShouldScrollOnMainThread(bool) = 0;
188 virtual bool shouldScrollOnMainThread() const = 0;
190 virtual void setNonFastScrollableRegion(const WebVector<WebRect>&) = 0;
191 virtual WebVector<WebRect> nonFastScrollableRegion() const = 0;
193 virtual void setTouchEventHandlerRegion(const WebVector<WebRect>&) = 0;
194 virtual WebVector<WebRect> touchEventHandlerRegion() const = 0;
196 virtual void setIsContainerForFixedPositionLayers(bool) = 0;
197 virtual bool isContainerForFixedPositionLayers() const = 0;
199 // This function sets layer position constraint. The constraint will be used
200 // to adjust layer position during threaded scrolling.
201 virtual void setPositionConstraint(const WebLayerPositionConstraint&) = 0;
202 virtual WebLayerPositionConstraint positionConstraint() const = 0;
204 // The scroll client is notified when the scroll position of the WebLayer
205 // changes. Only a single scroll client can be set for a WebLayer at a time.
206 // The WebLayer does not take ownership of the scroll client, and it is the
207 // responsibility of the client to reset the layer's scroll client before
208 // deleting the scroll client.
209 virtual void setScrollClient(WebLayerScrollClient*) = 0;
211 // Forces this layer to use a render surface. There is no benefit in doing
212 // so, but this is to facilitate benchmarks and tests.
213 virtual void setForceRenderSurface(bool) = 0;
215 // True if the layer is not part of a tree attached to a WebLayerTreeView.
216 virtual bool isOrphan() const = 0;
218 virtual void setWebLayerClient(WebLayerClient*) = 0;
220 // TODO(wjmaclean) Remove next two lines once https://codereview.chromium.org/23983047 lands.
221 virtual void setMaxScrollPosition(WebSize) { }
222 virtual void setScrollable(bool) { }