Remove flutter_sprites (#5996)

This code is now in its own standalone library. The library is in a private git
repository in the flutter organization because the code is unmaintained. If
you're interested in using and maintaining this code, please contact
flutter-dev@googlegroups.com for more information.

dev/benchmarks/complex_layout/pubspec.yaml

@@ -6,8 +6,7 @@ dependencies:
     path: ../../../packages/flutter
   flutter_driver:
     path: ../../../packages/flutter_driver
-  # Also update dev/manual_tests/pubspec.yaml
-  # and examples/flutter_gallery/pubspec.yaml
+  # Also update examples/flutter_gallery/pubspec.yaml
   flutter_gallery_assets:
     git:
       url: https://flutter.googlesource.com/gallery-assets

dev/bots/test.sh

@@ -31,7 +31,6 @@ fi
 # run tests
 (cd packages/flutter; flutter test $COVERAGE_FLAG)
 (cd packages/flutter_driver; dart -c test/all.dart)
-(cd packages/flutter_sprites; flutter test)
 (cd packages/flutter_test; flutter test)
 (cd packages/flutter_tools; dart -c test/all.dart)
 

dev/manual_tests/pubspec.yaml

@@ -2,14 +2,6 @@ name: flutter_manual_tests
 dependencies:
   flutter:
     path: ../../packages/flutter
-  flutter_sprites:
-    path: ../../packages/flutter_sprites
-  # Also update dev/manual_tests/pubspec.yaml
-  # and dev/benchmarks/complex_layout/pubspec.yaml
-  flutter_gallery_assets:
-    git:
-      url: https://flutter.googlesource.com/gallery-assets
-      ref: ef928550119411358b8b25e16aecde6ace513526
 
 dev_dependencies:
   test: any # flutter_test provides the version constraints

examples/flutter_gallery/pubspec.yaml

@@ -9,7 +9,6 @@ dependencies:
   flutter_markdown:
     path: ../../packages/flutter_markdown
   # Also update dev/benchmarks/complex_layout/pubspec.yaml
-  # and examples/flutter_gallery/pubspec.yaml
   flutter_gallery_assets:
     git:
       url: https://flutter.googlesource.com/gallery-assets

packages/flutter_sprites/lib/flutter_sprites.dart

-// 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.
-
-/// A sprite toolkit built on top of Flutter.
-library flutter_sprites;
-
-import 'dart:async';
-import 'dart:convert';
-import 'dart:math' as math;
-import 'dart:typed_data';
-import 'dart:ui' as ui show Image;
-
-import 'package:flutter/gestures.dart';
-import 'package:flutter/rendering.dart';
-import 'package:flutter/scheduler.dart';
-import 'package:flutter/services.dart';
-import 'package:flutter/widgets.dart';
-import 'package:meta/meta.dart';
-import 'package:vector_math/vector_math_64.dart';
-
-part 'src/action.dart';
-part 'src/action_spline.dart';
-part 'src/color_sequence.dart';
-part 'src/constraint.dart';
-part 'src/effect_line.dart';
-part 'src/image_map.dart';
-part 'src/label.dart';
-part 'src/layer.dart';
-part 'src/nine_slice_sprite.dart';
-part 'src/node.dart';
-part 'src/node3d.dart';
-part 'src/node_with_size.dart';
-part 'src/particle_system.dart';
-part 'src/sprite.dart';
-part 'src/sprite_box.dart';
-part 'src/sprite_widget.dart';
-part 'src/spritesheet.dart';
-part 'src/texture.dart';
-part 'src/textured_line.dart';
-part 'src/util.dart';
-part 'src/virtual_joystick.dart';

packages/flutter_sprites/lib/src/action_spline.dart

-// 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.
-
-part of flutter_sprites;
-
-Point _cardinalSplineAt(Point p0, Point p1, Point p2, Point p3, double tension, double t) {
-  double t2 = t * t;
-  double t3 = t2 * t;
-
-  double s = (1.0 - tension) / 2.0;
-
-  double b1 = s * ((-t3 + (2.0 * t2)) - t);
-	double b2 = s * (-t3 + t2) + (2.0 * t3 - 3.0 * t2 + 1.0);
-	double b3 = s * (t3 - 2.0 * t2 + t) + (-2.0 * t3 + 3.0 * t2);
-	double b4 = s * (t3 - t2);
-
-  double x = p0.x * b1 + p1.x * b2 + p2.x * b3 + p3.x * b4;
-	double y = p0.y * b1 + p1.y * b2 + p2.y * b3 + p3.y * b4;
-
-  return new Point(x, y);
-}
-
-/// Signature for callbacks used by the [ActionSpline] to set a [Point] value.
-typedef void PointSetterCallback(Point value);
-
-/// The spline action is used to animate a point along a spline definied by
-/// a set of points.
-class ActionSpline extends ActionInterval {
-
-  /// Creates a new spline action with a set of points. The [setter] is a
-  /// callback for setting the positions, [points] define the spline, and
-  /// [duration] is the time for the action to complete. Optionally a [curve]
-  /// can be used for easing.
-  ActionSpline(this.setter, this.points, double duration, [Curve curve]) : super(duration, curve) {
-    _dt = 1.0 / (points.length - 1.0);
-  }
-
-  /// The callback used to update a point when the action is run.
-  final PointSetterCallback setter;
-
-  /// A list of points that define the spline.
-  final List<Point> points;
-
-  /// The tension of the spline, defines the roundness of the curve.
-  double tension = 0.5;
-
-  double _dt;
-
-  @override
-  void update(double t) {
-
-    int p;
-    double lt;
-
-    if (t < 0.0) t = 0.0;
-
-    if (t >= 1.0) {
-      p = points.length - 1;
-      lt = 1.0;
-    } else {
-      p = (t / _dt).floor();
-      lt = (t - _dt * p) / _dt;
-    }
-
-    Point p0 = points[(p - 1).clamp(0, points.length - 1)];
-    Point p1 = points[(p + 0).clamp(0, points.length - 1)];
-    Point p2 = points[(p + 1).clamp(0, points.length - 1)];
-    Point p3 = points[(p + 2).clamp(0, points.length - 1)];
-
-    Point newPos = _cardinalSplineAt(p0, p1, p2, p3, tension, lt);
-
-    setter(newPos);
-  }
-}

packages/flutter_sprites/lib/src/color_sequence.dart

-// 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.
-
-part of flutter_sprites;
-
-/// A sequence of colors representing a gradient or a color transition over
-/// time. The sequence is represented by a list of [colors] and a list of
-/// [colorStops], the stops are normalized values (0.0 to 1.0) and ordered in
-/// the list. Both lists have the same number of elements.
-class ColorSequence {
-  /// List of colors.
-  List<Color> colors;
-
-  /// List of color stops, normalized values (0.0 to 1.0) and ordered.
-  List<double> colorStops;
-
-  /// Creates a new color sequence from a list of [colors] and a list of
-  /// [colorStops].
-  ColorSequence(this.colors, this.colorStops) {
-    assert(colors != null);
-    assert(colorStops != null);
-    assert(colors.length == colorStops.length);
-  }
-
-  /// Creates a new color sequence from a start and an end color.
-  ColorSequence.fromStartAndEndColor(Color start, Color end) {
-    colors = <Color>[start, end];
-    colorStops = <double>[0.0, 1.0];
-  }
-
-  /// Creates a new color sequence by copying an existing sequence.
-  ColorSequence.copy(ColorSequence sequence) {
-    colors = new List<Color>.from(sequence.colors);
-    colorStops = new List<double>.from(sequence.colorStops);
-  }
-
-  /// Returns the color at a normalized (0.0 to 1.0) position in the color
-  /// sequence. If a color stop isn't hit, the returned color will be an
-  /// interpolation of a color between two color stops.
-  Color colorAtPosition(double pos) {
-    assert(pos >= 0.0 && pos <= 1.0);
-
-    if (pos == 0.0) return colors[0];
-
-    double lastStop = colorStops[0];
-    Color lastColor = colors[0];
-
-    for (int i = 0; i < colors.length; i++) {
-      double currentStop = colorStops[i];
-      Color currentColor = colors[i];
-
-      if (pos <= currentStop) {
-        double blend = (pos - lastStop) / (currentStop - lastStop);
-        return _interpolateColor(lastColor, currentColor, blend);
-      }
-      lastStop = currentStop;
-      lastColor = currentColor;
-    }
-    return colors[colors.length-1];
-  }
-}
-
-Color _interpolateColor(Color a, Color b, double blend) {
-  double aa = a.alpha.toDouble();
-  double ar = a.red.toDouble();
-  double ag = a.green.toDouble();
-  double ab = a.blue.toDouble();
-
-  double ba = b.alpha.toDouble();
-  double br = b.red.toDouble();
-  double bg = b.green.toDouble();
-  double bb = b.blue.toDouble();
-
-  int na = (aa * (1.0 - blend) + ba * blend).toInt();
-  int nr = (ar * (1.0 - blend) + br * blend).toInt();
-  int ng = (ag * (1.0 - blend) + bg * blend).toInt();
-  int nb = (ab * (1.0 - blend) + bb * blend).toInt();
-
-  return new Color.fromARGB(na, nr, ng, nb);
-}

packages/flutter_sprites/lib/src/constraint.dart

-// 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.
-
-part of flutter_sprites;
-
-/// A constraint limits or otherwise controls a [Node]'s properties, such as
-/// position or rotation. Add a list of constraints by setting the [Node]'s
-/// constraints property.
-///
-/// Constrains are applied after the update calls are
-/// completed. They can also be applied at any time by calling
-/// [Node.applyConstraints]. It's possible to create custom constraints by
-/// overriding this class and implementing the [constrain] method.
-abstract class Constraint {
-  /// Called before the node's update method is called. This method can be
-  /// overridden to create setup work that needs to happen before the the
-  /// node is updated, e.g. to calculate the node's speed.
-  void preUpdate(Node node, double dt) {
-  }
-
-  /// Called after update is complete, if the constraint has been added to a
-  /// [Node]. Override this method to modify the node's property according to
-  /// the constraint.
-  void constrain(Node node, double dt);
-}
-
-double _dampenRotation(double src, double dst, double dampening) {
-  if (dampening == null)
-    return dst;
-
-  double delta = dst - src;
-  while (delta > 180.0) delta -= 360;
-  while (delta < -180) delta += 360;
-  delta *= dampening;
-
-  return src + delta;
-}
-
-/// A [Constraint] that aligns a nodes rotation to its movement.
-class ConstraintRotationToMovement extends Constraint {
-  /// Creates a new constraint the aligns a nodes rotation to its movement
-  /// vector. A [baseRotation] and [dampening] can optionally be set.
-  ConstraintRotationToMovement({this.baseRotation: 0.0, this.dampening});
-
-  /// The filter factor used when constraining the rotation of the node. Valid
-  /// values are in the range 0.0 to 1.0
-  final double dampening;
-
-  /// The base rotation will be added to a the movement vectors rotation.
-  final double baseRotation;
-
-  Point _lastPosition;
-
-  @override
-  void preUpdate(Node node, double dt) {
-    _lastPosition = node.position;
-  }
-
-  @override
-  void constrain(Node node, double dt) {
-    if (_lastPosition == null) return;
-    if (_lastPosition == node.position) return;
-
-    // Get the target angle
-    Offset offset = node.position - _lastPosition;
-    double target = degrees(GameMath.atan2(offset.dy, offset.dx)) + baseRotation;
-
-    node.rotation = _dampenRotation(node.rotation, target, dampening);
-  }
-}
-
-/// A [Constraint] that copies a node's rotation, optionally with [dampening].
-class ConstraintRotationToNodeRotation extends Constraint {
-  /// Creates a new constraint that copies a node's rotation, optionally
-  /// with a [baseRotation] added and using [dampening].
-  ConstraintRotationToNodeRotation(this.targetNode, { this.baseRotation: 0.0, this.dampening });
-
-  /// The node to copy the rotation from
-  final Node targetNode;
-
-  /// The base rotation will be added to the rotation that copied from the targetNode
-  final double baseRotation;
-
-  /// The filter factor used when constraining the rotation of the node. Valid
-  /// values are in the range 0.0 to 1.0
-  final double dampening;
-
-  @override
-  void constrain(Node node, double dt) {
-    double target = targetNode.rotation + baseRotation;
-    node.rotation = _dampenRotation(node.rotation, target, dampening);
-  }
-}
-
-/// A [Constraint] that rotates a node to point towards another node. The target
-/// node is allowed to have a different parent, but they must be in the same
-/// [SpriteBox].
-class ConstraintRotationToNode extends Constraint {
-  /// Creates a new [Constraint] that rotates the node towards the [targetNode].
-  /// The [baseRotation] will be added to the nodes rotation, and [dampening]
-  /// can be used to ease the rotation.
-  ConstraintRotationToNode(this.targetNode, {this.baseRotation: 0.0, this.dampening});
-
-  /// The node to rotate towards.
-  final Node targetNode;
-
-  /// The base rotation will be added after the target rotation is calculated.
-  final double baseRotation;
-
-  /// The filter factor used when constraining the rotation of the node. Valid
-  /// values are in the range 0.0 to 1.0
-  final double dampening;
-
-  @override
-  void constrain(Node node, double dt) {
-    Offset offset;
-
-    if (targetNode.spriteBox != node.spriteBox) {
-      // The target node is in another sprite box or has been removed
-      return;
-    }
-
-    if (targetNode.parent == node.parent) {
-      offset = targetNode.position - node.position;
-    } else {
-      offset = node.convertPointToBoxSpace(Point.origin)
-        - targetNode.convertPointToBoxSpace(Point.origin);
-    }
-
-    double target = degrees(GameMath.atan2(offset.dy, offset.dx)) + baseRotation;
-
-    node.rotation = _dampenRotation(node.rotation, target, dampening);
-  }
-}
-
-/// A [Constraint] that constrains the position of a node to equal the position
-/// of another node, optionally with dampening.
-class ConstraintPositionToNode extends Constraint {
-  /// Creates a new [Constraint] that constrains the poistion of a node to be
-  /// equal to the position of the [targetNode]. Optionally an [offset] can
-  /// be used and also [dampening]. The targetNode doesn't need to have the
-  /// same parent, but they need to be added to the same [SpriteBox].
-  ConstraintPositionToNode(this.targetNode, {this.dampening, this.offset: Offset.zero});
-
-  /// Target node to follow.
-  final Node targetNode;
-
-  /// Offset to the target node.
-  final Offset offset;
-
-  /// Dampening used when following the [targetNode], value between 0.0 and 1.0.
-  final double dampening;
-
-  @override
-  void constrain(Node node, double dt) {
-    Point targetPosition;
-
-    if (targetNode.spriteBox != node.spriteBox || node.parent == null) {
-      // The target node is in another sprite box or has been removed
-      return;
-    }
-
-    if (targetNode.parent == node.parent) {
-      targetPosition = targetNode.position;
-    } else {
-      targetPosition = node.parent.convertPointFromNode(Point.origin, targetNode);
-    }
-
-    if (offset != null)
-      targetPosition += offset;
-
-    if (dampening == null)
-      node.position = targetPosition;
-    else
-      node.position = GameMath.filterPoint(node.position, targetPosition, dampening);
-  }
-}

packages/flutter_sprites/lib/src/effect_line.dart

-// 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.
-
-part of flutter_sprites;
-
-/// Used by [EffectLine] to determine how the width of the line is calculated.
-enum EffectLineWidthMode {
-
-  /// Linear interpolation between minWidth at the start and maxWidth at the
-  /// end of the line.
-  linear,
-
-  /// Creates a barrel shaped line, with minWidth at the end points of the line
-  /// and maxWidth at the middle.
-  barrel,
-}
-
-/// Used by [EffectLine] to determine how the texture of the line is animated.
-enum EffectLineAnimationMode {
-
-  /// The texture of the line isn't animated.
-  none,
-
-  /// The texture of the line is scrolling.
-  scroll,
-
-  /// The texture of the line is set to a random position at every frame. This
-  /// mode is useful for creating flashing or electricity styled effects.
-  random,
-}
-
-/// The EffectLine class is using the [TexturedLine] class to draw animated
-/// lines. These can be used to draw things such as smoke trails, electricity
-/// effects, or other animated types of lines.
-class EffectLine extends Node {
-
-  /// Creates a new EffectLine with the specified parameters. Only the
-  /// [texture] parameter is required, all other parameters are optional.
-  EffectLine({
-    this.texture: null,
-    this.transferMode: TransferMode.dstOver,
-    List<Point> points,
-    this.widthMode : EffectLineWidthMode.linear,
-    this.minWidth: 10.0,
-    this.maxWidth: 10.0,
-    this.widthGrowthSpeed: 0.0,
-    this.animationMode: EffectLineAnimationMode.none,
-    this.scrollSpeed: 0.1,
-    double scrollStart: 0.0,
-    this.fadeDuration: null,
-    this.fadeAfterDelay: null,
-    this.textureLoopLength: null,
-    this.simplify: true,
-    ColorSequence colorSequence
-  }) {
-    if (points == null)
-      this.points = <Point>[];
-    else
-      this.points = points;
-
-    _colorSequence = colorSequence;
-    if (_colorSequence == null) {
-      _colorSequence = new ColorSequence.fromStartAndEndColor(
-        const Color(0xffffffff),
-        const Color(0xffffffff)
-      );
-    }
-
-    _offset = scrollStart;
-
-    _painter = new TexturedLinePainter(points, _colors, _widths, texture);
-    _painter.textureLoopLength = textureLoopLength;
-  }
-
-  /// The texture used to draw the line.
-  final Texture texture;
-
-  /// The transfer mode used to draw the line, default is
-  /// [TransferMode.dstOver].
-  final TransferMode transferMode;
-
-  /// Mode used to calculate the width of the line.
-  final EffectLineWidthMode widthMode;
-
-  /// The width of the line at its thinnest point.
-  final double minWidth;
-
-  /// The width of the line at its thickest point.
-  final double maxWidth;
-
-  /// The speed at which the line is growing, defined in points per second.
-  final double widthGrowthSpeed;
-
-  /// The mode used to animate the texture of the line.
-  final EffectLineAnimationMode animationMode;
-
-  /// The speed of which the texture of the line is scrolling. This property
-  /// is only used if the [animationMode] is set to
-  /// [EffectLineAnimationMode.scroll].
-  final double scrollSpeed;
-
-  /// Color gradient used to draw the line, from start to finish.
-  ColorSequence get colorSequence => _colorSequence;
-
-  ColorSequence _colorSequence;
-
-  /// List of points that make up the line. Typically, you will only want to
-  /// set this at the beginning. Then use [addPoint] to add additional points
-  /// to the line.
-  List<Point> get points => _points;
-
-  set points(List<Point> points) {
-    _points = points;
-    _pointAges = <double>[];
-    for (int i = 0; i < _points.length; i++) {
-      _pointAges.add(0.0);
-    }
-  }
-
-  List<Point> _points;
-
-  List<double> _pointAges;
-  List<Color> _colors;
-  List<double> _widths;
-
-  /// The time it takes for an added point to fade out. It's total life time is
-  /// [fadeDuration] + [fadeAfterDelay].
-  final double fadeDuration;
-
-  /// The time it takes until an added point starts to fade out.
-  final double fadeAfterDelay;
-
-  /// The length, in points, that the texture is stretched to. If the
-  /// textureLoopLength is shorter than the line, the texture will be looped.
-  final double textureLoopLength;
-
-  /// True if the line should be simplified by removing points that are close
-  /// to other points. This makes drawing faster, but can result in a slight
-  /// jittering effect when points are added.
-  final bool simplify;
-
-  TexturedLinePainter _painter;
-  double _offset = 0.0;
-
-  @override
-  void update(double dt) {
-    // Update scrolling position
-    if (animationMode == EffectLineAnimationMode.scroll) {
-      _offset += dt * scrollSpeed;
-      _offset %= 1.0;
-    } else if (animationMode == EffectLineAnimationMode.random) {
-      _offset = randomDouble();
-    }
-
-    // Update age of line points and remove if neccesasry
-    if (fadeDuration != null && fadeAfterDelay != null) {
-      // Increase age of points
-      for (int i = _points.length - 1; i >= 0; i--) {
-        _pointAges[i] += dt;
-      }
-
-      // Check if the first/oldest point should be removed
-      while(_points.length > 0 && _pointAges[0] > (fadeDuration + fadeAfterDelay)) {
-        // Update scroll if it isn't the last and only point that is about to removed
-        if (_points.length > 1 && textureLoopLength != null) {
-          double dist = GameMath.distanceBetweenPoints(_points[0], _points[1]);
-          _offset = (_offset - (dist / textureLoopLength)) % 1.0;
-          if (_offset < 0.0) _offset += 1;
-        }
-
-        // Remove the point
-        _pointAges.removeAt(0);
-        _points.removeAt(0);
-      }
-    }
-  }
-
-  @override
-  void paint(Canvas canvas) {
-    if (points.length < 2) return;
-
-    _painter.points = points;
-
-    // Calculate colors
-    List<double> stops = _painter.calculatedTextureStops;
-
-    List<Color> colors = <Color>[];
-    for (int i = 0; i < stops.length; i++) {
-      double stop = stops[i];
-      Color color = _colorSequence.colorAtPosition(stop);
-
-      if (fadeDuration != null && fadeAfterDelay != null) {
-        double age = _pointAges[i];
-        if (age > fadeAfterDelay) {
-          double fade = 1.0 - (age - fadeAfterDelay) / fadeDuration;
-          int alpha = (color.alpha * fade).toInt().clamp(0, 255);
-          color = new Color.fromARGB(alpha, color.red, color.green, color.blue);
-        }
-      }
-      colors.add(color);
-    }
-    _painter.colors = colors;
-
-    // Calculate widths
-    List<double> widths = <double>[];
-    for (int i = 0; i < stops.length; i++) {
-      double stop = stops[i];
-      double growth = math.max(widthGrowthSpeed * _pointAges[i], 0.0);
-      if (widthMode == EffectLineWidthMode.linear) {
-        double width = minWidth + (maxWidth - minWidth) * stop + growth;
-        widths.add(width);
-      } else if (widthMode == EffectLineWidthMode.barrel) {
-        double width = minWidth + math.sin(stop * math.PI) * (maxWidth - minWidth) + growth;
-        widths.add(width);
-      }
-    }
-    _painter.widths = widths;
-
-    _painter.textureStopOffset = _offset;
-
-    _painter.paint(canvas);
-  }
-
-  /// Adds a new point to the end of the line.
-  void addPoint(Point point) {
-    // Skip duplicate points
-    if (points.length > 0 && point.x == points[points.length - 1].x && point.y == points[points.length - 1].y)
-      return;
-
-    if (simplify && points.length >= 2 && GameMath.distanceBetweenPoints(point, points[points.length - 2]) < 10.0) {
-      // Check if we should remove last point before adding the new one
-
-      // Calculate the square distance from the middle point to the line of the
-      // new point and the second to last point
-      double dist2 = _distToSeqment2(
-        points[points.length - 1],
-        point,
-        points[points.length - 2]
-      );
-
-      // If the point is on the line, remove it
-      if (dist2 < 1.0) {
-        _points.removeAt(_points.length - 1);
-      }
-    }
-
-    // Add point and point's age
-    _points.add(point);
-    _pointAges.add(0.0);
-  }
-
-  double _sqr(double x) => x * x;
-
-  double _dist2(Point v, Point w) => _sqr(v.x - w.x) + _sqr(v.y - w.y);
-
-  double _distToSeqment2(Point p, Point v, Point w) {
-    double l2 = _dist2(v, w);
-    if (l2 == 0.0) return _dist2(p, v);
-    double t = ((p.x - v.x) * (w.x - v.x) + (p.y - v.y) * (w.y - v.y)) / l2;
-    if (t < 0) return _dist2(p, v);
-    if (t > 1) return _dist2(p, w);
-    return _dist2(p, new Point(v.x + t * (w.x - v.x), v.y + t * (w.y - v.y)));
-  }
-}

packages/flutter_sprites/lib/src/image_map.dart

-// 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.
-
-part of flutter_sprites;
-
-/// The ImageMap is a helper class for loading and keeping references to
-/// multiple images.
-class ImageMap {
-
-  /// Creates a new ImageMap where images will be loaded from the specified
-  /// [bundle].
-  ImageMap(AssetBundle bundle) : _bundle = bundle;
-
-  final AssetBundle _bundle;
-  final Map<String, ui.Image> _images = new Map<String, ui.Image>();
-
-  /// Loads a list of images given their urls.
-  Future<List<ui.Image>> load(List<String> urls) {
-    return Future.wait(urls.map(_loadImage));
-  }
-
-  Future<ui.Image> _loadImage(String url) async {
-    ImageStream stream = new AssetImage(url, bundle: _bundle).resolve(ImageConfiguration.empty);
-    Completer<ui.Image> completer = new Completer<ui.Image>();
-    void listener(ImageInfo frame, bool synchronousCall) {
-      final ui.Image image = frame.image;
-      _images[url] = image;
-      completer.complete(image);
-      stream.removeListener(listener);
-    }
-    stream.addListener(listener);
-    return completer.future;
-  }
-
-  /// Returns a preloaded image, given its [url].
-  ui.Image getImage(String url) => _images[url];
-
-  /// Returns a preloaded image, given its [url].
-  ui.Image operator [](String url) => _images[url];
-}

packages/flutter_sprites/lib/src/label.dart

-// 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.
-
-part of flutter_sprites;
-
-/// Labels are used to display a string of text in a the node tree. To align
-/// the label, the textAlign property of the [TextStyle] can be set.
-class Label extends Node {
-  /// Creates a new Label with the provided [text] and [textStyle].
-  Label(this._text, {
-    TextStyle textStyle,
-    TextAlign textAlign
-  }) : _textStyle = textStyle ?? const TextStyle(),
-       textAlign = textAlign ?? TextAlign.left;
-
-  /// The text being drawn by the label.
-  String get text => _text;
-  String _text;
-  set text(String text) {
-    _text = text;
-    _painter = null;
-  }
-
-  /// The style to draw the text in.
-  TextStyle get textStyle => _textStyle;
-  TextStyle _textStyle;
-  set textStyle(TextStyle textStyle) {
-    _textStyle = textStyle;
-    _painter = null;
-  }
-
-  /// How the text should be aligned horizontally.
-  TextAlign textAlign;
-
-  TextPainter _painter;
-  double _width;
-
-  @override
-  void paint(Canvas canvas) {
-    if (_painter == null) {
-      _painter = new TextPainter(text: new TextSpan(style: _textStyle, text: _text))
-        ..layout();
-      _width = _painter.size.width;
-    }
-
-    Offset offset = Offset.zero;
-    if (textAlign == TextAlign.center) {
-      offset = new Offset(-_width / 2.0, 0.0);
-    } else if (textAlign == TextAlign.right) {
-      offset = new Offset(-_width, 0.0);
-    }
-
-    _painter.paint(canvas, offset);
-  }
-}

packages/flutter_sprites/lib/src/layer.dart

-// 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.
-
-part of flutter_sprites;
-
-/// A [Node] that provides an intermediate rendering surface in the sprite
-/// rendering tree. A [Layer] can be used to change the opacity, color, or to
-/// apply an effect to a set of nodes. All nodes that are children to the
-/// [Layer] will be rendered into the surface. If the area that is needed for
-/// the children to be drawn is know, the [layerRect] property should be set as
-/// this can enhance performance.
-class Layer extends Node with SpritePaint {
-
-  /// The area that the children of the [Layer] will occupy. This value is
-  /// treated as a hint to the rendering system and may in some cases be
-  /// ignored. If the area isn't known, the layerRect can be set to [null].
-  ///
-  ///     myLayer.layerRect = new Rect.fromLTRB(0.0, 0.0, 200.0, 100.0);
-  Rect layerRect;
-
-  /// Creates a new layer. The layerRect can optionally be passed as an argument
-  /// if it is known.
-  ///
-  ///     var myLayer = new Layer();
-  Layer([this.layerRect = null]);
-
-  Paint _cachedPaint = new Paint()
-    ..filterQuality = FilterQuality.low
-    ..isAntiAlias = false;
-
-  @override
-  void _prePaint(Canvas canvas) {
-    super._prePaint(canvas);
-
-    _updatePaint(_cachedPaint);
-    canvas.saveLayer(layerRect, _cachedPaint);
-  }
-
-  @override
-  void _postPaint(Canvas canvas) {
-    canvas.restore();
-    super._postPaint(canvas);
-  }
-}

packages/flutter_sprites/lib/src/nine_slice_sprite.dart

-// 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.
-
-part of flutter_sprites;
-
-/// A NineSliceSprite is similar to a [Sprite], but it it can strech its
-/// inner area to fit the size of the [Node]. This is ideal for fast drawing
-/// of things like buttons.
-class NineSliceSprite extends NodeWithSize with SpritePaint {
-
-  /// Creates a new NineSliceSprite from the privided [texture], [size], and
-  /// texture [insets].
-  NineSliceSprite(Texture texture, Size size, EdgeInsets insets) : super(size) {
-    assert(texture != null && !texture.rotated);
-    assert(size != null);
-    assert(insets != null);
-    pivot = const Point(0.5, 0.5);
-    this.texture = texture;
-    this.insets = insets;
-  }
-
-  /// Creates a new NineSliceSprite from the provided [image], [size], and
-  /// texture [insets].
-  NineSliceSprite.fromImage(ui.Image image, Size size, EdgeInsets insets)
-    : this(new Texture(image), size, insets);
-
-  /// The texture that the sprite will render to screen. Cannot be null.
-  ///
-  ///     my9Sprite.texture = myTexture;
-  Texture get texture => _texture;
-
-  Texture _texture;
-
-  set texture(Texture texture) {
-    _texture = texture;
-    _isDirty = true;
-    if (texture == null) {
-      _cachedPaint = new Paint();
-    } else {
-      Matrix4 matrix = new Matrix4.identity();
-      ImageShader shader = new ImageShader(texture.image,
-        TileMode.repeated, TileMode.repeated, matrix.storage);
-
-      _cachedPaint = new Paint()
-        ..shader = shader;
-    }
-  }
-
-  /// The insets of the texture as normalized values. The insets define the
-  /// areas of the texture that will not be deformed as the sprite stretches.
-  EdgeInsets get insets => _insets;
-
-  EdgeInsets _insets;
-
-  set insets(EdgeInsets insets) {
-    assert(insets != null);
-    _insets = insets;
-    _isDirty = true;
-  }
-
-  /// If true, the center part of the sprite will be drawn, this is the default
-  /// behavior.
-  bool get drawCenterPart => _drawCenterPart;
-
-  bool _drawCenterPart = true;
-
-  set drawCenterPart(bool drawCenterPart) {
-    _drawCenterPart = drawCenterPart;
-    _isDirty = true;
-  }
-
-  @override
-  set size(Size size) {
-    super.size = size;
-    _isDirty = true;
-  }
-
-  Paint _cachedPaint = new Paint()
-    ..filterQuality = FilterQuality.low
-    ..isAntiAlias = false;
-
-  // Cached values.
-  bool _isDirty = true;
-  List<Point> _vertices;
-  List<Point> _textureCoordinates;
-  List<Color> _colors;
-  List<int> _indices;
-
-  @override
-  void paint(Canvas canvas) {
-    applyTransformForPivot(canvas);
-
-    // Setup paint object for opacity and transfer mode.
-    _updatePaint(_cachedPaint);
-
-    if (_isDirty) {
-      // Calcuate vertices and indices.
-      _vertices = <Point>[
-        Point.origin,
-
-      ];
-
-      // Texture width and height.
-      double tw = texture.frame.width;
-      double th = texture.frame.height;
-      _textureCoordinates = <Point>[];
-      _vertices = <Point>[];
-      _colors = <Color>[];
-
-      for (int y = 0; y < 4; y += 1) {
-        double vy;
-        double ty;
-
-        switch(y) {
-          case 0:
-            vy = 0.0;
-            ty = texture.frame.top;
-            break;
-          case 1:
-            vy = insets.top * th;
-            ty = texture.frame.top + insets.top * th;
-            break;
-          case 2:
-            vy = size.height - insets.bottom * th;
-            ty = texture.frame.bottom - insets.bottom * th;
-            break;
-          case 3:
-            vy = size.height;
-            ty = texture.frame.bottom;
-            break;
-        }
-
-        for (int x = 0; x < 4; x += 1) {
-          double vx;
-          double tx;
-
-          switch(x) {
-            case 0:
-              vx = 0.0;
-              tx = texture.frame.left;
-              break;
-            case 1:
-              vx = insets.left * tw;
-              tx = texture.frame.left + insets.left * tw;
-              break;
-            case 2:
-              vx = size.width - insets.right * tw;
-              tx = texture.frame.right - insets.right * tw;
-              break;
-            case 3:
-              vx = size.width;
-              tx = texture.frame.right;
-              break;
-          }
-
-          _vertices.add(new Point(vx, vy));
-          _textureCoordinates.add(new Point(tx, ty));
-          _colors.add(const Color(0xffffffff));
-        }
-      }
-
-      // Build indices.
-      _indices = <int>[];
-      for (int y = 0; y < 3; y += 1) {
-        for (int x = 0; x < 3; x += 1) {
-          // Check if we should skip the middle rectangle.
-          if (!drawCenterPart && x == 1 && y == 1)
-            continue;
-
-          // Add a rectangle (two triangles).
-          int index = y * 4 + x;
-
-          _indices.add(index);
-          _indices.add(index + 1);
-          _indices.add(index + 4);
-
-          _indices.add(index + 1);
-          _indices.add(index + 5);
-          _indices.add(index + 4);
-        }
-      }
-    }
-
-    canvas.drawVertices(
-      VertexMode.triangles,
-      _vertices,
-      _textureCoordinates,
-      _colors,
-      TransferMode.modulate,
-      _indices,
-      _cachedPaint
-    );
-  }
-}

packages/flutter_sprites/lib/src/node3d.dart

-// 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.
-
-part of flutter_sprites;
-
-/// An node that transforms its children using a 3D perspective projection. This
-/// node type can be used to create 3D flips and other similar effects.
-///
-///     var myNode3D = new Node3D();
-///     myNode3D.rotationY = 45.0;
-///     myNode3D.addChild(new Sprite(myTexture));
-class Node3D extends Node {
-
-  double _rotationX = 0.0;
-
-  /// The node's rotation around the x axis in degrees.
-  double get rotationX => _rotationX;
-
-  set rotationX(double rotationX) {
-    _rotationX = rotationX;
-    invalidateTransformMatrix();
-  }
-
-  double _rotationY = 0.0;
-
-  /// The node's rotation around the y axis in degrees.
-  double get rotationY => _rotationY;
-
-  set rotationY(double rotationY) {
-    _rotationY = rotationY;
-    invalidateTransformMatrix();
-  }
-
-  double _projectionDepth = 500.0;
-
-  /// The projection depth. Default value is 500.0.
-  double get projectionDepth => _projectionDepth;
-
-  set projectionDepth(double projectionDepth) {
-    _projectionDepth = projectionDepth;
-    invalidateTransformMatrix();
-  }
-
-  @override
-  Matrix4 computeTransformMatrix() {
-    // Apply normal 2d transforms
-    Matrix4 matrix = super.computeTransformMatrix();
-
-    // Apply perspective projection
-    Matrix4 projection = new Matrix4(1.0, 0.0, 0.0, 0.0,
-                                     0.0, 1.0, 0.0, 0.0,
-                                     0.0, 0.0, 1.0, -1.0/_projectionDepth,
-                                     0.0, 0.0, 0.0, 1.0);
-    matrix.multiply(projection);
-
-    // Rotate around x and y axis
-    matrix.rotateY(radians(_rotationY));
-    matrix.rotateX(radians(_rotationX));
-
-    return matrix;
-  }
-}

packages/flutter_sprites/lib/src/node_with_size.dart

-// 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.
-
-part of flutter_sprites;
-
-/// The super class of any [Node] that has a size.
-///
-/// NodeWithSize adds the ability for a node to have a size and a pivot point.
-class NodeWithSize extends Node {
-
-  /// Changing the size will affect the size of the rendering of the node.
-  ///
-  ///     myNode.size = new Size(1024.0, 1024.0);
-  Size size;
-
-  /// The normalized point which the node is transformed around.
-  ///
-  ///     // Position myNode from is middle top
-  ///     myNode.pivot = new Point(0.5, 0.0);
-  Point pivot;
-
-  /// Creates a new NodeWithSize.
-  ///
-  /// The default [size] is zero and the default [pivot] point is the origin. Subclasses may change the default values.
-  ///
-  ///     var myNodeWithSize = new NodeWithSize(new Size(1024.0, 1024.0));
-  NodeWithSize(this.size) {
-    if (size == null)
-      size = Size.zero;
-    pivot = Point.origin;
-  }
-
-  /// Call this method in your [paint] method if you want the origin of your drawing to be the top left corner of the
-  /// node's bounding box.
-  ///
-  /// If you use this method you will need to save and restore your canvas at the beginning and
-  /// end of your [paint] method.
-  ///
-  ///     void paint(Canvas canvas) {
-  ///       canvas.save();
-  ///       applyTransformForPivot(canvas);
-  ///
-  ///       // Do painting here
-  ///
-  ///       canvas.restore();
-  ///     }
-  void applyTransformForPivot(Canvas canvas) {
-    if (pivot.x != 0 || pivot.y != 0) {
-      double pivotInPointsX = size.width * pivot.x;
-      double pivotInPointsY = size.height * pivot.y;
-      canvas.translate(-pivotInPointsX, -pivotInPointsY);
-    }
-  }
-
-  @override
-  bool isPointInside (Point nodePoint) {
-
-    double minX = -size.width * pivot.x;
-    double minY = -size.height * pivot.y;
-    double maxX = minX + size.width;
-    double maxY = minY + size.height;
-    return (nodePoint.x >= minX && nodePoint.x < maxX &&
-            nodePoint.y >= minY && nodePoint.y < maxY);
-  }
-}

packages/flutter_sprites/lib/src/sprite.dart

-// 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.
-
-part of flutter_sprites;
-
-/// A Sprite is a [Node] that renders a bitmap image to the screen.
-class Sprite extends NodeWithSize with SpritePaint {
-
-  /// The texture that the sprite will render to screen.
-  ///
-  /// If the texture is null, the sprite will be rendered as a red square
-  /// marking the bounds of the sprite.
-  ///
-  ///     mySprite.texture = myTexture;
-  Texture texture;
-
-  /// If true, constrains the proportions of the image by scaling it down, if its proportions doesn't match the [size].
-  ///
-  ///     mySprite.constrainProportions = true;
-  bool constrainProportions = false;
-
-  Paint _cachedPaint = new Paint()
-    ..filterQuality = FilterQuality.low
-    ..isAntiAlias = false;
-
-  /// Creates a new sprite from the provided [texture].
-  ///
-  ///     var mySprite = new Sprite(myTexture)
-  Sprite([this.texture]) : super(Size.zero) {
-    if (texture != null) {
-      size = texture.size;
-      pivot = texture.pivot;
-    } else {
-      pivot = new Point(0.5, 0.5);
-    }
-  }
-
-  /// Creates a new sprite from the provided [image].
-  ///
-  /// var mySprite = new Sprite.fromImage(myImage);
-  Sprite.fromImage(ui.Image image) : super(Size.zero) {
-    assert(image != null);
-
-    texture = new Texture(image);
-    size = texture.size;
-
-    pivot = new Point(0.5, 0.5);
-  }
-
-  @override
-  void paint(Canvas canvas) {
-    // Account for pivot point
-    applyTransformForPivot(canvas);
-
-    if (texture != null) {
-      double w = texture.size.width;
-      double h = texture.size.height;
-
-      if (w <= 0 || h <= 0) return;
-
-      double scaleX = size.width / w;
-      double scaleY = size.height / h;
-
-      if (constrainProportions) {
-        // Constrain proportions, using the smallest scale and by centering the image
-        if (scaleX < scaleY) {
-          canvas.translate(0.0, (size.height - scaleX * h) / 2.0);
-          scaleY = scaleX;
-        } else {
-          canvas.translate((size.width - scaleY * w) / 2.0, 0.0);
-          scaleX = scaleY;
-        }
-      }
-
-      canvas.scale(scaleX, scaleY);
-
-      // Setup paint object for opacity and transfer mode
-      _updatePaint(_cachedPaint);
-
-      // Do actual drawing of the sprite
-      texture.drawTexture(canvas, Point.origin, _cachedPaint);
-    } else {
-      // Paint a red square for missing texture
-      canvas.drawRect(new Rect.fromLTRB(0.0, 0.0, size.width, size.height),
-      new Paint()..color = new Color.fromARGB(255, 255, 0, 0));
-    }
-  }
-}
-
-/// Defines properties, such as [opacity] and [transferMode] that are shared
-/// between [Node]s that render textures to screen.
-abstract class SpritePaint {
-  double _opacity = 1.0;
-
-  /// The opacity of the sprite in the range 0.0 to 1.0.
-  ///
-  ///     mySprite.opacity = 0.5;
-  double get opacity => _opacity;
-
-  set opacity(double opacity) {
-    assert(opacity != null);
-    assert(opacity >= 0.0 && opacity <= 1.0);
-    _opacity = opacity;
-  }
-
-  /// The color to draw on top of the sprite, null if no color overlay is used.
-  ///
-  ///     // Color the sprite red
-  ///     mySprite.colorOverlay = new Color(0x77ff0000);
-  Color colorOverlay;
-
-  /// The transfer mode used when drawing the sprite to screen.
-  ///
-  ///     // Add the colors of the sprite with the colors of the background
-  ///     mySprite.transferMode = TransferMode.plusMode;
-  TransferMode transferMode;
-
-  void _updatePaint(Paint paint) {
-    paint.color = new Color.fromARGB((255.0*_opacity).toInt(), 255, 255, 255);
-
-    if (colorOverlay != null) {
-      paint.colorFilter = new ColorFilter.mode(colorOverlay, TransferMode.srcATop);
-    }
-
-    if (transferMode != null) {
-      paint.transferMode = transferMode;
-    }
-  }
-}

packages/flutter_sprites/lib/src/sprite_widget.dart

-// 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.
-
-part of flutter_sprites;
-
-/// A widget that uses a [SpriteBox] to render a sprite node tree to the screen.
-class SpriteWidget extends SingleChildRenderObjectWidget {
-
-  /// The rootNode of the sprite node tree.
-  ///
-  ///     var node = mySpriteWidget.rootNode;
-  final NodeWithSize rootNode;
-
-  /// The transform mode used to fit the sprite node tree to the size of the widget.
-  final SpriteBoxTransformMode transformMode;
-
-  /// Creates a new sprite widget with [rootNode] as its content.
-  ///
-  /// The widget will setup the coordinate space for the sprite node tree using the size of the [rootNode] in
-  /// combination with the supplied [transformMode]. By default the letterbox transform mode is used. See
-  /// [SpriteBoxTransformMode] for more details on the different modes.
-  ///
-  /// The most common way to setup the sprite node graph is to subclass [NodeWithSize] and pass it to the sprite widget.
-  /// In the custom subclass it's possible to build the node graph, do animations and handle user events.
-  ///
-  ///     var mySpriteTree = new MyCustomNodeWithSize();
-  ///     var mySpriteWidget = new SpriteWidget(mySpriteTree, SpriteBoxTransformMode.fixedHeight);
-  SpriteWidget(this.rootNode, [this.transformMode = SpriteBoxTransformMode.letterbox]);
-
-  @override
-  SpriteBox createRenderObject(BuildContext context) => new SpriteBox(rootNode, transformMode);
-
-  @override
-  void updateRenderObject(BuildContext context, SpriteBox renderObject) {
-    renderObject
-      ..rootNode = rootNode
-      ..transformMode = transformMode;
-  }
-}

packages/flutter_sprites/pubspec.yaml

-name: flutter_sprites
-description: A sprite toolkit built on top of Flutter
-version: 0.0.15
-author: Flutter Authors <flutter-dev@googlegroups.com>
-homepage: http://flutter.io
-
-dependencies:
-  box2d: '>=0.3.0 <0.4.0'
-  flutter:
-    path: ../flutter
-
-dev_dependencies:
-  flutter_test:
-    path: ../flutter_test

packages/flutter_sprites/test/color_sequence_test.dart

-// 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';
-
-import 'package:flutter_sprites/flutter_sprites.dart';
-import 'package:test/test.dart';
-
-void main() {
-  test("Simple test of ColorSequence", () {
-    List<Color> colors = <Color>[const Color(0xFFFFFFFF), const Color(0x000000FF)];
-    List<double> stops = <double>[0.0, 1.0];
-    ColorSequence cs = new ColorSequence(colors, stops);
-    expect(cs.colorAtPosition(0.0), equals(const Color(0xFFFFFFFF)));
-    expect(cs.colorAtPosition(0.5), equals(const Color(0x7F7F7FFF)));
-    expect(cs.colorAtPosition(1.0), equals(const Color(0x000000FF)));
-  });
-}