Struct leafwing_input_manager::axislike::SingleAxis

pub struct SingleAxis {
    pub axis_type: AxisType,
    pub positive_low: f32,
    pub negative_low: f32,
    pub value: Option<f32>,
}

A single directional axis with a configurable trigger zone.

These can be stored in a InputKind to create a virtual button.

Warning

positive_low must be greater than or equal to negative_low for this type to be validly constructed.

Fields

axis_type: AxisType

The axis that is being checked.

positive_low: f32

Any axis value higher than this will trigger the input.

negative_low: f32

Any axis value lower than this will trigger the input.

value: Option<f32>

The target value for this input, used for input mocking.

WARNING: this field is ignored for the sake of Eq and Hash

Implementations

impl SingleAxis

pub fn symmetric(axis_type: impl Into<AxisType>, threshold: f32) -> SingleAxis

Creates a SingleAxis with both positive_low and negative_low set to threshold.

pub fn from_value(axis_type: impl Into<AxisType>, value: f32) -> SingleAxis

Creates a SingleAxis with the specified axis_type and value.

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

pub const fn mouse_wheel_x() -> SingleAxis

Creates a SingleAxis corresponding to horizontal MouseWheel movement

pub const fn mouse_wheel_y() -> SingleAxis

Creates a SingleAxis corresponding to vertical MouseWheel movement

pub const fn mouse_motion_x() -> SingleAxis

Creates a SingleAxis corresponding to horizontal MouseMotion movement

pub const fn mouse_motion_y() -> SingleAxis

Creates a SingleAxis corresponding to vertical MouseMotion movement

pub fn negative_only(
    axis_type: impl Into<AxisType>,
    threshold: f32
) -> SingleAxis

Creates a SingleAxis with the axis_type and negative_low set to threshold.

Positive values will not trigger the input.

pub fn positive_only(
    axis_type: impl Into<AxisType>,
    threshold: f32
) -> SingleAxis

Creates a SingleAxis with the axis_type and positive_low set to threshold.

Negative values will not trigger the input.

pub fn with_deadzone(self, deadzone: f32) -> SingleAxis

Returns this SingleAxis with the deadzone set to the specified value

Trait Implementations

impl Clone for SingleAxis

fn clone(&self) -> SingleAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SingleAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SingleAxis

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

Deserialize this value from the given Serde deserializer.

impl From<SingleAxis> for InputKind

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

impl From<SingleAxis> for UserInput

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

impl Hash for SingleAxis

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,

Feeds a slice of this type into the given Hasher.

impl PartialEq<SingleAxis> for SingleAxis

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

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

const 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 SingleAxis

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 SingleAxis

impl Eq for SingleAxis