Struct leafwing_input_manager::axislike::DualAxis

pub struct DualAxis {
    pub x: SingleAxis,
    pub y: SingleAxis,
    pub deadzone: DeadZoneShape,
}

Two directional axes combined as one input.

These can be stored in a VirtualDPad, which is itself stored in an InputKind for consumption.

This input will generate a DualAxis which can be read with ActionState::axis_pair.

Warning

positive_low must be greater than or equal to negative_low for both x and y for this type to be validly constructed.

Fields

x: SingleAxis

The axis representing horizontal movement.

y: SingleAxis

The axis representing vertical movement.

deadzone: DeadZoneShape

The shape of the deadzone

Implementations

impl DualAxis

pub const DEFAULT_DEADZONE: f32 = 0.100000001f32

The default size of the deadzone used by constructor methods.

This cannot be changed, but the struct can be easily manually constructed.

pub const DEFAULT_DEADZONE_SHAPE: DeadZoneShape = _

The default shape of the deadzone used by constructor methods.

This cannot be changed, but the struct can be easily manually constructed.

pub fn symmetric( x_axis_type: impl Into<AxisType>, y_axis_type: impl Into<AxisType>, deadzone_shape: DeadZoneShape ) -> DualAxis

Creates a DualAxis with both positive_low and negative_low in both axes set to threshold with a deadzone_shape.

pub fn from_value( x_axis_type: impl Into<AxisType>, y_axis_type: impl Into<AxisType>, x_value: f32, y_value: f32 ) -> DualAxis

Creates a SingleAxis with the specified axis_type and value.

All thresholds are set to 0.0. Primarily useful for input mocking.

pub fn left_stick() -> DualAxis

Creates a DualAxis for the left analogue stick of the gamepad.

pub fn right_stick() -> DualAxis

Creates a DualAxis for the right analogue stick of the gamepad.

pub const fn mouse_wheel() -> DualAxis

Creates a DualAxis corresponding to horizontal and vertical MouseWheel movement

pub const fn mouse_motion() -> DualAxis

Creates a DualAxis corresponding to horizontal and vertical MouseMotion movement

pub fn with_deadzone(self, deadzone: DeadZoneShape) -> DualAxis

Returns this DualAxis with the deadzone set to the specified values and shape

pub fn with_sensitivity( self, x_sensitivity: f32, y_sensitivity: f32 ) -> DualAxis

Returns this DualAxis with the sensitivity set to the specified values

pub fn inverted_x(self) -> DualAxis

Returns this DualAxis with an inverted X-axis.

pub fn inverted_y(self) -> DualAxis

Returns this DualAxis with an inverted Y-axis.

pub fn inverted(self) -> DualAxis

Returns this DualAxis with both axes inverted.

Trait Implementations

impl Clone for DualAxis

fn clone(&self) -> DualAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DualAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DualAxis

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DualAxis> for InputKind

fn from(input: DualAxis) -> Self

Converts to this type from the input type.

impl From<DualAxis> for UserInput

fn from(input: DualAxis) -> Self

Converts to this type from the input type.

impl Hash for DualAxis

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 DualAxis

fn eq(&self, other: &DualAxis) -> 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 DualAxis

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 DualAxis

impl Eq for DualAxis

impl StructuralEq for DualAxis

impl StructuralPartialEq for DualAxis