Implement snapping behavior for iOS
[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 #ifndef ScrollingTreeScrollingNode_h
27 #define ScrollingTreeScrollingNode_h
28
29 #if ENABLE(ASYNC_SCROLLING)
30
31 #include "IntRect.h"
32 #include "ScrollTypes.h"
33 #include "ScrollingCoordinator.h"
34 #include "ScrollingTreeNode.h"
35 #include <wtf/PassOwnPtr.h>
36
37 namespace WebCore {
38
39 class ScrollingTree;
40 class ScrollingStateScrollingNode;
41
42 class ScrollingTreeScrollingNode : public ScrollingTreeNode {
43 public:
44     virtual ~ScrollingTreeScrollingNode();
45
46     virtual void updateBeforeChildren(const ScrollingStateNode&) override;
47     virtual void updateAfterChildren(const ScrollingStateNode&) override;
48
49     virtual void updateLayersAfterAncestorChange(const ScrollingTreeNode& changedNode, const FloatRect& fixedPositionRect, const FloatSize& cumulativeDelta) override;
50
51     virtual void handleWheelEvent(const PlatformWheelEvent&) = 0;
52     virtual void setScrollPosition(const FloatPoint&);
53     virtual void setScrollPositionWithoutContentEdgeConstraints(const FloatPoint&);
54
55     virtual void updateLayersAfterViewportChange(const FloatRect& fixedPositionRect, double scale) = 0;
56     virtual void updateLayersAfterDelegatedScroll(const FloatPoint&) { }
57
58     virtual FloatPoint scrollPosition() const = 0;
59
60 #if ENABLE(CSS_SCROLL_SNAP)
61     const Vector<float>& horizontalSnapOffsets() const { return m_horizontalSnapOffsets; }
62     const Vector<float>& verticalSnapOffsets() const { return m_verticalSnapOffsets; }
63 #endif
64
65 protected:
66     ScrollingTreeScrollingNode(ScrollingTree&, ScrollingNodeType, ScrollingNodeID);
67
68     virtual FloatPoint minimumScrollPosition() const;
69     virtual FloatPoint maximumScrollPosition() const;
70
71     virtual void setScrollLayerPosition(const FloatPoint&) = 0;
72
73     FloatPoint lastCommittedScrollPosition() const { return m_lastCommittedScrollPosition; }
74     const FloatSize& scrollableAreaSize() const { return m_scrollableAreaSize; }
75     const FloatSize& totalContentsSize() const { return m_totalContentsSize; }
76     const FloatSize& reachableContentsSize() const { return m_reachableContentsSize; }
77     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
78
79     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
80     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
81     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
82     const FloatSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
83     void setTotalContentsSizeForRubberBand(const FloatSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
84
85     ScrollElasticity horizontalScrollElasticity() const { return m_scrollableAreaParameters.horizontalScrollElasticity; }
86     ScrollElasticity verticalScrollElasticity() const { return m_scrollableAreaParameters.verticalScrollElasticity; }
87
88     bool hasEnabledHorizontalScrollbar() const { return m_scrollableAreaParameters.hasEnabledHorizontalScrollbar; }
89     bool hasEnabledVerticalScrollbar() const { return m_scrollableAreaParameters.hasEnabledVerticalScrollbar; }
90
91     bool canHaveScrollbars() const { return m_scrollableAreaParameters.horizontalScrollbarMode != ScrollbarAlwaysOff || m_scrollableAreaParameters.verticalScrollbarMode != ScrollbarAlwaysOff; }
92
93 private:
94     FloatSize m_scrollableAreaSize;
95     FloatSize m_totalContentsSize;
96     FloatSize m_totalContentsSizeForRubberBand;
97     FloatSize m_reachableContentsSize;
98     FloatPoint m_lastCommittedScrollPosition;
99     IntPoint m_scrollOrigin;
100 #if ENABLE(CSS_SCROLL_SNAP)
101     Vector<float> m_horizontalSnapOffsets;
102     Vector<float> m_verticalSnapOffsets;
103 #endif
104     ScrollableAreaParameters m_scrollableAreaParameters;
105 };
106
107 SCROLLING_NODE_TYPE_CASTS(ScrollingTreeScrollingNode, isScrollingNode());
108
109 } // namespace WebCore
110
111 #endif // ENABLE(ASYNC_SCROLLING)
112
113 #endif // ScrollingTreeScrollingNode_h