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