Source/WebCore/platform/mac/ScrollAnimationRubberBand.h

/*
 * Copyright (C) 2021 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "ScrollAnimation.h"

#if HAVE(RUBBER_BANDING)

namespace WebCore {

class ScrollAnimationRubberBand final: public ScrollAnimation {
public:
    ScrollAnimationRubberBand(ScrollAnimationClient&);
    virtual ~ScrollAnimationRubberBand();

    // targetOffset is the scroll offset when the animation has finished (i.e. scrolled to an edge).
    bool startRubberBandAnimation(const FloatSize& initialVelocity, const FloatSize& initialOverscroll);

private:
    void updateScrollExtents() final;
    void serviceAnimation(MonotonicTime) final;
    bool retargetActiveAnimation(const FloatPoint&) final;
    ScrollClamping clamping() const final { return ScrollClamping::Unclamped; }
    String debugDescription() const final;

    bool animateScroll(MonotonicTime);

    FloatSize m_initialVelocity;
    FloatSize m_initialOverscroll;
};

} // namespace WebCore

SPECIALIZE_TYPE_TRAITS_SCROLL_ANIMATION(WebCore::ScrollAnimationRubberBand, type() == WebCore::ScrollAnimation::Type::RubberBand)

#endif // HAVE(RUBBER_BANDING)