Struct CentralInputStore

pub struct CentralInputStore { /* private fields */ }

An overarching store for all user inputs.

This resource allows values to be updated and fetched in a single location, and ensures that their values are only recomputed once per frame.

To add a new kind of input, call InputRegistration::register_input_kind during App setup.

Implementations

impl CentralInputStore

pub fn clear(&mut self)

Clears all existing values.

This should be called once at the start of each frame, before polling for new input.

pub fn update_buttonlike<B: Buttonlike>( &mut self, buttonlike: B, value: ButtonValue, )

Updates the value of a Buttonlike input.

pub fn update_axislike<A: Axislike>(&mut self, axislike: A, value: f32)

Updates the value of an Axislike input.

pub fn update_dualaxislike<D: DualAxislike>( &mut self, dualaxislike: D, value: Vec2, )

Updates the value of a DualAxislike input.

pub fn update_tripleaxislike<T: TripleAxislike>( &mut self, tripleaxislike: T, value: Vec3, )

Updates the value of a TripleAxislike input.

pub fn pressed<B: Buttonlike + Hash + Eq + Clone>(&self, buttonlike: &B) -> bool

Check if a Buttonlike input is currently pressing.

pub fn button_value<B: Buttonlike + Hash + Eq + Clone>( &self, buttonlike: &B, ) -> f32

Fetches the value of a Buttonlike input.

This should be between 0.0 and 1.0, where 0.0 is not pressed and 1.0 is fully pressed.

pub fn value<A: Axislike + Hash + Eq + Clone>(&self, axislike: &A) -> f32

Fetches the value of an Axislike input.

This should be between -1.0 and 1.0, where -1.0 is fully left or down and 1.0 is fully right or up.

pub fn pair<D: DualAxislike + Hash + Eq + Clone>( &self, dualaxislike: &D, ) -> Vec2

Fetches the value of a DualAxislike input.

pub fn triple<T: TripleAxislike + Hash + Eq + Clone>( &self, tripleaxislike: &T, ) -> Vec3

Fetches the value of a TripleAxislike input.

Trait Implementations

impl Debug for CentralInputStore

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

Formats the value using the given formatter.

impl Default for CentralInputStore

fn default() -> CentralInputStore

Returns the “default value” for a type.

impl FromReflect for CentralInputStore

where CentralInputStore: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Constructs a concrete instance of Self from a reflected value.

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.

impl GetTypeRegistration for CentralInputStore

where CentralInputStore: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialReflect for CentralInputStore

where CentralInputStore: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns an owned enumeration of “kinds” of type.

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.

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

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

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

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

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

Converts this reflected value into its dynamic representation based on its kind.

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

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for CentralInputStore

where CentralInputStore: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

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

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

Performs a type-checked assignment of a reflected value to this value.

impl Struct for CentralInputStore

where CentralInputStore: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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.

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.

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.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

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

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

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

Will return None if TypeInfo is not available.

impl TypePath for CentralInputStore

where CentralInputStore: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

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

Returns the name of the type, or None if it is anonymous.

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

Returns the name of the crate the type is in, or None if it is anonymous.

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

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for CentralInputStore

where CentralInputStore: Any + Send + Sync, HashMap<TypeId, UpdatedValues>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HashSet<TypeId>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for CentralInputStore

where Self: Send + Sync + 'static,