The scene graph: the source
Open the live demo · Read the guide · View on GitHub
Regions the guide quotes: hierarchy (line 38), root (line 67), motion (line 99), check (line 118).
1/// A small hierarchy whose child transforms follow two rotating pivots.
2library;
4import 'package:flutter3d/flutter3d.dart';
5import 'package:flutter3d_showcase/src/demo/demo.dart';
7/// The `scene-graph` page: a star, a planet and a moon on nested pivots. Its
8/// check is that the children's transforms follow their parents'.
9final class SceneGraphDemo extends ShowcaseDemo {
10 /// How fast the system pivot turns, in radians a second, 0 to 2; the planet's
11 /// pivot turns 2.7 times as fast.
12 double speed = 0.7;
14 late final SceneNode _systemPivot;
15 late final SceneNode _planetPivot;
16 late final SceneNode _moonPivot;
17 late final MeshNode _moon;
18 late final Vector3 _initialMoonPosition;
19 late final int _initialMoonVersion;
21 double _angle = 0.0;
24 void configureView(DemoContext context) {
25 context.orbit
26 ..distance = 10.0
27 ..pitch = 0.4
28 ..yaw = 0.35;
29 }
32 Scene build(DemoContext context) {
33 final DeviceMesh sphere = DeviceMesh.upload(
34 context.device,
35 const SphereShape(segments: 32, rings: 16).build(),
36 );
38 _systemPivot = SceneNode(name: 'system pivot');
39 _planetPivot = SceneNode(name: 'planet orbit')..setPosition(3.1, 0.0, 0.0);
40 _moonPivot = SceneNode(name: 'moon orbit')..setPosition(1.15, 0.0, 0.0);
42 final MeshNode planet = MeshNode(
43 sphere,
44 RenderMaterial(
45 name: 'blue planet',
46 baseColor: LinearColor.fromSrgb(0.18, 0.48, 0.88, 1.0),
47 roughness: 0.62,
48 ),
49 name: 'planet',
50 )..setUniformScale(0.72);
51 _moon = MeshNode(
52 sphere,
53 RenderMaterial(
54 name: 'moon rock',
55 baseColor: LinearColor.fromSrgb(0.72, 0.7, 0.66, 1.0),
56 roughness: 0.92,
57 ),
58 name: 'moon',
59 )..setUniformScale(0.25);
61 _systemPivot.add(_planetPivot);
62 _planetPivot
63 ..add(planet)
64 ..add(_moonPivot);
65 _moonPivot.add(_moon);
67 final MeshNode star = MeshNode(
68 sphere,
69 RenderMaterial(
70 name: 'star',
71 baseColor: LinearColor.fromSrgb(1.0, 0.56, 0.12, 1.0),
72 emissive: LinearColor(1.0, 0.28, 0.04),
73 emissiveStrength: 1.8 * RenderMaterial.defaultEmissiveStrength,
74 roughness: 0.5,
75 ),
76 name: 'star',
77 )..setUniformScale(1.15);
78 final Scene scene = Scene()
79 ..ambientColor = LinearColor(0.2, 0.26, 0.42)
80 ..ambientIntensity = 0.12 * LightNode.legacyUnit
81 ..add(star)
82 ..add(_systemPivot)
83 ..add(
84 LightNode(
85 type: LightType.point,
86 intensity: 24.0 * LightNode.legacyUnit,
87 range: 12.0,
88 name: 'starlight',
89 ),
90 );
92 _initialMoonPosition = _moon.readScenePosition();
93 _initialMoonVersion = _moon.matrixVersion;
94 return scene;
95 }
98 void update(DemoContext context, double dt) {
99 _angle += dt * speed;
100 _systemPivot.setRotationYawPitchRoll(_angle, 0.0, 0.0);
101 _planetPivot.setRotationYawPitchRoll(_angle * 2.7, 0.0, 0.0);
102 }
105 List<DemoControl> controls(DemoContext context) => <DemoControl>[
106 SliderControl(
107 'Orbit speed',
108 min: 0.0,
109 max: 2.0,
110 value: () => speed,
111 onChanged: (double value) => speed = value,
112 format: (double value) => value.toStringAsFixed(2),
113 ),
114 ];
117 void verify(Scene scene, FrameResult frame) {
118 final Vector3 current = _moon.readScenePosition();
119 final bool hierarchyIsIntact =
120 _moon.parent == _moonPivot &&
121 _moonPivot.parent == _planetPivot &&
122 _planetPivot.parent == _systemPivot;
123 if (!hierarchyIsIntact ||
124 (current - _initialMoonPosition).length < 0.001 ||
125 _moon.matrixVersion == _initialMoonVersion ||
126 frame.drawCalls < 3) {
127 throw StateError('the child transforms did not follow their parents');
128 }
129 }
130}