velocity_tracker.dart 8.9 KB
Newer Older
1 2 3 4
// 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.

5
import 'dart:ui' show Offset;
6

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

9 10
import 'lsq_solver.dart';

11
export 'dart:ui' show Offset;
12

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

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

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

28
  /// Return the negation of a velocity.
29
  Velocity operator -() => Velocity(pixelsPerSecond: -pixelsPerSecond);
30 31

  /// Return the difference of two velocities.
32
  Velocity operator -(Velocity other) {
33
    return Velocity(
34 35
        pixelsPerSecond: pixelsPerSecond - other.pixelsPerSecond);
  }
36 37

  /// Return the sum of two velocities.
38
  Velocity operator +(Velocity other) {
39
    return Velocity(
40 41 42
        pixelsPerSecond: pixelsPerSecond + other.pixelsPerSecond);
  }

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
  /// 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)
58
      return Velocity(pixelsPerSecond: (pixelsPerSecond / pixelsPerSecond.distance) * maxValue);
59
    if (valueSquared < minValue * minValue)
60
      return Velocity(pixelsPerSecond: (pixelsPerSecond / pixelsPerSecond.distance) * minValue);
61 62 63
    return this;
  }

64
  @override
65 66 67 68 69 70 71
  bool operator ==(dynamic other) {
    if (other is! Velocity)
      return false;
    final Velocity typedOther = other;
    return pixelsPerSecond == typedOther.pixelsPerSecond;
  }

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

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

79 80 81
/// A two dimensional velocity estimate.
///
/// VelocityEstimates are computed by [VelocityTracker.getVelocityEstimate]. An
82
/// estimate's [confidence] measures how well the velocity tracker's position
83 84 85 86 87 88 89 90 91 92 93
/// 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:
///
///  * VelocityTracker, which computes [VelocityEstimate]s.
///  * Velocity, which encapsulates (just) a velocity vector and provides some
///    useful velocity operations.
class VelocityEstimate {
  /// Creates a dimensional velocity estimate.
94 95
  ///
  /// [pixelsPerSecond], [confidence], [duration], and [offset] must not be null.
96
  const VelocityEstimate({
97 98 99 100
    @required this.pixelsPerSecond,
    @required this.confidence,
    @required this.duration,
    @required this.offset,
101 102 103 104
  }) : assert(pixelsPerSecond != null),
       assert(confidence != null),
       assert(duration != null),
       assert(offset != null);
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

  /// 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
124
  String toString() => 'VelocityEstimate(${pixelsPerSecond.dx.toStringAsFixed(1)}, ${pixelsPerSecond.dy.toStringAsFixed(1)}; offset: $offset, duration: $duration, confidence: ${confidence.toStringAsFixed(1)})';
125 126 127
}

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

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

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

139
/// Computes a pointer's velocity based on data from [PointerMoveEvent]s.
140
///
141
/// The input data is provided by calling [addPosition]. Adding data is cheap.
142
///
143 144 145
/// 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.
146
///
147 148
/// The quality of the velocity estimation will be better if more data points
/// have been received.
149
class VelocityTracker {
150 151 152 153
  static const int _assumePointerMoveStoppedMilliseconds = 40;
  static const int _historySize = 20;
  static const int _horizonMilliseconds = 100;
  static const int _minSampleSize = 3;
154

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

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

Adam Barth's avatar
Adam Barth committed
167 168
  /// Returns an estimate of the velocity of the object being tracked by the
  /// tracker given the current information available to the tracker.
169 170 171 172
  ///
  /// Information is added using [addPosition].
  ///
  /// Returns null if there is no data on which to base an estimate.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
  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;
198
      if (age > _horizonMilliseconds || delta > _assumePointerMoveStoppedMilliseconds)
199 200 201
        break;

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

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

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

239 240 241 242 243
  /// 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.
  ///
244 245
  /// Returns [Velocity.zero] if there is no data from which to compute an
  /// estimate or if the estimated velocity is zero.
246
  Velocity getVelocity() {
247 248
    final VelocityEstimate estimate = getVelocityEstimate();
    if (estimate == null || estimate.pixelsPerSecond == Offset.zero)
249
      return Velocity.zero;
250
    return Velocity(pixelsPerSecond: estimate.pixelsPerSecond);
251 252
  }
}