sliver_grid.dart 27.9 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:math' as math;

xster's avatar
xster committed
7
import 'package:flutter/foundation.dart';
8 9 10 11 12 13 14 15 16 17

import 'box.dart';
import 'object.dart';
import 'sliver.dart';
import 'sliver_multi_box_adaptor.dart';

/// Describes the placement of a child in a [RenderSliverGrid].
///
/// See also:
///
18 19 20
///  * [SliverGridLayout], which represents the geometry of all the tiles in a
///    grid.
///  * [SliverGridLayout.getGeometryForChildIndex], which returns this object
21 22 23
///    to describe the child's placement.
///  * [RenderSliverGrid], which uses this class during its
///    [RenderSliverGrid.performLayout] method.
24
@immutable
25 26 27
class SliverGridGeometry {
  /// Creates an object that describes the placement of a child in a [RenderSliverGrid].
  const SliverGridGeometry({
28 29 30 31
    required this.scrollOffset,
    required this.crossAxisOffset,
    required this.mainAxisExtent,
    required this.crossAxisExtent,
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
  });

  /// The scroll offset of the leading edge of the child relative to the leading
  /// edge of the parent.
  final double scrollOffset;

  /// The offset of the child in the non-scrolling axis.
  ///
  /// If the scroll axis is vertical, this offset is from the left-most edge of
  /// the parent to the left-most edge of the child. If the scroll axis is
  /// horizontal, this offset is from the top-most edge of the parent to the
  /// top-most edge of the child.
  final double crossAxisOffset;

  /// The extent of the child in the scrolling axis.
  ///
  /// If the scroll axis is vertical, this extent is the child's height. If the
  /// scroll axis is horizontal, this extent is the child's width.
  final double mainAxisExtent;

  /// The extent of the child in the non-scrolling axis.
  ///
  /// If the scroll axis is vertical, this extent is the child's width. If the
  /// scroll axis is horizontal, this extent is the child's height.
  final double crossAxisExtent;

Adam Barth's avatar
Adam Barth committed
58 59 60 61
  /// The scroll offset of the trailing edge of the child relative to the
  /// leading edge of the parent.
  double get trailingScrollOffset => scrollOffset + mainAxisExtent;

62 63 64 65 66 67 68 69 70
  /// Returns a tight [BoxConstraints] that forces the child to have the
  /// required size.
  BoxConstraints getBoxConstraints(SliverConstraints constraints) {
    return constraints.asBoxConstraints(
      minExtent: mainAxisExtent,
      maxExtent: mainAxisExtent,
      crossAxisExtent: crossAxisExtent,
    );
  }
Adam Barth's avatar
Adam Barth committed
71 72 73

  @override
  String toString() {
74 75 76 77 78 79 80
    final List<String> properties = <String>[
      'scrollOffset: $scrollOffset',
      'crossAxisOffset: $crossAxisOffset',
      'mainAxisExtent: $mainAxisExtent',
      'crossAxisExtent: $crossAxisExtent',
    ];
    return 'SliverGridGeometry(${properties.join(', ')})';
Adam Barth's avatar
Adam Barth committed
81
  }
82 83
}

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
/// The size and position of all the tiles in a [RenderSliverGrid].
///
/// Rather that providing a grid with a [SliverGridLayout] directly, you instead
/// provide the grid a [SliverGridDelegate], which can compute a
/// [SliverGridLayout] given the current [SliverConstraints].
///
/// The tiles can be placed arbitrarily, but it is more efficient to place tiles
/// in roughly in order by scroll offset because grids reify a contiguous
/// sequence of children.
///
/// See also:
///
///  * [SliverGridRegularTileLayout], which represents a layout that uses
///    equally sized and spaced tiles.
///  * [SliverGridGeometry], which represents the size and position of a single
///    tile in a grid.
///  * [SliverGridDelegate.getLayout], which returns this object to describe the
101
///    delegate's layout.
102 103
///  * [RenderSliverGrid], which uses this class during its
///    [RenderSliverGrid.performLayout] method.
104
@immutable
105 106 107 108 109
abstract class SliverGridLayout {
  /// Abstract const constructor. This constructor enables subclasses to provide
  /// const constructors so that they can be used in const expressions.
  const SliverGridLayout();

110
  /// The minimum child index that intersects with (or is after) this scroll offset.
111 112
  int getMinChildIndexForScrollOffset(double scrollOffset);

113
  /// The maximum child index that intersects with (or is before) this scroll offset.
114 115 116 117 118
  int getMaxChildIndexForScrollOffset(double scrollOffset);

  /// The size and position of the child with the given index.
  SliverGridGeometry getGeometryForChildIndex(int index);

119 120 121 122 123
  /// The scroll extent needed to fully display all the tiles if there are
  /// `childCount` children in total.
  ///
  /// The child count will never be null.
  double computeMaxScrollOffset(int childCount);
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
}

/// A [SliverGridLayout] that uses equally sized and spaced tiles.
///
/// Rather that providing a grid with a [SliverGridLayout] directly, you instead
/// provide the grid a [SliverGridDelegate], which can compute a
/// [SliverGridLayout] given the current [SliverConstraints].
///
/// This layout is used by [SliverGridDelegateWithFixedCrossAxisCount] and
/// [SliverGridDelegateWithMaxCrossAxisExtent].
///
/// See also:
///
///  * [SliverGridDelegateWithFixedCrossAxisCount], which uses this layout.
///  * [SliverGridDelegateWithMaxCrossAxisExtent], which uses this layout.
139
///  * [SliverGridLayout], which represents an arbitrary tile layout.
140 141 142
///  * [SliverGridGeometry], which represents the size and position of a single
///    tile in a grid.
///  * [SliverGridDelegate.getLayout], which returns this object to describe the
143
///    delegate's layout.
144 145 146 147 148 149 150
///  * [RenderSliverGrid], which uses this class during its
///    [RenderSliverGrid.performLayout] method.
class SliverGridRegularTileLayout extends SliverGridLayout {
  /// Creates a layout that uses equally sized and spaced tiles.
  ///
  /// All of the arguments must not be null and must not be negative. The
  /// `crossAxisCount` argument must be greater than zero.
151
  const SliverGridRegularTileLayout({
152 153 154 155 156 157
    required this.crossAxisCount,
    required this.mainAxisStride,
    required this.crossAxisStride,
    required this.childMainAxisExtent,
    required this.childCrossAxisExtent,
    required this.reverseCrossAxis,
158 159 160 161
  }) : assert(crossAxisCount != null && crossAxisCount > 0),
       assert(mainAxisStride != null && mainAxisStride >= 0),
       assert(crossAxisStride != null && crossAxisStride >= 0),
       assert(childMainAxisExtent != null && childMainAxisExtent >= 0),
162 163
       assert(childCrossAxisExtent != null && childCrossAxisExtent >= 0),
       assert(reverseCrossAxis != null);
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182

  /// The number of children in the cross axis.
  final int crossAxisCount;

  /// The number of pixels from the leading edge of one tile to the leading edge
  /// of the next tile in the main axis.
  final double mainAxisStride;

  /// The number of pixels from the leading edge of one tile to the leading edge
  /// of the next tile in the cross axis.
  final double crossAxisStride;

  /// The number of pixels from the leading edge of one tile to the trailing
  /// edge of the same tile in the main axis.
  final double childMainAxisExtent;

  /// The number of pixels from the leading edge of one tile to the trailing
  /// edge of the same tile in the cross axis.
  final double childCrossAxisExtent;
183

184 185 186 187 188 189 190 191 192 193 194
  /// Whether the children should be placed in the opposite order of increasing
  /// coordinates in the cross axis.
  ///
  /// For example, if the cross axis is horizontal, the children are placed from
  /// left to right when [reverseCrossAxis] is false and from right to left when
  /// [reverseCrossAxis] is true.
  ///
  /// Typically set to the return value of [axisDirectionIsReversed] applied to
  /// the [SliverConstraints.crossAxisDirection].
  final bool reverseCrossAxis;

195
  @override
196
  int getMinChildIndexForScrollOffset(double scrollOffset) {
197
    return mainAxisStride > precisionErrorTolerance ? crossAxisCount * (scrollOffset ~/ mainAxisStride) : 0;
198 199 200 201
  }

  @override
  int getMaxChildIndexForScrollOffset(double scrollOffset) {
202 203 204 205 206
    if (mainAxisStride > 0.0) {
      final int mainAxisCount = (scrollOffset / mainAxisStride).ceil();
      return math.max(0, crossAxisCount * mainAxisCount - 1);
    }
    return 0;
207 208
  }

209 210
  double _getOffsetFromStartInCrossAxis(double crossAxisStart) {
    if (reverseCrossAxis)
211
      return crossAxisCount * crossAxisStride - crossAxisStart - childCrossAxisExtent - (crossAxisStride - childCrossAxisExtent);
212 213 214
    return crossAxisStart;
  }

215 216
  @override
  SliverGridGeometry getGeometryForChildIndex(int index) {
217
    final double crossAxisStart = (index % crossAxisCount) * crossAxisStride;
218
    return SliverGridGeometry(
219
      scrollOffset: (index ~/ crossAxisCount) * mainAxisStride,
220
      crossAxisOffset: _getOffsetFromStartInCrossAxis(crossAxisStart),
221 222 223 224 225 226
      mainAxisExtent: childMainAxisExtent,
      crossAxisExtent: childCrossAxisExtent,
    );
  }

  @override
227 228
  double computeMaxScrollOffset(int childCount) {
    assert(childCount != null);
229
    final int mainAxisCount = ((childCount - 1) ~/ crossAxisCount) + 1;
230 231 232
    final double mainAxisSpacing = mainAxisStride - childMainAxisExtent;
    return mainAxisStride * mainAxisCount - mainAxisSpacing;
  }
233 234
}

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
/// Controls the layout of tiles in a grid.
///
/// Given the current constraints on the grid, a [SliverGridDelegate] computes
/// the layout for the tiles in the grid. The tiles can be placed arbitrarily,
/// but it is more efficient to place tiles in roughly in order by scroll offset
/// because grids reify a contiguous sequence of children.
///
/// See also:
///
///  * [SliverGridDelegateWithFixedCrossAxisCount], which creates a layout with
///    a fixed number of tiles in the cross axis.
///  * [SliverGridDelegateWithMaxCrossAxisExtent], which creates a layout with
///    tiles that have a maximum cross-axis extent.
///  * [GridView], which uses this delegate to control the layout of its tiles.
///  * [SliverGrid], which uses this delegate to control the layout of its
///    tiles.
///  * [RenderSliverGrid], which uses this delegate to control the layout of its
///    tiles.
253 254 255 256 257
abstract class SliverGridDelegate {
  /// Abstract const constructor. This constructor enables subclasses to provide
  /// const constructors so that they can be used in const expressions.
  const SliverGridDelegate();

258 259
  /// Returns information about the size and position of the tiles in the grid.
  SliverGridLayout getLayout(SliverConstraints constraints);
260

261 262 263 264 265 266
  /// Override this method to return true when the children need to be
  /// laid out.
  ///
  /// This should compare the fields of the current delegate and the given
  /// `oldDelegate` and return true if the fields are such that the layout would
  /// be different.
267
  bool shouldRelayout(covariant SliverGridDelegate oldDelegate);
268 269
}

270 271 272 273 274 275 276 277
/// Creates grid layouts with a fixed number of tiles in the cross axis.
///
/// For example, if the grid is vertical, this delegate will create a layout
/// with a fixed number of columns. If the grid is horizontal, this delegate
/// will create a layout with a fixed number of rows.
///
/// This delegate creates grids with equally sized and spaced tiles.
///
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
/// {@tool dartpad --template=stateless_widget_scaffold}
///
/// Here is an example using the [childAspectRatio] property. On a device with a
/// screen width of 800.0, it creates a GridView with each tile with a width of
/// 200.0 and a height of 100.0.
///
/// ```dart
/// Widget build(BuildContext context) {
///   return GridView(
///     gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(
///       crossAxisCount: 4,
///       childAspectRatio: 0.5,
///     ),
///     children: List<Widget>.generate(20, (int i) {
///       return Builder(builder: (BuildContext context) {
293
///         return Text('$i');
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
///       });
///     }),
///   );
/// }
/// ```
/// {@end-tool}
///
/// {@tool dartpad --template=stateless_widget_scaffold}
///
/// Here is an example using the [mainAxisExtent] property. On a device with a
/// screen width of 800.0, it creates a GridView with each tile with a width of
/// 200.0 and a height of 150.0.
///
/// ```dart
/// Widget build(BuildContext context) {
///   return GridView(
///     gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(
///       crossAxisCount: 4,
///       mainAxisExtent: 150.0,
///     ),
///     children: List<Widget>.generate(20, (int i) {
///       return Builder(builder: (BuildContext context) {
316
///         return Text('$i');
317 318 319 320 321 322 323
///       });
///     }),
///   );
/// }
/// ```
/// {@end-tool}
///
324 325 326 327 328 329 330 331 332 333 334
/// See also:
///
///  * [SliverGridDelegateWithMaxCrossAxisExtent], which creates a layout with
///    tiles that have a maximum cross-axis extent.
///  * [SliverGridDelegate], which creates arbitrary layouts.
///  * [GridView], which can use this delegate to control the layout of its
///    tiles.
///  * [SliverGrid], which can use this delegate to control the layout of its
///    tiles.
///  * [RenderSliverGrid], which can use this delegate to control the layout of
///    its tiles.
335
class SliverGridDelegateWithFixedCrossAxisCount extends SliverGridDelegate {
336 337 338
  /// Creates a delegate that makes grid layouts with a fixed number of tiles in
  /// the cross axis.
  ///
339 340 341 342
  /// All of the arguments except [mainAxisExtent] must not be null.
  /// The `mainAxisSpacing`, `mainAxisExtent` and `crossAxisSpacing` arguments
  /// must not be negative. The `crossAxisCount` and `childAspectRatio`
  /// arguments must be greater than zero.
343
  const SliverGridDelegateWithFixedCrossAxisCount({
344
    required this.crossAxisCount,
345 346 347
    this.mainAxisSpacing = 0.0,
    this.crossAxisSpacing = 0.0,
    this.childAspectRatio = 1.0,
348
    this.mainAxisExtent,
349 350 351 352
  }) : assert(crossAxisCount != null && crossAxisCount > 0),
       assert(mainAxisSpacing != null && mainAxisSpacing >= 0),
       assert(crossAxisSpacing != null && crossAxisSpacing >= 0),
       assert(childAspectRatio != null && childAspectRatio > 0);
353 354 355 356 357 358 359 360 361 362 363 364 365

  /// The number of children in the cross axis.
  final int crossAxisCount;

  /// The number of logical pixels between each child along the main axis.
  final double mainAxisSpacing;

  /// The number of logical pixels between each child along the cross axis.
  final double crossAxisSpacing;

  /// The ratio of the cross-axis to the main-axis extent of each child.
  final double childAspectRatio;

366 367 368 369 370 371
  /// The extent of each tile in the main axis. If provided it would define the
  /// logical pixels taken by each tile in the main-axis.
  ///
  /// If null, [childAspectRatio] is used instead.
  final double? mainAxisExtent;

372 373 374 375 376 377 378 379 380
  bool _debugAssertIsValid() {
    assert(crossAxisCount > 0);
    assert(mainAxisSpacing >= 0.0);
    assert(crossAxisSpacing >= 0.0);
    assert(childAspectRatio > 0.0);
    return true;
  }

  @override
381
  SliverGridLayout getLayout(SliverConstraints constraints) {
382
    assert(_debugAssertIsValid());
383 384 385 386
    final double usableCrossAxisExtent = math.max(
      0.0,
      constraints.crossAxisExtent - crossAxisSpacing * (crossAxisCount - 1),
    );
387
    final double childCrossAxisExtent = usableCrossAxisExtent / crossAxisCount;
388
    final double childMainAxisExtent = mainAxisExtent ?? childCrossAxisExtent / childAspectRatio;
389
    return SliverGridRegularTileLayout(
390 391 392 393 394
      crossAxisCount: crossAxisCount,
      mainAxisStride: childMainAxisExtent + mainAxisSpacing,
      crossAxisStride: childCrossAxisExtent + crossAxisSpacing,
      childMainAxisExtent: childMainAxisExtent,
      childCrossAxisExtent: childCrossAxisExtent,
395
      reverseCrossAxis: axisDirectionIsReversed(constraints.crossAxisDirection),
396 397 398 399 400 401 402 403
    );
  }

  @override
  bool shouldRelayout(SliverGridDelegateWithFixedCrossAxisCount oldDelegate) {
    return oldDelegate.crossAxisCount != crossAxisCount
        || oldDelegate.mainAxisSpacing != mainAxisSpacing
        || oldDelegate.crossAxisSpacing != crossAxisSpacing
404 405
        || oldDelegate.childAspectRatio != childAspectRatio
        || oldDelegate.mainAxisExtent != mainAxisExtent;
406 407 408
  }
}

409
/// Creates grid layouts with tiles that each have a maximum cross-axis extent.
410 411 412
///
/// This delegate will select a cross-axis extent for the tiles that is as
/// large as possible subject to the following conditions:
413
///
414 415
///  - The extent evenly divides the cross-axis extent of the grid.
///  - The extent is at most [maxCrossAxisExtent].
416
///
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
/// For example, if the grid is vertical, the grid is 500.0 pixels wide, and
/// [maxCrossAxisExtent] is 150.0, this delegate will create a grid with 4
/// columns that are 125.0 pixels wide.
///
/// This delegate creates grids with equally sized and spaced tiles.
///
/// See also:
///
///  * [SliverGridDelegateWithFixedCrossAxisCount], which creates a layout with
///    a fixed number of tiles in the cross axis.
///  * [SliverGridDelegate], which creates arbitrary layouts.
///  * [GridView], which can use this delegate to control the layout of its
///    tiles.
///  * [SliverGrid], which can use this delegate to control the layout of its
///    tiles.
///  * [RenderSliverGrid], which can use this delegate to control the layout of
///    its tiles.
434
class SliverGridDelegateWithMaxCrossAxisExtent extends SliverGridDelegate {
435 436
  /// Creates a delegate that makes grid layouts with tiles that have a maximum
  /// cross-axis extent.
437
  ///
438 439 440
  /// All of the arguments except [mainAxisExtent] must not be null.
  /// The [maxCrossAxisExtent], [mainAxisExtent], [mainAxisSpacing],
  /// and [crossAxisSpacing] arguments must not be negative.
441
  /// The [childAspectRatio] argument must be greater than zero.
442
  const SliverGridDelegateWithMaxCrossAxisExtent({
443
    required this.maxCrossAxisExtent,
444 445 446
    this.mainAxisSpacing = 0.0,
    this.crossAxisSpacing = 0.0,
    this.childAspectRatio = 1.0,
447
    this.mainAxisExtent,
448
  }) : assert(maxCrossAxisExtent != null && maxCrossAxisExtent > 0),
449 450 451
       assert(mainAxisSpacing != null && mainAxisSpacing >= 0),
       assert(crossAxisSpacing != null && crossAxisSpacing >= 0),
       assert(childAspectRatio != null && childAspectRatio > 0);
452

453 454 455 456 457 458 459 460 461 462 463
  /// The maximum extent of tiles in the cross axis.
  ///
  /// This delegate will select a cross-axis extent for the tiles that is as
  /// large as possible subject to the following conditions:
  ///
  ///  - The extent evenly divides the cross-axis extent of the grid.
  ///  - The extent is at most [maxCrossAxisExtent].
  ///
  /// For example, if the grid is vertical, the grid is 500.0 pixels wide, and
  /// [maxCrossAxisExtent] is 150.0, this delegate will create a grid with 4
  /// columns that are 125.0 pixels wide.
464 465 466 467 468 469 470 471 472 473 474
  final double maxCrossAxisExtent;

  /// The number of logical pixels between each child along the main axis.
  final double mainAxisSpacing;

  /// The number of logical pixels between each child along the cross axis.
  final double crossAxisSpacing;

  /// The ratio of the cross-axis to the main-axis extent of each child.
  final double childAspectRatio;

475 476 477 478 479 480
  /// The extent of each tile in the main axis. If provided it would define the
  /// logical pixels taken by each tile in the main-axis.
  ///
  /// If null, [childAspectRatio] is used instead.
  final double? mainAxisExtent;

481 482
  bool _debugAssertIsValid(double crossAxisExtent) {
    assert(crossAxisExtent > 0.0);
483 484 485 486 487 488 489 490
    assert(maxCrossAxisExtent > 0.0);
    assert(mainAxisSpacing >= 0.0);
    assert(crossAxisSpacing >= 0.0);
    assert(childAspectRatio > 0.0);
    return true;
  }

  @override
491
  SliverGridLayout getLayout(SliverConstraints constraints) {
492
    assert(_debugAssertIsValid(constraints.crossAxisExtent));
493
    final int crossAxisCount = (constraints.crossAxisExtent / (maxCrossAxisExtent + crossAxisSpacing)).ceil();
494 495 496 497
    final double usableCrossAxisExtent = math.max(
      0.0,
      constraints.crossAxisExtent - crossAxisSpacing * (crossAxisCount - 1),
    );
498
    final double childCrossAxisExtent = usableCrossAxisExtent / crossAxisCount;
499
    final double childMainAxisExtent = mainAxisExtent ?? childCrossAxisExtent / childAspectRatio;
500
    return SliverGridRegularTileLayout(
501 502 503 504 505
      crossAxisCount: crossAxisCount,
      mainAxisStride: childMainAxisExtent + mainAxisSpacing,
      crossAxisStride: childCrossAxisExtent + crossAxisSpacing,
      childMainAxisExtent: childMainAxisExtent,
      childCrossAxisExtent: childCrossAxisExtent,
506
      reverseCrossAxis: axisDirectionIsReversed(constraints.crossAxisDirection),
507 508 509 510 511 512 513 514
    );
  }

  @override
  bool shouldRelayout(SliverGridDelegateWithMaxCrossAxisExtent oldDelegate) {
    return oldDelegate.maxCrossAxisExtent != maxCrossAxisExtent
        || oldDelegate.mainAxisSpacing != mainAxisSpacing
        || oldDelegate.crossAxisSpacing != crossAxisSpacing
515 516
        || oldDelegate.childAspectRatio != childAspectRatio
        || oldDelegate.mainAxisExtent != mainAxisExtent;
517 518 519
  }
}

520
/// Parent data structure used by [RenderSliverGrid].
521
class SliverGridParentData extends SliverMultiBoxAdaptorParentData {
522 523 524 525 526 527
  /// The offset of the child in the non-scrolling axis.
  ///
  /// If the scroll axis is vertical, this offset is from the left-most edge of
  /// the parent to the left-most edge of the child. If the scroll axis is
  /// horizontal, this offset is from the top-most edge of the parent to the
  /// top-most edge of the child.
528
  double? crossAxisOffset;
529 530 531 532 533

  @override
  String toString() => 'crossAxisOffset=$crossAxisOffset; ${super.toString()}';
}

534
/// A sliver that places multiple box children in a two dimensional arrangement.
535 536 537 538 539 540 541 542 543 544 545
///
/// [RenderSliverGrid] places its children in arbitrary positions determined by
/// [gridDelegate]. Each child is forced to have the size specified by the
/// [gridDelegate].
///
/// See also:
///
///  * [RenderSliverList], which places its children in a linear
///    array.
///  * [RenderSliverFixedExtentList], which places its children in a linear
///    array with a fixed extent in the main axis.
546
class RenderSliverGrid extends RenderSliverMultiBoxAdaptor {
547 548 549 550
  /// Creates a sliver that contains multiple box children that whose size and
  /// position are determined by a delegate.
  ///
  /// The [childManager] and [gridDelegate] arguments must not be null.
551
  RenderSliverGrid({
552 553
    required RenderSliverBoxChildManager childManager,
    required SliverGridDelegate gridDelegate,
554 555 556
  }) : assert(gridDelegate != null),
       _gridDelegate = gridDelegate,
       super(childManager: childManager);
557 558 559 560

  @override
  void setupParentData(RenderObject child) {
    if (child.parentData is! SliverGridParentData)
561
      child.parentData = SliverGridParentData();
562 563
  }

564
  /// The delegate that controls the size and position of the children.
565 566
  SliverGridDelegate get gridDelegate => _gridDelegate;
  SliverGridDelegate _gridDelegate;
567 568 569
  set gridDelegate(SliverGridDelegate value) {
    assert(value != null);
    if (_gridDelegate == value)
570
      return;
571 572
    if (value.runtimeType != _gridDelegate.runtimeType ||
        value.shouldRelayout(_gridDelegate))
573
      markNeedsLayout();
574
    _gridDelegate = value;
575 576 577 578
  }

  @override
  double childCrossAxisPosition(RenderBox child) {
579
    final SliverGridParentData childParentData = child.parentData! as SliverGridParentData;
580
    return childParentData.crossAxisOffset!;
581 582 583 584
  }

  @override
  void performLayout() {
585
    final SliverConstraints constraints = this.constraints;
586
    childManager.didStartLayout();
587 588
    childManager.setDidUnderflow(false);

589
    final double scrollOffset = constraints.scrollOffset + constraints.cacheOrigin;
590
    assert(scrollOffset >= 0.0);
591 592 593
    final double remainingExtent = constraints.remainingCacheExtent;
    assert(remainingExtent >= 0.0);
    final double targetEndScrollOffset = scrollOffset + remainingExtent;
594

595 596 597
    final SliverGridLayout layout = _gridDelegate.getLayout(constraints);

    final int firstIndex = layout.getMinChildIndexForScrollOffset(scrollOffset);
598
    final int? targetLastIndex = targetEndScrollOffset.isFinite ?
599
      layout.getMaxChildIndexForScrollOffset(targetEndScrollOffset) : null;
600 601

    if (firstChild != null) {
602 603 604
      final int oldFirstIndex = indexOf(firstChild!);
      final int oldLastIndex = indexOf(lastChild!);
      final int leadingGarbage = (firstIndex - oldFirstIndex).clamp(0, childCount);
605 606
      final int trailingGarbage = targetLastIndex == null
        ? 0
607
        : (oldLastIndex - targetLastIndex).clamp(0, childCount);
608 609 610
      collectGarbage(leadingGarbage, trailingGarbage);
    } else {
      collectGarbage(0, 0);
611 612
    }

613
    final SliverGridGeometry firstChildGridGeometry = layout.getGeometryForChildIndex(firstIndex);
614
    final double leadingScrollOffset = firstChildGridGeometry.scrollOffset;
Adam Barth's avatar
Adam Barth committed
615
    double trailingScrollOffset = firstChildGridGeometry.trailingScrollOffset;
616 617

    if (firstChild == null) {
618 619 620
      if (!addInitialChild(index: firstIndex, layoutOffset: firstChildGridGeometry.scrollOffset)) {
        // There are either no children, or we are past the end of all our children.
        final double max = layout.computeMaxScrollOffset(childManager.childCount);
621
        geometry = SliverGeometry(
622 623 624
          scrollExtent: max,
          maxPaintExtent: max,
        );
625
        childManager.didFinishLayout();
626 627 628 629
        return;
      }
    }

630
    RenderBox? trailingChildWithLayout;
631

632
    for (int index = indexOf(firstChild!) - 1; index >= firstIndex; --index) {
633
      final SliverGridGeometry gridGeometry = layout.getGeometryForChildIndex(index);
634
      final RenderBox child = insertAndLayoutLeadingChild(
Ian Hickson's avatar
Ian Hickson committed
635
        gridGeometry.getBoxConstraints(constraints),
636
      )!;
637
      final SliverGridParentData childParentData = child.parentData! as SliverGridParentData;
638
      childParentData.layoutOffset = gridGeometry.scrollOffset;
639 640 641
      childParentData.crossAxisOffset = gridGeometry.crossAxisOffset;
      assert(childParentData.index == index);
      trailingChildWithLayout ??= child;
Adam Barth's avatar
Adam Barth committed
642
      trailingScrollOffset = math.max(trailingScrollOffset, gridGeometry.trailingScrollOffset);
643 644 645
    }

    if (trailingChildWithLayout == null) {
646
      firstChild!.layout(firstChildGridGeometry.getBoxConstraints(constraints));
647
      final SliverGridParentData childParentData = firstChild!.parentData! as SliverGridParentData;
648
      childParentData.layoutOffset = firstChildGridGeometry.scrollOffset;
649 650 651 652
      childParentData.crossAxisOffset = firstChildGridGeometry.crossAxisOffset;
      trailingChildWithLayout = firstChild;
    }

653
    for (int index = indexOf(trailingChildWithLayout!) + 1; targetLastIndex == null || index <= targetLastIndex; ++index) {
654 655
      final SliverGridGeometry gridGeometry = layout.getGeometryForChildIndex(index);
      final BoxConstraints childConstraints = gridGeometry.getBoxConstraints(constraints);
656
      RenderBox? child = childAfter(trailingChildWithLayout!);
657
      if (child == null || indexOf(child) != index) {
658 659 660 661 662 663 664 665 666 667
        child = insertAndLayoutChild(childConstraints, after: trailingChildWithLayout);
        if (child == null) {
          // We have run out of children.
          break;
        }
      } else {
        child.layout(childConstraints);
      }
      trailingChildWithLayout = child;
      assert(child != null);
668
      final SliverGridParentData childParentData = child.parentData! as SliverGridParentData;
669
      childParentData.layoutOffset = gridGeometry.scrollOffset;
670 671
      childParentData.crossAxisOffset = gridGeometry.crossAxisOffset;
      assert(childParentData.index == index);
Adam Barth's avatar
Adam Barth committed
672
      trailingScrollOffset = math.max(trailingScrollOffset, gridGeometry.trailingScrollOffset);
673 674
    }

675
    final int lastIndex = indexOf(lastChild!);
676 677

    assert(debugAssertChildListIsNonEmptyAndContiguous());
678
    assert(indexOf(firstChild!) == firstIndex);
679
    assert(targetLastIndex == null || lastIndex <= targetLastIndex);
680 681 682 683 684 685 686 687 688

    final double estimatedTotalExtent = childManager.estimateMaxScrollOffset(
      constraints,
      firstIndex: firstIndex,
      lastIndex: lastIndex,
      leadingScrollOffset: leadingScrollOffset,
      trailingScrollOffset: trailingScrollOffset,
    );

Adam Barth's avatar
Adam Barth committed
689
    final double paintExtent = calculatePaintOffset(
690
      constraints,
691
      from: math.min(constraints.scrollOffset, leadingScrollOffset),
692 693
      to: trailingScrollOffset,
    );
694 695 696 697 698
    final double cacheExtent = calculateCacheOffset(
      constraints,
      from: leadingScrollOffset,
      to: trailingScrollOffset,
    );
699

700
    geometry = SliverGeometry(
701
      scrollExtent: estimatedTotalExtent,
Adam Barth's avatar
Adam Barth committed
702
      paintExtent: paintExtent,
703
      maxPaintExtent: estimatedTotalExtent,
704
      cacheExtent: cacheExtent,
705 706 707 708
      // Conservative to avoid complexity.
      hasVisualOverflow: true,
    );

709 710 711 712
    // We may have started the layout while scrolled to the end, which
    // would not expose a new child.
    if (estimatedTotalExtent == trailingScrollOffset)
      childManager.setDidUnderflow(true);
713
    childManager.didFinishLayout();
714 715
  }
}