scena 1.7.2

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

use crate::diagnostics::LookupError;
use crate::{GeometryHandle, MaterialHandle, ModelHandle};

use super::{MeshNode, ModelNode, NodeKey, NodeKind, Scene, Transform};

/// Builder returned by [`Scene::mesh`].
#[must_use = "mesh builders do nothing until add() is called"]
pub struct MeshBuilder<'scene> {
    scene: &'scene mut Scene,
    parent: NodeKey,
    transform: Transform,
    geometry: GeometryHandle,
    material: MaterialHandle,
}

/// Builder returned by [`Scene::model`].
#[must_use = "model builders do nothing until add() is called"]
pub struct ModelBuilder<'scene> {
    scene: &'scene mut Scene,
    parent: NodeKey,
    transform: Transform,
    model: ModelHandle,
}

impl<'scene> MeshBuilder<'scene> {
    pub(super) fn new(
        scene: &'scene mut Scene,
        parent: NodeKey,
        geometry: GeometryHandle,
        material: MaterialHandle,
    ) -> Self {
        Self {
            scene,
            parent,
            transform: Transform::default(),
            geometry,
            material,
        }
    }
}

impl<'scene> ModelBuilder<'scene> {
    pub(super) fn new(scene: &'scene mut Scene, parent: NodeKey, model: ModelHandle) -> Self {
        Self {
            scene,
            parent,
            transform: Transform::default(),
            model,
        }
    }
}

impl MeshBuilder<'_> {
    /// Overrides the parent node. The parent is validated when [`Self::add`] is called.
    pub fn parent(mut self, parent: NodeKey) -> Self {
        self.parent = parent;
        self
    }

    /// Overrides the local transform. The default is [`Transform::IDENTITY`].
    ///
    /// Mesh geometry is transformed during render preparation, including the active scene
    /// origin shift used for large-scene precision.
    pub fn transform(mut self, transform: Transform) -> Self {
        self.transform = transform;
        self
    }

    /// Inserts the mesh node and returns its typed node key.
    pub fn add(self) -> Result<NodeKey, LookupError> {
        self.scene.insert_node(
            self.parent,
            NodeKind::Mesh(MeshNode {
                geometry: self.geometry,
                material: self.material,
            }),
            self.transform,
        )
    }
}

impl ModelBuilder<'_> {
    /// Overrides the parent node. The parent is validated when [`Self::add`] is called.
    pub fn parent(mut self, parent: NodeKey) -> Self {
        self.parent = parent;
        self
    }

    /// Overrides the local transform. The default is [`Transform::IDENTITY`].
    pub fn transform(mut self, transform: Transform) -> Self {
        self.transform = transform;
        self
    }

    /// Inserts the model node and returns its typed node key.
    pub fn add(self) -> Result<NodeKey, LookupError> {
        self.scene.insert_node(
            self.parent,
            NodeKind::Model(ModelNode { model: self.model }),
            self.transform,
        )
    }
}