[−][src]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,
    },
    Multiple(Vec<Axis>),
}

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.

Multiple(Vec<Axis>)

Represents multiple input alternatives. Allows to bind more than one input to a single axis.

Trait Implementations

`impl Clone for Axis`[src]

`fn clone(&self) -> Axis`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Axis`[src]

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

`impl<'de> Deserialize<'de> for Axis`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

`impl PartialEq<Axis> for Axis`[src]

`fn eq(&self, other: &Axis) -> bool`[src]

`fn ne(&self, other: &Axis) -> bool`[src]

`impl Serialize for Axis`[src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl StructuralPartialEq for Axis`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Axis`

`impl Send for Axis`

`impl Sync for Axis`

`impl Unpin for Axis`

`impl UnwindSafe for Axis`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Any for T where T: Any,`

`fn get_type_id(&self) -> TypeId`

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Config for T where T: for<'a> Deserialize<'a> + Serialize,` [src]

`fn load(path: P) -> Result<T, ConfigError> where P: AsRef<Path>,` [src]

`fn load_bytes(bytes: &[u8]) -> Result<T, ConfigError>`[src]

`fn write(&self, path: P) -> Result<(), ConfigError> where P: AsRef<Path>,` [src]

`fn load_no_fallback(path: P) -> Result<Self, ConfigError> where P: AsRef<Path>,` [src]

`impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,` [src]

`impl<T> Event for T where T: Send + Sync + 'static,`

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> Resource for T where T: Any + Send + Sync,`

`impl<T> Same<T> for T`

`type Output = T`

Should always be Self

`impl<T> SetParameter for T`

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,`

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,`

`fn to_subset(&self) -> Option<SS>`

`fn is_in_subset(&self) -> bool`

`unsafe fn to_subset_unchecked(&self) -> SS`

`fn from_subset(element: &SS) -> SP`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Enum amethyst_input::Axis

Variants

Fields of Emulated

Fields of Controller

Fields of Mouse

Fields of MouseWheel

Trait Implementations

impl Clone for Axis[src]

fn clone(&self) -> Axis[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Axis[src]

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

impl<'de> Deserialize<'de> for Axis[src]

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

impl PartialEq<Axis> for Axis[src]

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

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

impl Serialize for Axis[src]

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

impl StructuralPartialEq for Axis[src]

Auto Trait Implementations

impl RefUnwindSafe for Axis

impl Send for Axis

impl Sync for Axis

impl Unpin for Axis

impl UnwindSafe for Axis

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

fn type_id(&self) -> TypeId[src]

impl<T> Any for T where T: Any,

fn get_type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Config for T where T: for<'a> Deserialize<'a> + Serialize, [src]

fn load<P>(path: P) -> Result<T, ConfigError> where P: AsRef<Path>, [src]

fn load_bytes(bytes: &[u8]) -> Result<T, ConfigError>[src]

fn write<P>(&self, path: P) -> Result<(), ConfigError> where P: AsRef<Path>, [src]

fn load_no_fallback<P>(path: P) -> Result<Self, ConfigError> where P: AsRef<Path>, [src]

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>, [src]

impl<T> Event for T where T: Send + Sync + 'static,

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> Resource for T where T: Any + Send + Sync,

impl<T> Same<T> for T

type Output = T

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

unsafe fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V