Struct leafwing_input_manager::axislike::VirtualAxis

pub struct VirtualAxis {
    pub negative: InputKind,
    pub positive: InputKind,
}

A virtual Axis that you can get a value between -1 and 1 from.

Typically, you don’t want to store a SingleAxis in this type, even though it can be stored as an InputKind.

Instead, use it directly as InputKind::SingleAxis!

Fields

negative: InputKind

The input that represents the negative direction of this virtual axis

positive: InputKind

The input that represents the positive direction of this virtual axis

Implementations

impl VirtualAxis

pub const fn from_keys(negative: KeyCode, positive: KeyCode) -> VirtualAxis

Helper function for generating a VirtualAxis from arbitrary keycodes, shorthand for wrapping each key in InputKind::PhysicalKey

pub const fn horizontal_arrow_keys() -> VirtualAxis

Generates a VirtualAxis corresponding to the horizontal arrow keyboard keycodes

pub const fn vertical_arrow_keys() -> VirtualAxis

Generates a VirtualAxis corresponding to the horizontal arrow keyboard keycodes

pub const fn ad() -> VirtualAxis

Generates a VirtualAxis corresponding to the AD keyboard keycodes.

pub const fn ws() -> VirtualAxis

Generates a VirtualAxis corresponding to the WS keyboard keycodes.

pub const fn horizontal_dpad() -> VirtualAxis

Generates a VirtualAxis corresponding to the horizontal DPad buttons on a gamepad.

pub const fn vertical_dpad() -> VirtualAxis

Generates a VirtualAxis corresponding to the vertical DPad buttons on a gamepad.

pub const fn horizontal_gamepad_face_buttons() -> VirtualAxis

Generates a VirtualAxis corresponding to the horizontal gamepad face buttons.

pub const fn vertical_gamepad_face_buttons() -> VirtualAxis

Generates a VirtualAxis corresponding to the vertical gamepad face buttons.

pub fn inverted(self) -> Self

Returns this VirtualAxis but with flipped positive/negative inputs.

Trait Implementations

impl Clone for VirtualAxis

fn clone(&self) -> VirtualAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VirtualAxis

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<VirtualAxis> for UserInput

fn from(input: VirtualAxis) -> Self

Converts to this type from the input type.

impl FromReflect for VirtualAxis

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

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

Constructs a concrete instance of Self from a reflected value.

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

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for VirtualAxis

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Hash for VirtualAxis

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VirtualAxis

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

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

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.

impl Reflect for VirtualAxis

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

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

Returns the [TypeInfo] of the type represented by this value.

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 reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

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

fn apply(&mut self, value: &dyn Reflect)

Applies 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 reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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 serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for VirtualAxis

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for VirtualAxis

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

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

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

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

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

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

Returns a reference to the value of the field with index index as a &dyn Reflect.

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl TypePath for VirtualAxis

where Self: 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 VirtualAxis

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for VirtualAxis

impl StructuralPartialEq for VirtualAxis