Struct fyrox::scene::SceneContainer

pub struct SceneContainer { /* private fields */ }

Container for scenes in the engine.

Implementations

impl SceneContainer

pub fn is_valid_handle(&self, handle: Handle<Scene>) -> bool

Return true if given handle is valid and “points” to “alive” scene.

pub fn pair_iter(&self) -> impl Iterator<Item = (Handle<Scene>, &Scene)>

Returns pair iterator which yields (handle, scene_ref) pairs.

pub fn pair_iter_mut( &mut self ) -> impl Iterator<Item = (Handle<Scene>, &mut Scene)>

Returns pair iterator which yields (handle, scene_ref) pairs.

pub fn try_get(&self, handle: Handle<Scene>) -> Option<&Scene>

Tries to borrow a scene using its handle.

pub fn try_get_mut(&mut self, handle: Handle<Scene>) -> Option<&mut Scene>

Tries to borrow a scene using its handle.

pub fn iter(&self) -> impl Iterator<Item = &Scene>

Creates new iterator over scenes in container.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Scene>

Creates new mutable iterator over scenes in container.

pub fn add(&mut self, scene: Scene) -> Handle<Scene>

Adds new scene into container.

pub fn clear(&mut self)

Removes all scenes from container.

pub fn remove(&mut self, handle: Handle<Scene>)

Removes given scene from container. The scene will be destroyed on a next update call.

pub fn take_reserve(&mut self, handle: Handle<Scene>) -> (Ticket<Scene>, Scene)

Takes scene from the container and transfers ownership to caller. You must either put scene back using ticket or call forget_ticket to make memory used by scene vacant again.

pub fn put_back(&mut self, ticket: Ticket<Scene>, scene: Scene) -> Handle<Scene>

Puts scene back using its ticket.

pub fn forget_ticket(&mut self, ticket: Ticket<Scene>)

Forgets ticket of a scene, making place at which ticket points, vacant again.

Trait Implementations

impl Index<Handle<Scene>> for SceneContainer

type Output = Scene

The returned type after indexing.

fn index( &self, index: Handle<Scene> ) -> &<SceneContainer as Index<Handle<Scene>>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Handle<Scene>> for SceneContainer

fn index_mut( &mut self, index: Handle<Scene> ) -> &mut <SceneContainer as Index<Handle<Scene>>>::Output

Performs the mutable indexing (container[index]) operation.