Struct Scene 

pub struct Scene { /* private fields */ }

A hierarchical scene graph for storing and organizing nodes.

the scene manages the Scene Tree which stores Nodes in a Tree structure meaning Nodes can have children. Nodes are stored internally using a RWLock to allow mutibility because of this borrow checking is runtime managed and calling .write on the same node twice at once will panic.

Example

let scene = Scene::new();
let camera = scene.add("main_camera", Camera3D::default());
let player = Scene.add("player", Player::default());
player.add_child("tool", Tool::new());

Implementations

impl<'a> Scene

pub fn new() -> Scene

pub fn spawn<T>(&'a self, name: impl Into<String>, node: T) -> NodeHandle<'a, T>

where T: Node,

Adds a node to the root of the scene with no parents.

pub fn spawn_as_child<T>( &'a self, name: impl Into<String>, node: T, parent: NodeId, ) -> NodeHandle<'a, T>

where T: Node,

Adds a node to the scene with a parent

pub fn on<E, N>( &self, node: NodeId, handler: impl FnMut(EventCtx<'_, E, N>) + SendSync + 'static, )

where E: EventLabel, N: Node,

add an event to a node

pub fn merge(&self, other: impl Into<Scene>) -> Vec<NodeId>

merge a different scene into this one preserving the hierarchy.

pub fn merge_as_child( &self, other: impl Into<Scene>, parent: NodeId, ) -> Vec<NodeId>

merge a different scene as a child of a specified node

pub fn merge_asset<T>(&self, handle: AssetHandle<T>)

where T: Asset + SceneAsset,

merge a scene without blocking the load

pub fn merge_asset_as_child<T>(&self, handle: AssetHandle<T>, parent: NodeId)

where T: Asset + SceneAsset,

merge a scene assent as a child of a node

pub fn get<T>(&'a self, id: NodeId) -> Option<NodeHandle<'a, T>>

where T: Node,

get handle to a node via an id

pub fn get_by_name<T>(&'a self, name: &str) -> Option<NodeHandle<'a, T>>

where T: Node,

get a node by name

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

get the parent of the node

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

get the children of the node

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

get the name of a node

pub fn collect<T>(&'a self) -> Vec<NodeHandle<'a, T>>

where T: Node,

collects all nodes of a specific type

pub fn root_ids(&self) -> Vec<NodeId>

get all the root node ids

pub fn emit<E>(&self, event: &E, ctx: &GameContext)

where E: EventLabel,

emit an event to the scene (this will also update world space transforms)

pub fn sync_world_transform(&self)

goes through every node and updates the world position recursively

this is done once per frame after update

pub fn emit_to<E>(&self, id: NodeId, event: &E, ctx: &GameContext)

where E: EventLabel,

emit an event to a single node

pub fn for_each<T>(&self, f: &mut impl FnMut(&mut T))

where T: Node,

run a callback on each node of a specific type

pub fn for_each_ref<T>(&self, f: &mut impl FnMut(&T))

where T: Node,

run a callback for each node of a specific type

pub fn for_each_with_id<T>(&self, f: &mut impl FnMut(NodeId, &mut T))

where T: Node,

run a callback on each node of a specific type and get the NodeId

pub fn poll_async(&mut self, assets: &AssetLibrary)

polls pending assets and adds them if ready

Trait Implementations

impl Default for Scene

fn default() -> Scene

Returns the “default value” for a type.

impl IntoScene for Scene

fn into(self, _assets: &AssetLibrary) -> Scene