Enum amethyst_input::Axis

pub enum Axis {
    Emulated {
        pos: Button,
        neg: Button,
    },
    Controller {
        controller_id: u32,
        axis: ControllerAxis,
        invert: bool,
        dead_zone: f64,
    },
    Mouse {
        axis: MouseAxis,
        over_extendable: bool,
        radius: f32,
    },
    MouseWheel {
        horizontal: bool,
    },
}

Represents any input represented by a float value from -1 to 1. Retrieve the value of this with axis_value.

Variants

Emulated

Represents an emulated analogue axis made up of pair of digital inputs, like W and S keyboard buttons or DPadUp and DPadDown controller buttons.

Fields of Emulated

pos: Button

Positive button, when pressed down axis value will return 1 if neg is not pressed down.

neg: Button

Negative button, when pressed down axis value will return -1 if pos is not pressed down.

Controller

Represents an analogue axis of a controller.

Fields of Controller

controller_id: u32

A number representing a specific controller, assigned and reused in order of connection.

axis: ControllerAxis

The axis being bound

invert: bool

Whether or not to multiply the axis value by -1.

dead_zone: f64

Treat input values from -dead_zone to dead_zone as 0, linearly interpolate remaining ranges.

Mouse

Represents a mouse as a 2D input device

Fields of Mouse

axis: MouseAxis

The axis being bound

over_extendable: bool

Should the API be allowed to return values outside [-1..1]?

radius: f32

Zone to which the movement is relative

MouseWheel

Represents the wheel on a PC mouse.

Fields of MouseWheel

horizontal: bool

If this value is true then this axis is for the horizontal mouse wheel rather than the vertical mouse wheel.

You almost always want this false.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Axis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Axis

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Axis> for Axis

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

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

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

This method tests for !=.

impl Serialize for Axis

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Axis