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 fn from_keys(negative: KeyCode, positive: KeyCode) -> VirtualAxis

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

pub fn horizontal_arrow_keys() -> VirtualAxis

Generates a VirtualAxis corresponding to the horizontal arrow keyboard keycodes

pub fn vertical_arrow_keys() -> VirtualAxis

Generates a VirtualAxis corresponding to the horizontal arrow keyboard keycodes

pub fn ad() -> VirtualAxis

Generates a VirtualAxis corresponding to the AD keyboard keycodes.

pub fn ws() -> VirtualAxis

Generates a VirtualAxis corresponding to the WS keyboard keycodes.

pub fn horizontal_dpad() -> VirtualAxis

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

pub fn vertical_dpad() -> VirtualAxis

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

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 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 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 Eq for VirtualAxis

impl StructuralEq for VirtualAxis

impl StructuralPartialEq for VirtualAxis