flutter3d
Showcase Changelog 62 packages API reference

Layers and contact callbacks: the source

since 0.2.0 or earlier Physics and particles

Regions the guide quotes: zone (line 51), movers (line 61), enter (line 103), check (line 112).

1/// A trigger that only cares about one layer, and a listener that hears it.
2///
3/// Quoted by `collision_layers.md` and shown whole in the Source tab.
4library;
5
6import 'package:flutter3d/flutter3d.dart';
7import 'package:flutter3d_physics/flutter3d_physics.dart';
8import 'package:flutter3d_showcase/src/demo/demo.dart';
9import 'package:flutter3d_showcase/src/demo/run_physics.dart';
11/// Which bit means what is a game's own business; `Layers.all` is the only
12/// meaning this package ships. These two are named here, once, for this page.
13const int _kPlayerLayer = 1 << 1;
14const int _kEnemyLayer = 1 << 2;
16/// Records every collider that started overlapping the zone it is attached
17/// to, by name, in the order it happened.
18final class _ZoneListener with CollisionListener {
19 final List<String> started = <String>[];
21 @override
22 void onCollisionStart(CollisionContext context) {
23 final other = context.other;
24 started.add(other.userData! as String);
25 }
28/// The `collision-layers` page: a trigger zone that listens to one layer.
29/// Its check is that only the player entered it.
30final class CollisionLayersDemo extends ShowcaseDemo {
31 late final CollisionWorld _world;
32 late final Collider _player;
33 late final Collider _enemy;
34 final _ZoneListener _listener = _ZoneListener();
36 Vector3 get _zoneCentre => Vector3(0.0, 0.5, 0.0);
37 Vector3 get _away => Vector3(0.0, 0.5, 6.0);
39 @override
40 void configureView(DemoContext context) {
41 context.orbit
42 ..distance = 5.0
43 ..pitch = 0.2
44 ..yaw = 0.5;
45 }
47 @override
48 Scene build(DemoContext context) {
49 _world = onRunPhysics(CollisionWorld());
51 // The zone's mask names one layer, so only a collider carrying that bit
52 // is ever considered for it, whatever mask that collider carries itself.
53 final Collider zone = Collider(
54 shape: CollisionSphere(0.6),
55 position: _zoneCentre,
56 kind: ColliderKind.trigger,
57 mask: _kPlayerLayer,
58 )..onContact(_listener);
59 _world.add(zone);
61 _player = _world.add(
62 Collider(
63 shape: CollisionBox(Vector3(0.3, 0.3, 0.3)),
64 position: _away,
65 kind: ColliderKind.kinematic,
66 layer: _kPlayerLayer,
67 userData: 'player',
68 ),
69 );
70 _enemy = _world.add(
71 Collider(
72 shape: CollisionBox(Vector3(0.3, 0.3, 0.3)),
73 position: _away,
74 kind: ColliderKind.kinematic,
75 layer: _kEnemyLayer,
76 userData: 'enemy',
77 ),
78 );
79 _world.update();
81 return Scene()
82 ..add(
83 MeshNode(
84 DeviceMesh.upload(
85 context.device,
86 SphereShape(segments: 20, rings: 10).build(),
87 ),
88 RenderMaterial(
89 name: 'zone',
90 baseColor: LinearColor.fromSrgb(0.3, 0.7, 0.9, 0.6),
91 ),
92 name: 'zone',
93 )..setPositionFrom(_zoneCentre),
94 )
95 ..add(
96 LightNode(name: 'sun', intensity: 2.5 * LightNode.legacyUnit)
97 ..setLocalForward(Vector3(-0.3, -0.6, -0.4)),
98 );
99 }
101 @override
102 void update(DemoContext context, double dt) {
103 // Both walk into the same spot. Only the one carrying the layer the
104 // zone's mask names will be heard.
105 _player.moveTo(_zoneCentre);
106 _enemy.moveTo(_zoneCentre);
107 _world.update();
108 }
110 @override
111 void verify(Scene scene, FrameResult frame) {
112 if (_listener.started.length != 1 || _listener.started.first != 'player') {
113 throw StateError(
114 'only the player should have entered the zone, got ${_listener.started}',
115 );
116 }
117 if (frame.drawCalls < 1) {
118 throw StateError('the zone did not reach the frame');
119 }
120 }