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 dynamic_scene = DynamicSceneBuilder::from_world(&world).extract_entity(entity).build();

Implementations§

source§

impl<'w> DynamicSceneBuilder<'w>

source

pub fn from_world(world: &'w World) -> DynamicSceneBuilder<'w>

Prepare a builder that will extract entities and their component from the given World.

source

pub fn with_filter(self, filter: SceneFilter) -> DynamicSceneBuilder<'w>

Specify a custom component SceneFilter to be used with this builder.

source

pub fn with_resource_filter( self, filter: SceneFilter ) -> DynamicSceneBuilder<'w>

Specify a custom resource SceneFilter to be used with this builder.

source

pub fn allow<T>(self) -> 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.

source

pub fn deny<T>(self) -> 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.

source

pub fn allow_all(self) -> DynamicSceneBuilder<'w>

Updates the filter to allow all component types.

This is useful for resetting the filter so that types may be selectively denied.

source

pub fn deny_all(self) -> DynamicSceneBuilder<'w>

Updates the filter to deny all component types.

This is useful for resetting the filter so that types may be selectively allowed.

source

pub fn allow_resource<T>(self) -> 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.

source

pub fn deny_resource<T>(self) -> 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.

source

pub fn allow_all_resources(self) -> DynamicSceneBuilder<'w>

Updates the filter to allow all resource types.

This is useful for resetting the filter so that types may be selectively denied.

source

pub fn deny_all_resources(self) -> DynamicSceneBuilder<'w>

Updates the filter to deny all resource types.

This is useful for resetting the filter so that types may be selectively allowed.

source

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.

source

pub fn extract_entity(self, entity: Entity) -> DynamicSceneBuilder<'w>

Extract one entity from the builder’s World.

Re-extracting an entity that was already extracted will have no effect.

source

pub fn remove_empty_entities(self) -> 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.

source

pub fn extract_entities( self, entities: impl Iterator<Item = Entity> ) -> 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 scene = DynamicSceneBuilder::from_world(&world)
    .extract_entities(query.iter(&world))
    .build();

Note that components extracted from queried entities must still pass through the filter if one is set.

source

pub fn extract_resources(self) -> 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).extract_resources();
let scene = builder.build();

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,