3594b1086ecba378b516bd28d57abc4b230dd729
[WebKit-https.git] / Source / WebCore / page / scrolling / ScrollingTreeScrollingNode.h
1 /*
2  * Copyright (C) 2012 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 #pragma once
27
28 #if ENABLE(ASYNC_SCROLLING)
29
30 #include "IntRect.h"
31 #include "ScrollSnapOffsetsInfo.h"
32 #include "ScrollTypes.h"
33 #include "ScrollingCoordinator.h"
34 #include "ScrollingTreeNode.h"
35
36 namespace WebCore {
37
38 class ScrollingTree;
39 class ScrollingStateScrollingNode;
40
41 class ScrollingTreeScrollingNode : public ScrollingTreeNode {
42 public:
43     virtual ~ScrollingTreeScrollingNode();
44
45     WEBCORE_EXPORT void commitStateBeforeChildren(const ScrollingStateNode&) override;
46     WEBCORE_EXPORT void commitStateAfterChildren(const ScrollingStateNode&) override;
47
48     WEBCORE_EXPORT void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) override;
49
50     virtual void handleWheelEvent(const PlatformWheelEvent&) = 0;
51     WEBCORE_EXPORT virtual void setScrollPosition(const FloatPoint&);
52     WEBCORE_EXPORT virtual void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&);
53
54     virtual void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) = 0;
55     virtual void updateLayersAfterDelegatedScroll(const FloatPoint&) { }
56
57     virtual FloatPoint scrollPosition() const = 0;
58
59 #if ENABLE(CSS_SCROLL_SNAP)
60     const Vector<float>& horizontalSnapOffsets() const { return m_snapOffsetsInfo.horizontalSnapOffsets; }
61     const Vector<float>& verticalSnapOffsets() const { return m_snapOffsetsInfo.verticalSnapOffsets; }
62     const Vector<ScrollOffsetRange<float>>& horizontalSnapOffsetRanges() const { return m_snapOffsetsInfo.horizontalSnapOffsetRanges; }
63     const Vector<ScrollOffsetRange<float>>& verticalSnapOffsetRanges() const { return m_snapOffsetsInfo.verticalSnapOffsetRanges; }
64     unsigned currentHorizontalSnapPointIndex() const { return m_currentHorizontalSnapPointIndex; }
65     unsigned currentVerticalSnapPointIndex() const { return m_currentVerticalSnapPointIndex; }
66     void setCurrentHorizontalSnapPointIndex(unsigned index) { m_currentHorizontalSnapPointIndex = index; }
67     void setCurrentVerticalSnapPointIndex(unsigned index) { m_currentVerticalSnapPointIndex = index; }
68 #endif
69
70 protected:
71     ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
72
73     WEBCORE_EXPORT virtual FloatPoint minimumScrollPosition() const;
74     WEBCORE_EXPORT virtual FloatPoint maximumScrollPosition() const;
75
76     virtual void setScrollLayerPosition(const FloatPoint&, const FloatRect& layoutViewport) = 0;
77
78     FloatPoint lastCommittedScrollPosition() const { return m_lastCommittedScrollPosition; }
79     const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
80     const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
81     const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
82     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
83
84     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
85     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
86     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
87     const FloatSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
88     void setTotalContentsSizeForRubberBand(const FloatSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
89
90     ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
91     ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
92
93     bool hasEnabledHorizontalScrollbar() const { return m_scrollableAreaParameters.hasEnabledHorizontalScrollbar; }
94     bool hasEnabledVerticalScrollbar() const { return m_scrollableAreaParameters.hasEnabledVerticalScrollbar; }
95
96     bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarAlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarAlwaysOff; }
97
98     WEBCORE_EXPORT void dumpProperties(TextStream&, ScrollingStateTreeAsTextBehavior) const override;
99
100 private:
101     FloatSize m_scrollableAreaSize;
102     FloatSize m_totalContentsSize;
103     FloatSize m_totalContentsSizeForRubberBand;
104     FloatSize m_reachableContentsSize;
105     FloatPoint m_lastCommittedScrollPosition;
106     IntPoint m_scrollOrigin;
107 #if ENABLE(CSS_SCROLL_SNAP)
108     ScrollSnapOffsetsInfo<float> m_snapOffsetsInfo;
109     unsigned m_currentHorizontalSnapPointIndex { 0 };
110     unsigned m_currentVerticalSnapPointIndex { 0 };
111 #endif
112     ScrollableAreaParameters m_scrollableAreaParameters;
113 };
114
115 } // namespace WebCore
116
117 SPECIALIZE_TYPE_TRAITS_SCROLLING_NODE(ScrollingTreeScrollingNode, isScrollingNode())
118
119 #endif // ENABLE(ASYNC_SCROLLING)