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

5
import 'dart:ui' as ui show lerpDouble, WindowPadding;
6

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

9
import 'basic_types.dart';
10

11 12 13
/// Base class for [EdgeInsets] that allows for text-direction aware
/// resolution.
///
14 15
/// A property or argument of this type accepts classes created either with [
/// EdgeInsets.fromLTRB] and its variants, or [
16
/// EdgeInsetsDirectional.fromSTEB] and its variants.
17
///
18
/// To convert an [EdgeInsetsGeometry] object of indeterminate type into a
19 20 21 22 23
/// [EdgeInsets] object, call the [resolve] method.
///
/// See also:
///
///  * [Padding], a widget that describes margins using [EdgeInsetsGeometry].
24
@immutable
25 26 27 28 29 30 31 32 33 34 35 36
abstract class EdgeInsetsGeometry {
  /// Abstract const constructor. This constructor enables subclasses to provide
  /// const constructors so that they can be used in const expressions.
  const EdgeInsetsGeometry();

  double get _bottom;
  double get _end;
  double get _left;
  double get _right;
  double get _start;
  double get _top;

37 38 39 40 41 42 43 44 45 46 47 48
  /// An [EdgeInsetsGeometry] with infinite offsets in each direction.
  ///
  /// Can be used as an infinite upper bound for [clamp].
  static const EdgeInsetsGeometry infinity = _MixedEdgeInsets.fromLRSETB(
    double.infinity,
    double.infinity,
    double.infinity,
    double.infinity,
    double.infinity,
    double.infinity,
  );

49 50 51 52 53 54 55 56 57 58
  /// Whether every dimension is non-negative.
  bool get isNonNegative {
    return _left >= 0.0
        && _right >= 0.0
        && _start >= 0.0
        && _end >= 0.0
        && _top >= 0.0
        && _bottom >= 0.0;
  }

59
  /// The total offset in the horizontal direction.
60
  double get horizontal => _left + _right + _start + _end;
61

62
  /// The total offset in the vertical direction.
63 64 65 66 67 68 69 70 71 72 73 74 75 76
  double get vertical => _top + _bottom;

  /// The total offset in the given direction.
  double along(Axis axis) {
    assert(axis != null);
    switch (axis) {
      case Axis.horizontal:
        return horizontal;
      case Axis.vertical:
        return vertical;
    }
  }

  /// The size that this [EdgeInsets] would occupy with an empty interior.
77
  Size get collapsedSize => Size(horizontal, vertical);
78 79

  /// An [EdgeInsetsGeometry] with top and bottom, left and right, and start and end flipped.
80
  EdgeInsetsGeometry get flipped => _MixedEdgeInsets.fromLRSETB(_right, _left, _end, _start, _bottom, _top);
81 82 83 84 85 86 87 88

  /// Returns a new size that is bigger than the given size by the amount of
  /// inset in the horizontal and vertical directions.
  ///
  /// See also:
  ///
  ///  * [EdgeInsets.inflateRect], to inflate a [Rect] rather than a [Size] (for
  ///    [EdgeInsetsDirectional], requires first calling [resolve] to establish
89
  ///    how the start and end map to the left or right).
90 91
  ///  * [deflateSize], to deflate a [Size] rather than inflating it.
  Size inflateSize(Size size) {
92
    return Size(size.width + horizontal, size.height + vertical);
93 94 95 96 97 98 99 100 101 102 103 104
  }

  /// Returns a new size that is smaller than the given size by the amount of
  /// inset in the horizontal and vertical directions.
  ///
  /// If the argument is smaller than [collapsedSize], then the resulting size
  /// will have negative dimensions.
  ///
  /// See also:
  ///
  ///  * [EdgeInsets.deflateRect], to deflate a [Rect] rather than a [Size]. (for
  ///    [EdgeInsetsDirectional], requires first calling [resolve] to establish
105
  ///    how the start and end map to the left or right).
106 107
  ///  * [inflateSize], to inflate a [Size] rather than deflating it.
  Size deflateSize(Size size) {
108
    return Size(size.width - horizontal, size.height - vertical);
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
  }

  /// Returns the difference between two [EdgeInsetsGeometry] objects.
  ///
  /// If you know you are applying this to two [EdgeInsets] or two
  /// [EdgeInsetsDirectional] objects, consider using the binary infix `-`
  /// operator instead, which always returns an object of the same type as the
  /// operands, and is typed accordingly.
  ///
  /// If [subtract] is applied to two objects of the same type ([EdgeInsets] or
  /// [EdgeInsetsDirectional]), an object of that type will be returned (though
  /// this is not reflected in the type system). Otherwise, an object
  /// representing a combination of both is returned. That object can be turned
  /// into a concrete [EdgeInsets] using [resolve].
  ///
  /// This method returns the same result as [add] applied to the result of
  /// negating the argument (using the prefix unary `-` operator or multiplying
  /// the argument by -1.0 using the `*` operator).
  EdgeInsetsGeometry subtract(EdgeInsetsGeometry other) {
128
    return _MixedEdgeInsets.fromLRSETB(
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
      _left - other._left,
      _right - other._right,
      _start - other._start,
      _end - other._end,
      _top - other._top,
      _bottom - other._bottom,
    );
  }

  /// Returns the sum of two [EdgeInsetsGeometry] objects.
  ///
  /// If you know you are adding two [EdgeInsets] or two [EdgeInsetsDirectional]
  /// objects, consider using the `+` operator instead, which always returns an
  /// object of the same type as the operands, and is typed accordingly.
  ///
  /// If [add] is applied to two objects of the same type ([EdgeInsets] or
  /// [EdgeInsetsDirectional]), an object of that type will be returned (though
  /// this is not reflected in the type system). Otherwise, an object
  /// representing a combination of both is returned. That object can be turned
  /// into a concrete [EdgeInsets] using [resolve].
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
150
    return _MixedEdgeInsets.fromLRSETB(
151 152 153 154 155 156 157 158 159
      _left + other._left,
      _right + other._right,
      _start + other._start,
      _end + other._end,
      _top + other._top,
      _bottom + other._bottom,
    );
  }

nt4f04uNd's avatar
nt4f04uNd committed
160
  /// Returns a new [EdgeInsetsGeometry] object with all values greater than
161 162 163
  /// or equal to `min`, and less than or equal to `max`.
  EdgeInsetsGeometry clamp(EdgeInsetsGeometry min, EdgeInsetsGeometry max) {
    return _MixedEdgeInsets.fromLRSETB(
164 165 166 167 168 169
      clampDouble(_left, min._left, max._left),
      clampDouble(_right, min._right, max._right),
      clampDouble(_start, min._start, max._start),
      clampDouble(_end, min._end, max._end),
      clampDouble(_top, min._top, max._top),
      clampDouble(_bottom, min._bottom, max._bottom),
170 171 172
    );
  }

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
  /// Returns the [EdgeInsetsGeometry] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  ///
  /// This operator returns an object of the same type as the operand.
  EdgeInsetsGeometry operator -();

  /// Scales the [EdgeInsetsGeometry] object in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
  EdgeInsetsGeometry operator *(double other);

  /// Divides the [EdgeInsetsGeometry] object in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
  EdgeInsetsGeometry operator /(double other);

  /// Integer divides the [EdgeInsetsGeometry] object in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
193 194 195
  ///
  /// This operator may have unexpected results when applied to a mixture of
  /// [EdgeInsets] and [EdgeInsetsDirectional] objects.
196 197 198 199 200
  EdgeInsetsGeometry operator ~/(double other);

  /// Computes the remainder in each dimension by the given factor.
  ///
  /// This operator returns an object of the same type as the operand.
201 202 203
  ///
  /// This operator may have unexpected results when applied to a mixture of
  /// [EdgeInsets] and [EdgeInsetsDirectional] objects.
204 205 206 207 208 209 210 211 212 213 214 215
  EdgeInsetsGeometry operator %(double other);

  /// Linearly interpolate between two [EdgeInsetsGeometry] objects.
  ///
  /// If either is null, this function interpolates from [EdgeInsets.zero], and
  /// the result is an object of the same type as the non-null argument.
  ///
  /// If [lerp] is applied to two objects of the same type ([EdgeInsets] or
  /// [EdgeInsetsDirectional]), an object of that type will be returned (though
  /// this is not reflected in the type system). Otherwise, an object
  /// representing a combination of both is returned. That object can be turned
  /// into a concrete [EdgeInsets] using [resolve].
216
  ///
217
  /// {@macro dart.ui.shadow.lerp}
218
  static EdgeInsetsGeometry? lerp(EdgeInsetsGeometry? a, EdgeInsetsGeometry? b, double t) {
219
    assert(t != null);
220 221 222
    if (a == null && b == null)
      return null;
    if (a == null)
223
      return b! * t;
224 225 226 227 228 229
    if (b == null)
      return a * (1.0 - t);
    if (a is EdgeInsets && b is EdgeInsets)
      return EdgeInsets.lerp(a, b, t);
    if (a is EdgeInsetsDirectional && b is EdgeInsetsDirectional)
      return EdgeInsetsDirectional.lerp(a, b, t);
230
    return _MixedEdgeInsets.fromLRSETB(
231 232 233 234 235 236
      ui.lerpDouble(a._left, b._left, t)!,
      ui.lerpDouble(a._right, b._right, t)!,
      ui.lerpDouble(a._start, b._start, t)!,
      ui.lerpDouble(a._end, b._end, t)!,
      ui.lerpDouble(a._top, b._top, t)!,
      ui.lerpDouble(a._bottom, b._bottom, t)!,
237 238 239
    );
  }

240
  /// Convert this instance into an [EdgeInsets], which uses literal coordinates
241 242 243 244 245 246 247 248
  /// (i.e. the `left` coordinate being explicitly a distance from the left, and
  /// the `right` coordinate being explicitly a distance from the right).
  ///
  /// See also:
  ///
  ///  * [EdgeInsets], for which this is a no-op (returns itself).
  ///  * [EdgeInsetsDirectional], which flips the horizontal direction
  ///    based on the `direction` argument.
249
  EdgeInsets resolve(TextDirection? direction);
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280

  @override
  String toString() {
    if (_start == 0.0 && _end == 0.0) {
      if (_left == 0.0 && _right == 0.0 && _top == 0.0 && _bottom == 0.0)
        return 'EdgeInsets.zero';
      if (_left == _right && _right == _top && _top == _bottom)
        return 'EdgeInsets.all(${_left.toStringAsFixed(1)})';
      return 'EdgeInsets(${_left.toStringAsFixed(1)}, '
                        '${_top.toStringAsFixed(1)}, '
                        '${_right.toStringAsFixed(1)}, '
                        '${_bottom.toStringAsFixed(1)})';
    }
    if (_left == 0.0 && _right == 0.0) {
      return 'EdgeInsetsDirectional(${_start.toStringAsFixed(1)}, '
                                   '${_top.toStringAsFixed(1)}, '
                                   '${_end.toStringAsFixed(1)}, '
                                   '${_bottom.toStringAsFixed(1)})';
    }
    return 'EdgeInsets(${_left.toStringAsFixed(1)}, '
                      '${_top.toStringAsFixed(1)}, '
                      '${_right.toStringAsFixed(1)}, '
                      '${_bottom.toStringAsFixed(1)})'
           ' + '
           'EdgeInsetsDirectional(${_start.toStringAsFixed(1)}, '
                                 '0.0, '
                                 '${_end.toStringAsFixed(1)}, '
                                 '0.0)';
  }

  @override
281
  bool operator ==(Object other) {
282 283 284 285 286 287 288
    return other is EdgeInsetsGeometry
        && other._left == _left
        && other._right == _right
        && other._start == _start
        && other._end == _end
        && other._top == _top
        && other._bottom == _bottom;
289 290 291
  }

  @override
292
  int get hashCode => Object.hash(_left, _right, _start, _end, _top, _bottom);
293 294
}

295 296 297 298
/// An immutable set of offsets in each of the four cardinal directions.
///
/// Typically used for an offset from each of the four sides of a box. For
/// example, the padding inside a box can be represented using this class.
299
///
300 301 302 303 304 305 306
/// The [EdgeInsets] class specifies offsets in terms of visual edges, left,
/// top, right, and bottom. These values are not affected by the
/// [TextDirection]. To support both left-to-right and right-to-left layouts,
/// consider using [EdgeInsetsDirectional], which is expressed in terms of
/// _start_, top, _end_, and bottom, where start and end are resolved in terms
/// of a [TextDirection] (typically obtained from the ambient [Directionality]).
///
307
/// {@tool snippet}
308 309 310
///
/// Here are some examples of how to create [EdgeInsets] instances:
///
311 312
/// Typical eight-pixel margin on all sides:
///
313 314
/// ```dart
/// const EdgeInsets.all(8.0)
315
/// ```
316
/// {@end-tool}
317
/// {@tool snippet}
318 319
///
/// Eight pixel margin above and below, no horizontal margins:
320
///
321
/// ```dart
322
/// const EdgeInsets.symmetric(vertical: 8.0)
323
/// ```
324
/// {@end-tool}
325
/// {@tool snippet}
326
///
327 328 329
/// Left margin indent of 40 pixels:
///
/// ```dart
330 331
/// const EdgeInsets.only(left: 40.0)
/// ```
332
/// {@end-tool}
333 334 335
///
/// See also:
///
336 337 338 339 340
///  * [Padding], a widget that accepts [EdgeInsets] to describe its margins.
///  * [EdgeInsetsDirectional], which (for properties and arguments that accept
///    the type [EdgeInsetsGeometry]) allows the horizontal insets to be
///    specified in a [TextDirection]-aware manner.
class EdgeInsets extends EdgeInsetsGeometry {
341
  /// Creates insets from offsets from the left, top, right, and bottom.
342 343
  const EdgeInsets.fromLTRB(this.left, this.top, this.right, this.bottom);

344
  /// Creates insets where all the offsets are `value`.
345
  ///
346
  /// {@tool snippet}
347
  ///
348 349
  /// Typical eight-pixel margin on all sides:
  ///
350 351 352
  /// ```dart
  /// const EdgeInsets.all(8.0)
  /// ```
353
  /// {@end-tool}
354
  const EdgeInsets.all(double value)
355 356 357 358
    : left = value,
      top = value,
      right = value,
      bottom = value;
359

360
  /// Creates insets with only the given values non-zero.
361
  ///
362
  /// {@tool snippet}
363
  ///
364 365
  /// Left margin indent of 40 pixels:
  ///
366 367 368
  /// ```dart
  /// const EdgeInsets.only(left: 40.0)
  /// ```
369
  /// {@end-tool}
370
  const EdgeInsets.only({
371 372 373
    this.left = 0.0,
    this.top = 0.0,
    this.right = 0.0,
374
    this.bottom = 0.0,
375
  });
376

377
  /// Creates insets with symmetrical vertical and horizontal offsets.
378
  ///
379
  /// {@tool snippet}
380
  ///
381 382
  /// Eight pixel margin above and below, no horizontal margins:
  ///
383 384 385
  /// ```dart
  /// const EdgeInsets.symmetric(vertical: 8.0)
  /// ```
386
  /// {@end-tool}
387 388 389 390 391 392 393
  const EdgeInsets.symmetric({
    double vertical = 0.0,
    double horizontal = 0.0,
  }) : left = horizontal,
       top = vertical,
       right = horizontal,
       bottom = vertical;
394

395
  /// Creates insets that match the given window padding.
396
  ///
397 398 399
  /// If you need the current system padding or view insets in the context of a
  /// widget, consider using [MediaQuery.of] to obtain these values rather than
  /// using the value from [dart:ui.window], so that you get notified of
400
  /// changes.
401 402 403 404 405
  EdgeInsets.fromWindowPadding(ui.WindowPadding padding, double devicePixelRatio)
    : left = padding.left / devicePixelRatio,
      top = padding.top / devicePixelRatio,
      right = padding.right / devicePixelRatio,
      bottom = padding.bottom / devicePixelRatio;
406

407
  /// An [EdgeInsets] with zero offsets in each direction.
408
  static const EdgeInsets zero = EdgeInsets.only();
409

410 411
  /// The offset from the left.
  final double left;
412

413 414 415
  @override
  double get _left => left;

416 417 418
  /// The offset from the top.
  final double top;

419 420 421
  @override
  double get _top => top;

422 423 424
  /// The offset from the right.
  final double right;

425 426 427
  @override
  double get _right => right;

428 429 430
  /// The offset from the bottom.
  final double bottom;

431 432 433 434 435 436 437 438 439
  @override
  double get _bottom => bottom;

  @override
  double get _start => 0.0;

  @override
  double get _end => 0.0;

440 441
  /// An Offset describing the vector from the top left of a rectangle to the
  /// top left of that rectangle inset by this object.
442
  Offset get topLeft => Offset(left, top);
443 444 445

  /// An Offset describing the vector from the top right of a rectangle to the
  /// top right of that rectangle inset by this object.
446
  Offset get topRight => Offset(-right, top);
447 448 449

  /// An Offset describing the vector from the bottom left of a rectangle to the
  /// bottom left of that rectangle inset by this object.
450
  Offset get bottomLeft => Offset(left, -bottom);
451 452 453

  /// An Offset describing the vector from the bottom right of a rectangle to the
  /// bottom right of that rectangle inset by this object.
454
  Offset get bottomRight => Offset(-right, -bottom);
455

456 457
  /// An [EdgeInsets] with top and bottom as well as left and right flipped.
  @override
458
  EdgeInsets get flipped => EdgeInsets.fromLTRB(right, bottom, left, top);
459

460 461 462 463 464
  /// Returns a new rect that is bigger than the given rect in each direction by
  /// the amount of inset in each direction. Specifically, the left edge of the
  /// rect is moved left by [left], the top edge of the rect is moved up by
  /// [top], the right edge of the rect is moved right by [right], and the
  /// bottom edge of the rect is moved down by [bottom].
465 466 467 468 469
  ///
  /// See also:
  ///
  ///  * [inflateSize], to inflate a [Size] rather than a [Rect].
  ///  * [deflateRect], to deflate a [Rect] rather than inflating it.
470
  Rect inflateRect(Rect rect) {
471
    return Rect.fromLTRB(rect.left - left, rect.top - top, rect.right + right, rect.bottom + bottom);
472 473
  }

474 475 476 477 478 479 480 481 482 483 484 485 486 487
  /// Returns a new rect that is smaller than the given rect in each direction by
  /// the amount of inset in each direction. Specifically, the left edge of the
  /// rect is moved right by [left], the top edge of the rect is moved down by
  /// [top], the right edge of the rect is moved left by [right], and the
  /// bottom edge of the rect is moved up by [bottom].
  ///
  /// If the argument's [Rect.size] is smaller than [collapsedSize], then the
  /// resulting rectangle will have negative dimensions.
  ///
  /// See also:
  ///
  ///  * [deflateSize], to deflate a [Size] rather than a [Rect].
  ///  * [inflateRect], to inflate a [Rect] rather than deflating it.
  Rect deflateRect(Rect rect) {
488
    return Rect.fromLTRB(rect.left + left, rect.top + top, rect.right - right, rect.bottom - bottom);
489 490
  }

491 492 493 494 495
  @override
  EdgeInsetsGeometry subtract(EdgeInsetsGeometry other) {
    if (other is EdgeInsets)
      return this - other;
    return super.subtract(other);
496 497
  }

498 499 500 501 502
  @override
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
    if (other is EdgeInsets)
      return this + other;
    return super.add(other);
503 504
  }

505 506 507
  @override
  EdgeInsetsGeometry clamp(EdgeInsetsGeometry min, EdgeInsetsGeometry max) {
    return EdgeInsets.fromLTRB(
508 509 510 511
      clampDouble(_left, min._left, max._left),
      clampDouble(_top, min._top, max._top),
      clampDouble(_right, min._right, max._right),
      clampDouble(_bottom, min._bottom, max._bottom),
512 513 514
    );
  }

515
  /// Returns the difference between two [EdgeInsets].
516
  EdgeInsets operator -(EdgeInsets other) {
517
    return EdgeInsets.fromLTRB(
518
      left - other.left,
519 520
      top - other.top,
      right - other.right,
521
      bottom - other.bottom,
522 523 524
    );
  }

525
  /// Returns the sum of two [EdgeInsets].
526
  EdgeInsets operator +(EdgeInsets other) {
527
    return EdgeInsets.fromLTRB(
528
      left + other.left,
529 530
      top + other.top,
      right + other.right,
531
      bottom + other.bottom,
532 533 534
    );
  }

535 536 537 538 539
  /// Returns the [EdgeInsets] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  @override
  EdgeInsets operator -() {
540
    return EdgeInsets.fromLTRB(
541 542 543 544 545 546 547 548 549
      -left,
      -top,
      -right,
      -bottom,
    );
  }

  /// Scales the [EdgeInsets] in each dimension by the given factor.
  @override
550
  EdgeInsets operator *(double other) {
551
    return EdgeInsets.fromLTRB(
552
      left * other,
553 554
      top * other,
      right * other,
555
      bottom * other,
556 557 558
    );
  }

559 560
  /// Divides the [EdgeInsets] in each dimension by the given factor.
  @override
561
  EdgeInsets operator /(double other) {
562
    return EdgeInsets.fromLTRB(
563
      left / other,
564 565
      top / other,
      right / other,
566
      bottom / other,
567 568 569
    );
  }

570 571
  /// Integer divides the [EdgeInsets] in each dimension by the given factor.
  @override
572
  EdgeInsets operator ~/(double other) {
573
    return EdgeInsets.fromLTRB(
574
      (left ~/ other).toDouble(),
575 576
      (top ~/ other).toDouble(),
      (right ~/ other).toDouble(),
577
      (bottom ~/ other).toDouble(),
578 579 580
    );
  }

581
  /// Computes the remainder in each dimension by the given factor.
582
  @override
583
  EdgeInsets operator %(double other) {
584
    return EdgeInsets.fromLTRB(
585
      left % other,
586 587
      top % other,
      right % other,
588
      bottom % other,
589 590 591
    );
  }

592
  /// Linearly interpolate between two [EdgeInsets].
593
  ///
594
  /// If either is null, this function interpolates from [EdgeInsets.zero].
595
  ///
596
  /// {@macro dart.ui.shadow.lerp}
597
  static EdgeInsets? lerp(EdgeInsets? a, EdgeInsets? b, double t) {
598
    assert(t != null);
599 600 601
    if (a == null && b == null)
      return null;
    if (a == null)
602
      return b! * t;
603 604
    if (b == null)
      return a * (1.0 - t);
605
    return EdgeInsets.fromLTRB(
606 607 608 609
      ui.lerpDouble(a.left, b.left, t)!,
      ui.lerpDouble(a.top, b.top, t)!,
      ui.lerpDouble(a.right, b.right, t)!,
      ui.lerpDouble(a.bottom, b.bottom, t)!,
610 611 612
    );
  }

613
  @override
614
  EdgeInsets resolve(TextDirection? direction) => this;
615 616 617 618

  /// Creates a copy of this EdgeInsets but with the given fields replaced
  /// with the new values.
  EdgeInsets copyWith({
619 620 621 622
    double? left,
    double? top,
    double? right,
    double? bottom,
623
  }) {
624
    return EdgeInsets.only(
625 626 627 628 629 630
      left: left ?? this.left,
      top: top ?? this.top,
      right: right ?? this.right,
      bottom: bottom ?? this.bottom,
    );
  }
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
}

/// An immutable set of offsets in each of the four cardinal directions, but
/// whose horizontal components are dependent on the writing direction.
///
/// This can be used to indicate padding from the left in [TextDirection.ltr]
/// text and padding from the right in [TextDirection.rtl] text without having
/// to be aware of the current text direction.
///
/// See also:
///
///  * [EdgeInsets], a variant that uses physical labels (left and right instead
///    of start and end).
class EdgeInsetsDirectional extends EdgeInsetsGeometry {
  /// Creates insets from offsets from the start, top, end, and bottom.
  const EdgeInsetsDirectional.fromSTEB(this.start, this.top, this.end, this.bottom);

  /// Creates insets with only the given values non-zero.
  ///
650
  /// {@tool snippet}
651 652 653 654 655 656
  ///
  /// A margin indent of 40 pixels on the leading side:
  ///
  /// ```dart
  /// const EdgeInsetsDirectional.only(start: 40.0)
  /// ```
657
  /// {@end-tool}
658
  const EdgeInsetsDirectional.only({
659 660 661
    this.start = 0.0,
    this.top = 0.0,
    this.end = 0.0,
662
    this.bottom = 0.0,
663 664
  });

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
  /// Creates insets where all the offsets are `value`.
  ///
  /// {@tool snippet}
  ///
  /// Typical eight-pixel margin on all sides:
  ///
  /// ```dart
  /// const EdgeInsetsDirectional.all(8.0)
  /// ```
  /// {@end-tool}
  const EdgeInsetsDirectional.all(double value)
    : start = value,
      top = value,
      end = value,
      bottom = value;

681 682 683 684
  /// An [EdgeInsetsDirectional] with zero offsets in each direction.
  ///
  /// Consider using [EdgeInsets.zero] instead, since that object has the same
  /// effect, but will be cheaper to [resolve].
685
  static const EdgeInsetsDirectional zero = EdgeInsetsDirectional.only();
686

687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
  /// The offset from the start side, the side from which the user will start
  /// reading text.
  ///
  /// This value is normalized into an [EdgeInsets.left] or [EdgeInsets.right]
  /// value by the [resolve] method.
  final double start;

  @override
  double get _start => start;

  /// The offset from the top.
  ///
  /// This value is passed through to [EdgeInsets.top] unmodified by the
  /// [resolve] method.
  final double top;

  @override
  double get _top => top;

  /// The offset from the end side, the side on which the user ends reading
  /// text.
  ///
  /// This value is normalized into an [EdgeInsets.left] or [EdgeInsets.right]
  /// value by the [resolve] method.
  final double end;

  @override
  double get _end => end;

  /// The offset from the bottom.
  ///
  /// This value is passed through to [EdgeInsets.bottom] unmodified by the
  /// [resolve] method.
  final double bottom;

  @override
  double get _bottom => bottom;

  @override
  double get _left => 0.0;

  @override
  double get _right => 0.0;

  @override
  bool get isNonNegative => start >= 0.0 && top >= 0.0 && end >= 0.0 && bottom >= 0.0;

  /// An [EdgeInsetsDirectional] with [top] and [bottom] as well as [start] and [end] flipped.
  @override
736
  EdgeInsetsDirectional get flipped => EdgeInsetsDirectional.fromSTEB(end, bottom, start, top);
737 738 739 740 741 742

  @override
  EdgeInsetsGeometry subtract(EdgeInsetsGeometry other) {
    if (other is EdgeInsetsDirectional)
      return this - other;
    return super.subtract(other);
743 744
  }

745
  @override
746 747 748 749 750 751 752 753
  EdgeInsetsGeometry add(EdgeInsetsGeometry other) {
    if (other is EdgeInsetsDirectional)
      return this + other;
    return super.add(other);
  }

  /// Returns the difference between two [EdgeInsetsDirectional] objects.
  EdgeInsetsDirectional operator -(EdgeInsetsDirectional other) {
754
    return EdgeInsetsDirectional.fromSTEB(
755 756 757 758 759 760 761 762 763
      start - other.start,
      top - other.top,
      end - other.end,
      bottom - other.bottom,
    );
  }

  /// Returns the sum of two [EdgeInsetsDirectional] objects.
  EdgeInsetsDirectional operator +(EdgeInsetsDirectional other) {
764
    return EdgeInsetsDirectional.fromSTEB(
765 766 767 768 769 770
      start + other.start,
      top + other.top,
      end + other.end,
      bottom + other.bottom,
    );
  }
771

772 773 774 775 776
  /// Returns the [EdgeInsetsDirectional] object with each dimension negated.
  ///
  /// This is the same as multiplying the object by -1.0.
  @override
  EdgeInsetsDirectional operator -() {
777
    return EdgeInsetsDirectional.fromSTEB(
778 779 780 781 782 783 784 785
      -start,
      -top,
      -end,
      -bottom,
    );
  }

  /// Scales the [EdgeInsetsDirectional] object in each dimension by the given factor.
786
  @override
787
  EdgeInsetsDirectional operator *(double other) {
788
    return EdgeInsetsDirectional.fromSTEB(
789 790 791 792 793 794 795 796 797 798
      start * other,
      top * other,
      end * other,
      bottom * other,
    );
  }

  /// Divides the [EdgeInsetsDirectional] object in each dimension by the given factor.
  @override
  EdgeInsetsDirectional operator /(double other) {
799
    return EdgeInsetsDirectional.fromSTEB(
800 801 802 803 804 805 806 807 808 809
      start / other,
      top / other,
      end / other,
      bottom / other,
    );
  }

  /// Integer divides the [EdgeInsetsDirectional] object in each dimension by the given factor.
  @override
  EdgeInsetsDirectional operator ~/(double other) {
810
    return EdgeInsetsDirectional.fromSTEB(
811 812 813 814 815 816 817 818 819 820
      (start ~/ other).toDouble(),
      (top ~/ other).toDouble(),
      (end ~/ other).toDouble(),
      (bottom ~/ other).toDouble(),
    );
  }

  /// Computes the remainder in each dimension by the given factor.
  @override
  EdgeInsetsDirectional operator %(double other) {
821
    return EdgeInsetsDirectional.fromSTEB(
822 823 824 825 826 827 828 829 830 831 832 833 834 835
      start % other,
      top % other,
      end % other,
      bottom % other,
    );
  }

  /// Linearly interpolate between two [EdgeInsetsDirectional].
  ///
  /// If either is null, this function interpolates from [EdgeInsetsDirectional.zero].
  ///
  /// To interpolate between two [EdgeInsetsGeometry] objects of arbitrary type
  /// (either [EdgeInsets] or [EdgeInsetsDirectional]), consider the
  /// [EdgeInsetsGeometry.lerp] static method.
836
  ///
837
  /// {@macro dart.ui.shadow.lerp}
838
  static EdgeInsetsDirectional? lerp(EdgeInsetsDirectional? a, EdgeInsetsDirectional? b, double t) {
839
    assert(t != null);
840 841 842
    if (a == null && b == null)
      return null;
    if (a == null)
843
      return b! * t;
844 845
    if (b == null)
      return a * (1.0 - t);
846
    return EdgeInsetsDirectional.fromSTEB(
847 848 849 850
      ui.lerpDouble(a.start, b.start, t)!,
      ui.lerpDouble(a.top, b.top, t)!,
      ui.lerpDouble(a.end, b.end, t)!,
      ui.lerpDouble(a.bottom, b.bottom, t)!,
851 852 853 854
    );
  }

  @override
855
  EdgeInsets resolve(TextDirection? direction) {
856
    assert(direction != null);
857
    switch (direction!) {
858
      case TextDirection.rtl:
859
        return EdgeInsets.fromLTRB(end, top, start, bottom);
860
      case TextDirection.ltr:
861
        return EdgeInsets.fromLTRB(start, top, end, bottom);
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
    }
  }
}

class _MixedEdgeInsets extends EdgeInsetsGeometry {
  const _MixedEdgeInsets.fromLRSETB(this._left, this._right, this._start, this._end, this._top, this._bottom);

  @override
  final double _left;

  @override
  final double _right;

  @override
  final double _start;

  @override
  final double _end;

  @override
  final double _top;

  @override
  final double _bottom;

  @override
  bool get isNonNegative {
    return _left >= 0.0
        && _right >= 0.0
        && _start >= 0.0
        && _end >= 0.0
        && _top >= 0.0
        && _bottom >= 0.0;
  }

  @override
  _MixedEdgeInsets operator -() {
899
    return _MixedEdgeInsets.fromLRSETB(
900 901 902 903 904 905 906 907 908 909 910
      -_left,
      -_right,
      -_start,
      -_end,
      -_top,
      -_bottom,
    );
  }

  @override
  _MixedEdgeInsets operator *(double other) {
911
    return _MixedEdgeInsets.fromLRSETB(
912 913 914 915 916 917 918 919 920 921 922
      _left * other,
      _right * other,
      _start * other,
      _end * other,
      _top * other,
      _bottom * other,
    );
  }

  @override
  _MixedEdgeInsets operator /(double other) {
923
    return _MixedEdgeInsets.fromLRSETB(
924 925 926 927 928 929 930 931 932 933 934
      _left / other,
      _right / other,
      _start / other,
      _end / other,
      _top / other,
      _bottom / other,
    );
  }

  @override
  _MixedEdgeInsets operator ~/(double other) {
935
    return _MixedEdgeInsets.fromLRSETB(
936 937 938 939 940 941 942 943 944 945 946
      (_left ~/ other).toDouble(),
      (_right ~/ other).toDouble(),
      (_start ~/ other).toDouble(),
      (_end ~/ other).toDouble(),
      (_top ~/ other).toDouble(),
      (_bottom ~/ other).toDouble(),
    );
  }

  @override
  _MixedEdgeInsets operator %(double other) {
947
    return _MixedEdgeInsets.fromLRSETB(
948 949 950 951 952 953 954 955 956 957
      _left % other,
      _right % other,
      _start % other,
      _end % other,
      _top % other,
      _bottom % other,
    );
  }

  @override
958
  EdgeInsets resolve(TextDirection? direction) {
959
    assert(direction != null);
960
    switch (direction!) {
961
      case TextDirection.rtl:
962
        return EdgeInsets.fromLTRB(_end + _left, _top, _start + _right, _bottom);
963
      case TextDirection.ltr:
964
        return EdgeInsets.fromLTRB(_start + _left, _top, _end + _right, _bottom);
965 966
    }
  }
967
}