Struct leafwing_input_manager::axislike::AxisPair

pub struct AxisPair { /* private fields */ }

A high-level abstract user input that varies from -1 to 1, inclusive, along two axes

The neutral origin is always at 0, 0. When constructed; the magnitude is capped at 1, but direction is preserved.

This struct should store the processed form of your raw inputs in a device-agnostic fashion. Any deadzone correction, rescaling or drift-correction should be done at an earlier level.

Implementations

impl AxisPair

pub fn new(xy: Vec2) -> AxisPair

Creates a new AxisPair from the provided (x,y) coordinates

The direction is preserved, by the magnitude will be clamped to at most 1.

impl AxisPair

pub fn x(&self) -> f32

The value along the x-axis, ranging from -1 to 1

pub fn y(&self) -> f32

The value along the y-axis, ranging from -1 to 1

pub fn xy(&self) -> Vec2

The (x, y) values, each ranging from -1 to 1

pub fn direction(&self) -> Direction

The Direction that this axis is pointing towards, if any

If the axis is neutral (x,y) = (0,0), a (0, 0) Direction will be returned

pub fn rotation(&self) -> Option<Rotation>

The Rotation (measured clockwise from midnight) that this axis is pointing towards, if any

If the axis is neutral (x,y) = (0,0), this will be None

pub fn magnitude(&self) -> f32

How far from the origin is this axis’s position?

Always bounded between 0 and 1.

If you only need to compare relative magnitudes, use magnitude_squared instead for faster computation.

pub fn magnitude_squared(&self) -> f32

The square of the axis’ magnitude

Always bounded between 0 and 1.

This is faster than magnitude, as it avoids a square root, but will generally have less natural behavior.

Trait Implementations

impl Clone for AxisPair

fn clone(&self) -> AxisPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AxisPair

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

Formats the value using the given formatter.

impl PartialEq<AxisPair> for AxisPair

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

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

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

This method tests for !=.

impl StructuralPartialEq for AxisPair