feat!: The HasTappableComponents mixin is no longer needed (#2450)

This PR is the second in a series of refactors that aim to simplify event handling in Flame. The approach is as follows:

    Added the MultiTapDispatcher component, which contains the logic that used to be within the HasTappableComponents mixin. This component is internal; it mounts to a FlameGame directly, and ensures that it is a singleton.
    Whenever any TapCallbacks component is added to a game, it automatically adds the MultiTapDispatcher component (unless there is already one), which in turn registers a tap gesture detector with GestureDetectorBuilder and rebuilds the game widget.

The end result is that now in order to make a component tappable you only need to add the TapCallbacks mixin to that component, everything else will be handled by the framework.

Consequently, the HasTappableComponents mixin is now empty and marked as deprecated.
This commit is contained in:
Lukas Klingsbo
2023-04-02 18:52:57 +02:00
committed by GitHub
parent 8319056477
commit b5bdf4ec17
89 changed files with 714 additions and 895 deletions

View File

@ -2,6 +2,7 @@ import 'dart:math';
import 'package:flame/collisions.dart';
import 'package:flame/components.dart';
import 'package:flame/experimental.dart';
import 'package:flame/extensions.dart';
import 'package:flame/game.dart';
import 'package:flame/input.dart';
@ -9,7 +10,7 @@ import 'package:flame/input.dart';
enum Shapes { circle, rectangle, polygon }
class GestureHitboxesExample extends FlameGame
with HasTappables, HasHoverables {
with TapCallbacks, HasHoverables {
static const description = '''
Tap to create a PositionComponent with a randomly shaped hitbox.
You can then hover over to shapes to see that they receive the hover events
@ -49,17 +50,16 @@ class GestureHitboxesExample extends FlameGame
}
@override
bool onTapDown(int pointerId, TapDownInfo info) {
super.onTapDown(pointerId, info);
final tapPosition = info.eventPosition.game;
void onTapDown(TapDownEvent info) {
super.onTapDown(info);
final tapPosition = info.localPosition;
final component = randomShape(tapPosition);
add(component);
return true;
}
}
class MyShapeComponent extends PositionComponent
with Tappable, Hoverable, GestureHitboxes {
with TapCallbacks, Hoverable, GestureHitboxes {
final ShapeHitbox hitbox;
late final Color baseColor;
late final Color hoverColor;
@ -69,9 +69,7 @@ class MyShapeComponent extends PositionComponent
super.position,
super.size,
super.angle,
}) : super(
anchor: Anchor.center,
);
}) : super(anchor: Anchor.center);
@override
Future<void> onLoad() async {
@ -83,9 +81,8 @@ class MyShapeComponent extends PositionComponent
}
@override
bool onTapDown(TapDownInfo _) {
void onTapDown(TapDownEvent _) {
removeFromParent();
return true;
}
@override