decoration_image.dart 18.3 KB
Newer Older
1 2 3 4 5 6 7 8
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:ui' as ui show Image;

import 'package:flutter/foundation.dart';

9
import 'alignment.dart';
10
import 'basic_types.dart';
11
import 'borders.dart';
12
import 'box_fit.dart';
13 14
import 'image_provider.dart';
import 'image_stream.dart';
15 16 17 18 19 20 21 22 23 24 25 26

/// How to paint any portions of a box not covered by an image.
enum ImageRepeat {
  /// Repeat the image in both the x and y directions until the box is filled.
  repeat,

  /// Repeat the image in the x direction until the box is filled horizontally.
  repeatX,

  /// Repeat the image in the y direction until the box is filled vertically.
  repeatY,

27
  /// Leave uncovered portions of the box transparent.
28
  noRepeat,
29 30 31 32 33 34 35 36 37 38
}

/// An image for a box decoration.
///
/// The image is painted using [paintImage], which describes the meanings of the
/// various fields on this class in more detail.
@immutable
class DecorationImage {
  /// Creates an image to show in a [BoxDecoration].
  ///
Ian Hickson's avatar
Ian Hickson committed
39 40
  /// The [image], [alignment], [repeat], and [matchTextDirection] arguments
  /// must not be null.
41 42 43 44
  const DecorationImage({
    @required this.image,
    this.colorFilter,
    this.fit,
45
    this.alignment = Alignment.center,
46
    this.centerSlice,
47 48
    this.repeat = ImageRepeat.noRepeat,
    this.matchTextDirection = false,
Ian Hickson's avatar
Ian Hickson committed
49 50 51 52
  }) : assert(image != null),
       assert(alignment != null),
       assert(repeat != null),
       assert(matchTextDirection != null);
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

  /// The image to be painted into the decoration.
  ///
  /// Typically this will be an [AssetImage] (for an image shipped with the
  /// application) or a [NetworkImage] (for an image obtained from the network).
  final ImageProvider image;

  /// A color filter to apply to the image before painting it.
  final ColorFilter colorFilter;

  /// How the image should be inscribed into the box.
  ///
  /// The default is [BoxFit.scaleDown] if [centerSlice] is null, and
  /// [BoxFit.fill] if [centerSlice] is not null.
  ///
  /// See the discussion at [paintImage] for more details.
  final BoxFit fit;

  /// How to align the image within its bounds.
  ///
Ian Hickson's avatar
Ian Hickson committed
73
  /// The alignment aligns the given position in the image to the given position
74
  /// in the layout bounds. For example, an [Alignment] alignment of (-1.0,
75 76
  /// -1.0) aligns the image to the top-left corner of its layout bounds, while a
  /// [Alignment] alignment of (1.0, 1.0) aligns the bottom right of the
Ian Hickson's avatar
Ian Hickson committed
77
  /// image with the bottom right corner of its layout bounds. Similarly, an
78
  /// alignment of (0.0, 1.0) aligns the bottom middle of the image with the
Ian Hickson's avatar
Ian Hickson committed
79 80 81 82 83 84
  /// middle of the bottom edge of its layout bounds.
  ///
  /// To display a subpart of an image, consider using a [CustomPainter] and
  /// [Canvas.drawImageRect].
  ///
  /// If the [alignment] is [TextDirection]-dependent (i.e. if it is a
85
  /// [AlignmentDirectional]), then a [TextDirection] must be available
Ian Hickson's avatar
Ian Hickson committed
86
  /// when the image is painted.
87
  ///
88
  /// Defaults to [Alignment.center].
89 90 91 92 93 94 95
  ///
  /// See also:
  ///
  ///  * [Alignment], a class with convenient constants typically used to
  ///    specify an [AlignmentGeometry].
  ///  * [AlignmentDirectional], like [Alignment] for specifying alignments
  ///    relative to text direction.
96
  final AlignmentGeometry alignment;
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

  /// The center slice for a nine-patch image.
  ///
  /// The region of the image inside the center slice will be stretched both
  /// horizontally and vertically to fit the image into its destination. The
  /// region of the image above and below the center slice will be stretched
  /// only horizontally and the region of the image to the left and right of
  /// the center slice will be stretched only vertically.
  ///
  /// The stretching will be applied in order to make the image fit into the box
  /// specified by [fit]. When [centerSlice] is not null, [fit] defaults to
  /// [BoxFit.fill], which distorts the destination image size relative to the
  /// image's original aspect ratio. Values of [BoxFit] which do not distort the
  /// destination image size will result in [centerSlice] having no effect
  /// (since the nine regions of the image will be rendered with the same
  /// scaling, as if it wasn't specified).
  final Rect centerSlice;

  /// How to paint any portions of the box that would not otherwise be covered
  /// by the image.
  final ImageRepeat repeat;

Ian Hickson's avatar
Ian Hickson committed
119 120 121 122 123 124 125 126 127
  /// Whether to paint the image in the direction of the [TextDirection].
  ///
  /// If this is true, then in [TextDirection.ltr] contexts, the image will be
  /// drawn with its origin in the top left (the "normal" painting direction for
  /// images); and in [TextDirection.rtl] contexts, the image will be drawn with
  /// a scaling factor of -1 in the horizontal direction so that the origin is
  /// in the top right.
  final bool matchTextDirection;

128 129 130 131 132 133 134
  /// Creates a [DecorationImagePainter] for this [DecorationImage].
  ///
  /// The `onChanged` argument must not be null. It will be called whenever the
  /// image needs to be repainted, e.g. because it is loading incrementally or
  /// because it is animated.
  DecorationImagePainter createPainter(VoidCallback onChanged) {
    assert(onChanged != null);
135
    return DecorationImagePainter._(this, onChanged);
136 137
  }

138 139 140 141 142 143 144 145 146 147 148 149
  @override
  bool operator ==(dynamic other) {
    if (identical(this, other))
      return true;
    if (runtimeType != other.runtimeType)
      return false;
    final DecorationImage typedOther = other;
    return image == typedOther.image
        && colorFilter == typedOther.colorFilter
        && fit == typedOther.fit
        && alignment == typedOther.alignment
        && centerSlice == typedOther.centerSlice
Ian Hickson's avatar
Ian Hickson committed
150 151
        && repeat == typedOther.repeat
        && matchTextDirection == typedOther.matchTextDirection;
152 153 154
  }

  @override
Ian Hickson's avatar
Ian Hickson committed
155
  int get hashCode => hashValues(image, colorFilter, fit, alignment, centerSlice, repeat, matchTextDirection);
156 157 158 159 160 161 162 163 164 165 166

  @override
  String toString() {
    final List<String> properties = <String>[];
    properties.add('$image');
    if (colorFilter != null)
      properties.add('$colorFilter');
    if (fit != null &&
        !(fit == BoxFit.fill && centerSlice != null) &&
        !(fit == BoxFit.scaleDown && centerSlice == null))
      properties.add('$fit');
Ian Hickson's avatar
Ian Hickson committed
167
    properties.add('$alignment');
168 169 170 171
    if (centerSlice != null)
      properties.add('centerSlice: $centerSlice');
    if (repeat != ImageRepeat.noRepeat)
      properties.add('$repeat');
Ian Hickson's avatar
Ian Hickson committed
172 173
    if (matchTextDirection)
      properties.add('match text direction');
174 175 176 177
    return '$runtimeType(${properties.join(", ")})';
  }
}

178 179 180 181 182 183 184 185 186 187 188 189
/// The painter for a [DecorationImage].
///
/// To obtain a painter, call [DecorationImage.createPainter].
///
/// To paint, call [paint]. The `onChanged` callback passed to
/// [DecorationImage.createPainter] will be called if the image needs to paint
/// again (e.g. because it is animated or because it had not yet loaded the
/// first time the [paint] method was called).
///
/// This object should be disposed using the [dispose] method when it is no
/// longer needed.
class DecorationImagePainter {
190
  DecorationImagePainter._(this._details, this._onChanged) : assert(_details != null);
191 192 193 194 195 196 197

  final DecorationImage _details;
  final VoidCallback _onChanged;

  ImageStream _imageStream;
  ImageInfo _image;

198 199 200 201 202 203 204 205 206 207 208 209 210 211
  /// Draw the image onto the given canvas.
  ///
  /// The image is drawn at the position and size given by the `rect` argument.
  ///
  /// The image is clipped to the given `clipPath`, if any.
  ///
  /// The `configuration` object is used to resolve the image (e.g. to pick
  /// resolution-specific assets), and to implement the
  /// [DecorationImage.matchTextDirection] feature.
  ///
  /// If the image needs to be painted again, e.g. because it is animated or
  /// because it had not yet been loaded the first time this method was called,
  /// then the `onChanged` callback passed to [DecorationImage.createPainter]
  /// will be called.
212 213 214 215 216 217 218 219 220 221 222
  void paint(Canvas canvas, Rect rect, Path clipPath, ImageConfiguration configuration) {
    assert(canvas != null);
    assert(rect != null);
    assert(configuration != null);

    bool flipHorizontally = false;
    if (_details.matchTextDirection) {
      assert(() {
        // We check this first so that the assert will fire immediately, not just
        // when the image is ready.
        if (configuration.textDirection == null) {
223
          throw FlutterError(
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
            'ImageDecoration.matchTextDirection can only be used when a TextDirection is available.\n'
            'When DecorationImagePainter.paint() was called, there was no text direction provided '
            'in the ImageConfiguration object to match.\n'
            'The DecorationImage was:\n'
            '  $_details\n'
            'The ImageConfiguration was:\n'
            '  $configuration'
          );
        }
        return true;
      }());
      if (configuration.textDirection == TextDirection.rtl)
        flipHorizontally = true;
    }

    final ImageStream newImageStream = _details.image.resolve(configuration);
    if (newImageStream.key != _imageStream?.key) {
241 242
      final ImageStreamListener listener = ImageStreamListener(_handleImage);
      _imageStream?.removeListener(listener);
243
      _imageStream = newImageStream;
244
      _imageStream.addListener(listener);
245 246 247 248 249 250 251 252 253 254 255 256 257
    }
    if (_image == null)
      return;

    if (clipPath != null) {
      canvas.save();
      canvas.clipPath(clipPath);
    }

    paintImage(
      canvas: canvas,
      rect: rect,
      image: _image.image,
258
      scale: _image.scale,
259 260 261 262 263 264
      colorFilter: _details.colorFilter,
      fit: _details.fit,
      alignment: _details.alignment.resolve(configuration.textDirection),
      centerSlice: _details.centerSlice,
      repeat: _details.repeat,
      flipHorizontally: flipHorizontally,
265
      filterQuality: FilterQuality.low,
266 267 268 269 270 271
    );

    if (clipPath != null)
      canvas.restore();
  }

272
  void _handleImage(ImageInfo value, bool synchronousCall) {
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
    if (_image == value)
      return;
    _image = value;
    assert(_onChanged != null);
    if (!synchronousCall)
      _onChanged();
  }

  /// Releases the resources used by this painter.
  ///
  /// This should be called whenever the painter is no longer needed.
  ///
  /// After this method has been called, the object is no longer usable.
  @mustCallSuper
  void dispose() {
288
    _imageStream?.removeListener(ImageStreamListener(_handleImage));
289
  }
290 291 292 293 294

  @override
  String toString() {
    return '$runtimeType(stream: $_imageStream, image: $_image) for $_details';
  }
295 296
}

297 298
/// Paints an image into the given rectangle on the canvas.
///
Ian Hickson's avatar
Ian Hickson committed
299 300
/// The arguments have the following meanings:
///
301
///  * `canvas`: The canvas onto which the image will be painted.
Ian Hickson's avatar
Ian Hickson committed
302
///
303 304 305
///  * `rect`: The region of the canvas into which the image will be painted.
///    The image might not fill the entire rectangle (e.g., depending on the
///    `fit`). If `rect` is empty, nothing is painted.
Ian Hickson's avatar
Ian Hickson committed
306
///
307
///  * `image`: The image to paint onto the canvas.
Ian Hickson's avatar
Ian Hickson committed
308
///
309 310
///  * `scale`: The number of image pixels for each logical pixel.
///
311 312
///  * `colorFilter`: If non-null, the color filter to apply when painting the
///    image.
Ian Hickson's avatar
Ian Hickson committed
313
///
314 315 316 317 318
///  * `fit`: How the image should be inscribed into `rect`. If null, the
///    default behavior depends on `centerSlice`. If `centerSlice` is also null,
///    the default behavior is [BoxFit.scaleDown]. If `centerSlice` is
///    non-null, the default behavior is [BoxFit.fill]. See [BoxFit] for
///    details.
Ian Hickson's avatar
Ian Hickson committed
319 320 321
///
///  * `alignment`: How the destination rectangle defined by applying `fit` is
///    aligned within `rect`. For example, if `fit` is [BoxFit.contain] and
322
///    `alignment` is [Alignment.bottomRight], the image will be as large
Ian Hickson's avatar
Ian Hickson committed
323
///    as possible within `rect` and placed with its bottom right corner at the
324
///    bottom right corner of `rect`. Defaults to [Alignment.center].
Ian Hickson's avatar
Ian Hickson committed
325
///
326 327 328 329 330 331 332 333 334 335
///  * `centerSlice`: The image is drawn in nine portions described by splitting
///    the image by drawing two horizontal lines and two vertical lines, where
///    `centerSlice` describes the rectangle formed by the four points where
///    these four lines intersect each other. (This forms a 3-by-3 grid
///    of regions, the center region being described by `centerSlice`.)
///    The four regions in the corners are drawn, without scaling, in the four
///    corners of the destination rectangle defined by applying `fit`. The
///    remaining five regions are drawn by stretching them to fit such that they
///    exactly cover the destination rectangle while maintaining their relative
///    positions.
Ian Hickson's avatar
Ian Hickson committed
336 337 338 339 340 341 342 343 344 345 346
///
///  * `repeat`: If the image does not fill `rect`, whether and how the image
///    should be repeated to fill `rect`. By default, the image is not repeated.
///    See [ImageRepeat] for details.
///
///  * `flipHorizontally`: Whether to flip the image horizontally. This is
///    occasionally used with images in right-to-left environments, for images
///    that were designed for left-to-right locales (or vice versa). Be careful,
///    when using this, to not flip images with integral shadows, text, or other
///    effects that will look incorrect when flipped.
///
347 348 349 350 351
///  * `invertColors`: Inverting the colors of an image applies a new color
///    filter to the paint. If there is another specified color filter, the
///    invert will be applied after it. This is primarily used for implementing
///    smart invert on iOS.
///
352 353 354 355 356 357
///  * `filterQuality`: Use this to change the quality when scaling an image.
///     Use the [FilterQuality.low] quality setting to scale the image, which corresponds to
///     bilinear interpolation, rather than the default [FilterQuality.none] which corresponds
///     to nearest-neighbor.
///
/// The `canvas`, `rect`, `image`, `scale`, `alignment`, `repeat`, `flipHorizontally` and `filterQuality`
Ian Hickson's avatar
Ian Hickson committed
358
/// arguments must not be null.
359 360 361 362 363 364 365 366 367 368
///
/// See also:
///
///  * [paintBorder], which paints a border around a rectangle on a canvas.
///  * [DecorationImage], which holds a configuration for calling this function.
///  * [BoxDecoration], which uses this function to paint a [DecorationImage].
void paintImage({
  @required Canvas canvas,
  @required Rect rect,
  @required ui.Image image,
369
  double scale = 1.0,
370 371
  ColorFilter colorFilter,
  BoxFit fit,
372
  Alignment alignment = Alignment.center,
373
  Rect centerSlice,
374 375
  ImageRepeat repeat = ImageRepeat.noRepeat,
  bool flipHorizontally = false,
376
  bool invertColors = false,
377
  FilterQuality filterQuality = FilterQuality.low,
378 379 380
}) {
  assert(canvas != null);
  assert(image != null);
Ian Hickson's avatar
Ian Hickson committed
381 382 383
  assert(alignment != null);
  assert(repeat != null);
  assert(flipHorizontally != null);
384 385 386
  if (rect.isEmpty)
    return;
  Size outputSize = rect.size;
387
  Size inputSize = Size(image.width.toDouble(), image.height.toDouble());
388 389
  Offset sliceBorder;
  if (centerSlice != null) {
390
    sliceBorder = Offset(
391
      centerSlice.left + inputSize.width - centerSlice.right,
392
      centerSlice.top + inputSize.height - centerSlice.bottom,
393 394 395 396 397 398
    );
    outputSize -= sliceBorder;
    inputSize -= sliceBorder;
  }
  fit ??= centerSlice == null ? BoxFit.scaleDown : BoxFit.fill;
  assert(centerSlice == null || (fit != BoxFit.none && fit != BoxFit.cover));
399 400
  final FittedSizes fittedSizes = applyBoxFit(fit, inputSize / scale, outputSize);
  final Size sourceSize = fittedSizes.source * scale;
401 402 403 404 405 406 407 408 409 410 411 412 413
  Size destinationSize = fittedSizes.destination;
  if (centerSlice != null) {
    outputSize += sliceBorder;
    destinationSize += sliceBorder;
    // We don't have the ability to draw a subset of the image at the same time
    // as we apply a nine-patch stretch.
    assert(sourceSize == inputSize, 'centerSlice was used with a BoxFit that does not guarantee that the image is fully visible.');
  }
  if (repeat != ImageRepeat.noRepeat && destinationSize == outputSize) {
    // There's no need to repeat the image because we're exactly filling the
    // output rect with the image.
    repeat = ImageRepeat.noRepeat;
  }
414
  final Paint paint = Paint()..isAntiAlias = false;
415 416 417
  if (colorFilter != null)
    paint.colorFilter = colorFilter;
  if (sourceSize != destinationSize) {
418
    paint.filterQuality = filterQuality;
419
  }
420
  paint.invertColors = invertColors;
421 422 423 424
  final double halfWidthDelta = (outputSize.width - destinationSize.width) / 2.0;
  final double halfHeightDelta = (outputSize.height - destinationSize.height) / 2.0;
  final double dx = halfWidthDelta + (flipHorizontally ? -alignment.x : alignment.x) * halfWidthDelta;
  final double dy = halfHeightDelta + alignment.y * halfHeightDelta;
425 426
  final Offset destinationPosition = rect.topLeft.translate(dx, dy);
  final Rect destinationRect = destinationPosition & destinationSize;
Ian Hickson's avatar
Ian Hickson committed
427 428
  final bool needSave = repeat != ImageRepeat.noRepeat || flipHorizontally;
  if (needSave)
429
    canvas.save();
Ian Hickson's avatar
Ian Hickson committed
430
  if (repeat != ImageRepeat.noRepeat)
431
    canvas.clipRect(rect);
Ian Hickson's avatar
Ian Hickson committed
432 433 434 435 436
  if (flipHorizontally) {
    final double dx = -(rect.left + rect.width / 2.0);
    canvas.translate(-dx, 0.0);
    canvas.scale(-1.0, 1.0);
    canvas.translate(dx, 0.0);
437 438
  }
  if (centerSlice == null) {
Ian Hickson's avatar
Ian Hickson committed
439
    final Rect sourceRect = alignment.inscribe(
440
      sourceSize, Offset.zero & inputSize,
441
    );
442 443 444 445 446 447
    if (repeat == ImageRepeat.noRepeat) {
      canvas.drawImageRect(image, sourceRect, destinationRect, paint);
    } else {
      for (Rect tileRect in _generateImageTileRects(rect, destinationRect, repeat))
        canvas.drawImageRect(image, sourceRect, tileRect, paint);
    }
448
  } else {
449 450 451 452 453 454
    if (repeat == ImageRepeat.noRepeat) {
      canvas.drawImageNine(image, centerSlice, destinationRect, paint);
    } else {
      for (Rect tileRect in _generateImageTileRects(rect, destinationRect, repeat))
        canvas.drawImageNine(image, centerSlice, tileRect, paint);
    }
455
  }
Ian Hickson's avatar
Ian Hickson committed
456
  if (needSave)
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
    canvas.restore();
}

Iterable<Rect> _generateImageTileRects(Rect outputRect, Rect fundamentalRect, ImageRepeat repeat) sync* {
  int startX = 0;
  int startY = 0;
  int stopX = 0;
  int stopY = 0;
  final double strideX = fundamentalRect.width;
  final double strideY = fundamentalRect.height;

  if (repeat == ImageRepeat.repeat || repeat == ImageRepeat.repeatX) {
    startX = ((outputRect.left - fundamentalRect.left) / strideX).floor();
    stopX = ((outputRect.right - fundamentalRect.right) / strideX).ceil();
  }

  if (repeat == ImageRepeat.repeat || repeat == ImageRepeat.repeatY) {
    startY = ((outputRect.top - fundamentalRect.top) / strideY).floor();
    stopY = ((outputRect.bottom - fundamentalRect.bottom) / strideY).ceil();
  }

  for (int i = startX; i <= stopX; ++i) {
    for (int j = startY; j <= stopY; ++j)
480
      yield fundamentalRect.shift(Offset(i * strideX, j * strideY));
481 482
  }
}