Files
Texture/Source/Private/ASBatchFetching.mm
T
ricky 18d805f523 [RTL/Batching] Make ASDisplayShouldFetchBatchForScrollView aware of flipped CV layouts (#1985)
* [RTL/Batching] Make ASDisplayShouldFetchBatchForScrollView aware of flipped CV layouts

UICollectionViewLayout has a property called `flipsHorizontallyInOppositeLayoutDirection`. If this is set to `YES` then a RTL collectionView’s contentOffset behaves like it does in LTR. In other words, the first item is at contentOffset 0. In this case, the existing logic for `ASDisplayShouldFetchBatchForScrollView` works in RTL.

If you don’t override `flipsHorizontallyInOppositeLayoutDirection` to be `YES`, then it means that in RTL languages the first item in your collectionView will actually be at x offset `collectionView.contentSize.width - collectionView.frame.size.width`. As you scroll to the right, the content offset will decrease until you reach the end of the data at a content offset of 0,0. In this case, `ASDisplayShouldFetchBatchForScrollView` needs to know that you are in RTL and the layout is not flipped. It can then use the contentOffset as the `remainingDistance` to determine when to fetch.

* fix indentation

* assert that we are on main when accessing CV layout
2021-05-03 13:32:48 -07:00

109 lines
4.6 KiB
Plaintext

//
// ASBatchFetching.mm
// Texture
//
// Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
// Changes after 4/13/2017 are: Copyright (c) Pinterest, Inc. All rights reserved.
// Licensed under Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
//
#import <AsyncDisplayKit/ASBatchFetching.h>
#import <AsyncDisplayKit/ASBatchContext.h>
#import <AsyncDisplayKit/ASBatchFetchingDelegate.h>
BOOL ASDisplayShouldFetchBatchForScrollView(UIScrollView<ASBatchFetchingScrollView> *scrollView,
ASScrollDirection scrollDirection,
ASScrollDirection scrollableDirections,
CGPoint contentOffset,
CGPoint velocity,
BOOL flipsHorizontallyInOppositeLayoutDirection)
{
// Don't fetch if the scroll view does not allow
if (![scrollView canBatchFetch]) {
return NO;
}
// Check if we should batch fetch
ASBatchContext *context = scrollView.batchContext;
CGRect bounds = scrollView.bounds;
CGSize contentSize = scrollView.contentSize;
CGFloat leadingScreens = scrollView.leadingScreensForBatching;
id<ASBatchFetchingDelegate> delegate = scrollView.batchFetchingDelegate;
BOOL visible = (scrollView.window != nil);
BOOL shouldRenderRTLLayout = [UIView userInterfaceLayoutDirectionForSemanticContentAttribute:scrollView.semanticContentAttribute] == UIUserInterfaceLayoutDirectionRightToLeft;
return ASDisplayShouldFetchBatchForContext(context, scrollDirection, scrollableDirections, bounds, contentSize, contentOffset, leadingScreens, visible, shouldRenderRTLLayout, velocity, flipsHorizontallyInOppositeLayoutDirection, delegate);
}
BOOL ASDisplayShouldFetchBatchForContext(ASBatchContext *context,
ASScrollDirection scrollDirection,
ASScrollDirection scrollableDirections,
CGRect bounds,
CGSize contentSize,
CGPoint targetOffset,
CGFloat leadingScreens,
BOOL visible,
BOOL shouldRenderRTLLayout,
CGPoint velocity,
BOOL flipsHorizontallyInOppositeLayoutDirection,
id<ASBatchFetchingDelegate> delegate)
{
// Do not allow fetching if a batch is already in-flight and hasn't been completed or cancelled
if ([context isFetching]) {
return NO;
}
// No fetching for null states
if (leadingScreens <= 0.0 || CGRectIsEmpty(bounds)) {
return NO;
}
CGFloat viewLength, offset, contentLength, velocityLength;
if (ASScrollDirectionContainsVerticalDirection(scrollableDirections)) {
viewLength = bounds.size.height;
offset = targetOffset.y;
contentLength = contentSize.height;
velocityLength = velocity.y;
} else { // horizontal / right
viewLength = bounds.size.width;
offset = targetOffset.x;
contentLength = contentSize.width;
velocityLength = velocity.x;
}
BOOL hasSmallContent = contentLength < viewLength;
if (hasSmallContent) {
return YES;
}
// If we are not visible, but we do have enough content to fill visible area,
// don't batch fetch.
if (visible == NO) {
return NO;
}
// If they are scrolling toward the head of content, don't batch fetch.
BOOL isScrollingTowardHead = (ASScrollDirectionContainsUp(scrollDirection) || (shouldRenderRTLLayout ? ASScrollDirectionContainsRight(scrollDirection) : ASScrollDirectionContainsLeft(scrollDirection)));
if (isScrollingTowardHead) {
return NO;
}
CGFloat triggerDistance = viewLength * leadingScreens;
CGFloat remainingDistance = 0;
if (!flipsHorizontallyInOppositeLayoutDirection && shouldRenderRTLLayout && ASScrollDirectionContainsHorizontalDirection(scrollableDirections)) {
remainingDistance = offset;
} else {
remainingDistance = contentLength - viewLength - offset;
}
BOOL result = remainingDistance <= triggerDistance;
if (delegate != nil && velocityLength > 0.0) {
// Don't need to get absolute value of remaining time
// because both remainingDistance and velocityLength are positive when scrolling toward tail
NSTimeInterval remainingTime = remainingDistance / (velocityLength * 1000);
result = [delegate shouldFetchBatchWithRemainingTime:remainingTime hint:result];
}
return result;
}