Trait DualAxislike

pub trait DualAxislike:
    UserInput
    + DynClone
    + DynEq
    + DynHash
    + Reflect
    + Serialize {
    // Required method
    fn axis_pair(
        &self,
        input_store: &CentralInputStore,
        gamepad: Entity,
    ) -> Vec2;

    // Provided methods
    fn set_axis_pair(&self, world: &mut World, value: Vec2) { ... }
    fn set_axis_pair_as_gamepad(
        &self,
        world: &mut World,
        value: Vec2,
        _gamepad: Option<Entity>,
    ) { ... }
}

A trait used for dual-axis-like user inputs, which provide separate X and Y values.

Required Methods

fn axis_pair(&self, input_store: &CentralInputStore, gamepad: Entity) -> Vec2

Gets the values of this input along the X and Y axes (if applicable).

Provided Methods

fn set_axis_pair(&self, world: &mut World, value: Vec2)

Simulate a dual-axis-like input by sending the appropriate event.

This method defaults to calling DualAxislike::set_axis_pair_as_gamepad if not overridden, as is the case for gamepad-reliant inputs.

fn set_axis_pair_as_gamepad( &self, world: &mut World, value: Vec2, _gamepad: Option<Entity>, )

Simulate a dual-axis-like input, pretending to be the provided gamepad Entity.

This method defaults to calling DualAxislike::set_axis_pair if not overridden, as is the case for things like a mouse wheel.

Use find_gamepad inside of this method to search for a gamepad to press the button on if the provided gamepad is None.

Trait Implementations

impl<'de> Deserialize<'de> for Box<dyn DualAxislike>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for Box<dyn DualAxislike>

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 Box<dyn DualAxislike>

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<'hash> Hash for dyn DualAxislike + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn DualAxislike + Send + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn DualAxislike + Send + Sync + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn DualAxislike + Sync + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'eq> PartialEq<&Box<dyn DualAxislike + 'eq>> for Box<dyn DualAxislike + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'eq> PartialEq<&Box<dyn DualAxislike + Send + 'eq>> for Box<dyn DualAxislike + Send + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'eq> PartialEq<&Box<dyn DualAxislike + Sync + Send + 'eq>> for Box<dyn DualAxislike + Send + Sync + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'eq> PartialEq<&Box<dyn DualAxislike + Sync + 'eq>> for Box<dyn DualAxislike + Sync + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'eq> PartialEq for dyn DualAxislike + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'eq> PartialEq for dyn DualAxislike + Send + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'eq> PartialEq for dyn DualAxislike + Send + Sync + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'eq> PartialEq for dyn DualAxislike + Sync + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for Box<dyn DualAxislike>

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 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 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 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 apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

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

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

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

Attempts to clone Self using reflection.

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

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

fn reflect_partial_eq( &self, _value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

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 Box<dyn DualAxislike>

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<'de> RegisterTypeTag<'de, dyn DualAxislike> for DualAxislikeChord

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn DualAxislike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl<'de> RegisterTypeTag<'de, dyn DualAxislike> for GamepadStick

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn DualAxislike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl<'de> RegisterTypeTag<'de, dyn DualAxislike> for MouseMove

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn DualAxislike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl<'de> RegisterTypeTag<'de, dyn DualAxislike> for MouseScroll

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn DualAxislike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl<'de> RegisterTypeTag<'de, dyn DualAxislike> for VirtualDPad

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn DualAxislike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for dyn DualAxislike + '_

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TypePath for Box<dyn DualAxislike>

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 Box<dyn DualAxislike>

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<'eq> Eq for dyn DualAxislike + 'eq

impl<'eq> Eq for dyn DualAxislike + Send + 'eq

impl<'eq> Eq for dyn DualAxislike + Send + Sync + 'eq

impl<'eq> Eq for dyn DualAxislike + Sync + 'eq

Implementors

impl DualAxislike for DualAxislikeChord

impl DualAxislike for GamepadStick

impl DualAxislike for MouseMove

impl DualAxislike for MouseScroll

impl DualAxislike for VirtualDPad