[chromium] Convert screen space scroll gestures to layer space
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / cc / CCInputHandler.h
1 /* Copyright (C) 2011 Google Inc. All rights reserved.
2  *
3  * Redistribution and use in source and binary forms, with or without
4  * modification, are permitted provided that the following conditions
5  * are met:
6  * 1.  Redistributions of source code must retain the above copyright
7  *     notice, this list of conditions and the following disclaimer.
8  * 2.  Redistributions in binary form must reproduce the above copyright
9  *     notice, this list of conditions and the following disclaimer in the
10  *     documentation and/or other materials provided with the distribution.
11  *
12  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
13  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
14  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
15  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
16  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
17  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
19  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
21  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22  */
23
24 #ifndef CCInputHandler_h
25 #define CCInputHandler_h
26
27 #include <wtf/Noncopyable.h>
28 #include <wtf/PassOwnPtr.h>
29
30 namespace WebCore {
31
32 class CCActiveGestureAnimation;
33 class CCGestureCurveTarget;
34 class IntPoint;
35 class IntSize;
36
37 // The CCInputHandler is a way for the embedders to interact with
38 // the impl thread side of the compositor implementation.
39 //
40 // There is one CCInputHandler for every CCLayerTreeHost. It is
41 // created and used only on the impl thread.
42 //
43 // The CCInputHandler is constructed with an InputHandlerClient, which is the
44 // interface by which the handler can manipulate the LayerTree.
45 class CCInputHandlerClient {
46     WTF_MAKE_NONCOPYABLE(CCInputHandlerClient);
47 public:
48     enum ScrollStatus { ScrollOnMainThread, ScrollStarted, ScrollIgnored };
49     enum ScrollInputType { Gesture, Wheel };
50
51     // Selects a layer to be scrolled at a given point in window coordinates.
52     // Returns ScrollStarted if the layer at the coordinates can be scrolled,
53     // ScrollOnMainThread if the scroll event should instead be delegated to the
54     // main thread, or ScrollIgnored if there is nothing to be scrolled at the
55     // given coordinates.
56     virtual ScrollStatus scrollBegin(const IntPoint&, ScrollInputType) = 0;
57
58     // Scroll the selected layer starting at the given window coordinate. If
59     // there is no room to move the layer in the requested direction, its first
60     // ancestor layer that can be scrolled will be moved instead. Should only be
61     // called if scrollBegin() returned ScrollStarted.
62     virtual void scrollBy(const IntPoint&, const IntSize&) = 0;
63
64     // Stop scrolling the selected layer. Should only be called if scrollBegin()
65     // returned ScrollStarted.
66     virtual void scrollEnd() = 0;
67
68     virtual void pinchGestureBegin() = 0;
69     virtual void pinchGestureUpdate(float magnifyDelta, const IntPoint& anchor) = 0;
70     virtual void pinchGestureEnd() = 0;
71
72     virtual void startPageScaleAnimation(const IntSize& targetPosition,
73                                          bool anchorPoint,
74                                          float pageScale,
75                                          double startTime,
76                                          double duration) = 0;
77
78     virtual CCActiveGestureAnimation* activeGestureAnimation() = 0;
79     virtual void setActiveGestureAnimation(PassOwnPtr<CCActiveGestureAnimation>) = 0;
80
81     // Request another callback to CCInputHandler::animate().
82     virtual void scheduleAnimation() = 0;
83
84 protected:
85     CCInputHandlerClient() { }
86     virtual ~CCInputHandlerClient() { }
87 };
88
89 class CCInputHandler {
90     WTF_MAKE_NONCOPYABLE(CCInputHandler);
91 public:
92     static PassOwnPtr<CCInputHandler> create(CCInputHandlerClient*);
93     virtual ~CCInputHandler() { }
94
95     virtual int identifier() const = 0;
96     virtual void animate(double monotonicTime) = 0;
97
98 protected:
99     CCInputHandler() { }
100 };
101
102 }
103
104 #endif