55b42e636ab5c94272feecd8b8c487b2f7eecae4
[WebKit-https.git] / Source / WebCore / page / WheelEventDeltaFilter.h
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 #ifndef WheelEventDeltaFilter_h
27 #define WheelEventDeltaFilter_h
28
29 #include "FloatSize.h"
30 #include <wtf/Deque.h>
31
32 namespace WebCore {
33
34 class PlatformWheelEvent;
35
36 class WheelEventDeltaFilter {
37 public:
38     WheelEventDeltaFilter();
39     virtual ~WheelEventDeltaFilter();
40
41     WEBCORE_EXPORT static std::unique_ptr<WheelEventDeltaFilter> create();
42     WEBCORE_EXPORT virtual void updateFromDelta(const FloatSize&) = 0;
43     WEBCORE_EXPORT virtual void beginFilteringDeltas() = 0;
44     WEBCORE_EXPORT virtual void endFilteringDeltas() = 0;
45     WEBCORE_EXPORT bool isFilteringDeltas() const
46     {
47         return m_isFilteringDeltas;
48     }
49     
50     WEBCORE_EXPORT FloatSize filteredDelta() const
51     {
52         return m_currentFilteredDelta;
53     }
54
55 protected:
56     FloatSize m_currentFilteredDelta;
57     bool m_isFilteringDeltas { false };
58 };
59
60 enum class DominantScrollGestureDirection {
61     None,
62     Vertical,
63     Horizontal
64 };
65
66 class BasicWheelEventDeltaFilter final : public WheelEventDeltaFilter {
67 public:
68     BasicWheelEventDeltaFilter();
69     virtual void updateFromDelta(const FloatSize&) override;
70     virtual void beginFilteringDeltas() override;
71     virtual void endFilteringDeltas() override;
72
73 private:
74     DominantScrollGestureDirection dominantScrollGestureDirection() const;
75
76     Deque<FloatSize> m_recentWheelEventDeltas;
77 };
78
79 }
80
81 #endif