Struct bevy::prelude::DynamicSceneBuilder
pub struct DynamicSceneBuilder<'w> { /* private fields */ }
Expand description
A DynamicScene
builder, used to build a scene from a World
by extracting some entities and resources.
Component Extraction
By default, all components registered with ReflectComponent
type data in a world’s AppTypeRegistry
will be extracted.
(this type data is added automatically during registration if Reflect
is derived with the #[reflect(Component)]
attribute).
This can be changed by specifying a filter or by explicitly
allowing/denying certain components.
Extraction happens immediately and uses the filter as it exists during the time of extraction.
Resource Extraction
By default, all resources registered with ReflectResource
type data in a world’s AppTypeRegistry
will be extracted.
(this type data is added automatically during registration if Reflect
is derived with the #[reflect(Resource)]
attribute).
This can be changed by specifying a filter or by explicitly
allowing/denying certain resources.
Extraction happens immediately and uses the filter as it exists during the time of extraction.
Entity Order
Extracted entities will always be stored in ascending order based on their index.
This means that inserting Entity(1v0)
then Entity(0v0)
will always result in the entities
being ordered as [Entity(0v0), Entity(1v0)]
.
Example
let mut builder = DynamicSceneBuilder::from_world(&world);
builder.extract_entity(entity);
let dynamic_scene = builder.build();
Implementations§
§impl<'w> DynamicSceneBuilder<'w>
impl<'w> DynamicSceneBuilder<'w>
pub fn from_world(world: &'w World) -> DynamicSceneBuilder<'w>
pub fn from_world(world: &'w World) -> DynamicSceneBuilder<'w>
Prepare a builder that will extract entities and their component from the given World
.
pub fn with_filter(
&mut self,
filter: SceneFilter
) -> &mut DynamicSceneBuilder<'w>
pub fn with_filter( &mut self, filter: SceneFilter ) -> &mut DynamicSceneBuilder<'w>
Specify a custom component SceneFilter
to be used with this builder.
pub fn with_resource_filter(
&mut self,
filter: SceneFilter
) -> &mut DynamicSceneBuilder<'w>
pub fn with_resource_filter( &mut self, filter: SceneFilter ) -> &mut DynamicSceneBuilder<'w>
Specify a custom resource SceneFilter
to be used with this builder.
pub fn allow<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where
T: Component,
pub fn allow<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where T: Component,
Allows the given component type, T
, to be included in the generated scene.
This method may be called multiple times for any number of components.
This is the inverse of deny
.
If T
has already been denied, then it will be removed from the denylist.
pub fn deny<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where
T: Component,
pub fn deny<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where T: Component,
Denies the given component type, T
, from being included in the generated scene.
This method may be called multiple times for any number of components.
This is the inverse of allow
.
If T
has already been allowed, then it will be removed from the allowlist.
pub fn allow_all(&mut self) -> &mut DynamicSceneBuilder<'w>
pub fn allow_all(&mut self) -> &mut DynamicSceneBuilder<'w>
Updates the filter to allow all component types.
This is useful for resetting the filter so that types may be selectively denied.
pub fn deny_all(&mut self) -> &mut DynamicSceneBuilder<'w>
pub fn deny_all(&mut self) -> &mut DynamicSceneBuilder<'w>
Updates the filter to deny all component types.
This is useful for resetting the filter so that types may be selectively allowed.
pub fn allow_resource<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where
T: Resource,
pub fn allow_resource<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where T: Resource,
Allows the given resource type, T
, to be included in the generated scene.
This method may be called multiple times for any number of resources.
This is the inverse of deny_resource
.
If T
has already been denied, then it will be removed from the denylist.
pub fn deny_resource<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where
T: Resource,
pub fn deny_resource<T>(&mut self) -> &mut DynamicSceneBuilder<'w>where T: Resource,
Denies the given resource type, T
, from being included in the generated scene.
This method may be called multiple times for any number of resources.
This is the inverse of allow_resource
.
If T
has already been allowed, then it will be removed from the allowlist.
pub fn allow_all_resources(&mut self) -> &mut DynamicSceneBuilder<'w>
pub fn allow_all_resources(&mut self) -> &mut DynamicSceneBuilder<'w>
Updates the filter to allow all resource types.
This is useful for resetting the filter so that types may be selectively denied.
pub fn deny_all_resources(&mut self) -> &mut DynamicSceneBuilder<'w>
pub fn deny_all_resources(&mut self) -> &mut DynamicSceneBuilder<'w>
Updates the filter to deny all resource types.
This is useful for resetting the filter so that types may be selectively allowed.
pub fn build(self) -> DynamicScene
pub fn build(self) -> DynamicScene
Consume the builder, producing a DynamicScene
.
To make sure the dynamic scene doesn’t contain entities without any components, call
Self::remove_empty_entities
before building the scene.
pub fn extract_entity(&mut self, entity: Entity) -> &mut DynamicSceneBuilder<'w>
pub fn extract_entity(&mut self, entity: Entity) -> &mut DynamicSceneBuilder<'w>
Extract one entity from the builder’s World
.
Re-extracting an entity that was already extracted will have no effect.
pub fn remove_empty_entities(&mut self) -> &mut DynamicSceneBuilder<'w>
pub fn remove_empty_entities(&mut self) -> &mut DynamicSceneBuilder<'w>
Despawns all entities with no components.
These were likely created because none of their components were present in the provided type registry upon extraction.
pub fn extract_entities(
&mut self,
entities: impl Iterator<Item = Entity>
) -> &mut DynamicSceneBuilder<'w>
pub fn extract_entities( &mut self, entities: impl Iterator<Item = Entity> ) -> &mut DynamicSceneBuilder<'w>
Extract entities from the builder’s World
.
Re-extracting an entity that was already extracted will have no effect.
To control which components are extracted, use the allow
or
deny
helper methods.
This method may be used to extract entities from a query:
#[derive(Component, Default, Reflect)]
#[reflect(Component)]
struct MyComponent;
let mut query = world.query_filtered::<Entity, With<MyComponent>>();
let mut builder = DynamicSceneBuilder::from_world(&world);
builder.extract_entities(query.iter(&world));
let scene = builder.build();
Note that components extracted from queried entities must still pass through the filter if one is set.
pub fn extract_resources(&mut self) -> &mut DynamicSceneBuilder<'w>
pub fn extract_resources(&mut self) -> &mut DynamicSceneBuilder<'w>
Extract resources from the builder’s World
.
Re-extracting a resource that was already extracted will have no effect.
To control which resources are extracted, use the allow_resource
or
deny_resource
helper methods.
#[derive(Resource, Default, Reflect)]
#[reflect(Resource)]
struct MyResource;
world.insert_resource(MyResource);
let mut builder = DynamicSceneBuilder::from_world(&world);
builder.extract_resources();
let scene = builder.build();
Auto Trait Implementations§
impl<'w> !RefUnwindSafe for DynamicSceneBuilder<'w>
impl<'w> Send for DynamicSceneBuilder<'w>
impl<'w> Sync for DynamicSceneBuilder<'w>
impl<'w> Unpin for DynamicSceneBuilder<'w>
impl<'w> !UnwindSafe for DynamicSceneBuilder<'w>
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.