Scroll snapping on Mac should use AppKit animations
[WebKit-https.git] / Source / WebCore / platform / cocoa / ScrollSnapAnimatorState.mm
1 /*
2  * Copyright (C) 2014-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 #include "config.h"
27 #include "ScrollSnapAnimatorState.h"
28 #include <wtf/CurrentTime.h>
29 #include <wtf/MathExtras.h>
30
31 #if ENABLE(CSS_SCROLL_SNAP)
32
33 namespace WebCore {
34
35 static const float inertialScrollPredictionFactor = 10;
36 static inline float projectedInertialScrollDistance(float initialWheelDelta)
37 {
38     return inertialScrollPredictionFactor * initialWheelDelta;
39 }
40
41 void ScrollSnapAnimatorState::transitionToSnapAnimationState(const FloatSize& contentSize, const FloatSize& viewportSize, float pageScale, const FloatPoint& initialOffset)
42 {
43     setupAnimationForState(ScrollSnapState::Snapping, contentSize, viewportSize, pageScale, initialOffset, { }, { });
44 }
45
46 void ScrollSnapAnimatorState::transitionToGlideAnimationState(const FloatSize& contentSize, const FloatSize& viewportSize, float pageScale, const FloatPoint& initialOffset, const FloatPoint& initialVelocity, const FloatSize& initialDelta)
47 {
48     setupAnimationForState(ScrollSnapState::Gliding, contentSize, viewportSize, pageScale, initialOffset, initialVelocity, initialDelta);
49 }
50
51 void ScrollSnapAnimatorState::setupAnimationForState(ScrollSnapState state, const FloatSize& contentSize, const FloatSize& viewportSize, float pageScale, const FloatPoint& initialOffset, const FloatPoint& initialVelocity, const FloatSize& initialDelta)
52 {
53     ASSERT(state == ScrollSnapState::Snapping || state == ScrollSnapState::Gliding);
54     if (m_currentState == state)
55         return;
56
57     float targetOffsetX = targetOffsetForStartOffset(ScrollEventAxis::Horizontal, contentSize.width() - viewportSize.width(), initialOffset.x(), pageScale, initialDelta.width(), m_activeSnapIndexX);
58     float targetOffsetY = targetOffsetForStartOffset(ScrollEventAxis::Vertical, contentSize.height() - viewportSize.height(), initialOffset.y(), pageScale, initialDelta.height(), m_activeSnapIndexY);
59     m_momentumCalculator = ScrollingMomentumCalculator::create(viewportSize, contentSize, initialOffset, FloatPoint(targetOffsetX, targetOffsetY), initialDelta, initialVelocity);
60     m_startTime = monotonicallyIncreasingTime();
61     m_currentState = state;
62 }
63
64 void ScrollSnapAnimatorState::transitionToUserInteractionState()
65 {
66     teardownAnimationForState(ScrollSnapState::UserInteraction);
67 }
68
69 void ScrollSnapAnimatorState::transitionToDestinationReachedState()
70 {
71     teardownAnimationForState(ScrollSnapState::DestinationReached);
72 }
73
74 void ScrollSnapAnimatorState::teardownAnimationForState(ScrollSnapState state)
75 {
76     ASSERT(state == ScrollSnapState::UserInteraction || state == ScrollSnapState::DestinationReached);
77     if (m_currentState == state)
78         return;
79
80     m_momentumCalculator = nullptr;
81     m_startTime = 0;
82     m_currentState = state;
83 }
84
85 FloatPoint ScrollSnapAnimatorState::currentAnimatedScrollOffset(bool& isAnimationComplete) const
86 {
87     if (!m_momentumCalculator) {
88         isAnimationComplete = true;
89         return { };
90     }
91
92     double elapsedTime = monotonicallyIncreasingTime() - m_startTime;
93     isAnimationComplete = elapsedTime >= m_momentumCalculator->animationDuration();
94     return m_momentumCalculator->scrollOffsetAfterElapsedTime(elapsedTime);
95 }
96
97 float ScrollSnapAnimatorState::targetOffsetForStartOffset(ScrollEventAxis axis, float maxScrollOffset, float startOffset, float pageScale, float initialDelta, unsigned& outActiveSnapIndex) const
98 {
99     auto snapOffsets = snapOffsetsForAxis(axis);
100     if (!snapOffsets.size()) {
101         outActiveSnapIndex = 0;
102         return clampTo<float>(startOffset, 0, maxScrollOffset);
103     }
104
105     float projectedDestination = (startOffset + projectedInertialScrollDistance(initialDelta)) / pageScale;
106     float targetOffset = closestSnapOffset<LayoutUnit, float>(snapOffsets, projectedDestination, initialDelta, outActiveSnapIndex);
107     targetOffset = clampTo<float>(targetOffset, snapOffsets.first(), snapOffsets.last());
108     targetOffset = clampTo<float>(targetOffset, 0, maxScrollOffset);
109     return pageScale * targetOffset;
110 }
111     
112 } // namespace WebCore
113
114 #endif // CSS_SCROLL_SNAP