Scroll snapping on Mac should use AppKit animations
[WebKit-https.git] / Source / WebCore / page / WheelEventDeltaFilter.cpp
1 /*
2  * Copyright (C) 2015-2016 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 #include "config.h"
27 #include "WheelEventDeltaFilter.h"
28
29 #if HAVE(NSSCROLLING_FILTERS)
30 #include "WheelEventDeltaFilterMac.h"
31 #endif
32
33 #include "FloatSize.h"
34 #include "Logging.h"
35 #include "TextStream.h"
36
37 namespace WebCore {
38     
39 WheelEventDeltaFilter::WheelEventDeltaFilter()
40 {
41 }
42
43 WheelEventDeltaFilter::~WheelEventDeltaFilter()
44 {
45 }
46
47 std::unique_ptr<WheelEventDeltaFilter> WheelEventDeltaFilter::create()
48 {
49 #if HAVE(NSSCROLLING_FILTERS)
50     return std::make_unique<WheelEventDeltaFilterMac>();
51 #else
52     return std::make_unique<BasicWheelEventDeltaFilter>();
53 #endif
54 }
55
56 bool WheelEventDeltaFilter::isFilteringDeltas() const
57 {
58     return m_isFilteringDeltas;
59 }
60
61 FloatSize WheelEventDeltaFilter::filteredDelta() const
62 {
63     return m_currentFilteredDelta;
64 }
65
66 FloatPoint WheelEventDeltaFilter::filteredVelocity() const
67 {
68     return m_currentFilteredVelocity;
69 }
70
71 BasicWheelEventDeltaFilter::BasicWheelEventDeltaFilter()
72     : WheelEventDeltaFilter()
73 {
74 }
75
76 const size_t basicWheelEventDeltaFilterWindowSize = 3;
77
78 void BasicWheelEventDeltaFilter::updateFromDelta(const FloatSize& delta)
79 {
80     m_currentFilteredDelta = delta;
81     if (!m_isFilteringDeltas)
82         return;
83     
84     m_recentWheelEventDeltas.append(delta);
85     if (m_recentWheelEventDeltas.size() > basicWheelEventDeltaFilterWindowSize)
86         m_recentWheelEventDeltas.removeFirst();
87     
88     DominantScrollGestureDirection scrollDirection = dominantScrollGestureDirection();
89     if (scrollDirection == DominantScrollGestureDirection::Vertical)
90         m_currentFilteredDelta.setWidth(0);
91     else if (scrollDirection == DominantScrollGestureDirection::Horizontal)
92         m_currentFilteredDelta.setHeight(0);
93 }
94
95 void BasicWheelEventDeltaFilter::beginFilteringDeltas()
96 {
97     m_recentWheelEventDeltas.clear();
98     m_isFilteringDeltas = true;
99 }
100
101 void BasicWheelEventDeltaFilter::endFilteringDeltas()
102 {
103     m_currentFilteredDelta = FloatSize(0, 0);
104     m_isFilteringDeltas = false;
105 }
106
107 static inline bool deltaIsPredominantlyVertical(const FloatSize& delta)
108 {
109     return fabs(delta.height()) > fabs(delta.width());
110 }
111
112 DominantScrollGestureDirection BasicWheelEventDeltaFilter::dominantScrollGestureDirection() const
113 {
114     bool allVertical = m_recentWheelEventDeltas.size();
115     bool allHorizontal = m_recentWheelEventDeltas.size();
116     
117     for (const auto& delta : m_recentWheelEventDeltas) {
118         bool isVertical = deltaIsPredominantlyVertical(delta);
119         allVertical &= isVertical;
120         allHorizontal &= !isVertical;
121     }
122     
123     if (allVertical)
124         return DominantScrollGestureDirection::Vertical;
125     
126     if (allHorizontal)
127         return DominantScrollGestureDirection::Horizontal;
128     
129     return DominantScrollGestureDirection::None;
130 }
131
132 };