velocity_tracker.dart 8.86 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 6
// @dart = 2.8

7
import 'dart:ui' show Offset;
8

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

11 12
import 'lsq_solver.dart';

13
export 'dart:ui' show Offset;
14

15
/// A velocity in two dimensions.
16
@immutable
17
class Velocity {
18 19 20
  /// Creates a velocity.
  ///
  /// The [pixelsPerSecond] argument must not be null.
21 22 23
  const Velocity({
    @required this.pixelsPerSecond,
  }) : assert(pixelsPerSecond != null);
24 25

  /// A velocity that isn't moving at all.
26
  static const Velocity zero = Velocity(pixelsPerSecond: Offset.zero);
27 28 29 30

  /// The number of pixels per second of velocity in the x and y directions.
  final Offset pixelsPerSecond;

31
  /// Return the negation of a velocity.
32
  Velocity operator -() => Velocity(pixelsPerSecond: -pixelsPerSecond);
33 34

  /// Return the difference of two velocities.
35
  Velocity operator -(Velocity other) {
36
    return Velocity(
37 38
        pixelsPerSecond: pixelsPerSecond - other.pixelsPerSecond);
  }
39 40

  /// Return the sum of two velocities.
41
  Velocity operator +(Velocity other) {
42
    return Velocity(
43 44 45
        pixelsPerSecond: pixelsPerSecond + other.pixelsPerSecond);
  }

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
  /// Return a velocity whose magnitude has been clamped to [minValue]
  /// and [maxValue].
  ///
  /// If the magnitude of this Velocity is less than minValue then return a new
  /// Velocity with the same direction and with magnitude [minValue]. Similarly,
  /// if the magnitude of this Velocity is greater than maxValue then return a
  /// new Velocity with the same direction and magnitude [maxValue].
  ///
  /// If the magnitude of this Velocity is within the specified bounds then
  /// just return this.
  Velocity clampMagnitude(double minValue, double maxValue) {
    assert(minValue != null && minValue >= 0.0);
    assert(maxValue != null && maxValue >= 0.0 && maxValue >= minValue);
    final double valueSquared = pixelsPerSecond.distanceSquared;
    if (valueSquared > maxValue * maxValue)
61
      return Velocity(pixelsPerSecond: (pixelsPerSecond / pixelsPerSecond.distance) * maxValue);
62
    if (valueSquared < minValue * minValue)
63
      return Velocity(pixelsPerSecond: (pixelsPerSecond / pixelsPerSecond.distance) * minValue);
64 65 66
    return this;
  }

67
  @override
68
  bool operator ==(Object other) {
69 70
    return other is Velocity
        && other.pixelsPerSecond == pixelsPerSecond;
71 72
  }

73
  @override
74 75
  int get hashCode => pixelsPerSecond.hashCode;

76
  @override
77 78 79
  String toString() => 'Velocity(${pixelsPerSecond.dx.toStringAsFixed(1)}, ${pixelsPerSecond.dy.toStringAsFixed(1)})';
}

80 81 82
/// A two dimensional velocity estimate.
///
/// VelocityEstimates are computed by [VelocityTracker.getVelocityEstimate]. An
83
/// estimate's [confidence] measures how well the velocity tracker's position
84 85 86 87 88 89
/// data fit a straight line, [duration] is the time that elapsed between the
/// first and last position sample used to compute the velocity, and [offset]
/// is similarly the difference between the first and last positions.
///
/// See also:
///
90 91
///  * [VelocityTracker], which computes [VelocityEstimate]s.
///  * [Velocity], which encapsulates (just) a velocity vector and provides some
92 93 94
///    useful velocity operations.
class VelocityEstimate {
  /// Creates a dimensional velocity estimate.
95 96
  ///
  /// [pixelsPerSecond], [confidence], [duration], and [offset] must not be null.
97
  const VelocityEstimate({
98 99 100 101
    @required this.pixelsPerSecond,
    @required this.confidence,
    @required this.duration,
    @required this.offset,
102 103 104 105
  }) : assert(pixelsPerSecond != null),
       assert(confidence != null),
       assert(duration != null),
       assert(offset != null);
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124

  /// The number of pixels per second of velocity in the x and y directions.
  final Offset pixelsPerSecond;

  /// A value between 0.0 and 1.0 that indicates how well [VelocityTracker]
  /// was able to fit a straight line to its position data.
  ///
  /// The value of this property is 1.0 for a perfect fit, 0.0 for a poor fit.
  final double confidence;

  /// The time that elapsed between the first and last position sample used
  /// to compute [pixelsPerSecond].
  final Duration duration;

  /// The difference between the first and last position sample used
  /// to compute [pixelsPerSecond].
  final Offset offset;

  @override
125
  String toString() => 'VelocityEstimate(${pixelsPerSecond.dx.toStringAsFixed(1)}, ${pixelsPerSecond.dy.toStringAsFixed(1)}; offset: $offset, duration: $duration, confidence: ${confidence.toStringAsFixed(1)})';
126 127 128
}

class _PointAtTime {
129
  const _PointAtTime(this.point, this.time)
130 131
    : assert(point != null),
      assert(time != null);
132 133

  final Duration time;
134
  final Offset point;
135 136 137 138 139

  @override
  String toString() => '_PointAtTime($point at $time)';
}

140
/// Computes a pointer's velocity based on data from [PointerMoveEvent]s.
141
///
142
/// The input data is provided by calling [addPosition]. Adding data is cheap.
143
///
144 145 146
/// To obtain a velocity, call [getVelocity] or [getVelocityEstimate]. This will
/// compute the velocity based on the data added so far. Only call these when
/// you need to use the velocity, as they are comparatively expensive.
147
///
148 149
/// The quality of the velocity estimation will be better if more data points
/// have been received.
150
class VelocityTracker {
151 152 153 154
  static const int _assumePointerMoveStoppedMilliseconds = 40;
  static const int _historySize = 20;
  static const int _horizonMilliseconds = 100;
  static const int _minSampleSize = 3;
155

156
  // Circular buffer; current sample at _index.
157
  final List<_PointAtTime> _samples = List<_PointAtTime>(_historySize);
158
  int _index = 0;
159

Adam Barth's avatar
Adam Barth committed
160
  /// Adds a position as the given time to the tracker.
161
  void addPosition(Duration time, Offset position) {
162
    _index += 1;
163
    if (_index == _historySize)
164
      _index = 0;
165
    _samples[_index] = _PointAtTime(position, time);
166 167
  }

Adam Barth's avatar
Adam Barth committed
168 169
  /// Returns an estimate of the velocity of the object being tracked by the
  /// tracker given the current information available to the tracker.
170 171 172 173
  ///
  /// Information is added using [addPosition].
  ///
  /// Returns null if there is no data on which to base an estimate.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
  VelocityEstimate getVelocityEstimate() {
    final List<double> x = <double>[];
    final List<double> y = <double>[];
    final List<double> w = <double>[];
    final List<double> time = <double>[];
    int sampleCount = 0;
    int index = _index;

    final _PointAtTime newestSample = _samples[index];
    if (newestSample == null)
      return null;

    _PointAtTime previousSample = newestSample;
    _PointAtTime oldestSample = newestSample;

    // Starting with the most recent PointAtTime sample, iterate backwards while
    // the samples represent continuous motion.
    do {
      final _PointAtTime sample = _samples[index];
      if (sample == null)
        break;

      final double age = (newestSample.time - sample.time).inMilliseconds.toDouble();
      final double delta = (sample.time - previousSample.time).inMilliseconds.abs().toDouble();
      previousSample = sample;
199
      if (age > _horizonMilliseconds || delta > _assumePointerMoveStoppedMilliseconds)
200 201 202
        break;

      oldestSample = sample;
203 204 205
      final Offset position = sample.point;
      x.add(position.dx);
      y.add(position.dy);
206 207
      w.add(1.0);
      time.add(-age);
208
      index = (index == 0 ? _historySize : index) - 1;
209

210
      sampleCount += 1;
211
    } while (sampleCount < _historySize);
212

213
    if (sampleCount >= _minSampleSize) {
214
      final LeastSquaresSolver xSolver = LeastSquaresSolver(time, x, w);
215 216
      final PolynomialFit xFit = xSolver.solve(2);
      if (xFit != null) {
217
        final LeastSquaresSolver ySolver = LeastSquaresSolver(time, y, w);
218 219
        final PolynomialFit yFit = ySolver.solve(2);
        if (yFit != null) {
220 221
          return VelocityEstimate( // convert from pixels/ms to pixels/s
            pixelsPerSecond: Offset(xFit.coefficients[1] * 1000, yFit.coefficients[1] * 1000),
222 223 224 225 226 227 228 229 230 231
            confidence: xFit.confidence * yFit.confidence,
            duration: newestSample.time - oldestSample.time,
            offset: newestSample.point - oldestSample.point,
          );
        }
      }
    }

    // We're unable to make a velocity estimate but we did have at least one
    // valid pointer position.
232
    return VelocityEstimate(
233 234 235 236 237
      pixelsPerSecond: Offset.zero,
      confidence: 1.0,
      duration: newestSample.time - oldestSample.time,
      offset: newestSample.point - oldestSample.point,
    );
238 239
  }

240 241 242 243 244
  /// Computes the velocity of the pointer at the time of the last
  /// provided data point.
  ///
  /// This can be expensive. Only call this when you need the velocity.
  ///
245 246
  /// Returns [Velocity.zero] if there is no data from which to compute an
  /// estimate or if the estimated velocity is zero.
247
  Velocity getVelocity() {
248 249
    final VelocityEstimate estimate = getVelocityEstimate();
    if (estimate == null || estimate.pixelsPerSecond == Offset.zero)
250
      return Velocity.zero;
251
    return Velocity(pixelsPerSecond: estimate.pixelsPerSecond);
252 253
  }
}