Struct MapComponent

Source
pub struct MapComponent<Upstream, C> { /* private fields */ }
Expand description

Represents a node that extracts a component C from an entity signal. Implements Signal.

This is a specialized map node where the upstream signal emits Entity values. It attempts to get the component C from the emitted entity and propagates the component’s value. If the entity does not have the component, the signal terminates for that update.

Trait Implementations§

Source§

impl<Upstream: Clone, C: Clone> Clone for MapComponent<Upstream, C>

Source§

fn clone(&self) -> MapComponent<Upstream, C>

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<Upstream, C> FromReflect for MapComponent<Upstream, C>
where MapComponent<Upstream, C>: Any + Send + Sync, Upstream: TypePath, C: TypePath, Map<Upstream, C>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.
Source§

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails. Read more
Source§

impl<Upstream, C> GetTypeRegistration for MapComponent<Upstream, C>
where MapComponent<Upstream, C>: Any + Send + Sync, Upstream: TypePath, C: TypePath, Map<Upstream, C>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.
Source§

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type. Read more
Source§

impl<Upstream, C> PartialReflect for MapComponent<Upstream, C>
where MapComponent<Upstream, C>: Any + Send + Sync, Upstream: TypePath, C: TypePath, Map<Upstream, C>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value. Read more
Source§

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object. Read more
Source§

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value. Read more
Source§

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type. Read more
Source§

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type. Read more
Source§

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type. Read more
Source§

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type. Read more
Source§

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.
Source§

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.
Source§

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.
Source§

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value. Read more
Source§

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value. Read more
Source§

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value. Read more
Source§

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result. Read more
Source§

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value. Read more
Source§

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type). Read more
Source§

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

Debug formatter for the value. Read more
Source§

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value. Read more
Source§

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type. Read more
Source§

impl<Upstream, C> Reflect for MapComponent<Upstream, C>
where MapComponent<Upstream, C>: Any + Send + Sync, Upstream: TypePath, C: TypePath, Map<Upstream, C>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

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

Returns the value as a Box<dyn Any>. Read more
Source§

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any. Read more
Source§

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.
Source§

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.
Source§

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.
Source§

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value. Read more
Source§

impl<Upstream, C> Signal for MapComponent<Upstream, C>
where Upstream: Signal<Item = Entity>, Upstream::Item: FromReflect + SSs, C: Component + Clone + FromReflect + SSs,

Source§

type Item = C

The type of value produced by this signal.
Source§

fn register_signal(self, world: &mut World) -> SignalHandle

Registers the systems associated with this node and its predecessors in the World. Returns a SignalHandle containing the entities of all systems registered or reference-counted during this specific registration call instance. Note: This method is intended for internal use by the signal combinators and registration process.
Source§

impl<Upstream, C> Struct for MapComponent<Upstream, C>
where MapComponent<Upstream, C>: Any + Send + Sync, Upstream: TypePath, C: TypePath, Map<Upstream, C>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.
Source§

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.
Source§

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.
Source§

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.
Source§

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.
Source§

fn field_len(&self) -> usize

Returns the number of fields in the struct.
Source§

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.
Source§

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.
Source§

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.
Source§

impl<Upstream, C> TypePath for MapComponent<Upstream, C>
where MapComponent<Upstream, C>: Any + Send + Sync, Upstream: TypePath, C: TypePath,

Source§

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type. Read more
Source§

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type. Read more
Source§

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous. Read more
Source§

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous. Read more
Source§

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous. Read more
Source§

impl<Upstream, C> Typed for MapComponent<Upstream, C>
where MapComponent<Upstream, C>: Any + Send + Sync, Upstream: TypePath, C: TypePath, Map<Upstream, C>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

Auto Trait Implementations§

§

impl<Upstream, C> Freeze for MapComponent<Upstream, C>
where Upstream: Freeze,

§

impl<Upstream, C> RefUnwindSafe for MapComponent<Upstream, C>
where Upstream: RefUnwindSafe, C: RefUnwindSafe,

§

impl<Upstream, C> Send for MapComponent<Upstream, C>
where Upstream: Send, C: Send,

§

impl<Upstream, C> Sync for MapComponent<Upstream, C>
where Upstream: Sync, C: Sync,

§

impl<Upstream, C> Unpin for MapComponent<Upstream, C>
where Upstream: Unpin, C: Unpin,

§

impl<Upstream, C> UnwindSafe for MapComponent<Upstream, C>
where Upstream: UnwindSafe, C: UnwindSafe,

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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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 + Sync + Send>

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> DynamicTypePath for T
where T: TypePath,

Source§

impl<T> DynamicTyped for T
where T: Typed,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> GetField for S
where S: Struct,

Source§

fn get_field<T>(&self, name: &str) -> Option<&T>
where T: Reflect,

Returns a reference to the value of the field named name, downcast to T.
Source§

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>
where T: Reflect,

Returns a mutable reference to the value of the field named name, downcast to T.
Source§

impl<T> GetPath for T
where T: Reflect + ?Sized,

Source§

fn reflect_path<'p>( &self, path: impl ReflectPath<'p>, ) -> Result<&(dyn PartialReflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by path. Read more
Source§

fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut (dyn PartialReflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by path. Read more
Source§

fn path<'p, T>( &self, path: impl ReflectPath<'p>, ) -> Result<&T, ReflectPathError<'p>>
where T: Reflect,

Returns a statically typed reference to the value specified by path. Read more
Source§

fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut T, ReflectPathError<'p>>
where T: Reflect,

Returns a statically typed mutable reference to the value specified by path. Read more
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> IntoSignalEither for T
where T: Signal + FromReflect + SSs,

Source§

fn left_either<R>(self) -> SignalEither<Self, R>
where R: Signal + FromReflect + SSs,

Source§

fn right_either<L>(self) -> SignalEither<L, Self>
where L: Signal + FromReflect + SSs,

Source§

impl<T> SignalExt for T
where T: Signal,

Source§

fn map<O, IOO, F, M>(self, system: F) -> Map<Self, O>
where Self: Sized, Self::Item: FromReflect + SSs, O: FromReflect + SSs, IOO: Into<Option<O>> + SSs, F: IntoSystem<In<Self::Item>, IOO, M> + Send + Sync + 'static, M: SSs,

Appends a transformation step to the signal chain using a Bevy system. Read more
Source§

fn component<C>(self) -> MapComponent<Self, C>
where Self: Sized + Signal<Item = Entity>, C: Component + Clone + FromReflect + SSs,

Extracts a component C from a signal emitting Entity values. Read more
Source§

fn component_option<C>(self) -> ComponentOption<Self, C>

Extracts an Option<C> of a component from a signal emitting Entity values. Read more
Source§

fn has_component<C>(self) -> HasComponent<Self, C>
where Self: Sized + Signal<Item = Entity>, C: Component + Clone + FromReflect + SSs,

Checks if an entity from an entity signal has component C. Read more
Source§

fn dedupe(self) -> Dedupe<Self>
where Self: Sized, Self::Item: PartialEq + Clone + FromReflect + SSs,

Filters out consecutive duplicate values from the signal. Read more
Source§

fn first(self) -> First<Self>
where Self: Sized, Self::Item: FromReflect + SSs,

Emits only the very first value received from the upstream signal. Read more
Source§

fn combine<Other>(self, other: Other) -> Combine<Self, Other>

Combines this signal with another signal (other). Read more
Source§

fn flatten(self) -> Flatten<Self>
where Self: Sized, Self::Item: FromReflect + Signal + Clone, <Self::Item as Signal>::Item: FromReflect + SSs + Clone,

Flattens a signal where the item type is itself a signal (Signal<Item = impl Signal>). Read more
Source§

fn eq(self, value: Self::Item) -> Eq<Self>
where Self: Sized, Self::Item: PartialEq + FromReflect + SSs,

Compares the signal’s value for equality with a fixed value. Read more
Source§

fn neq(self, value: Self::Item) -> Neq<Self>
where Self: Sized, Self::Item: PartialEq + FromReflect + SSs,

Compares the signal’s value for inequality with a fixed value. Read more
Source§

fn not(self) -> Not<Self>
where Self: Sized, <Self as Signal>::Item: Not + FromReflect + SSs, <<Self as Signal>::Item as Not>::Output: FromReflect + SSs + Clone,

Applies logical negation to the signal’s value. Read more
Source§

fn filter<M>( self, predicate: impl IntoSystem<In<Self::Item>, bool, M> + Send + Sync + 'static, ) -> Filter<Self>
where Self: Sized, Self::Item: Clone + FromReflect + SSs,

Filters the signal based on a predicate system. Read more
Source§

fn switch<S, F, M>(self, switcher: F) -> Switch<Self, S>
where Self: Sized, Self::Item: FromReflect + SSs, S: Signal + Clone + FromReflect + SSs, S::Item: FromReflect + SSs + Clone, F: IntoSystem<In<Self::Item>, S, M> + Send + Sync + 'static, M: SSs,

Dynamically switches the signal’s behavior based on its own output. Read more
Source§

fn throttle(self, duration: Duration) -> Throttle<Self>
where Self: Sized, Self::Item: FromReflect + SSs,

Throttles the signal, ensuring a minimum duration between emitted values. Read more
Source§

fn map_bool<O, IOO, TF, FF, TM, FM>( self, true_system: TF, false_system: FF, ) -> MapBool<Self, O>
where Self: Sized + Signal<Item = bool>, O: FromReflect + SSs, IOO: Into<Option<O>> + SSs, TF: IntoSystem<In<()>, IOO, TM> + Send + Sync + 'static, FF: IntoSystem<In<()>, IOO, FM> + Send + Sync + 'static, TM: SSs, FM: SSs,

Maps the signal’s value using one of two systems based on the upstream boolean signal. Read more
Source§

fn map_true<O, IOO, TF, TM>(self, system: TF) -> MapTrue<Self, O>
where Self: Sized + Signal<Item = bool>, O: FromReflect + SSs, IOO: Into<Option<O>> + SSs, TF: IntoSystem<In<()>, IOO, TM> + Send + Sync + 'static, TM: SSs,

Maps the signal’s value using a system only if the upstream boolean signal is true. Read more
Source§

fn map_false<O, IOO, FF, FM>(self, system: FF) -> MapFalse<Self, O>
where Self: Sized + Signal<Item = bool>, O: FromReflect + SSs, IOO: Into<Option<O>> + SSs, FF: IntoSystem<In<()>, IOO, FM> + Send + Sync + 'static, FM: SSs,

Maps the signal’s value using a system only if the upstream boolean signal is false. Read more
Source§

fn map_option<I, O, IOO, SF, NF, SM, NM>( self, some_system: SF, none_system: NF, ) -> MapOption<Self, I, O>
where Self: Sized + Signal<Item = Option<I>>, I: FromReflect + GetTypeRegistration + Typed + SSs, O: FromReflect + SSs, IOO: Into<Option<O>> + SSs, SF: IntoSystem<In<I>, IOO, SM> + Send + Sync + 'static, NF: IntoSystem<In<()>, IOO, NM> + Send + Sync + 'static, SM: SSs, NM: SSs,

Maps the signal’s value using different systems for Some and None values. Read more
Source§

fn map_some<I, O, IOO, SF, SM>(self, system: SF) -> MapSome<Self, I, O>
where Self: Sized + Signal<Item = Option<I>>, I: FromReflect + GetTypeRegistration + Typed + SSs, O: FromReflect + SSs, IOO: Into<Option<O>> + SSs, SF: IntoSystem<In<I>, IOO, SM> + Send + Sync + 'static, SM: SSs,

Maps the signal’s value using a system only if the upstream signal emits Some(T). Read more
Source§

fn map_none<I, O, IOO, NF, NM>(self, none_system: NF) -> MapNone<Self, I, O>
where Self: Sized + Signal<Item = Option<I>>, I: FromReflect + GetTypeRegistration + Typed + SSs, O: FromReflect + SSs, IOO: Into<Option<O>> + SSs, NF: IntoSystem<In<()>, IOO, NM> + Send + Sync + 'static, NM: SSs,

Maps the signal’s value using a system only if the upstream signal emits None. Read more
Source§

fn debug(self) -> SignalDebug<Self>
where Self: Sized, Self::Item: Debug + FromReflect + SSs,

Adds debug logging to the signal chain. Read more
Source§

fn register(self, world: &mut World) -> SignalHandle
where Self: Sized,

Registers all the systems defined in this signal chain into the Bevy World. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Reflectable for T

Source§

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