Struct bevy_input::Axis

pub struct Axis<T> { /* private fields */ }

Stores the position data of the input devices of type T.

The values are stored as f32s, using Axis::set. Use Axis::get to retrieve the value clamped between Axis::MIN and Axis::MAX inclusive, or unclamped using Axis::get_unclamped.

Implementations

impl<T> Axis<T>

where T: Copy + Eq + Hash,

pub const MIN: f32 = -1f32

The smallest possible axis value.

pub const MAX: f32 = 1f32

The largest possible axis value.

pub fn set(&mut self, input_device: T, position_data: f32) -> Option<f32>

Sets the position data of the input_device to position_data.

If the input_device:

• was present before, the position data is updated, and the old value is returned.
• wasn’t present before, None is returned.

pub fn get(&self, input_device: T) -> Option<f32>

Returns the position data of the provided input_device.

This will be clamped between Axis::MIN and Axis::MAX inclusive.

pub fn get_unclamped(&self, input_device: T) -> Option<f32>

Returns the unclamped position data of the provided input_device.

This value may be outside of the Axis::MIN and Axis::MAX range.

Use for things like camera zoom, where you want devices like mouse wheels to be able to exceed the normal range. If being able to move faster on one input device than another would give an unfair advantage, you should likely use Axis::get instead.

pub fn remove(&mut self, input_device: T) -> Option<f32>

Removes the position data of the input_device, returning the position data if the input device was previously set.

pub fn devices(&self) -> impl ExactSizeIterator<Item = &T>

Returns an iterator of all the input devices that have position data

Trait Implementations

impl<T: Debug> Debug for Axis<T>

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

Formats the value using the given formatter.

impl<T> Default for Axis<T>

where T: Copy + Eq + Hash,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Resource for Axis<T>

where Self: Send + Sync + 'static,