Add basic rubber banding support
[WebKit-https.git] / Source / WebCore / platform / mac / ScrollAnimatorMac.h
1 /*
2  * Copyright (C) 2010, 2011 Apple 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef ScrollAnimatorMac_h
27 #define ScrollAnimatorMac_h
28
29 #if ENABLE(SMOOTH_SCROLLING)
30
31 #include "FloatPoint.h"
32 #include "FloatSize.h"
33 #include "ScrollAnimator.h"
34 #include "Timer.h"
35 #include <wtf/RetainPtr.h>
36
37 #ifdef __OBJC__
38 @class ScrollAnimationHelperDelegate;
39 #else
40 class ScrollAnimationHelperDelegate;
41 #endif
42
43 namespace WebCore {
44
45 class ScrollAnimatorMac : public ScrollAnimator {
46 public:
47     ScrollAnimatorMac(ScrollableArea*);
48     virtual ~ScrollAnimatorMac();
49
50     virtual bool scroll(ScrollbarOrientation, ScrollGranularity, float step, float multiplier);
51     virtual void scrollToOffsetWithoutAnimation(const FloatPoint&);
52
53 #if ENABLE(RUBBER_BANDING)
54     virtual void handleWheelEvent(PlatformWheelEvent&);
55 #if ENABLE(GESTURE_EVENTS)
56     virtual void handleGestureEvent(const PlatformGestureEvent&);
57 #endif
58 #endif
59
60     void immediateScrollToPoint(const FloatPoint& newPosition);
61     void immediateScrollByDeltaX(float deltaX);
62     void immediateScrollByDeltaY(float deltaY);
63
64 private:
65     RetainPtr<id> m_scrollAnimationHelper;
66     RetainPtr<ScrollAnimationHelperDelegate> m_scrollAnimationHelperDelegate;
67
68 #if ENABLE(RUBBER_BANDING)
69     bool allowsVerticalStretching() const;
70     bool allowsHorizontalStretching() const;
71     bool pinnedInDirection(float deltaX, float deltaY);
72     void snapRubberBand();
73     void snapRubberBandTimerFired(Timer<ScrollAnimatorMac>*);
74     void smoothScrollWithEvent(PlatformWheelEvent&);
75     void beginScrollGesture();
76     void endScrollGesture();
77
78     bool m_inScrollGesture;
79     bool m_momentumScrollInProgress;
80     bool m_ignoreMomentumScrolls;
81     CFTimeInterval m_lastMomemtumScrollTimestamp;
82     FloatSize m_overflowScrollDelta;
83     FloatSize m_stretchScrollForce;
84     FloatSize m_momentumVelocity;
85
86     // Rubber band state.
87     CFTimeInterval m_startTime;
88     FloatSize m_startStretch;
89     FloatPoint m_origOrigin;
90     FloatSize m_origVelocity;
91     Timer<ScrollAnimatorMac> m_snapRubberBandTimer;
92 #endif
93 };
94
95 } // namespace WebCore
96
97 #endif // ENABLE(SMOOTH_SCROLLING)
98
99 #endif // ScrollAnimatorMac_h