pub enum SceneFilter {
    Unset,
    Allowlist(HashSet<TypeId>),
    Denylist(HashSet<TypeId>),
}
Expand description

A filter used to control which types can be added to a DynamicScene.

This scene filter can be used more generically to represent a filter for any given type; however, note that its intended usage with DynamicScene only considers components and resources. Adding types that are not a component or resource will have no effect when used with DynamicScene.

Variants§

§

Unset

Represents an unset filter.

This is the equivalent of an empty Denylist or an Allowlist containing every type— essentially, all types are permissible.

Allowing a type will convert this filter to an Allowlist. Similarly, denying a type will convert this filter to a Denylist.

§

Allowlist(HashSet<TypeId>)

Contains the set of permitted types by their TypeId.

Types not contained within this set should not be allowed to be saved to an associated DynamicScene.

§

Denylist(HashSet<TypeId>)

Contains the set of prohibited types by their TypeId.

Types contained within this set should not be allowed to be saved to an associated DynamicScene.

Implementations§

source§

impl SceneFilter

source

pub fn allow_all() -> SceneFilter

Creates a filter where all types are allowed.

This is the equivalent of creating an empty Denylist.

source

pub fn deny_all() -> SceneFilter

Creates a filter where all types are denied.

This is the equivalent of creating an empty Allowlist.

source

pub fn allow<T>(self) -> SceneFilter
where T: Any,

Allow the given type, T.

If this filter is already set as a Denylist, then the given type will be removed from the denied set.

If this filter is Unset, then it will be completely replaced by a new Allowlist.

source

pub fn allow_by_id(self, type_id: TypeId) -> SceneFilter

Allow the given type.

If this filter is already set as a Denylist, then the given type will be removed from the denied set.

If this filter is Unset, then it will be completely replaced by a new Allowlist.

source

pub fn deny<T>(self) -> SceneFilter
where T: Any,

Deny the given type, T.

If this filter is already set as an Allowlist, then the given type will be removed from the allowed set.

If this filter is Unset, then it will be completely replaced by a new Denylist.

source

pub fn deny_by_id(self, type_id: TypeId) -> SceneFilter

Deny the given type.

If this filter is already set as an Allowlist, then the given type will be removed from the allowed set.

If this filter is Unset, then it will be completely replaced by a new Denylist.

source

pub fn is_allowed<T>(&self) -> bool
where T: Any,

Returns true if the given type, T, is allowed by the filter.

If the filter is Unset, this will always return true.

source

pub fn is_allowed_by_id(&self, type_id: TypeId) -> bool

Returns true if the given type is allowed by the filter.

If the filter is Unset, this will always return true.

source

pub fn is_denied<T>(&self) -> bool
where T: Any,

Returns true if the given type, T, is denied by the filter.

If the filter is Unset, this will always return false.

source

pub fn is_denied_by_id(&self, type_id: TypeId) -> bool

Returns true if the given type is denied by the filter.

If the filter is Unset, this will always return false.

source

pub fn iter(&self) -> Box<dyn ExactSizeIterator<Item = &TypeId> + '_>

Returns an iterator over the items in the filter.

If the filter is Unset, this will return an empty iterator.

source

pub fn len(&self) -> usize

Returns the number of items in the filter.

If the filter is Unset, this will always return a length of zero.

source

pub fn is_empty(&self) -> bool

Returns true if there are zero items in the filter.

If the filter is Unset, this will always return true.

Trait Implementations§

source§

impl Clone for SceneFilter

source§

fn clone(&self) -> SceneFilter

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for SceneFilter

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Default for SceneFilter

source§

fn default() -> SceneFilter

Returns the “default value” for a type. Read more
source§

impl IntoIterator for SceneFilter

§

type Item = TypeId

The type of the elements being iterated over.
§

type IntoIter = IntoIter<TypeId>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> <SceneFilter as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
source§

impl PartialEq for SceneFilter

source§

fn eq(&self, other: &SceneFilter) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for SceneFilter

source§

impl StructuralEq for SceneFilter

source§

impl StructuralPartialEq for SceneFilter

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> DynEq for T
where T: Any + Eq,

source§

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

Casts the type to dyn Any.
source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> FromWorld for T
where T: Default,

source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> TypeData for T
where T: 'static + Send + Sync + Clone,

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,