performLayout method

  1. @override
void performLayout()
override

Do the work of computing the layout for this render object.

Do not call this function directly: call layout instead. This function is called by layout when there is actually work to be done by this render object during layout. The layout constraints provided by your parent are available via the constraints getter.

If sizedByParent is true, then this function should not actually change the dimensions of this render object. Instead, that work should be done by performResize. If sizedByParent is false, then this function should both change the dimensions of this render object and instruct its children to layout.

In implementing this function, you must call layout on each of your children, passing true for parentUsesSize if your layout information is dependent on your child's layout information. Passing true for parentUsesSize ensures that this render object will undergo layout if the child undergoes layout. Otherwise, the child can change its layout information without informing this render object.

Implementation

@override
void performLayout() {
  assert((itemExtent != null && itemExtentBuilder == null) ||
      (itemExtent == null && itemExtentBuilder != null));
  assert(itemExtentBuilder != null || (itemExtent!.isFinite && itemExtent! >= 0));

  final SliverConstraints constraints = this.constraints;
  childManager.didStartLayout();
  childManager.setDidUnderflow(false);

  final double scrollOffset = constraints.scrollOffset + constraints.cacheOrigin;
  assert(scrollOffset >= 0.0);
  final double remainingExtent = constraints.remainingCacheExtent;
  assert(remainingExtent >= 0.0);
  final double targetEndScrollOffset = scrollOffset + remainingExtent;

  _currentLayoutDimensions = SliverLayoutDimensions(
      scrollOffset: constraints.scrollOffset,
      precedingScrollExtent: constraints.precedingScrollExtent,
      viewportMainAxisExtent: constraints.viewportMainAxisExtent,
      crossAxisExtent: constraints.crossAxisExtent
  );
  // TODO(Piinks): Clean up when deprecation expires.
  const double deprecatedExtraItemExtent = -1;

  final int firstIndex = getMinChildIndexForScrollOffset(scrollOffset, deprecatedExtraItemExtent);
  final int? targetLastIndex = targetEndScrollOffset.isFinite ?
      getMaxChildIndexForScrollOffset(targetEndScrollOffset, deprecatedExtraItemExtent) : null;

  if (firstChild != null) {
    final int leadingGarbage = calculateLeadingGarbage(firstIndex: firstIndex);
    final int trailingGarbage = targetLastIndex != null ? calculateTrailingGarbage(lastIndex: targetLastIndex) : 0;
    collectGarbage(leadingGarbage, trailingGarbage);
  } else {
    collectGarbage(0, 0);
  }

  if (firstChild == null) {
    final double layoutOffset = indexToLayoutOffset(deprecatedExtraItemExtent, firstIndex);
    if (!addInitialChild(index: firstIndex, layoutOffset: layoutOffset)) {
      // There are either no children, or we are past the end of all our children.
      final double max;
      if (firstIndex <= 0) {
        max = 0.0;
      } else {
        max = computeMaxScrollOffset(constraints, deprecatedExtraItemExtent);
      }
      geometry = SliverGeometry(
        scrollExtent: max,
        maxPaintExtent: max,
      );
      childManager.didFinishLayout();
      return;
    }
  }

  RenderBox? trailingChildWithLayout;

  for (int index = indexOf(firstChild!) - 1; index >= firstIndex; --index) {
    final RenderBox? child = insertAndLayoutLeadingChild(_getChildConstraints(index));
    if (child == null) {
      // Items before the previously first child are no longer present.
      // Reset the scroll offset to offset all items prior and up to the
      // missing item. Let parent re-layout everything.
      geometry = SliverGeometry(scrollOffsetCorrection: indexToLayoutOffset(deprecatedExtraItemExtent, index));
      return;
    }
    final SliverMultiBoxAdaptorParentData childParentData = child.parentData! as SliverMultiBoxAdaptorParentData;
    childParentData.layoutOffset = indexToLayoutOffset(deprecatedExtraItemExtent, index);
    assert(childParentData.index == index);
    trailingChildWithLayout ??= child;
  }

  if (trailingChildWithLayout == null) {
    firstChild!.layout(_getChildConstraints(indexOf(firstChild!)));
    final SliverMultiBoxAdaptorParentData childParentData = firstChild!.parentData! as SliverMultiBoxAdaptorParentData;
    childParentData.layoutOffset = indexToLayoutOffset(deprecatedExtraItemExtent, firstIndex);
    trailingChildWithLayout = firstChild;
  }

  double estimatedMaxScrollOffset = double.infinity;
  for (int index = indexOf(trailingChildWithLayout!) + 1; targetLastIndex == null || index <= targetLastIndex; ++index) {
    RenderBox? child = childAfter(trailingChildWithLayout!);
    if (child == null || indexOf(child) != index) {
      child = insertAndLayoutChild(_getChildConstraints(index), after: trailingChildWithLayout);
      if (child == null) {
        // We have run out of children.
        estimatedMaxScrollOffset = indexToLayoutOffset(deprecatedExtraItemExtent, index);
        break;
      }
    } else {
      child.layout(_getChildConstraints(index));
    }
    trailingChildWithLayout = child;
    final SliverMultiBoxAdaptorParentData childParentData = child.parentData! as SliverMultiBoxAdaptorParentData;
    assert(childParentData.index == index);
    childParentData.layoutOffset = indexToLayoutOffset(deprecatedExtraItemExtent, childParentData.index!);
  }

  final int lastIndex = indexOf(lastChild!);
  final double leadingScrollOffset = indexToLayoutOffset(deprecatedExtraItemExtent, firstIndex);
  final double trailingScrollOffset = indexToLayoutOffset(deprecatedExtraItemExtent, lastIndex + 1);

  assert(firstIndex == 0 || childScrollOffset(firstChild!)! - scrollOffset <= precisionErrorTolerance);
  assert(debugAssertChildListIsNonEmptyAndContiguous());
  assert(indexOf(firstChild!) == firstIndex);
  assert(targetLastIndex == null || lastIndex <= targetLastIndex);

  estimatedMaxScrollOffset = math.min(
    estimatedMaxScrollOffset,
    estimateMaxScrollOffset(
      constraints,
      firstIndex: firstIndex,
      lastIndex: lastIndex,
      leadingScrollOffset: leadingScrollOffset,
      trailingScrollOffset: trailingScrollOffset,
    ),
  );

  final double paintExtent = calculatePaintOffset(
    constraints,
    from: leadingScrollOffset,
    to: trailingScrollOffset,
  );

  final double cacheExtent = calculateCacheOffset(
    constraints,
    from: leadingScrollOffset,
    to: trailingScrollOffset,
  );

  final double targetEndScrollOffsetForPaint = constraints.scrollOffset + constraints.remainingPaintExtent;
  final int? targetLastIndexForPaint = targetEndScrollOffsetForPaint.isFinite ?
      getMaxChildIndexForScrollOffset(targetEndScrollOffsetForPaint, deprecatedExtraItemExtent) : null;

  geometry = SliverGeometry(
    scrollExtent: estimatedMaxScrollOffset,
    paintExtent: paintExtent,
    cacheExtent: cacheExtent,
    maxPaintExtent: estimatedMaxScrollOffset,
    // Conservative to avoid flickering away the clip during scroll.
    hasVisualOverflow: (targetLastIndexForPaint != null && lastIndex >= targetLastIndexForPaint)
      || constraints.scrollOffset > 0.0,
  );

  // We may have started the layout while scrolled to the end, which would not
  // expose a new child.
  if (estimatedMaxScrollOffset == trailingScrollOffset) {
    childManager.setDidUnderflow(true);
  }
  childManager.didFinishLayout();
}