ScrollAnimator.cpp [plain text]
#include "config.h"
#include "ScrollAnimator.h"
#include "FloatPoint.h"
#include "LayoutSize.h"
#include "PlatformWheelEvent.h"
#include "ScrollAnimationSmooth.h"
#include "ScrollableArea.h"
#include <algorithm>
#if ENABLE(CSS_SCROLL_SNAP) || ENABLE(RUBBER_BANDING)
#include "ScrollController.h"
#endif
namespace WebCore {
#if !ENABLE(SMOOTH_SCROLLING) && !PLATFORM(IOS_FAMILY) && !PLATFORM(MAC) && !PLATFORM(WPE)
std::unique_ptr<ScrollAnimator> ScrollAnimator::create(ScrollableArea& scrollableArea)
{
return makeUnique<ScrollAnimator>(scrollableArea);
}
#endif
ScrollAnimator::ScrollAnimator(ScrollableArea& scrollableArea)
: m_scrollableArea(scrollableArea)
#if ENABLE(CSS_SCROLL_SNAP) || ENABLE(RUBBER_BANDING)
, m_scrollController(*this)
#endif
, m_animationProgrammaticScroll(makeUnique<ScrollAnimationSmooth>(
[this]() -> ScrollExtents {
return { m_scrollableArea.minimumScrollPosition(), m_scrollableArea.maximumScrollPosition(), m_scrollableArea.visibleSize() };
},
m_currentPosition,
[this](FloatPoint&& position) {
FloatSize delta = position - m_currentPosition;
m_currentPosition = WTFMove(position);
notifyPositionChanged(delta);
},
[this] {
m_scrollableArea.setScrollBehaviorStatus(ScrollBehaviorStatus::NotInAnimation);
}))
{
}
ScrollAnimator::~ScrollAnimator()
{
#if ENABLE(CSS_SCROLL_SNAP) || ENABLE(RUBBER_BANDING)
m_scrollController.stopAllTimers();
#endif
}
bool ScrollAnimator::scroll(ScrollbarOrientation orientation, ScrollGranularity granularity, float step, float multiplier, ScrollBehavior behavior)
{
#if ENABLE(CSS_SCROLL_SNAP)
if (behavior != ScrollBehavior::DoDirectionalSnapping)
return scrollWithoutAnimation(orientation, step, multiplier);
FloatSize scrollOrigin = toFloatSize(m_scrollableArea.scrollOrigin());
FloatPoint newPosition = positionFromStep(orientation, step, multiplier);
auto newOffset = ScrollableArea::scrollOffsetFromPosition(newPosition, scrollOrigin);
auto currentOffset = ScrollableArea::scrollOffsetFromPosition(this->currentPosition(), scrollOrigin);
if (orientation == HorizontalScrollbar) {
newOffset.setX(m_scrollController.adjustScrollDestinationForDirectionalSnapping(ScrollEventAxis::Horizontal, newOffset.x(), multiplier, currentOffset.x()));
newPosition = ScrollableArea::scrollPositionFromOffset(newOffset, scrollOrigin);
return scroll(HorizontalScrollbar, granularity, newPosition.x() - this->currentPosition().x(), 1.0);
}
newOffset.setY(m_scrollController.adjustScrollDestinationForDirectionalSnapping(ScrollEventAxis::Vertical, newPosition.y(), multiplier, currentOffset.y()));
newPosition = ScrollableArea::scrollPositionFromOffset(newOffset, scrollOrigin);
return scroll(VerticalScrollbar, granularity, newPosition.y() - this->currentPosition().y(), 1.0);
#else
UNUSED_PARAM(granularity);
UNUSED_PARAM(behavior);
return scrollWithoutAnimation(orientation, step, multiplier);
#endif
}
bool ScrollAnimator::scrollWithoutAnimation(ScrollbarOrientation orientation, float step, float multiplier)
{
FloatPoint currentPosition = this->currentPosition();
FloatPoint newPosition = positionFromStep(orientation, step, multiplier);
newPosition = newPosition.constrainedBetween(m_scrollableArea.minimumScrollPosition(), m_scrollableArea.maximumScrollPosition());
if (currentPosition == newPosition)
return false;
m_currentPosition = newPosition;
notifyPositionChanged(newPosition - currentPosition);
return true;
}
void ScrollAnimator::scrollToOffset(const FloatPoint& offset)
{
m_animationProgrammaticScroll->setCurrentPosition(m_currentPosition);
auto newPosition = ScrollableArea::scrollPositionFromOffset(offset, toFloatSize(m_scrollableArea.scrollOrigin()));
m_animationProgrammaticScroll->scroll(newPosition);
m_scrollableArea.setScrollBehaviorStatus(ScrollBehaviorStatus::InNonNativeAnimation);
}
void ScrollAnimator::scrollToOffsetWithoutAnimation(const FloatPoint& offset, ScrollClamping)
{
FloatPoint newPosition = ScrollableArea::scrollPositionFromOffset(offset, toFloatSize(m_scrollableArea.scrollOrigin()));
FloatSize delta = newPosition - currentPosition();
m_currentPosition = newPosition;
notifyPositionChanged(delta);
updateActiveScrollSnapIndexForOffset();
}
FloatPoint ScrollAnimator::positionFromStep(ScrollbarOrientation orientation, float step, float multiplier)
{
FloatSize delta;
if (orientation == HorizontalScrollbar)
delta.setWidth(step * multiplier);
else
delta.setHeight(step * multiplier);
return this->currentPosition() + delta;
}
#if ENABLE(CSS_SCROLL_SNAP)
#if PLATFORM(MAC)
bool ScrollAnimator::processWheelEventForScrollSnap(const PlatformWheelEvent& wheelEvent)
{
return m_scrollController.processWheelEventForScrollSnap(wheelEvent);
}
#endif
bool ScrollAnimator::activeScrollSnapIndexDidChange() const
{
return m_scrollController.activeScrollSnapIndexDidChange();
}
unsigned ScrollAnimator::activeScrollSnapIndexForAxis(ScrollEventAxis axis) const
{
return m_scrollController.activeScrollSnapIndexForAxis(axis);
}
#endif
bool ScrollAnimator::handleWheelEvent(const PlatformWheelEvent& e)
{
#if ENABLE(CSS_SCROLL_SNAP) && PLATFORM(MAC)
if (m_scrollController.processWheelEventForScrollSnap(e))
return false;
#endif
#if PLATFORM(COCOA)
if (e.phase() == PlatformWheelEventPhase::MayBegin)
return true;
#endif
Scrollbar* horizontalScrollbar = m_scrollableArea.horizontalScrollbar();
Scrollbar* verticalScrollbar = m_scrollableArea.verticalScrollbar();
float deltaX = horizontalScrollbar ? e.deltaX() : 0;
float deltaY = verticalScrollbar ? e.deltaY() : 0;
bool handled = false;
ScrollGranularity granularity = ScrollByPixel;
IntSize maxForwardScrollDelta = m_scrollableArea.maximumScrollPosition() - m_scrollableArea.scrollPosition();
IntSize maxBackwardScrollDelta = m_scrollableArea.scrollPosition() - m_scrollableArea.minimumScrollPosition();
if ((deltaX < 0 && maxForwardScrollDelta.width() > 0)
|| (deltaX > 0 && maxBackwardScrollDelta.width() > 0)
|| (deltaY < 0 && maxForwardScrollDelta.height() > 0)
|| (deltaY > 0 && maxBackwardScrollDelta.height() > 0)) {
handled = true;
if (deltaY) {
if (e.granularity() == ScrollByPageWheelEvent) {
bool negative = deltaY < 0;
deltaY = Scrollbar::pageStepDelta(m_scrollableArea.visibleHeight());
if (negative)
deltaY = -deltaY;
}
if (e.hasPreciseScrollingDeltas())
scrollWithoutAnimation(VerticalScrollbar, verticalScrollbar->pixelStep(), -deltaY);
else
scroll(VerticalScrollbar, granularity, verticalScrollbar->pixelStep(), -deltaY);
}
if (deltaX) {
if (e.granularity() == ScrollByPageWheelEvent) {
bool negative = deltaX < 0;
deltaX = Scrollbar::pageStepDelta(m_scrollableArea.visibleWidth());
if (negative)
deltaX = -deltaX;
}
if (e.hasPreciseScrollingDeltas())
scrollWithoutAnimation(HorizontalScrollbar, horizontalScrollbar->pixelStep(), -deltaX);
else
scroll(HorizontalScrollbar, granularity, horizontalScrollbar->pixelStep(), -deltaX);
}
}
return handled;
}
#if ENABLE(TOUCH_EVENTS)
bool ScrollAnimator::handleTouchEvent(const PlatformTouchEvent&)
{
return false;
}
#endif
void ScrollAnimator::setCurrentPosition(const FloatPoint& position)
{
m_currentPosition = position;
updateActiveScrollSnapIndexForOffset();
}
void ScrollAnimator::updateActiveScrollSnapIndexForOffset()
{
#if ENABLE(CSS_SCROLL_SNAP)
auto scrollOffset = m_scrollableArea.scrollOffsetFromPosition(roundedIntPoint(currentPosition()));
m_scrollController.setActiveScrollSnapIndicesForOffset(scrollOffset);
if (m_scrollController.activeScrollSnapIndexDidChange()) {
m_scrollableArea.setCurrentHorizontalSnapPointIndex(m_scrollController.activeScrollSnapIndexForAxis(ScrollEventAxis::Horizontal));
m_scrollableArea.setCurrentVerticalSnapPointIndex(m_scrollController.activeScrollSnapIndexForAxis(ScrollEventAxis::Vertical));
}
#endif
}
void ScrollAnimator::notifyPositionChanged(const FloatSize& delta)
{
UNUSED_PARAM(delta);
m_scrollableArea.setScrollOffsetFromAnimation(m_scrollableArea.scrollOffsetFromPosition(roundedIntPoint(currentPosition())));
#if ENABLE(CSS_SCROLL_SNAP) || ENABLE(RUBBER_BANDING)
m_scrollController.scrollPositionChanged();
#endif
}
#if ENABLE(CSS_SCROLL_SNAP)
void ScrollAnimator::updateScrollSnapState()
{
m_scrollController.updateScrollSnapState(m_scrollableArea);
}
FloatPoint ScrollAnimator::scrollOffset() const
{
return m_scrollableArea.scrollOffsetFromPosition(roundedIntPoint(currentPosition()));
}
void ScrollAnimator::immediateScrollOnAxis(ScrollEventAxis axis, float delta)
{
FloatSize deltaSize;
if (axis == ScrollEventAxis::Horizontal)
deltaSize.setWidth(delta);
else
deltaSize.setHeight(delta);
scrollToOffsetWithoutAnimation(currentPosition() + deltaSize);
}
LayoutSize ScrollAnimator::scrollExtent() const
{
return m_scrollableArea.contentsSize();
}
FloatSize ScrollAnimator::viewportSize() const
{
return m_scrollableArea.visibleSize();
}
float ScrollAnimator::pageScaleFactor() const
{
return m_scrollableArea.pageScaleFactor();
}
#endif
#if ENABLE(CSS_SCROLL_SNAP) || ENABLE(RUBBER_BANDING)
std::unique_ptr<ScrollControllerTimer> ScrollAnimator::createTimer(Function<void()>&& function)
{
return WTF::makeUnique<ScrollControllerTimer>(RunLoop::current(), [function = WTFMove(function), weakScrollableArea = makeWeakPtr(m_scrollableArea)] {
if (!weakScrollableArea)
return;
function();
});
}
#endif
#if (ENABLE(CSS_SCROLL_SNAP) || ENABLE(RUBBER_BANDING)) && PLATFORM(MAC)
void ScrollAnimator::deferWheelEventTestCompletionForReason(WheelEventTestMonitor::ScrollableAreaIdentifier identifier, WheelEventTestMonitor::DeferReason reason) const
{
if (!m_wheelEventTestMonitor)
return;
m_wheelEventTestMonitor->deferForReason(identifier, reason);
}
void ScrollAnimator::removeWheelEventTestCompletionDeferralForReason(WheelEventTestMonitor::ScrollableAreaIdentifier identifier, WheelEventTestMonitor::DeferReason reason) const
{
if (!m_wheelEventTestMonitor)
return;
m_wheelEventTestMonitor->removeDeferralForReason(identifier, reason);
}
#endif
void ScrollAnimator::cancelAnimations()
{
#if !USE(REQUEST_ANIMATION_FRAME_TIMER)
m_animationProgrammaticScroll->stop();
#endif
}
void ScrollAnimator::willEndLiveResize()
{
m_animationProgrammaticScroll->updateVisibleLengths();
}
void ScrollAnimator::didAddVerticalScrollbar(Scrollbar*)
{
m_animationProgrammaticScroll->updateVisibleLengths();
}
void ScrollAnimator::didAddHorizontalScrollbar(Scrollbar*)
{
m_animationProgrammaticScroll->updateVisibleLengths();
}
}