scena 1.7.0

A Rust-native scene-graph renderer with typed scene state, glTF assets, and explicit prepare/render lifecycles.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
use crate::assets::Assets;
use crate::diagnostics::LookupError;
use crate::geometry::Aabb;

use super::transforms::{compose_transform, local_transform_from_world};
use super::view_math::{
    inverse_unit_quat, look_rotation, merge_optional_bounds, multiply_quat, normalize_or,
    positive_min, positive_or, subtract_vec3, transform_aabb, union_aabb,
};
use super::{
    Camera, CameraKey, ImportAnchor, NodeKey, NodeKind, PerspectiveCamera, Quat, Scene,
    SceneImport, Transform, Vec3,
};

impl Scene {
    /// Returns the scene node that owns a camera descriptor.
    pub fn camera_node(&self, camera: CameraKey) -> Option<NodeKey> {
        self.nodes.iter().find_map(|(node_key, node)| {
            if node.kind == NodeKind::Camera(camera) {
                Some(node_key)
            } else {
                None
            }
        })
    }

    /// Frames bounds with the selected camera and tightens the camera depth range.
    pub fn frame(&mut self, camera: CameraKey, bounds: Aabb) -> Result<(), LookupError> {
        let camera_node = self
            .camera_node(camera)
            .ok_or(LookupError::CameraNotFound(camera))?;
        let center = bounds.center();
        let radius = bounds.bounding_sphere_radius().max(MIN_FRAME_RADIUS);
        let camera_descriptor = self
            .cameras
            .get_mut(camera)
            .ok_or(LookupError::CameraNotFound(camera))?;

        let transform = match camera_descriptor {
            Camera::Perspective(camera) => {
                let half_vertical_fov = camera.vertical_fov.radians() * 0.5;
                let half_horizontal_fov =
                    (half_vertical_fov.tan() * positive_or(camera.aspect, 1.0)).atan();
                let limiting_half_fov = half_vertical_fov.min(half_horizontal_fov).max(0.001);
                let distance = radius / limiting_half_fov.tan() * FRAME_PADDING;
                let depth_radius = radius * FRAME_PADDING;
                let depth = super::DepthRange::fit_sphere(distance, depth_radius);
                camera.near = depth.near();
                camera.far = depth.far();
                Transform {
                    translation: Vec3::new(center.x, center.y, center.z + distance),
                    rotation: Quat::IDENTITY,
                    scale: Vec3::ONE,
                }
            }
            Camera::Orthographic(camera) => {
                let half = bounds.half_extent();
                let half_width = half.x.max(radius) * FRAME_PADDING;
                let half_height = half.y.max(radius) * FRAME_PADDING;
                let distance = (radius * FRAME_PADDING).max(1.0);
                let depth = super::DepthRange::fit_sphere(distance, radius * FRAME_PADDING);
                camera.left = -half_width;
                camera.right = half_width;
                camera.bottom = -half_height;
                camera.top = half_height;
                camera.near = depth.near();
                camera.far = depth.far();
                Transform {
                    translation: Vec3::new(center.x, center.y, center.z + distance),
                    rotation: Quat::IDENTITY,
                    scale: Vec3::ONE,
                }
            }
        };

        let transform = self.local_transform_for_world(camera_node, transform)?;
        self.set_node_transform_and_mark_changed(camera_node, transform)
    }

    /// Adds a perspective camera under the root and makes it active.
    pub fn add_default_camera(&mut self) -> Result<CameraKey, LookupError> {
        let camera = self.add_perspective_camera(
            self.root(),
            PerspectiveCamera::default(),
            Transform::at(Vec3::new(0.0, 0.0, 2.0)),
        )?;
        self.set_active_camera(camera)?;
        Ok(camera)
    }

    /// Convenience constructor returning a fresh `Scene` plus a default
    /// active camera in one call. The renderer-as-library analog of
    /// Three.js's `new THREE.Scene()` + camera one-liner: callers who
    /// only need a default perspective camera framed at z=2 can drop the
    /// two-step `Scene::new()` + `add_default_camera()` boilerplate.
    /// Closes scena-api-ergonomics-reviewer Phase 6 finding F1.
    pub fn with_default_camera() -> Result<(Self, CameraKey), LookupError> {
        let mut scene = Self::new();
        let camera = scene.add_default_camera()?;
        Ok((scene, camera))
    }

    /// Frames the world-space bounds of an imported scene.
    pub fn frame_import(
        &mut self,
        camera: CameraKey,
        import: &SceneImport,
    ) -> Result<(), LookupError> {
        let bounds = import
            .bounds_world(self)
            .ok_or(LookupError::ImportHasNoBounds)?;
        self.frame(camera, bounds)
    }

    /// Frames all currently visible mesh bounds known to the scene.
    pub fn frame_all(&mut self, camera: CameraKey) -> Result<(), LookupError> {
        let bounds = self
            .scene_bounds_world()
            .ok_or(LookupError::ImportHasNoBounds)?;
        self.frame(camera, bounds)
    }

    /// Frames all visible mesh and instance bounds, resolving direct geometry handles through
    /// `Assets`.
    pub fn frame_all_with_assets<F>(
        &mut self,
        camera: CameraKey,
        assets: &Assets<F>,
    ) -> Result<(), LookupError> {
        let bounds = self
            .scene_bounds_world()
            .into_iter()
            .chain(self.asset_backed_scene_bounds_world(assets))
            .reduce(union_aabb)
            .ok_or(LookupError::ImportHasNoBounds)?;
        self.frame(camera, bounds)
    }

    /// Frames the world-space bounds of a node and any bounded descendants.
    pub fn frame_node(&mut self, camera: CameraKey, node: NodeKey) -> Result<(), LookupError> {
        if !self.nodes.contains_key(node) {
            return Err(LookupError::NodeNotFound(node));
        }
        let bounds = self
            .node_subtree_bounds_world(node)
            .ok_or(LookupError::ImportHasNoBounds)?;
        self.frame(camera, bounds)
    }

    /// Frames a node or bounded descendants, resolving direct geometry handles through
    /// `Assets`.
    pub fn frame_node_with_assets<F>(
        &mut self,
        camera: CameraKey,
        node: NodeKey,
        assets: &Assets<F>,
    ) -> Result<(), LookupError> {
        if !self.nodes.contains_key(node) {
            return Err(LookupError::NodeNotFound(node));
        }
        let bounds = self
            .node_subtree_bounds_world(node)
            .into_iter()
            .chain(self.asset_backed_node_subtree_bounds_world(node, assets))
            .reduce(union_aabb)
            .ok_or(LookupError::ImportHasNoBounds)?;
        self.frame(camera, bounds)
    }

    /// Returns the world-space bounds for a node subtree, including geometry
    /// resolved through `Assets`.
    pub fn node_world_bounds<F>(
        &self,
        node: NodeKey,
        assets: &Assets<F>,
    ) -> Result<Option<Aabb>, LookupError> {
        if !self.nodes.contains_key(node) {
            return Err(LookupError::NodeNotFound(node));
        }
        Ok(self
            .node_subtree_bounds_world(node)
            .into_iter()
            .chain(self.asset_backed_node_subtree_bounds_world(node, assets))
            .reduce(union_aabb))
    }

    /// Returns the distance between two node origins in world space.
    pub fn world_distance(&self, a: NodeKey, b: NodeKey) -> Result<f32, LookupError> {
        let a = self
            .world_transform(a)
            .ok_or(LookupError::NodeNotFound(a))?
            .translation;
        let b = self
            .world_transform(b)
            .ok_or(LookupError::NodeNotFound(b))?
            .translation;
        Ok((a - b).length())
    }

    fn scene_bounds_world(&self) -> Option<Aabb> {
        self.mesh_bounds_nodes()
            .filter_map(|(node, bounds)| {
                let transform = self.world_transform(node)?;
                Some(transform_aabb(bounds, transform))
            })
            .reduce(union_aabb)
    }

    fn node_subtree_bounds_world(&self, node: NodeKey) -> Option<Aabb> {
        let node_ref = self.nodes.get(node)?;
        let local_bounds = self.node_bounds.get(&node).and_then(|bounds| {
            let transform = self.world_transform(node)?;
            Some(transform_aabb(*bounds, transform))
        });
        node_ref
            .children
            .iter()
            .filter_map(|child| self.node_subtree_bounds_world(*child))
            .fold(local_bounds, |bounds, child_bounds| {
                Some(match bounds {
                    Some(bounds) => union_aabb(bounds, child_bounds),
                    None => child_bounds,
                })
            })
    }

    fn asset_backed_scene_bounds_world<F>(&self, assets: &Assets<F>) -> Option<Aabb> {
        let mut bounds = None;
        for (node, node_ref) in self.nodes.iter() {
            if !self.visible_for_active_camera(node) {
                continue;
            }
            if let Some(node_bounds) = self.asset_backed_node_bounds_world(node, node_ref, assets) {
                bounds = Some(merge_optional_bounds(bounds, node_bounds));
            }
        }
        bounds
    }

    fn asset_backed_node_subtree_bounds_world<F>(
        &self,
        node: NodeKey,
        assets: &Assets<F>,
    ) -> Option<Aabb> {
        let node_ref = self.nodes.get(node)?;
        node_ref
            .children
            .iter()
            .filter_map(|child| self.asset_backed_node_subtree_bounds_world(*child, assets))
            .fold(
                self.asset_backed_node_bounds_world(node, node_ref, assets),
                |bounds, child_bounds| Some(merge_optional_bounds(bounds, child_bounds)),
            )
    }

    fn asset_backed_node_bounds_world<F>(
        &self,
        node: NodeKey,
        node_ref: &super::Node,
        assets: &Assets<F>,
    ) -> Option<Aabb> {
        match &node_ref.kind {
            NodeKind::Mesh(mesh) => {
                let geometry = assets.geometry(mesh.geometry())?;
                let transform = self.world_transform(node)?;
                Some(transform_aabb(geometry.bounds(), transform))
            }
            NodeKind::InstanceSet(instance_set) => {
                let instance_set = self.instance_sets.get(*instance_set)?;
                let geometry = assets.geometry(instance_set.geometry())?;
                let node_transform = self.world_transform(node)?;
                instance_set
                    .instances()
                    .map(|instance| {
                        transform_aabb(
                            geometry.bounds(),
                            compose_transform(node_transform, instance.transform()),
                        )
                    })
                    .reduce(union_aabb)
            }
            NodeKind::Empty
            | NodeKind::Renderable(_)
            | NodeKind::Model(_)
            | NodeKind::Label(_)
            | NodeKind::Camera(_)
            | NodeKind::Light(_) => None,
        }
    }

    /// Rotates the selected camera node so its local -Z axis points at `target`.
    pub fn look_at(&mut self, camera: CameraKey, target: NodeKey) -> Result<(), LookupError> {
        if !self.cameras.contains_key(camera) {
            return Err(LookupError::CameraNotFound(camera));
        }
        let target_position = self
            .world_transform(target)
            .ok_or(LookupError::NodeNotFound(target))?
            .translation;
        self.look_at_point(camera, target_position)
    }

    /// Rotates the selected camera node so its local -Z axis points at a world-space point.
    pub fn look_at_point(
        &mut self,
        camera: CameraKey,
        target_position: Vec3,
    ) -> Result<(), LookupError> {
        let camera_node = self
            .camera_node(camera)
            .ok_or(LookupError::CameraNotFound(camera))?;
        if !self.cameras.contains_key(camera) {
            return Err(LookupError::CameraNotFound(camera));
        }
        let camera_node_desc = self
            .nodes
            .get(camera_node)
            .ok_or(LookupError::CameraNotFound(camera))?;
        let mut camera_transform = camera_node_desc.transform;
        let camera_parent = camera_node_desc.parent;
        let camera_world = self
            .world_transform(camera_node)
            .ok_or(LookupError::CameraNotFound(camera))?;
        let forward = normalize_or(
            subtract_vec3(target_position, camera_world.translation),
            Vec3::new(0.0, 0.0, -1.0),
        );
        let desired_world_rotation = look_rotation(forward, Vec3::new(0.0, 1.0, 0.0));

        camera_transform.rotation = if let Some(parent) = camera_parent {
            let parent_world = self
                .world_transform(parent)
                .ok_or(LookupError::NodeNotFound(parent))?;
            multiply_quat(
                inverse_unit_quat(parent_world.rotation),
                desired_world_rotation,
            )
        } else {
            desired_world_rotation
        };
        self.set_node_transform_and_mark_changed(camera_node, camera_transform)
    }

    pub fn center_on(&mut self, node: NodeKey, center: Vec3) -> Result<(), LookupError> {
        let mut world_transform = self
            .world_transform(node)
            .ok_or(LookupError::NodeNotFound(node))?;
        world_transform.translation = center;
        let transform = self.local_transform_for_world(node, world_transform)?;
        self.set_node_transform_and_mark_changed(node, transform)
    }

    pub fn align_to(&mut self, node: NodeKey, transform: Transform) -> Result<(), LookupError> {
        let transform = self.local_transform_for_world(node, transform)?;
        self.set_node_transform_and_mark_changed(node, transform)
    }

    pub fn snap_anchor(&mut self, node: NodeKey, anchor: &ImportAnchor) -> Result<(), LookupError> {
        self.align_to(node, anchor.transform())
    }

    pub fn fit_inside(
        &mut self,
        node: NodeKey,
        source: Aabb,
        target: Aabb,
    ) -> Result<(), LookupError> {
        let source_half = source.half_extent();
        let target_half = target.half_extent();
        let scale = positive_min([
            target_half.x / source_half.x.max(f32::EPSILON),
            target_half.y / source_half.y.max(f32::EPSILON),
            target_half.z / source_half.z.max(f32::EPSILON),
        ]);
        let mut world_transform = self
            .world_transform(node)
            .ok_or(LookupError::NodeNotFound(node))?;
        world_transform.translation = target.center();
        world_transform.scale = Vec3::new(scale, scale, scale);
        let transform = self.local_transform_for_world(node, world_transform)?;
        self.set_node_transform_and_mark_changed(node, transform)
    }

    fn local_transform_for_world(
        &self,
        node: NodeKey,
        world_transform: Transform,
    ) -> Result<Transform, LookupError> {
        let parent = self
            .nodes
            .get(node)
            .ok_or(LookupError::NodeNotFound(node))?
            .parent;
        let Some(parent) = parent else {
            return Ok(world_transform);
        };
        let parent_world = self
            .world_transform(parent)
            .ok_or(LookupError::NodeNotFound(parent))?;
        local_transform_from_world(parent_world, world_transform)
            .ok_or(LookupError::NonInvertibleParentTransform { node, parent })
    }

    fn set_node_transform_and_mark_changed(
        &mut self,
        node: NodeKey,
        transform: Transform,
    ) -> Result<(), LookupError> {
        let node = self
            .nodes
            .get_mut(node)
            .ok_or(LookupError::NodeNotFound(node))?;
        if node.transform != transform {
            node.transform = transform;
            self.transform_revision = self.transform_revision.saturating_add(1);
        }
        Ok(())
    }
}

const FRAME_PADDING: f32 = 1.15;
const MIN_FRAME_RADIUS: f32 = 0.05;