drag_details.dart 8.9 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
import 'dart:ui' show Offset, PointerDeviceKind;
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

import 'package:flutter/foundation.dart';

import 'velocity_tracker.dart';

/// Details object for callbacks that use [GestureDragDownCallback].
///
/// See also:
///
///  * [DragGestureRecognizer.onDown], which uses [GestureDragDownCallback].
///  * [DragStartDetails], the details for [GestureDragStartCallback].
///  * [DragUpdateDetails], the details for [GestureDragUpdateCallback].
///  * [DragEndDetails], the details for [GestureDragEndCallback].
class DragDownDetails {
  /// Creates details for a [GestureDragDownCallback].
  ///
  /// The [globalPosition] argument must not be null.
24 25
  DragDownDetails({
    this.globalPosition = Offset.zero,
26
    Offset? localPosition,
27 28
  }) : assert(globalPosition != null),
       localPosition = localPosition ?? globalPosition;
29 30 31 32

  /// The global position at which the pointer contacted the screen.
  ///
  /// Defaults to the origin if not specified in the constructor.
33 34 35 36 37
  ///
  /// See also:
  ///
  ///  * [localPosition], which is the [globalPosition] transformed to the
  ///    coordinate space of the event receiver.
38 39
  final Offset globalPosition;

40 41 42 43 44 45
  /// The local position in the coordinate system of the event receiver at
  /// which the pointer contacted the screen.
  ///
  /// Defaults to [globalPosition] if not specified in the constructor.
  final Offset localPosition;

46
  @override
47
  String toString() => '${objectRuntimeType(this, 'DragDownDetails')}($globalPosition)';
48 49 50 51 52 53 54 55
}

/// Signature for when a pointer has contacted the screen and might begin to
/// move.
///
/// The `details` object provides the position of the touch.
///
/// See [DragGestureRecognizer.onDown].
56
typedef GestureDragDownCallback = void Function(DragDownDetails details);
57 58 59 60 61 62 63 64 65 66 67 68 69

/// Details object for callbacks that use [GestureDragStartCallback].
///
/// See also:
///
///  * [DragGestureRecognizer.onStart], which uses [GestureDragStartCallback].
///  * [DragDownDetails], the details for [GestureDragDownCallback].
///  * [DragUpdateDetails], the details for [GestureDragUpdateCallback].
///  * [DragEndDetails], the details for [GestureDragEndCallback].
class DragStartDetails {
  /// Creates details for a [GestureDragStartCallback].
  ///
  /// The [globalPosition] argument must not be null.
70 71 72
  DragStartDetails({
    this.sourceTimeStamp,
    this.globalPosition = Offset.zero,
73
    Offset? localPosition,
74
    this.kind,
75 76
  }) : assert(globalPosition != null),
       localPosition = localPosition ?? globalPosition;
77

78 79 80 81
  /// Recorded timestamp of the source pointer event that triggered the drag
  /// event.
  ///
  /// Could be null if triggered from proxied events such as accessibility.
82
  final Duration? sourceTimeStamp;
83

84 85 86
  /// The global position at which the pointer contacted the screen.
  ///
  /// Defaults to the origin if not specified in the constructor.
87 88 89 90 91
  ///
  /// See also:
  ///
  ///  * [localPosition], which is the [globalPosition] transformed to the
  ///    coordinate space of the event receiver.
92 93
  final Offset globalPosition;

94 95 96 97 98 99
  /// The local position in the coordinate system of the event receiver at
  /// which the pointer contacted the screen.
  ///
  /// Defaults to [globalPosition] if not specified in the constructor.
  final Offset localPosition;

100 101 102
  /// The kind of the device that initiated the event.
  final PointerDeviceKind? kind;

103 104 105 106
  // TODO(ianh): Expose the current position, so that you can have a no-jump
  // drag even when disambiguating (though of course it would lag the finger
  // instead).

107
  @override
108
  String toString() => '${objectRuntimeType(this, 'DragStartDetails')}($globalPosition)';
109 110 111 112 113 114 115 116
}

/// Signature for when a pointer has contacted the screen and has begun to move.
///
/// The `details` object provides the position of the touch when it first
/// touched the surface.
///
/// See [DragGestureRecognizer.onStart].
117
typedef GestureDragStartCallback = void Function(DragStartDetails details);
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

/// Details object for callbacks that use [GestureDragUpdateCallback].
///
/// See also:
///
///  * [DragGestureRecognizer.onUpdate], which uses [GestureDragUpdateCallback].
///  * [DragDownDetails], the details for [GestureDragDownCallback].
///  * [DragStartDetails], the details for [GestureDragStartCallback].
///  * [DragEndDetails], the details for [GestureDragEndCallback].
class DragUpdateDetails {
  /// Creates details for a [DragUpdateDetails].
  ///
  /// The [delta] argument must not be null.
  ///
  /// If [primaryDelta] is non-null, then its value must match one of the
  /// coordinates of [delta] and the other coordinate must be zero.
  ///
  /// The [globalPosition] argument must be provided and must not be null.
  DragUpdateDetails({
137
    this.sourceTimeStamp,
138
    this.delta = Offset.zero,
139
    this.primaryDelta,
140 141
    required this.globalPosition,
    Offset? localPosition,
142 143 144
  }) : assert(delta != null),
       assert(primaryDelta == null
           || (primaryDelta == delta.dx && delta.dy == 0.0)
145 146
           || (primaryDelta == delta.dy && delta.dx == 0.0)),
       localPosition = localPosition ?? globalPosition;
147

148 149 150 151
  /// Recorded timestamp of the source pointer event that triggered the drag
  /// event.
  ///
  /// Could be null if triggered from proxied events such as accessibility.
152
  final Duration? sourceTimeStamp;
153

154 155
  /// The amount the pointer has moved in the coordinate space of the event
  /// receiver since the previous update.
156 157 158 159 160 161 162 163
  ///
  /// If the [GestureDragUpdateCallback] is for a one-dimensional drag (e.g.,
  /// a horizontal or vertical drag), then this offset contains only the delta
  /// in that direction (i.e., the coordinate in the other direction is zero).
  ///
  /// Defaults to zero if not specified in the constructor.
  final Offset delta;

164 165
  /// The amount the pointer has moved along the primary axis in the coordinate
  /// space of the event receiver since the previous
166 167 168 169 170 171 172 173 174
  /// update.
  ///
  /// If the [GestureDragUpdateCallback] is for a one-dimensional drag (e.g.,
  /// a horizontal or vertical drag), then this value contains the component of
  /// [delta] along the primary axis (e.g., horizontal or vertical,
  /// respectively). Otherwise, if the [GestureDragUpdateCallback] is for a
  /// two-dimensional drag (e.g., a pan), then this value is null.
  ///
  /// Defaults to null if not specified in the constructor.
175
  final double? primaryDelta;
176 177

  /// The pointer's global position when it triggered this update.
178 179 180 181 182
  ///
  /// See also:
  ///
  ///  * [localPosition], which is the [globalPosition] transformed to the
  ///    coordinate space of the event receiver.
183
  final Offset globalPosition;
184 185 186 187 188 189

  /// The local position in the coordinate system of the event receiver at
  /// which the pointer contacted the screen.
  ///
  /// Defaults to [globalPosition] if not specified in the constructor.
  final Offset localPosition;
190 191

  @override
192
  String toString() => '${objectRuntimeType(this, 'DragUpdateDetails')}($delta)';
193 194 195 196 197 198
}

/// Signature for when a pointer that is in contact with the screen and moving
/// has moved again.
///
/// The `details` object provides the position of the touch and the distance it
199
/// has traveled since the last update.
200 201
///
/// See [DragGestureRecognizer.onUpdate].
202
typedef GestureDragUpdateCallback = void Function(DragUpdateDetails details);
203 204 205 206 207 208 209 210 211 212 213 214 215 216

/// Details object for callbacks that use [GestureDragEndCallback].
///
/// See also:
///
///  * [DragGestureRecognizer.onEnd], which uses [GestureDragEndCallback].
///  * [DragDownDetails], the details for [GestureDragDownCallback].
///  * [DragStartDetails], the details for [GestureDragStartCallback].
///  * [DragUpdateDetails], the details for [GestureDragUpdateCallback].
class DragEndDetails {
  /// Creates details for a [GestureDragEndCallback].
  ///
  /// The [velocity] argument must not be null.
  DragEndDetails({
217
    this.velocity = Velocity.zero,
218
    this.primaryVelocity,
219 220 221 222
  }) : assert(velocity != null),
       assert(primaryVelocity == null
           || primaryVelocity == velocity.pixelsPerSecond.dx
           || primaryVelocity == velocity.pixelsPerSecond.dy);
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

  /// The velocity the pointer was moving when it stopped contacting the screen.
  ///
  /// Defaults to zero if not specified in the constructor.
  final Velocity velocity;

  /// The velocity the pointer was moving along the primary axis when it stopped
  /// contacting the screen, in logical pixels per second.
  ///
  /// If the [GestureDragEndCallback] is for a one-dimensional drag (e.g., a
  /// horizontal or vertical drag), then this value contains the component of
  /// [velocity] along the primary axis (e.g., horizontal or vertical,
  /// respectively). Otherwise, if the [GestureDragEndCallback] is for a
  /// two-dimensional drag (e.g., a pan), then this value is null.
  ///
  /// Defaults to null if not specified in the constructor.
239
  final double? primaryVelocity;
240 241

  @override
242
  String toString() => '${objectRuntimeType(this, 'DragEndDetails')}($velocity)';
243
}