Struct leafwing_input_manager::axislike::DualAxisData

pub struct DualAxisData { /* private fields */ }

A wrapped Vec2 that represents the combaination of two input axes.

The neutral origin is always at 0, 0. When working with gamepad axes, both x and y values are bounded by [-1.0, 1.0]. For other input axes (such as mousewheel data), this may not be true!

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 DualAxisData

pub fn new(x: f32, y: f32) -> DualAxisData

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

pub fn from_xy(xy: Vec2) -> DualAxisData

Creates a new [AxisPair] directly from a Vec2

pub fn merged_with(&self, other: DualAxisData) -> DualAxisData

Merge the state of this [AxisPair] with another.

This is useful if you have multiple sticks bound to the same game action, and you want to get their combined position.

Warning

This method can result in values with a greater maximum magnitude than expected! Use [AxisPair::clamp_length] to limit the resulting direction.

impl DualAxisData

pub fn x(&self) -> f32

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

pub fn y(&self) -> f32

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

pub fn xy(&self) -> Vec2

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

pub fn direction(&self) -> Option<Direction>

The Direction that this axis is pointing towards, if any

If the axis is neutral (x,y) = (0,0), a (0, 0) None 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 length(&self) -> f32

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

Typically bounded by 0 and 1.

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

pub fn length_squared(&self) -> f32

The square of the axis’ magnitude

Typically bounded by 0 and 1.

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

pub fn clamp_length(&mut self, max: f32)

Clamps the magnitude of the axis

Trait Implementations

impl Clone for DualAxisData

fn clone(&self) -> DualAxisData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DualAxisData

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

Formats the value using the given formatter.

impl Default for DualAxisData

fn default() -> DualAxisData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DualAxisData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<DualAxisData> for Vec2

fn from(data: DualAxisData) -> Vec2

Converts to this type from the input type.

impl PartialEq<DualAxisData> for DualAxisData

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

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

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

This method tests for !=.

impl Serialize for DualAxisData

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

Serialize this value into the given Serde serializer.

impl Copy for DualAxisData

impl StructuralPartialEq for DualAxisData