Use _NSScrollingPredominantAxisFilter for wheel event filtering on Mac
[WebKit-https.git] / Source / WebCore / page / WheelEventDeltaFilter.cpp
1 /*
2  * Copyright (C) 2015 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 PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101100
30 #include "WheelEventDeltaFilterMac.h"
31 #endif
32
33 #include "FloatSize.h"
34
35 namespace WebCore {
36     
37 WheelEventDeltaFilter::WheelEventDeltaFilter()
38 {
39 }
40
41 WheelEventDeltaFilter::~WheelEventDeltaFilter()
42 {
43 }
44
45 std::unique_ptr<WheelEventDeltaFilter> WheelEventDeltaFilter::create()
46 {
47 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101100
48     return std::make_unique<WheelEventDeltaFilterMac>();
49 #else
50     return std::make_unique<BasicWheelEventDeltaFilter>();
51 #endif
52 }
53
54 BasicWheelEventDeltaFilter::BasicWheelEventDeltaFilter()
55     : WheelEventDeltaFilter()
56 {
57 }
58
59 const size_t basicWheelEventDeltaFilterWindowSize = 3;
60
61 void BasicWheelEventDeltaFilter::updateFromDelta(const FloatSize& delta)
62 {
63     m_currentFilteredDelta = delta;
64     if (!m_isFilteringDeltas)
65         return;
66     
67     m_recentWheelEventDeltas.append(delta);
68     if (m_recentWheelEventDeltas.size() > basicWheelEventDeltaFilterWindowSize)
69         m_recentWheelEventDeltas.removeFirst();
70     
71     DominantScrollGestureDirection scrollDirection = dominantScrollGestureDirection();
72     if (scrollDirection == DominantScrollGestureDirection::Vertical)
73         m_currentFilteredDelta.setWidth(0);
74     else if (scrollDirection == DominantScrollGestureDirection::Horizontal)
75         m_currentFilteredDelta.setHeight(0);
76 }
77
78 void BasicWheelEventDeltaFilter::beginFilteringDeltas()
79 {
80     m_recentWheelEventDeltas.clear();
81     m_isFilteringDeltas = true;
82 }
83
84 void BasicWheelEventDeltaFilter::endFilteringDeltas()
85 {
86     m_currentFilteredDelta = FloatSize(0, 0);
87     m_isFilteringDeltas = false;
88 }
89
90 static inline bool deltaIsPredominantlyVertical(const FloatSize& delta)
91 {
92     return fabs(delta.height()) > fabs(delta.width());
93 }
94
95 DominantScrollGestureDirection BasicWheelEventDeltaFilter::dominantScrollGestureDirection() const
96 {
97     bool allVertical = m_recentWheelEventDeltas.size();
98     bool allHorizontal = m_recentWheelEventDeltas.size();
99     
100     for (const auto& delta : m_recentWheelEventDeltas) {
101         bool isVertical = deltaIsPredominantlyVertical(delta);
102         allVertical &= isVertical;
103         allHorizontal &= !isVertical;
104     }
105     
106     if (allVertical)
107         return DominantScrollGestureDirection::Vertical;
108     
109     if (allHorizontal)
110         return DominantScrollGestureDirection::Horizontal;
111     
112     return DominantScrollGestureDirection::None;
113 }
114
115 };