Struct Scene 

pub struct Scene { /* private fields */ }

A scene graph managing nodes with parent-child hierarchy and layers.

Implementations

impl Scene

pub fn new() -> Self

Create an empty scene with a default layer.

pub fn version(&self) -> u64

Monotonically increasing generation counter.

Incremented by wrapping_add(1) on every mutation. Compare against a cached value to detect scene changes without hashing instance data.

pub fn add( &mut self, mesh_id: Option<MeshId>, transform: Mat4, material: Material, ) -> NodeId

Add a node with a mesh, transform, and material. Returns the new node’s ID.

pub fn add_named( &mut self, name: &str, mesh_id: Option<MeshId>, transform: Mat4, material: Material, ) -> NodeId

Add a named node. Returns the new node’s ID.

pub fn remove(&mut self, id: NodeId) -> Vec<NodeId>

Remove a node and all its descendants. Returns all removed IDs (caller can use these to release mesh references).

pub fn set_parent(&mut self, child_id: NodeId, new_parent: Option<NodeId>)

Reparent a node. None makes it a root node.

pub fn children(&self, id: NodeId) -> &[NodeId]

Children of a node.

pub fn parent(&self, id: NodeId) -> Option<NodeId>

Parent of a node.

pub fn roots(&self) -> &[NodeId]

Root nodes.

pub fn set_local_transform(&mut self, id: NodeId, transform: Mat4)

Set the local transform of a node, marking it and its descendants dirty.

pub fn set_visible(&mut self, id: NodeId, visible: bool)

Set node visibility.

pub fn set_material(&mut self, id: NodeId, material: Material)

Set node material.

pub fn set_mesh(&mut self, id: NodeId, mesh_id: Option<MeshId>)

Set node mesh.

pub fn set_name(&mut self, id: NodeId, name: &str)

Set node name.

pub fn set_show_normals(&mut self, id: NodeId, show: bool)

Set whether to show normals.

pub fn set_layer(&mut self, id: NodeId, layer: LayerId)

Set the layer of a node.

pub fn node(&self, id: NodeId) -> Option<&SceneNode>

Get a reference to a node.

pub fn node_count(&self) -> usize

Number of nodes in the scene.

pub fn nodes(&self) -> impl Iterator<Item = &SceneNode>

Iterate over all nodes.

pub fn add_layer(&mut self, name: &str) -> LayerId

Add a new layer, returning its ID.

pub fn remove_layer(&mut self, id: LayerId)

Remove a layer, moving all its nodes to the default layer. Cannot remove the default layer (LayerId(0)).

pub fn set_layer_visible(&mut self, id: LayerId, visible: bool)

Set layer visibility.

pub fn set_layer_locked(&mut self, id: LayerId, locked: bool)

Set layer locked state. Locked layers render but nodes cannot appear selected.

pub fn set_layer_color(&mut self, id: LayerId, color: [f32; 4])

Set layer display color.

pub fn set_layer_order(&mut self, id: LayerId, order: u32)

Set layer sort order.

pub fn is_layer_locked(&self, id: LayerId) -> bool

Whether a layer is currently locked.

pub fn layers(&self) -> Vec<&Layer>

All layers, sorted by their order field (ascending).

pub fn create_group(&mut self, name: &str) -> GroupId

Create a new named group, returning its ID.

pub fn remove_group(&mut self, id: GroupId)

Remove a group by ID. Does not affect its member nodes.

pub fn add_to_group(&mut self, node: NodeId, group: GroupId)

Add a node to a group.

pub fn remove_from_group(&mut self, node: NodeId, group: GroupId)

Remove a node from a group.

pub fn get_group(&self, id: GroupId) -> Option<&Group>

Get a group by ID.

pub fn groups(&self) -> &[Group]

All groups in the scene.

pub fn node_groups(&self, node: NodeId) -> Vec<GroupId>

Which groups contain the given node.

pub fn update_transforms(&mut self)

Recompute world transforms for all dirty nodes (BFS from roots).

pub fn collect_render_items( &mut self, selection: &Selection, ) -> Vec<SceneRenderItem>

Update transforms and collect render items for all visible nodes.

Skips nodes that are invisible, on an invisible layer, or have no mesh. Marks selected nodes based on the provided Selection.

pub fn collect_render_items_culled( &mut self, selection: &Selection, frustum: &Frustum, mesh_aabb_fn: impl Fn(MeshId) -> Option<Aabb>, ) -> (Vec<SceneRenderItem>, CullStats)

Update transforms and collect render items, culling objects outside the frustum.

Like collect_render_items, but skips objects whose world-space AABB is entirely outside the given frustum. mesh_aabb_fn should return the local-space AABB for a given MeshId (typically read from GpuMesh::aabb).

pub fn mesh_ref_count(&self, mesh_id: MeshId) -> usize

Count how many scene nodes reference the given mesh.

O(n) over all nodes. Useful for deciding when to free a GPU mesh.

pub fn walk_depth_first(&self) -> Vec<(NodeId, usize)>

Depth-first traversal of the scene tree. Returns (NodeId, depth) pairs.

Trait Implementations

impl Default for Scene

fn default() -> Self

Returns the “default value” for a type.