sliver_padding.dart 14.8 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
Ian Hickson's avatar
Ian Hickson committed
2 3 4 5 6 7 8 9 10 11 12 13 14
// 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;

import 'package:flutter/foundation.dart';
import 'package:flutter/gestures.dart';
import 'package:vector_math/vector_math_64.dart';

import 'debug.dart';
import 'object.dart';
import 'sliver.dart';

15
/// Insets a [RenderSliver] by applying [resolvedPadding] on each side.
Ian Hickson's avatar
Ian Hickson committed
16
///
17 18
/// A [RenderSliverEdgeInsetsPadding] subclass wraps the [SliverGeometry.layoutExtent]
/// of its child. Any incoming [SliverConstraints.overlap] is ignored and not
Ian Hickson's avatar
Ian Hickson committed
19 20
/// passed on to the child.
///
21
/// {@template flutter.rendering.sliverPadding.limitation}
22 23 24
/// Applying padding in the main extent of the viewport to slivers that have scroll effects is likely to have
/// undesired effects. For example, For example, wrapping a [SliverPersistentHeader] with
/// `pinned:true` will cause only the appbar to stay pinned while the padding will scroll away.
25 26
/// {@endtemplate}
abstract class RenderSliverEdgeInsetsPadding extends RenderSliver with RenderObjectWithChildMixin<RenderSliver> {
Ian Hickson's avatar
Ian Hickson committed
27
  /// The amount to pad the child in each dimension.
Ian Hickson's avatar
Ian Hickson committed
28
  ///
29 30
  /// The offsets are specified in terms of visual edges, left, top, right, and
  /// bottom. These values are not affected by the [TextDirection].
Ian Hickson's avatar
Ian Hickson committed
31
  ///
32
  /// Must not be null or contain negative values when [performLayout] is called.
33
  EdgeInsets? get resolvedPadding;
Ian Hickson's avatar
Ian Hickson committed
34 35 36 37 38 39 40 41 42

  /// The padding in the scroll direction on the side nearest the 0.0 scroll direction.
  ///
  /// Only valid after layout has started, since before layout the render object
  /// doesn't know what direction it will be laid out in.
  double get beforePadding {
    assert(constraints != null);
    assert(constraints.axisDirection != null);
    assert(constraints.growthDirection != null);
43
    assert(resolvedPadding != null);
Ian Hickson's avatar
Ian Hickson committed
44 45
    switch (applyGrowthDirectionToAxisDirection(constraints.axisDirection, constraints.growthDirection)) {
      case AxisDirection.up:
46
        return resolvedPadding!.bottom;
Ian Hickson's avatar
Ian Hickson committed
47
      case AxisDirection.right:
48
        return resolvedPadding!.left;
Ian Hickson's avatar
Ian Hickson committed
49
      case AxisDirection.down:
50
        return resolvedPadding!.top;
Ian Hickson's avatar
Ian Hickson committed
51
      case AxisDirection.left:
52
        return resolvedPadding!.right;
Ian Hickson's avatar
Ian Hickson committed
53 54 55 56 57 58 59 60 61 62 63
    }
  }

  /// The padding in the scroll direction on the side furthest from the 0.0 scroll offset.
  ///
  /// Only valid after layout has started, since before layout the render object
  /// doesn't know what direction it will be laid out in.
  double get afterPadding {
    assert(constraints != null);
    assert(constraints.axisDirection != null);
    assert(constraints.growthDirection != null);
64
    assert(resolvedPadding != null);
Ian Hickson's avatar
Ian Hickson committed
65 66
    switch (applyGrowthDirectionToAxisDirection(constraints.axisDirection, constraints.growthDirection)) {
      case AxisDirection.up:
67
        return resolvedPadding!.top;
Ian Hickson's avatar
Ian Hickson committed
68
      case AxisDirection.right:
69
        return resolvedPadding!.right;
Ian Hickson's avatar
Ian Hickson committed
70
      case AxisDirection.down:
71
        return resolvedPadding!.bottom;
Ian Hickson's avatar
Ian Hickson committed
72
      case AxisDirection.left:
73
        return resolvedPadding!.left;
Ian Hickson's avatar
Ian Hickson committed
74 75 76
    }
  }

77 78 79
  /// The total padding in the [SliverConstraints.axisDirection]. (In other
  /// words, for a vertical downwards-growing list, the sum of the padding on
  /// the top and bottom.)
Ian Hickson's avatar
Ian Hickson committed
80 81 82 83 84 85
  ///
  /// Only valid after layout has started, since before layout the render object
  /// doesn't know what direction it will be laid out in.
  double get mainAxisPadding {
    assert(constraints != null);
    assert(constraints.axis != null);
86
    assert(resolvedPadding != null);
87
    return resolvedPadding!.along(constraints.axis);
Ian Hickson's avatar
Ian Hickson committed
88 89 90 91 92 93 94 95 96 97 98
  }

  /// The total padding in the cross-axis direction. (In other words, for a
  /// vertical downwards-growing list, the sum of the padding on the left and
  /// right.)
  ///
  /// Only valid after layout has started, since before layout the render object
  /// doesn't know what direction it will be laid out in.
  double get crossAxisPadding {
    assert(constraints != null);
    assert(constraints.axis != null);
99
    assert(resolvedPadding != null);
Ian Hickson's avatar
Ian Hickson committed
100 101
    switch (constraints.axis) {
      case Axis.horizontal:
102
        return resolvedPadding!.vertical;
Ian Hickson's avatar
Ian Hickson committed
103
      case Axis.vertical:
104
        return resolvedPadding!.horizontal;
Ian Hickson's avatar
Ian Hickson committed
105 106 107 108 109 110
    }
  }

  @override
  void setupParentData(RenderObject child) {
    if (child.parentData is! SliverPhysicalParentData)
111
      child.parentData = SliverPhysicalParentData();
Ian Hickson's avatar
Ian Hickson committed
112 113 114 115
  }

  @override
  void performLayout() {
116
    final SliverConstraints constraints = this.constraints;
117
    assert(resolvedPadding != null);
Ian Hickson's avatar
Ian Hickson committed
118 119 120 121 122
    final double beforePadding = this.beforePadding;
    final double afterPadding = this.afterPadding;
    final double mainAxisPadding = this.mainAxisPadding;
    final double crossAxisPadding = this.crossAxisPadding;
    if (child == null) {
123
      geometry = SliverGeometry(
Ian Hickson's avatar
Ian Hickson committed
124 125 126 127 128 129
        scrollExtent: mainAxisPadding,
        paintExtent: math.min(mainAxisPadding, constraints.remainingPaintExtent),
        maxPaintExtent: mainAxisPadding,
      );
      return;
    }
130 131 132 133 134 135 136 137 138
    final double beforePaddingPaintExtent = calculatePaintOffset(
      constraints,
      from: 0.0,
      to: beforePadding,
    );
    double overlap = constraints.overlap;
    if (overlap > 0) {
      overlap = math.max(0.0, constraints.overlap - beforePaddingPaintExtent);
    }
139
    child!.layout(
Ian Hickson's avatar
Ian Hickson committed
140 141
      constraints.copyWith(
        scrollOffset: math.max(0.0, constraints.scrollOffset - beforePadding),
142
        cacheOrigin: math.min(0.0, constraints.cacheOrigin + beforePadding),
143
        overlap: overlap,
Ian Hickson's avatar
Ian Hickson committed
144
        remainingPaintExtent: constraints.remainingPaintExtent - calculatePaintOffset(constraints, from: 0.0, to: beforePadding),
145
        remainingCacheExtent: constraints.remainingCacheExtent - calculateCacheOffset(constraints, from: 0.0, to: beforePadding),
146
        crossAxisExtent: math.max(0.0, constraints.crossAxisExtent - crossAxisPadding),
147
        precedingScrollExtent: beforePadding + constraints.precedingScrollExtent,
Ian Hickson's avatar
Ian Hickson committed
148 149 150
      ),
      parentUsesSize: true,
    );
151
    final SliverGeometry childLayoutGeometry = child!.geometry!;
152
    if (childLayoutGeometry.scrollOffsetCorrection != null) {
153
      geometry = SliverGeometry(
154 155 156 157
        scrollOffsetCorrection: childLayoutGeometry.scrollOffsetCorrection,
      );
      return;
    }
Ian Hickson's avatar
Ian Hickson committed
158 159 160 161 162 163
    final double afterPaddingPaintExtent = calculatePaintOffset(
      constraints,
      from: beforePadding + childLayoutGeometry.scrollExtent,
      to: mainAxisPadding + childLayoutGeometry.scrollExtent,
    );
    final double mainAxisPaddingPaintExtent = beforePaddingPaintExtent + afterPaddingPaintExtent;
164 165 166 167 168 169 170 171 172 173 174
    final double beforePaddingCacheExtent = calculateCacheOffset(
      constraints,
      from: 0.0,
      to: beforePadding,
    );
    final double afterPaddingCacheExtent = calculateCacheOffset(
      constraints,
      from: beforePadding + childLayoutGeometry.scrollExtent,
      to: mainAxisPadding + childLayoutGeometry.scrollExtent,
    );
    final double mainAxisPaddingCacheExtent = afterPaddingCacheExtent + beforePaddingCacheExtent;
175 176 177 178
    final double paintExtent = math.min(
      beforePaddingPaintExtent + math.max(childLayoutGeometry.paintExtent, childLayoutGeometry.layoutExtent + afterPaddingPaintExtent),
      constraints.remainingPaintExtent,
    );
179
    geometry = SliverGeometry(
180
      paintOrigin: childLayoutGeometry.paintOrigin,
Ian Hickson's avatar
Ian Hickson committed
181
      scrollExtent: mainAxisPadding + childLayoutGeometry.scrollExtent,
182 183
      paintExtent: paintExtent,
      layoutExtent: math.min(mainAxisPaddingPaintExtent + childLayoutGeometry.layoutExtent, paintExtent),
184
      cacheExtent: math.min(mainAxisPaddingCacheExtent + childLayoutGeometry.cacheExtent, constraints.remainingCacheExtent),
Ian Hickson's avatar
Ian Hickson committed
185 186 187 188 189
      maxPaintExtent: mainAxisPadding + childLayoutGeometry.maxPaintExtent,
      hitTestExtent: math.max(
        mainAxisPaddingPaintExtent + childLayoutGeometry.paintExtent,
        beforePaddingPaintExtent + childLayoutGeometry.hitTestExtent,
      ),
190
      hasVisualOverflow: childLayoutGeometry.hasVisualOverflow,
Ian Hickson's avatar
Ian Hickson committed
191 192
    );

193
    final SliverPhysicalParentData childParentData = child!.parentData! as SliverPhysicalParentData;
Ian Hickson's avatar
Ian Hickson committed
194 195 196 197
    assert(constraints.axisDirection != null);
    assert(constraints.growthDirection != null);
    switch (applyGrowthDirectionToAxisDirection(constraints.axisDirection, constraints.growthDirection)) {
      case AxisDirection.up:
198
        childParentData.paintOffset = Offset(resolvedPadding!.left, calculatePaintOffset(constraints, from: resolvedPadding!.bottom + childLayoutGeometry.scrollExtent, to: resolvedPadding!.bottom + childLayoutGeometry.scrollExtent + resolvedPadding!.top));
Ian Hickson's avatar
Ian Hickson committed
199 200
        break;
      case AxisDirection.right:
201
        childParentData.paintOffset = Offset(calculatePaintOffset(constraints, from: 0.0, to: resolvedPadding!.left), resolvedPadding!.top);
Ian Hickson's avatar
Ian Hickson committed
202 203
        break;
      case AxisDirection.down:
204
        childParentData.paintOffset = Offset(resolvedPadding!.left, calculatePaintOffset(constraints, from: 0.0, to: resolvedPadding!.top));
Ian Hickson's avatar
Ian Hickson committed
205 206
        break;
      case AxisDirection.left:
207
        childParentData.paintOffset = Offset(calculatePaintOffset(constraints, from: resolvedPadding!.right + childLayoutGeometry.scrollExtent, to: resolvedPadding!.right + childLayoutGeometry.scrollExtent + resolvedPadding!.left), resolvedPadding!.top);
Ian Hickson's avatar
Ian Hickson committed
208 209 210 211 212 213 214 215 216 217
        break;
    }
    assert(childParentData.paintOffset != null);
    assert(beforePadding == this.beforePadding);
    assert(afterPadding == this.afterPadding);
    assert(mainAxisPadding == this.mainAxisPadding);
    assert(crossAxisPadding == this.crossAxisPadding);
  }

  @override
218 219
  bool hitTestChildren(SliverHitTestResult result, { required double mainAxisPosition, required double crossAxisPosition }) {
    if (child != null && child!.geometry!.hitTestExtent > 0.0) {
220
      final SliverPhysicalParentData childParentData = child!.parentData! as SliverPhysicalParentData;
221 222 223
      result.addWithAxisOffset(
        mainAxisPosition: mainAxisPosition,
        crossAxisPosition: crossAxisPosition,
224 225
        mainAxisOffset: childMainAxisPosition(child!),
        crossAxisOffset: childCrossAxisPosition(child!),
226
        paintOffset: childParentData.paintOffset,
227
        hitTest: child!.hitTest,
228 229
      );
    }
Ian Hickson's avatar
Ian Hickson committed
230 231 232 233
    return false;
  }

  @override
234
  double childMainAxisPosition(RenderSliver child) {
Ian Hickson's avatar
Ian Hickson committed
235 236 237 238 239
    assert(child != null);
    assert(child == this.child);
    return calculatePaintOffset(constraints, from: 0.0, to: beforePadding);
  }

240 241 242 243
  @override
  double childCrossAxisPosition(RenderSliver child) {
    assert(child != null);
    assert(child == this.child);
244 245 246
    assert(constraints != null);
    assert(constraints.axisDirection != null);
    assert(constraints.growthDirection != null);
247
    assert(resolvedPadding != null);
248 249 250
    switch (applyGrowthDirectionToAxisDirection(constraints.axisDirection, constraints.growthDirection)) {
      case AxisDirection.up:
      case AxisDirection.down:
251
        return resolvedPadding!.left;
252 253
      case AxisDirection.left:
      case AxisDirection.right:
254
        return resolvedPadding!.top;
255
    }
256 257
  }

258
  @override
259
  double? childScrollOffset(RenderObject child) {
260 261 262 263
    assert(child.parent == this);
    return beforePadding;
  }

Ian Hickson's avatar
Ian Hickson committed
264 265 266 267
  @override
  void applyPaintTransform(RenderObject child, Matrix4 transform) {
    assert(child != null);
    assert(child == this.child);
268
    final SliverPhysicalParentData childParentData = child.parentData! as SliverPhysicalParentData;
Ian Hickson's avatar
Ian Hickson committed
269 270 271 272 273
    childParentData.applyPaintTransform(transform);
  }

  @override
  void paint(PaintingContext context, Offset offset) {
274
    if (child != null && child!.geometry!.visible) {
275
      final SliverPhysicalParentData childParentData = child!.parentData! as SliverPhysicalParentData;
276
      context.paintChild(child!, offset + childParentData.paintOffset);
Ian Hickson's avatar
Ian Hickson committed
277 278 279 280 281 282 283 284
    }
  }

  @override
  void debugPaint(PaintingContext context, Offset offset) {
    super.debugPaint(context, offset);
    assert(() {
      if (debugPaintSizeEnabled) {
285
        final Size parentSize = getAbsoluteSize();
Ian Hickson's avatar
Ian Hickson committed
286
        final Rect outerRect = offset & parentSize;
287
        Rect? innerRect;
Ian Hickson's avatar
Ian Hickson committed
288
        if (child != null) {
289
          final Size childSize = child!.getAbsoluteSize();
290
          final SliverPhysicalParentData childParentData = child!.parentData! as SliverPhysicalParentData;
Ian Hickson's avatar
Ian Hickson committed
291
          innerRect = (offset + childParentData.paintOffset) & childSize;
292 293 294 295
          assert(innerRect.top >= outerRect.top);
          assert(innerRect.left >= outerRect.left);
          assert(innerRect.right <= outerRect.right);
          assert(innerRect.bottom <= outerRect.bottom);
Ian Hickson's avatar
Ian Hickson committed
296 297 298 299
        }
        debugPaintPadding(context.canvas, outerRect, innerRect);
      }
      return true;
300
    }());
Ian Hickson's avatar
Ian Hickson committed
301
  }
302 303 304 305 306 307 308 309 310 311 312 313 314 315
}

/// Insets a [RenderSliver], applying padding on each side.
///
/// A [RenderSliverPadding] object wraps the [SliverGeometry.layoutExtent] of
/// its child. Any incoming [SliverConstraints.overlap] is ignored and not
/// passed on to the child.
///
/// {@macro flutter.rendering.sliverPadding.limitation}
class RenderSliverPadding extends RenderSliverEdgeInsetsPadding {
  /// Creates a render object that insets its child in a viewport.
  ///
  /// The [padding] argument must not be null and must have non-negative insets.
  RenderSliverPadding({
316 317 318
    required EdgeInsetsGeometry padding,
    TextDirection? textDirection,
    RenderSliver? child,
319 320 321 322 323 324 325 326
  }) : assert(padding != null),
       assert(padding.isNonNegative),
       _padding = padding,
       _textDirection = textDirection {
    this.child = child;
  }

  @override
327 328
  EdgeInsets? get resolvedPadding => _resolvedPadding;
  EdgeInsets? _resolvedPadding;
329 330 331 332 333

  void _resolve() {
    if (resolvedPadding != null)
      return;
    _resolvedPadding = padding.resolve(textDirection);
334
    assert(resolvedPadding!.isNonNegative);
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
  }

  void _markNeedsResolution() {
    _resolvedPadding = null;
    markNeedsLayout();
  }

  /// The amount to pad the child in each dimension.
  ///
  /// If this is set to an [EdgeInsetsDirectional] object, then [textDirection]
  /// must not be null.
  EdgeInsetsGeometry get padding => _padding;
  EdgeInsetsGeometry _padding;
  set padding(EdgeInsetsGeometry value) {
    assert(value != null);
    assert(padding.isNonNegative);
    if (_padding == value)
      return;
    _padding = value;
    _markNeedsResolution();
  }

  /// The text direction with which to resolve [padding].
  ///
  /// This may be changed to null, but only after the [padding] has been changed
  /// to a value that does not depend on the direction.
361 362 363
  TextDirection? get textDirection => _textDirection;
  TextDirection? _textDirection;
  set textDirection(TextDirection? value) {
364 365 366 367 368 369 370 371 372 373 374
    if (_textDirection == value)
      return;
    _textDirection = value;
    _markNeedsResolution();
  }

  @override
  void performLayout() {
    _resolve();
    super.performLayout();
  }
375 376

  @override
377 378
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
379 380
    properties.add(DiagnosticsProperty<EdgeInsetsGeometry>('padding', padding));
    properties.add(EnumProperty<TextDirection>('textDirection', textDirection, defaultValue: null));
381
  }
Ian Hickson's avatar
Ian Hickson committed
382
}