flutter3d
Showcase Changelog 62 packages API reference

Head tracking: the source

since 0.1.0 Simulation, audio and XR

Regions the guide quotes: tracker (line 23), apply (line 97), turn (line 119).

1/// Where the head is, fed to a stereo rig every frame.
2///
3/// **`SensorHeadTracker`, the real implementation, reads a phone's rotation
4/// sensor through a platform channel** — nothing this test environment or a
5/// desktop browser has. This page implements the same `HeadTracker`
6/// interface by hand, driven by the pointer instead of a sensor, which is
7/// the honest stand-in: the rig on the other end cannot tell the difference,
8/// because all either one ever hands it is a `RigidPose`.
9///
10/// Quoted by `head_tracking.md` and shown whole in the Source tab.
11library;
13import 'dart:math' as math;
15import 'package:flutter/foundation.dart';
16import 'package:flutter/widgets.dart';
17import 'package:flutter3d/flutter3d.dart';
18import 'package:flutter3d/flutter3d.dart' as f3d show RenderMaterial;
19import 'package:flutter3d_showcase/src/demo/demo.dart';
20import 'package:flutter3d_showcase/src/demo/scene_kit.dart';
21import 'package:flutter3d_stereo/flutter3d_stereo.dart';
23/// Turns pointer drags into a head pose, the same shape a sensor would.
24final class _PointerHeadTracker extends HeadTracker {
25 final ValueNotifier<RigidPose> _pose = ValueNotifier<RigidPose>(
26 RigidPose.identity(),
27 );
28 double _yaw = 0.0;
30 @override
31 ValueListenable<RigidPose> get pose => _pose;
33 void dragBy(double dx) {
34 _yaw -= dx * 0.01;
35 _pose.value = RigidPose(
36 orientation: Quaternion.axisAngle(Vector3(0.0, 1.0, 0.0), _yaw),
37 position: Vector3.zero(),
38 );
39 }
41 @override
42 Future<void> start() async {}
44 @override
45 Future<void> stop() async {}
48/// The `head-tracking` page: a ball seen through a stereo rig whose head the
49/// pointer turns. Its check is that dragging turns the head and the head
50/// turns where the rig looks.
51final class HeadTrackingDemo extends ShowcaseDemo {
52 final _PointerHeadTracker _tracker = _PointerHeadTracker();
53 final StereoRig _rig = StereoRig();
54 late Scene _scene;
56 @override
57 Scene build(DemoContext context) {
58 final material = f3d.RenderMaterial(
59 name: 'ball',
60 baseColor: LinearColor.fromSrgb(0.8, 0.5, 0.3, 1.0),
61 );
62 final ball = MeshNode(
63 DeviceMesh.upload(context.device, SphereShape(segments: 24).build()),
64 material,
65 )..setPosition(0, 0, -2);
66 // A ring of posts round the viewer, each its own colour, so that turning
67 // the head visibly sweeps across something.
68 final List<SceneNode> posts = <SceneNode>[
69 for (var i = 0; i < 8; i++)
70 blockNode(
71 context,
72 'post $i',
73 Vector3(0.5, 1.0 + 0.4 * (i % 3), 0.5),
74 Vector4(
75 0.5 + 0.45 * math.sin(i * 0.8),
76 0.5 + 0.35 * math.sin(i * 1.6 + 1.0),
77 0.45 + 0.4 * math.sin(i * 2.4 + 2.0),
78 1.0,
79 ),
80 at: Vector3(
81 4.0 * math.sin(i * math.pi / 4),
82 (1.0 + 0.4 * (i % 3)) / 2 - 1.6,
83 -4.0 * math.cos(i * math.pi / 4),
84 ),
85 ),
86 ];
87 _scene = sceneOf(<SceneNode>[
88 _rig.stage,
89 ball,
90 floorNode(context, width: 14.0, depth: 14.0)
91 ..setPosition(0.0, -1.65, 0.0),
92 ...posts,
93 ]);
94 return _scene;
95 }
97 void _applyHead() => _rig.applyHead(_tracker.pose.value);
99 @override
100 Widget? customBody(BuildContext buildContext, DemoContext context) {
101 _applyHead();
102 return GestureDetector(
103 onHorizontalDragUpdate: (DragUpdateDetails details) {
104 _tracker.dragBy(details.delta.dx);
105 _applyHead();
106 },
107 child: StereoSurface(
108 renderer: context.renderer,
109 scene: _scene,
110 rig: _rig,
111 settings: () => const RenderSettings().forStereo(),
112 onBeforeDraw: _applyHead,
113 ),
114 );
115 }
117 @override
118 void verify(Scene scene, FrameResult frame) {
119 final before = _rig.gaze();
120 _tracker.dragBy(200.0);
121 _applyHead();
122 final after = _rig.gaze();
123 if ((before - after).length < 0.1) {
124 throw StateError(
125 'dragging should turn the head, and turning the head '
126 'should turn where the rig looks',
127 );
128 }
129 }