422a949b5ea55552151d4e2237abf12966ed1448
[WebKit-https.git] / Source / WebCore / platform / ScrollAnimator.cpp
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 #include "config.h"
32 #include "ScrollAnimator.h"
33
34 #include "FloatPoint.h"
35 #include "PlatformWheelEvent.h"
36 #include "ScrollableArea.h"
37 #include <algorithm>
38 #include <wtf/PassOwnPtr.h>
39
40 namespace WebCore {
41
42 #if !ENABLE(SMOOTH_SCROLLING) && !PLATFORM(IOS)
43 PassOwnPtr<ScrollAnimator> ScrollAnimator::create(ScrollableArea* scrollableArea)
44 {
45     return adoptPtr(new ScrollAnimator(scrollableArea));
46 }
47 #endif
48
49 ScrollAnimator::ScrollAnimator(ScrollableArea* scrollableArea)
50     : m_scrollableArea(scrollableArea)
51     , m_currentPosX(0)
52     , m_currentPosY(0)
53 {
54 }
55
56 ScrollAnimator::~ScrollAnimator()
57 {
58 }
59
60 bool ScrollAnimator::scroll(ScrollbarOrientation orientation, ScrollGranularity, float step, float multiplier)
61 {
62     float* currentPos = (orientation == HorizontalScrollbar) ? &m_currentPosX : &m_currentPosY;
63     float newPos = std::max(std::min(*currentPos + (step * multiplier), static_cast<float>(m_scrollableArea->scrollSize(orientation))), 0.0f);
64     float delta = *currentPos - newPos;
65     if (*currentPos == newPos)
66         return false;
67     *currentPos = newPos;
68
69     notifyPositionChanged(orientation == HorizontalScrollbar ? FloatSize(delta, 0) : FloatSize(0, delta));
70
71     return true;
72 }
73
74 void ScrollAnimator::scrollToOffsetWithoutAnimation(const FloatPoint& offset)
75 {
76     FloatSize delta = FloatSize(offset.x() - m_currentPosX, offset.y() - m_currentPosY);
77     m_currentPosX = offset.x();
78     m_currentPosY = offset.y();
79     notifyPositionChanged(delta);
80 }
81
82 bool ScrollAnimator::handleWheelEvent(const PlatformWheelEvent& e)
83 {
84 #if PLATFORM(COCOA)
85     // Events in the PlatformWheelEventPhaseMayBegin phase have no deltas, and therefore never passes through the scroll handling logic below.
86     // This causes us to return with an 'unhandled' return state, even though this event was successfully processed.
87     //
88     // We receive at least one PlatformWheelEventPhaseMayBegin when starting main-thread scrolling (see FrameView::wheelEvent), which can
89     // fool the scrolling thread into attempting to handle the scroll, unless we treat the event as handled here.
90     if (e.phase() == PlatformWheelEventPhaseMayBegin)
91         return true;
92 #endif
93
94     Scrollbar* horizontalScrollbar = m_scrollableArea->horizontalScrollbar();
95     Scrollbar* verticalScrollbar = m_scrollableArea->verticalScrollbar();
96
97     // Accept the event if we have a scrollbar in that direction and can still
98     // scroll any further.
99     float deltaX = horizontalScrollbar ? e.deltaX() : 0;
100     float deltaY = verticalScrollbar ? e.deltaY() : 0;
101
102     bool handled = false;
103
104     ScrollGranularity granularity = ScrollByPixel;
105     IntSize maxForwardScrollDelta = m_scrollableArea->maximumScrollPosition() - m_scrollableArea->scrollPosition();
106     IntSize maxBackwardScrollDelta = m_scrollableArea->scrollPosition() - m_scrollableArea->minimumScrollPosition();
107     if ((deltaX < 0 && maxForwardScrollDelta.width() > 0)
108         || (deltaX > 0 && maxBackwardScrollDelta.width() > 0)
109         || (deltaY < 0 && maxForwardScrollDelta.height() > 0)
110         || (deltaY > 0 && maxBackwardScrollDelta.height() > 0)) {
111         handled = true;
112
113         if (deltaY) {
114             if (e.granularity() == ScrollByPageWheelEvent) {
115                 bool negative = deltaY < 0;
116                 deltaY = std::max(std::max(static_cast<float>(m_scrollableArea->visibleHeight()) * Scrollbar::minFractionToStepWhenPaging(), static_cast<float>(m_scrollableArea->visibleHeight() - Scrollbar::maxOverlapBetweenPages())), 1.0f);
117                 if (negative)
118                     deltaY = -deltaY;
119             }
120             scroll(VerticalScrollbar, granularity, verticalScrollbar->pixelStep(), -deltaY);
121         }
122
123         if (deltaX) {
124             if (e.granularity() == ScrollByPageWheelEvent) {
125                 bool negative = deltaX < 0;
126                 deltaX = std::max(std::max(static_cast<float>(m_scrollableArea->visibleWidth()) * Scrollbar::minFractionToStepWhenPaging(), static_cast<float>(m_scrollableArea->visibleWidth() - Scrollbar::maxOverlapBetweenPages())), 1.0f);
127                 if (negative)
128                     deltaX = -deltaX;
129             }
130             scroll(HorizontalScrollbar, granularity, horizontalScrollbar->pixelStep(), -deltaX);
131         }
132     }
133     return handled;
134 }
135
136 #if ENABLE(TOUCH_EVENTS)
137 bool ScrollAnimator::handleTouchEvent(const PlatformTouchEvent&)
138 {
139     return false;
140 }
141 #endif
142
143 void ScrollAnimator::setCurrentPosition(const FloatPoint& position)
144 {
145     m_currentPosX = position.x();
146     m_currentPosY = position.y();
147 }
148
149 FloatPoint ScrollAnimator::currentPosition() const
150 {
151     return FloatPoint(m_currentPosX, m_currentPosY);
152 }
153
154 void ScrollAnimator::notifyPositionChanged(const FloatSize& delta)
155 {
156     UNUSED_PARAM(delta);
157     m_scrollableArea->setScrollOffsetFromAnimation(IntPoint(m_currentPosX, m_currentPosY));
158 }
159
160 } // namespace WebCore