Struct keeshond::scene::Scene

pub struct Scene<T: SceneType + 'static> { /* fields omitted */ }

A world in which Entities, Components, and ThinkerSystems/DrawerSystems reside.

Implementations

impl<T: SceneType + 'static> Scene<T>

pub fn new() -> Self

Creates a new Scene

pub fn component_control(&self) -> &ComponentControl

Returns a reference to the control used to access ComponentStores. You normally don't need to call this yourself.

pub fn component_control_mut(&mut self) -> &mut ComponentControl

Returns a mutable reference to the control used to access ComponentStores. You normally don't need to call this yourself.

pub fn register_component_type<C: Component + 'static>(&mut self) -> bool

pub fn add_component<C: Component + 'static>(
    &mut self,
    entity: &Entity,
    component: C
) -> bool

Attaches a Component to the given Entity. Returns true if successful.

pub fn remove_component<C: Component + 'static>(
    &mut self,
    entity: &Entity
) -> bool

Detaches a Component from the given Entity. Returns true if successful.

pub fn add_entity(&mut self) -> Entity

Creates a new Entity within the scene, returning its handler.

pub fn remove_entity(&mut self, entity: &Entity) -> bool

Removes the Entity with the given handle from the scene. Returns true if successful.

pub fn has_entity(&self, entity: &Entity) -> bool

Returns true if the scene has the given Entity.

pub fn spawn(
    &mut self,
    spawnable_id: T::SpawnableIdType,
    game: &mut GameControl,
    x: f64,
    y: f64,
    args: &[SpawnArg]
)

pub fn add_thinker_system(&mut self, system: Box<dyn ThinkerSystem<T>>)

Adds the given ThinkerSystem to the scene

pub fn add_drawer_system(&mut self, system: Box<dyn DrawerSystem>)

Adds the given DrawerSystem to the scene

Trait Implementations

impl<T: SceneType + 'static> BaseScene for Scene<T>

fn think(&mut self, game: &mut GameControl)

Processes all the ThinkerSystems in this scene. You normally do not need to call this yourself, as the Gameloop handles this for you.

fn start(&mut self, game: &mut GameControl) -> bool

Allows all the ThinkerSystems to process their "start of scene" actions. You normally do not need to call this yourself, as the Gameloop handles this for you.

fn end(&mut self, game: &mut GameControl) -> bool

Allows all the ThinkerSystems to process their "end of scene" actions. You normally do not need to call this yourself, as the Gameloop handles this for you.

fn draw(
    &mut self,
    drawing: &mut Box<dyn DrawControl>,
    transform: &DrawTransform,
    interpolation: f32
)

Processes all the DrawerSystems in this scene. You normally do not need to call this yourself, as the Gameloop handles this for you.

fn entity_count(&self) -> usize

Returns the number of Entities in the scene

fn component_count(&self) -> usize

Returns the number of Components in the scene