mouse_tracker.dart 16.3 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 7 8 9
// This library intentionally uses the LinkedHashMap constructor to declare that
// entries will be ordered. Using collection literals for this requires casting the
// resulting map, which has a runtime cost.
// ignore_for_file: prefer_collection_literals

10
import 'dart:collection' show LinkedHashMap;
11 12
import 'dart:ui';

13
import 'package:flutter/foundation.dart';
14
import 'package:flutter/gestures.dart';
15
import 'package:flutter/services.dart';
16

17 18
import 'object.dart';

19 20 21
export 'package:flutter/services.dart' show
  MouseCursor,
  SystemMouseCursors;
22

23
/// Signature for searching for [MouseTrackerAnnotation]s at the given offset.
24
///
25
/// It is used by the [MouseTracker] to fetch annotations for the mouse
26
/// position.
27
typedef MouseDetectorAnnotationFinder = HitTestResult Function(Offset offset);
28

29
// Various states of a connected mouse device used by [MouseTracker].
30 31
class _MouseState {
  _MouseState({
32
    required PointerEvent initialEvent,
33
  }) : _latestEvent = initialEvent;
34

35
  // The list of annotations that contains this device.
36
  //
37 38 39
  // It uses [LinkedHashMap] to keep the insertion order.
  LinkedHashMap<MouseTrackerAnnotation, Matrix4> get annotations => _annotations;
  LinkedHashMap<MouseTrackerAnnotation, Matrix4> _annotations = LinkedHashMap<MouseTrackerAnnotation, Matrix4>();
40

41 42
  LinkedHashMap<MouseTrackerAnnotation, Matrix4> replaceAnnotations(LinkedHashMap<MouseTrackerAnnotation, Matrix4> value) {
    final LinkedHashMap<MouseTrackerAnnotation, Matrix4> previous = _annotations;
43 44 45 46 47 48 49
    _annotations = value;
    return previous;
  }

  // The most recently processed mouse event observed from this device.
  PointerEvent get latestEvent => _latestEvent;
  PointerEvent _latestEvent;
50 51 52 53

  PointerEvent replaceLatestEvent(PointerEvent value) {
    assert(value.device == _latestEvent.device);
    final PointerEvent previous = _latestEvent;
54
    _latestEvent = value;
55
    return previous;
56 57
  }

58
  int get device => latestEvent.device;
59 60 61

  @override
  String toString() {
62
    final String describeLatestEvent = 'latestEvent: ${describeIdentity(latestEvent)}';
63 64
    final String describeAnnotations = 'annotations: [list of ${annotations.length}]';
    return '${describeIdentity(this)}($describeLatestEvent, $describeAnnotations)';
65 66 67
  }
}

68 69 70 71 72 73
// The information in `MouseTracker._handleDeviceUpdate` to provide the details
// of an update of a mouse device.
//
// This class contains the information needed to handle the update that might
// change the state of a mouse device, or the [MouseTrackerAnnotation]s that
// the mouse device is hovering.
74
@immutable
75
class _MouseTrackerUpdateDetails with Diagnosticable {
76 77 78
  /// When device update is triggered by a new frame.
  ///
  /// All parameters are required.
79
  const _MouseTrackerUpdateDetails.byNewFrame({
80 81
    required this.lastAnnotations,
    required this.nextAnnotations,
82
    required PointerEvent this.previousEvent,
83
  }) : triggeringEvent = null;
84 85 86 87 88

  /// When device update is triggered by a pointer event.
  ///
  /// The [lastAnnotations], [nextAnnotations], and [triggeringEvent] are
  /// required.
89
  const _MouseTrackerUpdateDetails.byPointerEvent({
90 91
    required this.lastAnnotations,
    required this.nextAnnotations,
92
    this.previousEvent,
93
    required PointerEvent this.triggeringEvent,
94
  });
95 96 97 98

  /// The annotations that the device is hovering before the update.
  ///
  /// It is never null.
99
  final LinkedHashMap<MouseTrackerAnnotation, Matrix4> lastAnnotations;
100 101 102 103

  /// The annotations that the device is hovering after the update.
  ///
  /// It is never null.
104
  final LinkedHashMap<MouseTrackerAnnotation, Matrix4> nextAnnotations;
105 106 107 108 109 110 111 112 113

  /// The last event that the device observed before the update.
  ///
  /// If the update is triggered by a frame, the [previousEvent] is never null,
  /// since the pointer must have been added before.
  ///
  /// If the update is triggered by a pointer event, the [previousEvent] is not
  /// null except for cases where the event is the first event observed by the
  /// pointer (which is not necessarily a [PointerAddedEvent]).
114
  final PointerEvent? previousEvent;
115 116 117 118

  /// The event that triggered this update.
  ///
  /// It is non-null if and only if the update is triggered by a pointer event.
119
  final PointerEvent? triggeringEvent;
120 121 122

  /// The pointing device of this update.
  int get device {
123
    final int result = (previousEvent ?? triggeringEvent)!.device;
124 125 126 127 128 129 130
    return result;
  }

  /// The last event that the device observed after the update.
  ///
  /// The [latestEvent] is never null.
  PointerEvent get latestEvent {
131
    final PointerEvent result = triggeringEvent ?? previousEvent!;
132 133 134 135 136 137 138 139 140
    return result;
  }

  @override
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(IntProperty('device', device));
    properties.add(DiagnosticsProperty<PointerEvent>('previousEvent', previousEvent));
    properties.add(DiagnosticsProperty<PointerEvent>('triggeringEvent', triggeringEvent));
141 142
    properties.add(DiagnosticsProperty<Map<MouseTrackerAnnotation, Matrix4>>('lastAnnotations', lastAnnotations));
    properties.add(DiagnosticsProperty<Map<MouseTrackerAnnotation, Matrix4>>('nextAnnotations', nextAnnotations));
143 144 145
  }
}

146 147
/// Tracks the relationship between mouse devices and annotations, and
/// triggers mouse events and cursor changes accordingly.
148
///
149 150 151 152
/// The [MouseTracker] tracks the relationship between mouse devices and
/// [MouseTrackerAnnotation], notified by [updateWithEvent] and
/// [updateAllDevices]. At every update, [MouseTracker] triggers the following
/// changes if applicable:
153
///
154 155 156
///  * Dispatches mouse-related pointer events (pointer enter, hover, and exit).
///  * Changes mouse cursors.
///  * Notifies when [mouseIsConnected] changes.
157
///
158 159 160
/// This class is a [ChangeNotifier] that notifies its listeners if the value of
/// [mouseIsConnected] changes.
///
161 162 163 164
/// An instance of [MouseTracker] is owned by the global singleton
/// [RendererBinding].
class MouseTracker extends ChangeNotifier {
  final MouseCursorManager _mouseCursorMixin = MouseCursorManager(
165
    SystemMouseCursors.basic,
166
  );
167

168 169
  // Tracks the state of connected mouse devices.
  //
170
  // It is the source of truth for the list of connected mouse devices, and
171 172 173 174
  // consists of two parts:
  //
  //  * The mouse devices that are connected.
  //  * In which annotations each device is contained.
175 176
  final Map<int, _MouseState> _mouseStates = <int, _MouseState>{};

177 178 179 180 181 182 183
  // Used to wrap any procedure that might change `mouseIsConnected`.
  //
  // This method records `mouseIsConnected`, runs `task`, and calls
  // [notifyListeners] at the end if the `mouseIsConnected` has changed.
  void _monitorMouseConnection(VoidCallback task) {
    final bool mouseWasConnected = mouseIsConnected;
    task();
184
    if (mouseWasConnected != mouseIsConnected) {
185
      notifyListeners();
186
    }
187 188 189
  }

  bool _debugDuringDeviceUpdate = false;
190
  // Used to wrap any procedure that might call `_handleDeviceUpdate`.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
  //
  // In debug mode, this method uses `_debugDuringDeviceUpdate` to prevent
  // `_deviceUpdatePhase` being recursively called.
  void _deviceUpdatePhase(VoidCallback task) {
    assert(!_debugDuringDeviceUpdate);
    assert(() {
      _debugDuringDeviceUpdate = true;
      return true;
    }());
    task();
    assert(() {
      _debugDuringDeviceUpdate = false;
      return true;
    }());
  }

207
  // Whether an observed event might update a device.
208
  static bool _shouldMarkStateDirty(_MouseState? state, PointerEvent event) {
209
    if (state == null) {
210
      return true;
211
    }
212
    final PointerEvent lastEvent = state.latestEvent;
213
    assert(event.device == lastEvent.device);
214 215
    // An Added can only follow a Removed, and a Removed can only be followed
    // by an Added.
216
    assert((event is PointerAddedEvent) == (lastEvent is PointerRemovedEvent));
217 218

    // Ignore events that are unrelated to mouse tracking.
219
    if (event is PointerSignalEvent) {
220
      return false;
221
    }
222
    return lastEvent is PointerAddedEvent
223 224 225 226
      || event is PointerRemovedEvent
      || lastEvent.position != event.position;
  }

227
  LinkedHashMap<MouseTrackerAnnotation, Matrix4> _hitTestResultToAnnotations(HitTestResult result) {
228
    final LinkedHashMap<MouseTrackerAnnotation, Matrix4> annotations = LinkedHashMap<MouseTrackerAnnotation, Matrix4>();
229
    for (final HitTestEntry entry in result.path) {
230 231 232
      final Object target = entry.target;
      if (target is MouseTrackerAnnotation) {
        annotations[target] = entry.transform!;
233 234 235 236 237
      }
    }
    return annotations;
  }

238 239
  // Find the annotations that is hovered by the device of the `state`, and
  // their respective global transform matrices.
240
  //
241
  // If the device is not connected or not a mouse, an empty map is returned
242 243
  // without calling `hitTest`.
  LinkedHashMap<MouseTrackerAnnotation, Matrix4> _findAnnotations(_MouseState state, MouseDetectorAnnotationFinder hitTest) {
244 245
    final Offset globalPosition = state.latestEvent.position;
    final int device = state.device;
246
    if (!_mouseStates.containsKey(device)) {
247
      return LinkedHashMap<MouseTrackerAnnotation, Matrix4>();
248
    }
249 250

    return _hitTestResultToAnnotations(hitTest(globalPosition));
251 252
  }

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
  // A callback that is called on the update of a device.
  //
  // An event (not necessarily a pointer event) that might change the
  // relationship between mouse devices and [MouseTrackerAnnotation]s is called
  // a _device update_. This method should be called at each such update.
  //
  // The update can be caused by two kinds of triggers:
  //
  //  * Triggered by the addition, movement, or removal of a pointer. Such calls
  //    occur during the handler of the event, indicated by
  //    `details.triggeringEvent` being non-null.
  //  * Triggered by the appearance, movement, or disappearance of an annotation.
  //    Such calls occur after each new frame, during the post-frame callbacks,
  //    indicated by `details.triggeringEvent` being null.
  //
  // Calls of this method must be wrapped in `_deviceUpdatePhase`.
  void _handleDeviceUpdate(_MouseTrackerUpdateDetails details) {
270
    assert(_debugDuringDeviceUpdate);
271 272 273 274
    _handleDeviceUpdateMouseEvents(details);
    _mouseCursorMixin.handleDeviceCursorUpdate(
      details.device,
      details.triggeringEvent,
275
      details.nextAnnotations.keys.map((MouseTrackerAnnotation annotation) => annotation.cursor),
276
    );
277 278
  }

279 280 281
  /// Whether or not at least one mouse is connected and has produced events.
  bool get mouseIsConnected => _mouseStates.isNotEmpty;

282 283 284
  /// Trigger a device update with a new event and its corresponding hit test
  /// result.
  ///
285
  /// The [updateWithEvent] indicates that an event has been observed, and is
286
  /// called during the handler of the event. It is typically called by
287 288 289 290
  /// [RendererBinding], and should be called with all events received, and let
  /// [MouseTracker] filter which to react to.
  ///
  /// The `getResult` is a function to return the hit test result at the
291 292
  /// position of the event. It should not return a cached hit test
  /// result, because the cache would not change during a tap sequence.
293
  void updateWithEvent(PointerEvent event, ValueGetter<HitTestResult> getResult) {
294
    if (event.kind != PointerDeviceKind.mouse) {
295
      return;
296 297
    }
    if (event is PointerSignalEvent) {
298
      return;
299
    }
300
    final HitTestResult result = event is PointerRemovedEvent ? HitTestResult() : getResult();
301
    final int device = event.device;
302
    final _MouseState? existingState = _mouseStates[device];
303
    if (!_shouldMarkStateDirty(existingState, event)) {
304
      return;
305
    }
306

307 308 309 310 311 312
    _monitorMouseConnection(() {
      _deviceUpdatePhase(() {
        // Update mouseState to the latest devices that have not been removed,
        // so that [mouseIsConnected], which is decided by `_mouseStates`, is
        // correct during the callbacks.
        if (existingState == null) {
313
          if (event is PointerRemovedEvent) {
314
            return;
315
          }
316 317 318
          _mouseStates[device] = _MouseState(initialEvent: event);
        } else {
          assert(event is! PointerAddedEvent);
319
          if (event is PointerRemovedEvent) {
320
            _mouseStates.remove(event.device);
321
          }
322
        }
323
        final _MouseState targetState = _mouseStates[device] ?? existingState!;
324 325

        final PointerEvent lastEvent = targetState.replaceLatestEvent(event);
326
        final LinkedHashMap<MouseTrackerAnnotation, Matrix4> nextAnnotations = event is PointerRemovedEvent ?
327
            LinkedHashMap<MouseTrackerAnnotation, Matrix4>() :
328
            _hitTestResultToAnnotations(result);
329
        final LinkedHashMap<MouseTrackerAnnotation, Matrix4> lastAnnotations = targetState.replaceAnnotations(nextAnnotations);
330

331
        _handleDeviceUpdate(_MouseTrackerUpdateDetails.byPointerEvent(
332 333 334 335 336 337 338
          lastAnnotations: lastAnnotations,
          nextAnnotations: nextAnnotations,
          previousEvent: lastEvent,
          triggeringEvent: event,
        ));
      });
    });
339 340
  }

341 342 343 344
  /// Trigger a device update for all detected devices.
  ///
  /// The [updateAllDevices] is typically called during the post frame phase,
  /// indicating a frame has passed and all objects have potentially moved. The
345
  /// `hitTest` is a function that acquires the hit test result at a given
346 347 348
  /// position, and must not be empty.
  ///
  /// For each connected device, the [updateAllDevices] will make a hit test on
349 350
  /// the device's last seen position, and check if necessary changes need to be
  /// made.
351
  void updateAllDevices(MouseDetectorAnnotationFinder hitTest) {
352 353 354
    _deviceUpdatePhase(() {
      for (final _MouseState dirtyState in _mouseStates.values) {
        final PointerEvent lastEvent = dirtyState.latestEvent;
355
        final LinkedHashMap<MouseTrackerAnnotation, Matrix4> nextAnnotations = _findAnnotations(dirtyState, hitTest);
356
        final LinkedHashMap<MouseTrackerAnnotation, Matrix4> lastAnnotations = dirtyState.replaceAnnotations(nextAnnotations);
357

358
        _handleDeviceUpdate(_MouseTrackerUpdateDetails.byNewFrame(
359 360 361 362
          lastAnnotations: lastAnnotations,
          nextAnnotations: nextAnnotations,
          previousEvent: lastEvent,
        ));
363
      }
364
    });
365 366
  }

367 368 369 370 371 372 373 374 375 376 377 378
  /// Returns the active mouse cursor for a device.
  ///
  /// The return value is the last [MouseCursor] activated onto this device, even
  /// if the activation failed.
  ///
  /// This function is only active when asserts are enabled. In release builds,
  /// it always returns null.
  @visibleForTesting
  MouseCursor? debugDeviceActiveCursor(int device) {
    return _mouseCursorMixin.debugDeviceActiveCursor(device);
  }

379
  // Handles device update and dispatches mouse event callbacks.
380
  static void _handleDeviceUpdateMouseEvents(_MouseTrackerUpdateDetails details) {
381 382
    final PointerEvent latestEvent = details.latestEvent;

383 384
    final LinkedHashMap<MouseTrackerAnnotation, Matrix4> lastAnnotations = details.lastAnnotations;
    final LinkedHashMap<MouseTrackerAnnotation, Matrix4> nextAnnotations = details.nextAnnotations;
385

386 387 388 389
    // Order is important for mouse event callbacks. The
    // `_hitTestResultToAnnotations` returns annotations in the visual order
    // from front to back, called the "hit-test order". The algorithm here is
    // explained in https://github.com/flutter/flutter/issues/41420
390

391
    // Send exit events to annotations that are in last but not in next, in
392
    // hit-test order.
393 394
    final PointerExitEvent baseExitEvent = PointerExitEvent.fromMouseEvent(latestEvent);
    lastAnnotations.forEach((MouseTrackerAnnotation annotation, Matrix4 transform) {
395
      if (!nextAnnotations.containsKey(annotation)) {
396
        if (annotation.validForMouseTracker && annotation.onExit != null) {
397
          annotation.onExit!(baseExitEvent.transformed(lastAnnotations[annotation]));
398
        }
399
      }
400
    });
401

402
    // Send enter events to annotations that are not in last but in next, in
403
    // reverse hit-test order.
404 405 406 407 408
    final List<MouseTrackerAnnotation> enteringAnnotations = nextAnnotations.keys.where(
      (MouseTrackerAnnotation annotation) => !lastAnnotations.containsKey(annotation),
    ).toList();
    final PointerEnterEvent baseEnterEvent = PointerEnterEvent.fromMouseEvent(latestEvent);
    for (final MouseTrackerAnnotation annotation in enteringAnnotations.reversed) {
409
      if (annotation.validForMouseTracker && annotation.onEnter != null) {
410
        annotation.onEnter!(baseEnterEvent.transformed(nextAnnotations[annotation]));
411
      }
412 413 414
    }
  }
}