Rubber-banding is often not smooth on infinitely scrolling websites
[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(THREADED_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 PlatformWheelEvent;
40 class ScrollingTree;
41 class ScrollingStateScrollingNode;
42
43 class ScrollingTreeScrollingNode : public ScrollingTreeNode {
44 public:
45     static PassOwnPtr<ScrollingTreeScrollingNode> create(ScrollingTree*, ScrollingNodeID);
46     virtual ~ScrollingTreeScrollingNode();
47
48     virtual void updateBeforeChildren(ScrollingStateNode*) OVERRIDE;
49
50     // FIXME: We should implement this when we support ScrollingTreeScrollingNodes as children.
51     virtual void parentScrollPositionDidChange(const IntRect& /*viewportRect*/, const FloatSize& /*cumulativeDelta*/) OVERRIDE { }
52
53     virtual void handleWheelEvent(const PlatformWheelEvent&) = 0;
54     virtual void setScrollPosition(const IntPoint&) = 0;
55
56     MainThreadScrollingReasons shouldUpdateScrollLayerPositionOnMainThread() const { return m_shouldUpdateScrollLayerPositionOnMainThread; }
57
58 protected:
59     explicit ScrollingTreeScrollingNode(ScrollingTree*, ScrollingNodeID);
60
61     const IntRect& viewportRect() const { return m_viewportRect; }
62     const IntSize& totalContentsSize() const { return m_totalContentsSize; }
63
64     // If the totalContentsSize changes in the middle of a rubber-band, we still want to use the old totalContentsSize for the sake of
65     // computing the stretchAmount(). Using the old value will keep the animation smooth. When there is no rubber-band in progress at
66     // all, m_totalContentsSizeForRubberBand should be equivalent to m_totalContentsSize.
67     const IntSize& totalContentsSizeForRubberBand() const { return m_totalContentsSizeForRubberBand; }
68     void setTotalContentsSizeForRubberBand(const IntSize& totalContentsSizeForRubberBand) { m_totalContentsSizeForRubberBand = totalContentsSizeForRubberBand; }
69
70     float frameScaleFactor() const { return m_frameScaleFactor; }
71
72     ScrollElasticity horizontalScrollElasticity() const { return m_horizontalScrollElasticity; }
73     ScrollElasticity verticalScrollElasticity() const { return m_verticalScrollElasticity; }
74
75     bool hasEnabledHorizontalScrollbar() const { return m_hasEnabledHorizontalScrollbar; }
76     bool hasEnabledVerticalScrollbar() const { return m_hasEnabledVerticalScrollbar; }
77
78     bool canHaveScrollbars() const { return m_horizontalScrollbarMode != ScrollbarAlwaysOff || m_verticalScrollbarMode != ScrollbarAlwaysOff; }
79
80     const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
81
82     int headerHeight() const { return m_headerHeight; }
83     int footerHeight() const { return m_footerHeight; }
84
85 private:
86     IntRect m_viewportRect;
87     IntSize m_totalContentsSize;
88     IntSize m_totalContentsSizeForRubberBand;
89     IntPoint m_scrollOrigin;
90     
91     float m_frameScaleFactor;
92
93     MainThreadScrollingReasons m_shouldUpdateScrollLayerPositionOnMainThread;
94
95     ScrollElasticity m_horizontalScrollElasticity;
96     ScrollElasticity m_verticalScrollElasticity;
97     
98     bool m_hasEnabledHorizontalScrollbar;
99     bool m_hasEnabledVerticalScrollbar;
100
101     ScrollbarMode m_horizontalScrollbarMode;
102     ScrollbarMode m_verticalScrollbarMode;
103
104     int m_headerHeight;
105     int m_footerHeight;
106 };
107
108 } // namespace WebCore
109
110 #endif // ENABLE(THREADED_SCROLLING)
111
112 #endif // ScrollingTreeScrollingNode_h