Struct Scene

#[repr(C)]
pub struct Scene {
    pub world: World,
    pub command_buffer: CommandBuffer,
    /* private fields */
}

Scene contains the ECS world and various functionality to interact with it.

Fields

world: World

command_buffer: CommandBuffer

Implementations

impl Scene

pub fn new() -> Self

pub fn get_entity_resource(&self) -> Entity

Gets the entity that contains all the resources

pub fn get_unused_name(&self) -> String

Creates a name that is guaranteed to be unused

pub fn get_or_create_hidden_entity(&mut self, name: &str) -> EntityMut<'_>

Creates a entity with a name or gets the one that already exists with that concrete name You can keep adding components to this entity with .insert()

pub fn get_or_create_entity(&mut self, name: &str) -> EntityMut<'_>

Creates a entity with a name or gets the one that already exists with that concrete name You can keep adding components to this entity with .insert() Also inserts a renderable component

pub fn despawn_with_name(&mut self, name: &str)

Despawns entity with a certain name and all it’s components

pub fn despawn(&mut self, entity: Entity)

pub fn get_entity_with_name(&self, name: &str) -> Option<Entity>

Panics

Will panic if no entity has that name

pub fn get_entity_mut_with_name(&mut self, name: &str) -> Option<EntityMut<'_>>

Panics

Will panic if no entity has that name

pub fn find_entity_with_id(&mut self, id: u8) -> Option<EntityRef<'_>>

Panics

Will return None if no entity with id found

pub fn get_current_cam(&self) -> Option<Camera>

Panics

Will panic if there is no camera added yet

pub fn add_resource<T: Component>(&mut self, component: T)

Use to create a unique component, similar to resources in Bevy

Panics

Will panic if the entity that contains all the resources has not been created

pub fn remove_resource<T: Component>(&mut self) -> Result<T, ComponentError>

Panics

This function will panic if the entity that contains all the resources has not been created.

Errors

This function will return an error if the required component does not exist.

pub fn has_resource<T: Component>(&self) -> bool

Panics

Will panic if the entity that contains all the resources has not been created

pub fn get_resource<'a, T: ComponentRef<'a>>( &'a self, ) -> Result<<T as ComponentRef<'a>>::Ref, ComponentError>

Gets a resource which is a component shared between all entities Use with: scene.get_resource::<&mut Component>();

Errors

Will error if the entity that contains all the resources has not been created

pub fn insert_if_doesnt_exist<T: Component + Default>(&mut self, entity: Entity)

Panics

Will panic if the entity has not been created

pub fn get_comp<'a, T: ComponentRef<'a>>( &'a self, entity: &Entity, ) -> Result<<T as ComponentRef<'a>>::Ref, ComponentError>

Generic function to get a component for a certain entity. Merely syntactic sugar. Use with: scene.get_comp::<&mut Component>(&entity);

Errors

Will error if the component or the entity does not exist

pub fn get_lights(&self, sorted_by_name: bool) -> Vec<Entity>

Panics

Will panic if the entity does not have a name assigned

pub fn get_all_entities(&self, sorted_by_name: bool) -> Vec<Entity>

pub fn get_renderables(&self, sorted_by_name: bool) -> Vec<Entity>

pub fn get_renderable_names(&self) -> Vec<String>

pub fn nr_renderables(&self) -> u32

pub fn get_bounding_points(&self) -> (Point3<f32>, Point3<f32>)

get two points that define the minimal point of the scene in all dimensions and the maximum point of the scene in all directions. These two points would form a rectangle containing the whole scene without the floor

pub fn get_min_y(&self) -> f32

pub fn get_scale(&self) -> f32

get the scale of the scene. useful for adding camera or lights automtically

pub fn get_centroid(&self) -> Point3<f32>

pub fn init_3_point_light( &self, light_config: &mut LightConfig, idx: usize, scale: f32, centroid: &Point3<f32>, )

pub fn make_concrete_config(&self, config: &mut Config)

pub fn from_config(&mut self, config: &mut Config, width: u32, height: u32)

Panics

Will panic if the camera entity has not yet been created

pub fn create_floor(&mut self, config: &Config)

pub fn get_floor(&self) -> Option<Actor>

pub fn has_floor(&self) -> bool

pub fn remove_all_gpu_components(&mut self)

Trait Implementations

impl Default for Scene

fn default() -> Self

Returns the “default value” for a type.

impl GetStaticEquivalent_ for Scene

type StaticEquivalent = _static_Scene

The 'static equivalent of Self

impl StableAbi for Scene

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.