Changeset 286126 in webkit

Timestamp:

Nov 22, 2021, 6:28:18 PM (5 years ago)

Author:

Simon Fraser

Message:

Have ScrollAnimator::scrollToPositionWithAnimation() take a clamping argument
​https://bugs.webkit.org/show_bug.cgi?id=233438

Reviewed by Cameron McCormack.

Create symmetry between scrollToPositionWithAnimation() and scrollToPositionWithoutAnimation()
by adding a ScrollClamping argument to the former. Neither need to be virtual.

ScrollAnimator::cancelAnimations() does not need to be virtual.

Rename ScrollableArea::constrainScrollPosition() to ScrollableArea::constrainedScrollPosition()
because it just returns a new position.

• platform/KeyboardScrollingAnimator.cpp:

(WebCore::KeyboardScrollingAnimator::updateKeyboardScrollPosition):
(WebCore::KeyboardScrollingAnimator::stopKeyboardScrollAnimation):

• platform/ScrollAnimator.cpp:

(WebCore::ScrollAnimator::scrollToPositionWithAnimation):
(WebCore::ScrollAnimator::adjustScrollPositionToBoundsIfNecessary):
(WebCore::ScrollAnimator::adjustScrollPositionIfNecessary const):

• platform/ScrollAnimator.h:
• platform/ScrollableArea.cpp:

(WebCore::ScrollableArea::scrollToPositionWithAnimation):

• platform/ScrollableArea.h:

(WebCore::ScrollableArea::constrainedScrollPosition const):
(WebCore::ScrollableArea::constrainScrollPosition const): Deleted.

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• platform/KeyboardScrollingAnimator.cpp (modified) (2 diffs)
• platform/ScrollAnimator.cpp (modified) (3 diffs)
• platform/ScrollAnimator.h (modified) (2 diffs)
• platform/ScrollableArea.cpp (modified) (1 diff)
• platform/ScrollableArea.h (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-11-22  Simon Fraser  <simon.fraser@apple.com>
+
+        Have ScrollAnimator::scrollToPositionWithAnimation() take a clamping argument
+        https://bugs.webkit.org/show_bug.cgi?id=233438
+
+        Reviewed by Cameron McCormack.
+
+        Create symmetry between scrollToPositionWithAnimation() and scrollToPositionWithoutAnimation()
+        by adding a ScrollClamping argument to the former. Neither need to be virtual.
+
+        ScrollAnimator::cancelAnimations() does not need to be virtual.
+
+        Rename ScrollableArea::constrainScrollPosition() to ScrollableArea::constrainedScrollPosition()
+        because it just returns a new position.
+
+        * platform/KeyboardScrollingAnimator.cpp:
+        (WebCore::KeyboardScrollingAnimator::updateKeyboardScrollPosition):
+        (WebCore::KeyboardScrollingAnimator::stopKeyboardScrollAnimation):
+        * platform/ScrollAnimator.cpp:
+        (WebCore::ScrollAnimator::scrollToPositionWithAnimation):
+        (WebCore::ScrollAnimator::adjustScrollPositionToBoundsIfNecessary):
+        (WebCore::ScrollAnimator::adjustScrollPositionIfNecessary const):
+        * platform/ScrollAnimator.h:
+        * platform/ScrollableArea.cpp:
+        (WebCore::ScrollableArea::scrollToPositionWithAnimation):
+        * platform/ScrollableArea.h:
+        (WebCore::ScrollableArea::constrainedScrollPosition const):
+        (WebCore::ScrollableArea::constrainScrollPosition const): Deleted.
+
 2021-11-22  Wenson Hsieh  <wenson_hsieh@apple.com>
 

trunk/Source/WebCore/platform/KeyboardScrollingAnimator.cpp

@@ -125 +125 @@
     }
 
-    ScrollPosition idealPosition = m_scrollAnimator.scrollableArea().constrainScrollPosition(IntPoint(m_currentKeyboardScroll ? m_scrollAnimator.currentPosition() : m_idealPosition));
+    ScrollPosition idealPosition = m_scrollAnimator.scrollableArea().constrainedScrollPosition(IntPoint(m_currentKeyboardScroll ? m_scrollAnimator.currentPosition() : m_idealPosition));
     FloatSize displacement = m_scrollAnimator.currentPosition() - idealPosition;
 
@@ -318 +318 @@
     // out to that point.
     ScrollPosition farthestPoint = farthestPointInDirection(m_scrollAnimator.currentPosition() + displacement, m_idealPositionForMinimumTravel, m_currentKeyboardScroll->direction);
-    m_idealPosition = m_scrollAnimator.scrollableArea().constrainScrollPosition(farthestPoint);
+    m_idealPosition = m_scrollAnimator.scrollableArea().constrainedScrollPosition(farthestPoint);
 
     m_currentKeyboardScroll = std::nullopt;

trunk/Source/WebCore/platform/ScrollAnimator.cpp

@@ -108 +108 @@
 }
 
-bool ScrollAnimator::scrollToPositionWithAnimation(const FloatPoint& newPosition)
-{
-    bool positionChanged = newPosition != currentPosition();
+bool ScrollAnimator::scrollToPositionWithAnimation(const FloatPoint& position, ScrollClamping clamping)
+{
+    auto adjustedPosition = clamping == ScrollClamping::Clamped ? position.constrainedBetween(scrollableArea().minimumScrollPosition(), scrollableArea().maximumScrollPosition()) : position;
+    bool positionChanged = adjustedPosition != currentPosition();
     if (!positionChanged && !scrollableArea().scrollOriginChanged())
         return false;
 
-    return m_scrollController.startAnimatedScrollToDestination(offsetFromPosition(m_currentPosition), offsetFromPosition(newPosition));
+    return m_scrollController.startAnimatedScrollToDestination(offsetFromPosition(m_currentPosition), offsetFromPosition(adjustedPosition));
 }
 
@@ -310 +311 @@
 
     auto currentScrollPosition = m_scrollableArea.scrollPosition();
-    auto constrainedPosition = m_scrollableArea.constrainScrollPosition(currentScrollPosition);
+    auto constrainedPosition = m_scrollableArea.constrainedScrollPosition(currentScrollPosition);
     immediateScrollBy(constrainedPosition - currentScrollPosition);
 
@@ -321 +322 @@
         return position;
 
-    return m_scrollableArea.constrainScrollPosition(ScrollPosition(position));
+    return m_scrollableArea.constrainedScrollPosition(ScrollPosition(position));
 }
 

trunk/Source/WebCore/platform/ScrollAnimator.h

@@ -77 +77 @@
     bool singleAxisScroll(ScrollEventAxis, float delta, OptionSet<ScrollBehavior>);
 
-    virtual bool scrollToPositionWithoutAnimation(const FloatPoint&, ScrollClamping = ScrollClamping::Clamped);
-    bool scrollToPositionWithAnimation(const FloatPoint&);
+    bool scrollToPositionWithoutAnimation(const FloatPoint&, ScrollClamping = ScrollClamping::Clamped);
+    bool scrollToPositionWithAnimation(const FloatPoint&, ScrollClamping = ScrollClamping::Clamped);
 
     void retargetRunningAnimation(const FloatPoint& newPosition);
 
     virtual bool handleWheelEvent(const PlatformWheelEvent&);
-
     virtual bool processWheelEventForScrollSnap(const PlatformWheelEvent&) { return false; }
 
@@ -96 +95 @@
 #endif
 
-    virtual void cancelAnimations();
+    void cancelAnimations();
 
     virtual bool isRubberBandInProgress() const { return false; }

trunk/Source/WebCore/platform/ScrollableArea.cpp

@@ -144 +144 @@
     bool startedAnimation = requestAnimatedScrollToPosition(roundedIntPoint(position), clamping);
     if (!startedAnimation)
-        startedAnimation = scrollAnimator().scrollToPositionWithAnimation(position);
+        startedAnimation = scrollAnimator().scrollToPositionWithAnimation(position, clamping);
 
     if (startedAnimation)

trunk/Source/WebCore/platform/ScrollableArea.h

@@ -237 +237 @@
     virtual ScrollPosition maximumScrollPosition() const;
 
-    ScrollPosition constrainScrollPosition(const ScrollPosition& position) const
+    ScrollPosition constrainedScrollPosition(const ScrollPosition& position) const
     {
         return position.constrainedBetween(minimumScrollPosition(), maximumScrollPosition());