Add base recognizer

Author: luanpotter

packages/flame/lib/src/events/flame_game_mixins/dispatcher.dart

@@ -0,0 +1,29 @@
+import 'package:flame/components.dart';
+import 'package:flame/src/game/flame_game.dart';
+import 'package:flutter/foundation.dart';
+
+abstract class Dispatcher<G extends FlameGame> extends Component
+    with HasGameReference<G> {
+  static void addDispatcher<T extends Component>(
+    Component component,
+    ComponentKey key,
+    T Function() create,
+  ) {
+    final game = component.findRootGame()!;
+    if (game.findByKey(key) != null) {
+      return;
+    }
+    final dispatcher = create();
+    game.registerKey(key, dispatcher);
+    game.add(dispatcher);
+  }
+
+  static void removeDispatcher(
+    FlameGame game,
+    ComponentKey key, {
+    VoidCallback? unregister,
+  }) {
+    unregister?.call();
+    game.unregisterKey(key);
+  }
+}

packages/flame/lib/src/events/flame_game_mixins/double_tap_dispatcher.dart

@@ -1,6 +1,7 @@
 import 'package:flame/components.dart';
 import 'package:flame/events.dart';
 import 'package:flame/game.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flutter/gestures.dart';
 
 class DoubleTapDispatcherKey implements ComponentKey {
@@ -18,7 +19,7 @@ class DoubleTapDispatcherKey implements ComponentKey {
 /// the component tree that is mixed with [DoubleTapCallbacks]. This will be
 /// attached to the [FlameGame] instance automatically whenever any
 /// [DoubleTapCallbacks] are mounted into the component tree.
-class DoubleTapDispatcher extends Component with HasGameReference<FlameGame> {
+class DoubleTapDispatcher extends Dispatcher<FlameGame> {
   final _components = <DoubleTapCallbacks>{};
 
   void _onDoubleTapDown(DoubleTapDownEvent event) {
@@ -45,7 +46,8 @@ class DoubleTapDispatcher extends Component with HasGameReference<FlameGame> {
   }
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const DoubleTapDispatcherKey(),
       DoubleTapDispatcher.new,
     );
@@ -67,8 +69,12 @@ class DoubleTapDispatcher extends Component with HasGameReference<FlameGame> {
 
   @override
   void onRemove() {
-    game.removeDispatcher<DoubleTapGestureRecognizer>(
+    Dispatcher.removeDispatcher(
+      game,
       const DoubleTapDispatcherKey(),
+      unregister: () {
+        game.gestureDetectors.unregister<DoubleTapGestureRecognizer>();
+      },
     );
   }
 }

packages/flame/lib/src/events/flame_game_mixins/long_press_dispatcher.dart

@@ -1,5 +1,6 @@
 import 'package:flame/components.dart';
 import 'package:flame/src/events/component_mixins/long_press_callbacks.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flame/src/events/messages/long_press_cancel_event.dart';
 import 'package:flame/src/events/messages/long_press_end_event.dart';
 import 'package:flame/src/events/messages/long_press_move_update_event.dart';
@@ -13,12 +14,10 @@ import 'package:meta/meta.dart';
 /// that use the [LongPressCallbacks] mixin. It will be attached to the
 /// [FlameGame] instance automatically whenever any [LongPressCallbacks]
 /// components are mounted into the component tree.
-class LongPressDispatcher extends Component {
+class LongPressDispatcher extends Dispatcher<FlameGame> {
   /// Records all components currently being long-pressed, keyed by pointerId.
   final Set<TaggedComponent<LongPressCallbacks>> _records = {};
 
-  FlameGame get game => parent! as FlameGame;
-
   /// Monotonically increasing id assigned to each new long press gesture.
   int _nextPointerId = 0;
 
@@ -124,7 +123,8 @@ class LongPressDispatcher extends Component {
   //#endregion
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const LongPressDispatcherKey(),
       LongPressDispatcher.new,
     );
@@ -147,8 +147,12 @@ class LongPressDispatcher extends Component {
 
   @override
   void onRemove() {
-    game.removeDispatcher<LongPressGestureRecognizer>(
+    Dispatcher.removeDispatcher(
+      game,
       const LongPressDispatcherKey(),
+      unregister: () {
+        game.gestureDetectors.unregister<LongPressGestureRecognizer>();
+      },
     );
     super.onRemove();
   }

packages/flame/lib/src/events/flame_game_mixins/multi_drag_dispatcher.dart

@@ -3,6 +3,7 @@ import 'dart:async';
 import 'package:flame/components.dart';
 import 'package:flame/events.dart';
 import 'package:flame/src/events/flame_drag_adapter.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flame/src/events/tagged_component.dart';
 import 'package:flame/src/game/flame_game.dart';
 import 'package:flame/src/game/game_render_box.dart';
@@ -24,7 +25,8 @@ class MultiDragDispatcherKey implements ComponentKey {
 /// [DragCallbacks] components in the component tree. It will be attached to
 /// the [FlameGame] instance automatically whenever any [DragCallbacks]
 /// components are mounted into the component tree.
-class MultiDragDispatcher extends Component implements MultiDragListener {
+class MultiDragDispatcher extends Dispatcher<FlameGame>
+    implements MultiDragListener {
   /// The record of all components currently being touched.
   final Set<TaggedComponent<DragCallbacks>> _records = {};
 
@@ -52,8 +54,6 @@ class MultiDragDispatcher extends Component implements MultiDragListener {
 
   Stream<DragCancelEvent> get onCancel => _dragCancelController.stream;
 
-  FlameGame get game => parent! as FlameGame;
-
   /// Called when the user initiates a drag gesture, for example by touching the
   /// screen and then moving the finger.
   ///
@@ -187,7 +187,8 @@ class MultiDragDispatcher extends Component implements MultiDragListener {
   //#endregion
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const MultiDragDispatcherKey(),
       MultiDragDispatcher.new,
     );
@@ -205,8 +206,12 @@ class MultiDragDispatcher extends Component implements MultiDragListener {
 
   @override
   void onRemove() {
-    game.removeDispatcher<ImmediateMultiDragGestureRecognizer>(
+    Dispatcher.removeDispatcher(
+      game,
       const MultiDragDispatcherKey(),
+      unregister: () {
+        game.gestureDetectors.unregister<ImmediateMultiDragGestureRecognizer>();
+      },
     );
     _dragUpdateController.close();
     _dragCancelController.close();

packages/flame/lib/src/events/flame_game_mixins/multi_tap_dispatcher.dart

@@ -1,6 +1,7 @@
 import 'package:flame/components.dart';
 import 'package:flame/events.dart';
 import 'package:flame/input.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flame/src/events/tagged_component.dart';
 import 'package:flame/src/game/flame_game.dart';
 import 'package:flame/src/game/game_render_box.dart';
@@ -18,12 +19,11 @@ class MultiTapDispatcherKey implements ComponentKey {
       other is MultiTapDispatcherKey && other.hashCode == hashCode;
 }
 
-class MultiTapDispatcher extends Component implements MultiTapListener {
+class MultiTapDispatcher extends Dispatcher<FlameGame>
+    implements MultiTapListener {
   /// The record of all components currently being touched.
   final Set<TaggedComponent<TapCallbacks>> _record = {};
 
-  FlameGame get game => parent! as FlameGame;
-
   /// Called when the user touches the device screen within the game canvas,
   /// either with a finger, a stylus, or a mouse.
   ///
@@ -150,7 +150,8 @@ class MultiTapDispatcher extends Component implements MultiTapListener {
   //#endregion
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const MultiTapDispatcherKey(),
       MultiTapDispatcher.new,
     );
@@ -177,8 +178,12 @@ class MultiTapDispatcher extends Component implements MultiTapListener {
 
   @override
   void onRemove() {
-    game.removeDispatcher<MultiTapGestureRecognizer>(
+    Dispatcher.removeDispatcher(
+      game,
       const MultiTapDispatcherKey(),
+      unregister: () {
+        game.gestureDetectors.unregister<MultiTapGestureRecognizer>();
+      },
     );
   }
 

packages/flame/lib/src/events/flame_game_mixins/pointer_move_dispatcher.dart

@@ -1,5 +1,6 @@
 import 'package:flame/components.dart';
 import 'package:flame/events.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flame/src/events/tagged_component.dart';
 import 'package:flame/src/game/flame_game.dart';
 import 'package:flutter/gestures.dart' as flutter;
@@ -9,12 +10,10 @@ import 'package:meta/meta.dart';
 /// [PointerMoveCallbacks] components in the component tree. It will be attached
 /// to the [FlameGame] instance automatically whenever any
 /// [PointerMoveCallbacks] components are mounted into the component tree.
-class PointerMoveDispatcher extends Component {
+class PointerMoveDispatcher extends Dispatcher<FlameGame> {
   /// The record of all components currently being hovered.
   final Set<TaggedComponent<PointerMoveCallbacks>> _records = {};
 
-  FlameGame get game => parent! as FlameGame;
-
   @mustCallSuper
   void onMouseMove(PointerMoveEvent event) {
     final updated = <TaggedComponent<PointerMoveCallbacks>>{};
@@ -46,7 +45,8 @@ class PointerMoveDispatcher extends Component {
   }
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const MouseMoveDispatcherKey(),
       PointerMoveDispatcher.new,
     );
@@ -60,7 +60,7 @@ class PointerMoveDispatcher extends Component {
   @override
   void onRemove() {
     game.mouseDetector = null;
-    game.unregisterKey(const MouseMoveDispatcherKey());
+    Dispatcher.removeDispatcher(game, const MouseMoveDispatcherKey());
   }
 }
 

packages/flame/lib/src/events/flame_game_mixins/scale_dispatcher.dart

@@ -3,6 +3,7 @@ import 'dart:math' as math;
 import 'package:flame/components.dart';
 import 'package:flame/events.dart';
 import 'package:flame/game.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flame/src/events/interfaces/scale_listener.dart';
 import 'package:flame/src/events/tagged_component.dart';
 import 'package:flame/src/game/game_widget/gesture_detector_builder.dart';
@@ -46,12 +47,10 @@ class ScaleDispatcherKey implements ComponentKey {
 /// implementing [ScaleCallbacks]. It will be attached to
 /// the [FlameGame] instance automatically whenever any [ScaleCallbacks]
 /// components are mounted into the component tree.
-class ScaleDispatcher extends Component implements ScaleListener {
+class ScaleDispatcher extends Dispatcher<FlameGame> implements ScaleListener {
   /// Records all components currently being scaled, keyed by pointerId.
   final Set<TaggedComponent<ScaleCallbacks>> _records = {};
 
-  FlameGame get game => parent! as FlameGame;
-
   /// Store the last drag events
   DragStartDetails? lastDragStart;
   DragUpdateDetails? lastDragUpdate;
@@ -295,7 +294,8 @@ class ScaleDispatcher extends Component implements ScaleListener {
   //#endregion
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const ScaleDispatcherKey(),
       ScaleDispatcher.new,
     );
@@ -341,7 +341,13 @@ class ScaleDispatcher extends Component implements ScaleListener {
 
   @override
   void onRemove() {
-    game.removeDispatcher<ScaleGestureRecognizer>(const ScaleDispatcherKey());
+    Dispatcher.removeDispatcher(
+      game,
+      const ScaleDispatcherKey(),
+      unregister: () {
+        game.gestureDetectors.unregister<ScaleGestureRecognizer>();
+      },
+    );
     super.onRemove();
   }
 

packages/flame/lib/src/events/flame_game_mixins/scroll_dispatcher.dart

@@ -1,5 +1,6 @@
 import 'package:flame/components.dart';
 import 'package:flame/src/events/component_mixins/scroll_callbacks.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flame/src/events/messages/scroll_event.dart';
 import 'package:flame/src/game/flame_game.dart';
 import 'package:flutter/gestures.dart' as flutter;
@@ -9,9 +10,7 @@ import 'package:meta/meta.dart';
 /// [ScrollCallbacks] components in the component tree. It will be attached
 /// to the [FlameGame] instance automatically whenever any
 /// [ScrollCallbacks] components are mounted into the component tree.
-class ScrollDispatcher extends Component {
-  FlameGame get game => parent! as FlameGame;
-
+class ScrollDispatcher extends Dispatcher<FlameGame> {
   @mustCallSuper
   void onPointerScroll(ScrollEvent event) {
     event.deliverAtPoint(
@@ -28,7 +27,8 @@ class ScrollDispatcher extends Component {
   }
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const ScrollDispatcherKey(),
       ScrollDispatcher.new,
     );
@@ -42,7 +42,7 @@ class ScrollDispatcher extends Component {
   @override
   void onRemove() {
     game.scrollDetector = null;
-    game.unregisterKey(const ScrollDispatcherKey());
+    Dispatcher.removeDispatcher(game, const ScrollDispatcherKey());
   }
 }
 

packages/flame/lib/src/events/flame_game_mixins/secondary_tap_dispatcher.dart

@@ -1,6 +1,7 @@
 import 'package:flame/components.dart';
 import 'package:flame/events.dart';
 import 'package:flame/game.dart';
+import 'package:flame/src/events/flame_game_mixins/dispatcher.dart';
 import 'package:flutter/gestures.dart';
 
 class SecondaryTapDispatcherKey implements ComponentKey {
@@ -19,8 +20,7 @@ class SecondaryTapDispatcherKey implements ComponentKey {
 /// [SecondaryTapCallbacks]. This will be attached to the [FlameGame] instance
 /// automatically whenever any [SecondaryTapCallbacks] are mounted into the
 /// component tree.
-class SecondaryTapDispatcher extends Component
-    with HasGameReference<FlameGame> {
+class SecondaryTapDispatcher extends Dispatcher<FlameGame> {
   final _components = <SecondaryTapCallbacks>{};
 
   void _onSecondaryTapDown(SecondaryTapDownEvent event) {
@@ -47,7 +47,8 @@ class SecondaryTapDispatcher extends Component
   }
 
   static void addDispatcher(Component component) {
-    component.findRootGame()!.addDispatcher(
+    Dispatcher.addDispatcher(
+      component,
       const SecondaryTapDispatcherKey(),
       SecondaryTapDispatcher.new,
     );
@@ -70,8 +71,12 @@ class SecondaryTapDispatcher extends Component
 
   @override
   void onRemove() {
-    game.removeDispatcher<TapGestureRecognizer>(
+    Dispatcher.removeDispatcher(
+      game,
       const SecondaryTapDispatcherKey(),
+      unregister: () {
+        game.gestureDetectors.unregister<TapGestureRecognizer>();
+      },
     );
   }
 }