-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
ScrollController.h
205 lines (168 loc) · 7.01 KB
/
ScrollController.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
* Copyright (C) 2011, 2014-2015 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ScrollController_h
#define ScrollController_h
#if ENABLE(RUBBER_BANDING) || ENABLE(CSS_SCROLL_SNAP)
#include "FloatPoint.h"
#include "FloatSize.h"
#include "ScrollTypes.h"
#include "WheelEventTestTrigger.h"
#include <wtf/Noncopyable.h>
#include <wtf/RunLoop.h>
#if ENABLE(CSS_SCROLL_SNAP)
#include "ScrollSnapAnimatorState.h"
#endif
namespace WebCore {
class LayoutSize;
class PlatformWheelEvent;
class ScrollableArea;
class WheelEventTestTrigger;
class ScrollControllerClient {
protected:
virtual ~ScrollControllerClient() { }
public:
#if ENABLE(RUBBER_BANDING)
virtual bool allowsHorizontalStretching(const PlatformWheelEvent&) = 0;
virtual bool allowsVerticalStretching(const PlatformWheelEvent&) = 0;
virtual IntSize stretchAmount() = 0;
virtual bool pinnedInDirection(const FloatSize&) = 0;
virtual bool canScrollHorizontally() = 0;
virtual bool canScrollVertically() = 0;
virtual bool shouldRubberBandInDirection(ScrollDirection) = 0;
virtual void immediateScrollBy(const FloatSize&) = 0;
virtual void immediateScrollByWithoutContentEdgeConstraints(const FloatSize&) = 0;
virtual void startSnapRubberbandTimer()
{
// Override to perform client-specific snap start logic
}
virtual void stopSnapRubberbandTimer()
{
// Override to perform client-specific snap end logic
}
// If the current scroll position is within the overhang area, this function will cause
// the page to scroll to the nearest boundary point.
virtual void adjustScrollPositionToBoundsIfNecessary() = 0;
#endif
virtual void deferTestsForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) const { /* Do nothing */ }
virtual void removeTestDeferralForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) const { /* Do nothing */ }
#if ENABLE(CSS_SCROLL_SNAP)
virtual LayoutUnit scrollOffsetOnAxis(ScrollEventAxis) const = 0;
virtual void immediateScrollOnAxis(ScrollEventAxis, float delta) = 0;
virtual void startScrollSnapTimer()
{
// Override to perform client-specific scroll snap point start logic
}
virtual void stopScrollSnapTimer()
{
// Override to perform client-specific scroll snap point end logic
}
virtual float pageScaleFactor() const
{
return 1.0f;
}
virtual unsigned activeScrollOffsetIndex(ScrollEventAxis) const
{
return 0;
}
virtual LayoutSize scrollExtent() const = 0;
#endif
};
class ScrollController {
WTF_MAKE_NONCOPYABLE(ScrollController);
public:
explicit ScrollController(ScrollControllerClient&);
#if PLATFORM(MAC)
bool handleWheelEvent(const PlatformWheelEvent&);
#endif
bool isRubberBandInProgress() const;
bool isScrollSnapInProgress() const;
#if ENABLE(CSS_SCROLL_SNAP)
void updateScrollSnapPoints(ScrollEventAxis, const Vector<LayoutUnit>&);
void setActiveScrollSnapIndexForAxis(ScrollEventAxis, unsigned);
void setActiveScrollSnapIndicesForOffset(int x, int y);
bool activeScrollSnapIndexDidChange() const { return m_activeScrollSnapIndexDidChange; }
void setScrollSnapIndexDidChange(bool state) { m_activeScrollSnapIndexDidChange = state; }
unsigned activeScrollSnapIndexForAxis(ScrollEventAxis) const;
void updateScrollSnapState(const ScrollableArea&);
#if PLATFORM(MAC)
bool processWheelEventForScrollSnap(const PlatformWheelEvent&);
#endif
#endif
private:
#if ENABLE(RUBBER_BANDING)
void startSnapRubberbandTimer();
void stopSnapRubberbandTimer();
void snapRubberBand();
void snapRubberBandTimerFired();
bool shouldRubberBandInHorizontalDirection(const PlatformWheelEvent&);
#endif
#if ENABLE(CSS_SCROLL_SNAP)
LayoutUnit scrollOffsetOnAxis(ScrollEventAxis) const;
void setNearestScrollSnapIndexForAxisAndOffset(ScrollEventAxis, int);
ScrollSnapAnimatorState& scrollSnapPointState(ScrollEventAxis);
const ScrollSnapAnimatorState& scrollSnapPointState(ScrollEventAxis) const;
#if PLATFORM(MAC)
void scrollSnapTimerFired();
void startScrollSnapTimer();
void stopScrollSnapTimer();
void processWheelEventForScrollSnapOnAxis(ScrollEventAxis, const PlatformWheelEvent&);
bool shouldOverrideWheelEvent(ScrollEventAxis, const PlatformWheelEvent&) const;
void beginScrollSnapAnimation(ScrollEventAxis, ScrollSnapState);
void endScrollSnapAnimation(ScrollSnapState);
void initializeScrollSnapAnimationParameters();
bool isSnappingOnAxis(ScrollEventAxis) const;
#endif
#endif
ScrollControllerClient& m_client;
CFTimeInterval m_lastMomentumScrollTimestamp { 0 };
FloatSize m_overflowScrollDelta;
FloatSize m_stretchScrollForce;
FloatSize m_momentumVelocity;
#if ENABLE(RUBBER_BANDING)
// Rubber band state.
CFTimeInterval m_startTime { 0 };
FloatSize m_startStretch;
FloatSize m_origVelocity;
RunLoop::Timer m_snapRubberbandTimer;
#endif
#if ENABLE(CSS_SCROLL_SNAP)
bool m_expectingHorizontalStatelessScrollSnap { false };
bool m_expectingVerticalStatelessScrollSnap { false };
std::unique_ptr<ScrollSnapAnimatorState> m_horizontalScrollSnapState;
std::unique_ptr<ScrollSnapAnimatorState> m_verticalScrollSnapState;
std::unique_ptr<ScrollSnapAnimationCurveState> m_scrollSnapCurveState;
#if PLATFORM(MAC)
RunLoop::Timer m_scrollSnapTimer;
#endif
#endif
bool m_inScrollGesture { false };
bool m_momentumScrollInProgress { false };
bool m_ignoreMomentumScrolls { false };
bool m_snapRubberbandTimerIsActive { false };
bool m_activeScrollSnapIndexDidChange { false };
};
} // namespace WebCore
#endif // ENABLE(RUBBER_BANDING)
#endif // ScrollController_h