stack.dart 27.1 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5
// 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;
6
import 'dart:ui' show lerpDouble;
7

8
import 'package:flutter/foundation.dart';
9

10
import 'box.dart';
11
import 'layer.dart';
12
import 'layout_helper.dart';
13
import 'object.dart';
14

Hixie's avatar
Hixie committed
15 16 17 18 19 20
/// An immutable 2D, axis-aligned, floating-point rectangle whose coordinates
/// are given relative to another rectangle's edges, known as the container.
/// Since the dimensions of the rectangle are relative to those of the
/// container, this class has no width and height members. To determine the
/// width or height of the rectangle, convert it to a [Rect] using [toRect()]
/// (passing the container's own Rect), and then examine that object.
Hixie's avatar
Hixie committed
21
///
22
/// The fields [left], [right], [bottom], and [top] must not be null.
23
@immutable
Hixie's avatar
Hixie committed
24 25
class RelativeRect {
  /// Creates a RelativeRect with the given values.
26 27 28 29
  ///
  /// The arguments must not be null.
  const RelativeRect.fromLTRB(this.left, this.top, this.right, this.bottom)
    : assert(left != null && top != null && right != null && bottom != null);
Hixie's avatar
Hixie committed
30 31 32 33 34

  /// Creates a RelativeRect from a Rect and a Size. The Rect (first argument)
  /// and the RelativeRect (the output) are in the coordinate space of the
  /// rectangle described by the Size, with 0,0 being at the top left.
  factory RelativeRect.fromSize(Rect rect, Size container) {
35
    return RelativeRect.fromLTRB(rect.left, rect.top, container.width - rect.right, container.height - rect.bottom);
Hixie's avatar
Hixie committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
  }

  /// Creates a RelativeRect from two Rects. The second Rect provides the
  /// container, the first provides the rectangle, in the same coordinate space,
  /// that is to be converted to a RelativeRect. The output will be in the
  /// container's coordinate space.
  ///
  /// For example, if the top left of the rect is at 0,0, and the top left of
  /// the container is at 100,100, then the top left of the output will be at
  /// -100,-100.
  ///
  /// If the first rect is actually in the container's coordinate space, then
  /// use [RelativeRect.fromSize] and pass the container's size as the second
  /// argument instead.
  factory RelativeRect.fromRect(Rect rect, Rect container) {
51
    return RelativeRect.fromLTRB(
Hixie's avatar
Hixie committed
52 53
      rect.left - container.left,
      rect.top - container.top,
54
      container.right - rect.right,
55
      container.bottom - rect.bottom,
Hixie's avatar
Hixie committed
56 57 58
    );
  }

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
  /// Creates a RelativeRect from horizontal position using `start` and `end`
  /// rather than `left` and `right`.
  ///
  /// If `textDirection` is [TextDirection.rtl], then the `start` argument is
  /// used for the [right] property and the `end` argument is used for the
  /// [left] property. Otherwise, if `textDirection` is [TextDirection.ltr],
  /// then the `start` argument is used for the [left] property and the `end`
  /// argument is used for the [right] property.
  factory RelativeRect.fromDirectional({
    required TextDirection textDirection,
    required double start,
    required double top,
    required double end,
    required double bottom,
  }) {
    double left;
    double right;
    switch (textDirection) {
      case TextDirection.rtl:
        left = end;
        right = start;
        break;
      case TextDirection.ltr:
        left = start;
        right = end;
        break;
    }

    return RelativeRect.fromLTRB(left, top, right, bottom);
  }

90
  /// A rect that covers the entire container.
91
  static const RelativeRect fill = RelativeRect.fromLTRB(0.0, 0.0, 0.0, 0.0);
Hixie's avatar
Hixie committed
92 93

  /// Distance from the left side of the container to the left side of this rectangle.
94 95
  ///
  /// May be negative if the left side of the rectangle is outside of the container.
96
  final double left;
Hixie's avatar
Hixie committed
97 98

  /// Distance from the top side of the container to the top side of this rectangle.
99 100
  ///
  /// May be negative if the top side of the rectangle is outside of the container.
101
  final double top;
Hixie's avatar
Hixie committed
102 103

  /// Distance from the right side of the container to the right side of this rectangle.
104
  ///
105
  /// May be positive if the right side of the rectangle is outside of the container.
106
  final double right;
Hixie's avatar
Hixie committed
107 108

  /// Distance from the bottom side of the container to the bottom side of this rectangle.
109
  ///
110
  /// May be positive if the bottom side of the rectangle is outside of the container.
111
  final double bottom;
Hixie's avatar
Hixie committed
112

113 114 115 116 117 118
  /// Returns whether any of the values are greater than zero.
  ///
  /// This corresponds to one of the sides ([left], [top], [right], or [bottom]) having
  /// some positive inset towards the center.
  bool get hasInsets => left > 0.0 || top > 0.0 || right > 0.0 || bottom > 0.0;

Hixie's avatar
Hixie committed
119 120
  /// Returns a new rectangle object translated by the given offset.
  RelativeRect shift(Offset offset) {
121
    return RelativeRect.fromLTRB(left + offset.dx, top + offset.dy, right - offset.dx, bottom - offset.dy);
Hixie's avatar
Hixie committed
122 123 124 125
  }

  /// Returns a new rectangle with edges moved outwards by the given delta.
  RelativeRect inflate(double delta) {
126
    return RelativeRect.fromLTRB(left - delta, top - delta, right - delta, bottom - delta);
Hixie's avatar
Hixie committed
127 128 129 130 131 132 133 134 135
  }

  /// Returns a new rectangle with edges moved inwards by the given delta.
  RelativeRect deflate(double delta) {
    return inflate(-delta);
  }

  /// Returns a new rectangle that is the intersection of the given rectangle and this rectangle.
  RelativeRect intersect(RelativeRect other) {
136
    return RelativeRect.fromLTRB(
Hixie's avatar
Hixie committed
137 138 139
      math.max(left, other.left),
      math.max(top, other.top),
      math.max(right, other.right),
140
      math.max(bottom, other.bottom),
Hixie's avatar
Hixie committed
141 142 143
    );
  }

144
  /// Convert this [RelativeRect] to a [Rect], in the coordinate space of the container.
Ian Hickson's avatar
Ian Hickson committed
145 146 147 148 149
  ///
  /// See also:
  ///
  ///  * [toSize], which returns the size part of the rect, based on the size of
  ///    the container.
Hixie's avatar
Hixie committed
150
  Rect toRect(Rect container) {
151
    return Rect.fromLTRB(left, top, container.width - right, container.height - bottom);
Hixie's avatar
Hixie committed
152 153
  }

Ian Hickson's avatar
Ian Hickson committed
154 155 156 157 158 159
  /// Convert this [RelativeRect] to a [Size], assuming a container with the given size.
  ///
  /// See also:
  ///
  ///  * [toRect], which also computes the position relative to the container.
  Size toSize(Size container) {
160
    return Size(container.width - left - right, container.height - top - bottom);
Ian Hickson's avatar
Ian Hickson committed
161 162
  }

Hixie's avatar
Hixie committed
163 164 165
  /// Linearly interpolate between two RelativeRects.
  ///
  /// If either rect is null, this function interpolates from [RelativeRect.fill].
166
  ///
167
  /// {@macro dart.ui.shadow.lerp}
168
  static RelativeRect? lerp(RelativeRect? a, RelativeRect? b, double t) {
169
    assert(t != null);
170
    if (a == null && b == null) {
Hixie's avatar
Hixie committed
171
      return null;
172 173
    }
    if (a == null) {
174
      return RelativeRect.fromLTRB(b!.left * t, b.top * t, b.right * t, b.bottom * t);
175
    }
Hixie's avatar
Hixie committed
176
    if (b == null) {
177
      final double k = 1.0 - t;
178
      return RelativeRect.fromLTRB(b!.left * k, b.top * k, b.right * k, b.bottom * k);
Hixie's avatar
Hixie committed
179
    }
180
    return RelativeRect.fromLTRB(
181 182 183 184
      lerpDouble(a.left, b.left, t)!,
      lerpDouble(a.top, b.top, t)!,
      lerpDouble(a.right, b.right, t)!,
      lerpDouble(a.bottom, b.bottom, t)!,
Hixie's avatar
Hixie committed
185 186 187
    );
  }

188
  @override
189
  bool operator ==(Object other) {
190
    if (identical(this, other)) {
Hixie's avatar
Hixie committed
191
      return true;
192
    }
193 194 195 196 197
    return other is RelativeRect
        && other.left == left
        && other.top == top
        && other.right == right
        && other.bottom == bottom;
Hixie's avatar
Hixie committed
198 199
  }

200
  @override
201
  int get hashCode => Object.hash(left, top, right, bottom);
Hixie's avatar
Hixie committed
202

203
  @override
204
  String toString() => 'RelativeRect.fromLTRB(${left.toStringAsFixed(1)}, ${top.toStringAsFixed(1)}, ${right.toStringAsFixed(1)}, ${bottom.toStringAsFixed(1)})';
Hixie's avatar
Hixie committed
205 206
}

Adam Barth's avatar
Adam Barth committed
207
/// Parent data for use with [RenderStack].
208
class StackParentData extends ContainerBoxParentData<RenderBox> {
Hixie's avatar
Hixie committed
209
  /// The distance by which the child's top edge is inset from the top of the stack.
210
  double? top;
211

Hixie's avatar
Hixie committed
212
  /// The distance by which the child's right edge is inset from the right of the stack.
213
  double? right;
214

Hixie's avatar
Hixie committed
215
  /// The distance by which the child's bottom edge is inset from the bottom of the stack.
216
  double? bottom;
217

Hixie's avatar
Hixie committed
218
  /// The distance by which the child's left edge is inset from the left of the stack.
219
  double? left;
220

221 222 223
  /// The child's width.
  ///
  /// Ignored if both left and right are non-null.
224
  double? width;
225 226 227 228

  /// The child's height.
  ///
  /// Ignored if both top and bottom are non-null.
229
  double? height;
230

Hixie's avatar
Hixie committed
231
  /// Get or set the current values in terms of a RelativeRect object.
232
  RelativeRect get rect => RelativeRect.fromLTRB(left!, top!, right!, bottom!);
233
  set rect(RelativeRect value) {
Hixie's avatar
Hixie committed
234 235 236
    top = value.top;
    right = value.right;
    bottom = value.bottom;
Hixie's avatar
Hixie committed
237
    left = value.left;
Hixie's avatar
Hixie committed
238 239
  }

Hixie's avatar
Hixie committed
240
  /// Whether this child is considered positioned.
241
  ///
Hixie's avatar
Hixie committed
242
  /// A child is positioned if any of the top, right, bottom, or left properties
243 244 245
  /// are non-null. Positioned children do not factor into determining the size
  /// of the stack but are instead placed relative to the non-positioned
  /// children in the stack.
246
  bool get isPositioned => top != null || right != null || bottom != null || left != null || width != null || height != null;
247

248
  @override
Hixie's avatar
Hixie committed
249
  String toString() {
250 251 252 253 254 255 256 257
    final List<String> values = <String>[
      if (top != null) 'top=${debugFormatDouble(top)}',
      if (right != null) 'right=${debugFormatDouble(right)}',
      if (bottom != null) 'bottom=${debugFormatDouble(bottom)}',
      if (left != null) 'left=${debugFormatDouble(left)}',
      if (width != null) 'width=${debugFormatDouble(width)}',
      if (height != null) 'height=${debugFormatDouble(height)}',
    ];
258
    if (values.isEmpty) {
259
      values.add('not positioned');
260
    }
261
    values.add(super.toString());
Hixie's avatar
Hixie committed
262 263
    return values.join('; ');
  }
264 265
}

266 267
/// How to size the non-positioned children of a [Stack].
///
268
/// This enum is used with [Stack.fit] and [RenderStack.fit] to control
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
/// how the [BoxConstraints] passed from the stack's parent to the stack's child
/// are adjusted.
///
/// See also:
///
///  * [Stack], the widget that uses this.
///  * [RenderStack], the render object that implements the stack algorithm.
enum StackFit {
  /// The constraints passed to the stack from its parent are loosened.
  ///
  /// For example, if the stack has constraints that force it to 350x600, then
  /// this would allow the non-positioned children of the stack to have any
  /// width from zero to 350 and any height from zero to 600.
  ///
  /// See also:
  ///
  ///  * [Center], which loosens the constraints passed to its child and then
  ///    centers the child in itself.
  ///  * [BoxConstraints.loosen], which implements the loosening of box
  ///    constraints.
  loose,

  /// The constraints passed to the stack from its parent are tightened to the
  /// biggest size allowed.
  ///
  /// For example, if the stack has loose constraints with a width in the range
  /// 10 to 100 and a height in the range 0 to 600, then the non-positioned
  /// children of the stack would all be sized as 100 pixels wide and 600 high.
  expand,

  /// The constraints passed to the stack from its parent are passed unmodified
  /// to the non-positioned children.
  ///
  /// For example, if a [Stack] is an [Expanded] child of a [Row], the
  /// horizontal constraints will be tight and the vertical constraints will be
  /// loose.
  passthrough,
}

308
/// Implements the stack layout algorithm.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
///
/// In a stack layout, the children are positioned on top of each other in the
/// order in which they appear in the child list. First, the non-positioned
/// children (those with null values for top, right, bottom, and left) are
/// laid out and initially placed in the upper-left corner of the stack. The
/// stack is then sized to enclose all of the non-positioned children. If there
/// are no non-positioned children, the stack becomes as large as possible.
///
/// The final location of non-positioned children is determined by the alignment
/// parameter. The left of each non-positioned child becomes the
/// difference between the child's width and the stack's width scaled by
/// alignment.x. The top of each non-positioned child is computed
/// similarly and scaled by alignment.y. So if the alignment x and y properties
/// are 0.0 (the default) then the non-positioned children remain in the
/// upper-left corner. If the alignment x and y properties are 0.5 then the
/// non-positioned children are centered within the stack.
///
/// Next, the positioned children are laid out. If a child has top and bottom
/// values that are both non-null, the child is given a fixed height determined
/// by subtracting the sum of the top and bottom values from the height of the stack.
/// Similarly, if the child has right and left values that are both non-null,
/// the child is given a fixed width derived from the stack's width.
/// Otherwise, the child is given unbounded constraints in the non-fixed dimensions.
///
/// Once the child is laid out, the stack positions the child
/// according to the top, right, bottom, and left properties of their
/// [StackParentData]. For example, if the bottom value is 10.0, the
/// bottom edge of the child will be inset 10.0 pixels from the bottom
/// edge of the stack. If the child extends beyond the bounds of the
/// stack, the stack will clip the child's painting to the bounds of
/// the stack.
///
/// See also:
///
///  * [RenderFlow]
class RenderStack extends RenderBox
Hans Muller's avatar
Hans Muller committed
345 346
    with ContainerRenderObjectMixin<RenderBox, StackParentData>,
         RenderBoxContainerDefaultsMixin<RenderBox, StackParentData> {
347 348 349 350 351
  /// Creates a stack render object.
  ///
  /// By default, the non-positioned children of the stack are aligned by their
  /// top left corners.
  RenderStack({
352
    List<RenderBox>? children,
353
    AlignmentGeometry alignment = AlignmentDirectional.topStart,
354
    TextDirection? textDirection,
355
    StackFit fit = StackFit.loose,
356
    Clip clipBehavior = Clip.hardEdge,
357 358
  }) : assert(alignment != null),
       assert(fit != null),
359
       assert(clipBehavior != null),
360
       _alignment = alignment,
361
       _textDirection = textDirection,
362
       _fit = fit,
363
       _clipBehavior = clipBehavior {
364 365 366
    addAll(children);
  }

367 368
  bool _hasVisualOverflow = false;

369
  @override
370
  void setupParentData(RenderBox child) {
371
    if (child.parentData is! StackParentData) {
372
      child.parentData = StackParentData();
373
    }
374 375
  }

376
  Alignment? _resolvedAlignment;
377

Ian Hickson's avatar
Ian Hickson committed
378
  void _resolve() {
379
    if (_resolvedAlignment != null) {
Ian Hickson's avatar
Ian Hickson committed
380
      return;
381
    }
Ian Hickson's avatar
Ian Hickson committed
382 383 384 385 386 387
    _resolvedAlignment = alignment.resolve(textDirection);
  }

  void _markNeedResolution() {
    _resolvedAlignment = null;
    markNeedsLayout();
388 389
  }

390 391
  /// How to align the non-positioned or partially-positioned children in the
  /// stack.
392 393 394
  ///
  /// The non-positioned children are placed relative to each other such that
  /// the points determined by [alignment] are co-located. For example, if the
395
  /// [alignment] is [Alignment.topLeft], then the top left corner of
396
  /// each non-positioned child will be located at the same global coordinate.
Ian Hickson's avatar
Ian Hickson committed
397
  ///
398 399 400 401 402 403
  /// Partially-positioned children, those that do not specify an alignment in a
  /// particular axis (e.g. that have neither `top` nor `bottom` set), use the
  /// alignment to determine how they should be positioned in that
  /// under-specified axis.
  ///
  /// If this is set to an [AlignmentDirectional] object, then [textDirection]
404 405 406 407
  /// must not be null.
  AlignmentGeometry get alignment => _alignment;
  AlignmentGeometry _alignment;
  set alignment(AlignmentGeometry value) {
408
    assert(value != null);
409
    if (_alignment == value) {
Ian Hickson's avatar
Ian Hickson committed
410
      return;
411
    }
Ian Hickson's avatar
Ian Hickson committed
412 413
    _alignment = value;
    _markNeedResolution();
414 415 416
  }

  /// The text direction with which to resolve [alignment].
Ian Hickson's avatar
Ian Hickson committed
417 418 419
  ///
  /// This may be changed to null, but only after the [alignment] has been changed
  /// to a value that does not depend on the direction.
420 421 422
  TextDirection? get textDirection => _textDirection;
  TextDirection? _textDirection;
  set textDirection(TextDirection? value) {
423
    if (_textDirection == value) {
Ian Hickson's avatar
Ian Hickson committed
424
      return;
425
    }
Ian Hickson's avatar
Ian Hickson committed
426 427
    _textDirection = value;
    _markNeedResolution();
Hans Muller's avatar
Hans Muller committed
428 429
  }

430 431 432 433 434
  /// How to size the non-positioned children in the stack.
  ///
  /// The constraints passed into the [RenderStack] from its parent are either
  /// loosened ([StackFit.loose]) or tightened to their biggest size
  /// ([StackFit.expand]).
435 436 437
  StackFit get fit => _fit;
  StackFit _fit;
  set fit(StackFit value) {
438
    assert(value != null);
439 440
    if (_fit != value) {
      _fit = value;
441 442 443 444
      markNeedsLayout();
    }
  }

445
  /// {@macro flutter.material.Material.clipBehavior}
446
  ///
447 448 449 450
  /// Defaults to [Clip.hardEdge], and must not be null.
  Clip get clipBehavior => _clipBehavior;
  Clip _clipBehavior = Clip.hardEdge;
  set clipBehavior(Clip value) {
451
    assert(value != null);
452 453
    if (value != _clipBehavior) {
      _clipBehavior = value;
454
      markNeedsPaint();
455
      markNeedsSemanticsUpdate();
456 457 458
    }
  }

459
  /// Helper function for calculating the intrinsics metrics of a Stack.
460
  static double getIntrinsicDimension(RenderBox? firstChild, double Function(RenderBox child) mainChildSizeGetter) {
461
    double extent = 0.0;
462
    RenderBox? child = firstChild;
463
    while (child != null) {
464
      final StackParentData childParentData = child.parentData! as StackParentData;
465
      if (!childParentData.isPositioned) {
466
        extent = math.max(extent, mainChildSizeGetter(child));
467
      }
Hixie's avatar
Hixie committed
468 469
      assert(child.parentData == childParentData);
      child = childParentData.nextSibling;
470
    }
471
    return extent;
472 473
  }

474
  @override
475
  double computeMinIntrinsicWidth(double height) {
476
    return getIntrinsicDimension(firstChild, (RenderBox child) => child.getMinIntrinsicWidth(height));
477 478
  }

479
  @override
480
  double computeMaxIntrinsicWidth(double height) {
481
    return getIntrinsicDimension(firstChild, (RenderBox child) => child.getMaxIntrinsicWidth(height));
482 483
  }

484
  @override
485
  double computeMinIntrinsicHeight(double width) {
486
    return getIntrinsicDimension(firstChild, (RenderBox child) => child.getMinIntrinsicHeight(width));
487 488 489
  }

  @override
490
  double computeMaxIntrinsicHeight(double width) {
491
    return getIntrinsicDimension(firstChild, (RenderBox child) => child.getMaxIntrinsicHeight(width));
492 493
  }

494
  @override
495
  double? computeDistanceToActualBaseline(TextBaseline baseline) {
496 497 498
    return defaultComputeDistanceToHighestActualBaseline(baseline);
  }

499 500 501 502 503 504 505 506 507 508
  /// Lays out the positioned `child` according to `alignment` within a Stack of `size`.
  ///
  /// Returns true when the child has visual overflow.
  static bool layoutPositionedChild(RenderBox child, StackParentData childParentData, Size size, Alignment alignment) {
    assert(childParentData.isPositioned);
    assert(child.parentData == childParentData);

    bool hasVisualOverflow = false;
    BoxConstraints childConstraints = const BoxConstraints();

509
    if (childParentData.left != null && childParentData.right != null) {
510
      childConstraints = childConstraints.tighten(width: size.width - childParentData.right! - childParentData.left!);
511
    } else if (childParentData.width != null) {
512
      childConstraints = childConstraints.tighten(width: childParentData.width);
513
    }
514

515
    if (childParentData.top != null && childParentData.bottom != null) {
516
      childConstraints = childConstraints.tighten(height: size.height - childParentData.bottom! - childParentData.top!);
517
    } else if (childParentData.height != null) {
518
      childConstraints = childConstraints.tighten(height: childParentData.height);
519
    }
520 521 522

    child.layout(childConstraints, parentUsesSize: true);

523
    final double x;
524
    if (childParentData.left != null) {
525
      x = childParentData.left!;
526
    } else if (childParentData.right != null) {
527
      x = size.width - childParentData.right! - child.size.width;
528 529 530 531
    } else {
      x = alignment.alongOffset(size - child.size as Offset).dx;
    }

532
    if (x < 0.0 || x + child.size.width > size.width) {
533
      hasVisualOverflow = true;
534
    }
535

536
    final double y;
537
    if (childParentData.top != null) {
538
      y = childParentData.top!;
539
    } else if (childParentData.bottom != null) {
540
      y = size.height - childParentData.bottom! - child.size.height;
541 542 543 544
    } else {
      y = alignment.alongOffset(size - child.size as Offset).dy;
    }

545
    if (y < 0.0 || y + child.size.height > size.height) {
546
      hasVisualOverflow = true;
547
    }
548 549 550 551 552 553

    childParentData.offset = Offset(x, y);

    return hasVisualOverflow;
  }

554
  @override
555 556 557 558 559 560 561 562
  Size computeDryLayout(BoxConstraints constraints) {
    return _computeSize(
      constraints: constraints,
      layoutChild: ChildLayoutHelper.dryLayoutChild,
    );
  }

  Size _computeSize({required BoxConstraints constraints, required ChildLayouter layoutChild}) {
Ian Hickson's avatar
Ian Hickson committed
563 564
    _resolve();
    assert(_resolvedAlignment != null);
565
    bool hasNonPositionedChildren = false;
566
    if (childCount == 0) {
567
      return (constraints.biggest.isFinite) ? constraints.biggest : constraints.smallest;
568
    }
569

570 571 572
    double width = constraints.minWidth;
    double height = constraints.minHeight;

573
    final BoxConstraints nonPositionedConstraints;
574 575
    assert(fit != null);
    switch (fit) {
576 577 578 579
      case StackFit.loose:
        nonPositionedConstraints = constraints.loosen();
        break;
      case StackFit.expand:
580
        nonPositionedConstraints = BoxConstraints.tight(constraints.biggest);
581 582 583 584 585 586
        break;
      case StackFit.passthrough:
        nonPositionedConstraints = constraints;
        break;
    }
    assert(nonPositionedConstraints != null);
587

588
    RenderBox? child = firstChild;
589
    while (child != null) {
590
      final StackParentData childParentData = child.parentData! as StackParentData;
591

Hixie's avatar
Hixie committed
592
      if (!childParentData.isPositioned) {
593 594
        hasNonPositionedChildren = true;

595
        final Size childSize = layoutChild(child, nonPositionedConstraints);
596 597 598 599 600

        width = math.max(width, childSize.width);
        height = math.max(height, childSize.height);
      }

Hixie's avatar
Hixie committed
601
      child = childParentData.nextSibling;
602 603
    }

604
    final Size size;
605
    if (hasNonPositionedChildren) {
606
      size = Size(width, height);
607 608 609
      assert(size.width == constraints.constrainWidth(width));
      assert(size.height == constraints.constrainHeight(height));
    } else {
610
      size = constraints.biggest;
611
    }
612

613
    assert(size.isFinite);
614 615
    return size;
  }
616

617 618 619 620 621 622 623 624 625 626 627 628
  @override
  void performLayout() {
    final BoxConstraints constraints = this.constraints;
    _hasVisualOverflow = false;

    size = _computeSize(
      constraints: constraints,
      layoutChild: ChildLayoutHelper.layoutChild,
    );

    assert(_resolvedAlignment != null);
    RenderBox? child = firstChild;
629
    while (child != null) {
630
      final StackParentData childParentData = child.parentData! as StackParentData;
631

Hixie's avatar
Hixie committed
632
      if (!childParentData.isPositioned) {
633
        childParentData.offset = _resolvedAlignment!.alongOffset(size - child.size as Offset);
Hans Muller's avatar
Hans Muller committed
634
      } else {
635
        _hasVisualOverflow = layoutPositionedChild(child, childParentData, size, _resolvedAlignment!) || _hasVisualOverflow;
636 637
      }

Hixie's avatar
Hixie committed
638 639
      assert(child.parentData == childParentData);
      child = childParentData.nextSibling;
640 641 642
    }
  }

643
  @override
644
  bool hitTestChildren(BoxHitTestResult result, { required Offset position }) {
Adam Barth's avatar
Adam Barth committed
645
    return defaultHitTestChildren(result, position: position);
646 647
  }

648 649 650 651 652 653 654 655
  /// Override in subclasses to customize how the stack paints.
  ///
  /// By default, the stack uses [defaultPaint]. This function is called by
  /// [paint] after potentially applying a clip to contain visual overflow.
  @protected
  void paintStack(PaintingContext context, Offset offset) {
    defaultPaint(context, offset);
  }
Hans Muller's avatar
Hans Muller committed
656

657
  @override
658
  void paint(PaintingContext context, Offset offset) {
659
    if (clipBehavior != Clip.none && _hasVisualOverflow) {
660
      _clipRectLayer.layer = context.pushClipRect(
661 662 663 664 665
        needsCompositing,
        offset,
        Offset.zero & size,
        paintStack,
        clipBehavior: clipBehavior,
666
        oldLayer: _clipRectLayer.layer,
667
      );
668
    } else {
669
      _clipRectLayer.layer = null;
Hans Muller's avatar
Hans Muller committed
670
      paintStack(context, offset);
671
    }
672
  }
Hixie's avatar
Hixie committed
673

674 675 676 677 678 679 680
  final LayerHandle<ClipRectLayer> _clipRectLayer = LayerHandle<ClipRectLayer>();

  @override
  void dispose() {
    _clipRectLayer.layer = null;
    super.dispose();
  }
681

682
  @override
683 684 685 686 687 688 689 690 691 692
  Rect? describeApproximatePaintClip(RenderObject child) {
    switch (clipBehavior) {
      case Clip.none:
        return null;
      case Clip.hardEdge:
      case Clip.antiAlias:
      case Clip.antiAliasWithSaveLayer:
        return _hasVisualOverflow ? Offset.zero & size : null;
    }
  }
Adam Barth's avatar
Adam Barth committed
693 694

  @override
695 696
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
697 698 699
    properties.add(DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
    properties.add(EnumProperty<TextDirection>('textDirection', textDirection));
    properties.add(EnumProperty<StackFit>('fit', fit));
700
    properties.add(EnumProperty<Clip>('clipBehavior', clipBehavior, defaultValue: Clip.hardEdge));
Adam Barth's avatar
Adam Barth committed
701
  }
702
}
Hans Muller's avatar
Hans Muller committed
703 704 705

/// Implements the same layout algorithm as RenderStack but only paints the child
/// specified by index.
706 707
///
/// Although only one child is displayed, the cost of the layout algorithm is
Hans Muller's avatar
Hans Muller committed
708
/// still O(N), like an ordinary stack.
709 710 711
class RenderIndexedStack extends RenderStack {
  /// Creates a stack render object that paints a single child.
  ///
712
  /// If the [index] parameter is null, nothing is displayed.
Hans Muller's avatar
Hans Muller committed
713
  RenderIndexedStack({
714 715 716
    super.children,
    super.alignment,
    super.textDirection,
717 718
    super.fit,
    super.clipBehavior,
719
    int? index = 0,
720
  }) : _index = index;
Hans Muller's avatar
Hans Muller committed
721

722 723
  @override
  void visitChildrenForSemantics(RenderObjectVisitor visitor) {
724
    if (index != null && firstChild != null) {
725
      visitor(_childAtIndex());
726
    }
727 728
  }

729
  /// The index of the child to show, null if nothing is to be displayed.
730 731 732
  int? get index => _index;
  int? _index;
  set index(int? value) {
Hans Muller's avatar
Hans Muller committed
733 734 735 736 737 738 739
    if (_index != value) {
      _index = value;
      markNeedsLayout();
    }
  }

  RenderBox _childAtIndex() {
740
    assert(index != null);
741
    RenderBox? child = firstChild;
Hans Muller's avatar
Hans Muller committed
742
    int i = 0;
743
    while (child != null && i < index!) {
744
      final StackParentData childParentData = child.parentData! as StackParentData;
Hixie's avatar
Hixie committed
745
      child = childParentData.nextSibling;
Hans Muller's avatar
Hans Muller committed
746 747 748 749
      i += 1;
    }
    assert(i == index);
    assert(child != null);
750
    return child!;
Hans Muller's avatar
Hans Muller committed
751 752
  }

753
  @override
754
  bool hitTestChildren(BoxHitTestResult result, { required Offset position }) {
755
    if (firstChild == null || index == null) {
Adam Barth's avatar
Adam Barth committed
756
      return false;
757
    }
Hans Muller's avatar
Hans Muller committed
758
    assert(position != null);
759
    final RenderBox child = _childAtIndex();
760
    final StackParentData childParentData = child.parentData! as StackParentData;
761 762 763
    return result.addWithPaintOffset(
      offset: childParentData.offset,
      position: position,
764
      hitTest: (BoxHitTestResult result, Offset transformed) {
765
        assert(transformed == position - childParentData.offset);
766
        return child.hitTest(result, position: transformed);
767 768
      },
    );
Hans Muller's avatar
Hans Muller committed
769 770
  }

771
  @override
Hans Muller's avatar
Hans Muller committed
772
  void paintStack(PaintingContext context, Offset offset) {
773
    if (firstChild == null || index == null) {
Hans Muller's avatar
Hans Muller committed
774
      return;
775
    }
776
    final RenderBox child = _childAtIndex();
777
    final StackParentData childParentData = child.parentData! as StackParentData;
Adam Barth's avatar
Adam Barth committed
778
    context.paintChild(child, childParentData.offset + offset);
Hans Muller's avatar
Hans Muller committed
779
  }
Adam Barth's avatar
Adam Barth committed
780 781

  @override
782 783
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
784
    properties.add(IntProperty('index', index));
Adam Barth's avatar
Adam Barth committed
785
  }
786 787 788 789 790 791 792 793 794

  @override
  List<DiagnosticsNode> debugDescribeChildren() {
    final List<DiagnosticsNode> children = <DiagnosticsNode>[];
    int i = 0;
    RenderObject? child = firstChild;
    while (child != null) {
      children.add(child.toDiagnosticsNode(
        name: 'child ${i + 1}',
795
        style: i != index ? DiagnosticsTreeStyle.offstage : null,
796 797 798 799 800 801
      ));
      child = (child.parentData! as StackParentData).nextSibling;
      i += 1;
    }
    return children;
  }
Hans Muller's avatar
Hans Muller committed
802
}