Struct VirtualAxis

pub struct VirtualAxis {
    pub negative: Box<dyn Buttonlike>,
    pub positive: Box<dyn Buttonlike>,
    pub processors: Vec<AxisProcessor>,
}

A virtual single-axis control constructed from two Buttonlikes. One button represents the negative direction (left for the X-axis, down for the Y-axis), while the other represents the positive direction (right for the X-axis, up for the Y-axis).

Value Processing

You can customize how the values are processed using a pipeline of processors. See WithAxisProcessingPipelineExt for details.

The raw value is determined based on the state of the associated buttons:

• -1.0 if only the negative button is currently pressed.
• 1.0 if only the positive button is currently pressed.
• 0.0 if neither button is pressed, or both are pressed simultaneously.

use bevy::prelude::*;
use bevy::input::InputPlugin;
use leafwing_input_manager::prelude::*;
use leafwing_input_manager::user_input::testing_utils::FetchUserInput;
use leafwing_input_manager::plugin::CentralInputStorePlugin;

let mut app = App::new();
app.add_plugins((InputPlugin, CentralInputStorePlugin));

// Define a virtual Y-axis using arrow "up" and "down" keys
let axis = VirtualAxis::vertical_arrow_keys();

// Pressing either key activates the input
KeyCode::ArrowUp.press(app.world_mut());
app.update();
assert_eq!(app.read_axis_value(axis), 1.0);

// You can configure a processing pipeline (e.g., doubling the value)
let doubled = VirtualAxis::vertical_arrow_keys().sensitivity(2.0);
assert_eq!(app.read_axis_value(doubled), 2.0);

Fields

negative: Box<dyn Buttonlike>

The button that represents the negative direction.

positive: Box<dyn Buttonlike>

The button that represents the positive direction.

processors: Vec<AxisProcessor>

A processing pipeline that handles input values.

Implementations

impl VirtualAxis

pub fn new(negative: impl Buttonlike, positive: impl Buttonlike) -> Self

Creates a new VirtualAxis with two given Buttonlikes. No processing is applied to raw data.

pub fn vertical_arrow_keys() -> Self

The VirtualAxis using the vertical arrow key mappings.

• KeyCode::ArrowDown for negative direction.
• KeyCode::ArrowUp for positive direction.

pub fn horizontal_arrow_keys() -> Self

The VirtualAxis using the horizontal arrow key mappings.

• KeyCode::ArrowLeft for negative direction.
• KeyCode::ArrowRight for positive direction.

pub fn ws() -> Self

The VirtualAxis using the common W/S key mappings.

• KeyCode::KeyS for negative direction.
• KeyCode::KeyW for positive direction.

pub fn ad() -> Self

The VirtualAxis using the common A/D key mappings.

• KeyCode::KeyA for negative direction.
• KeyCode::KeyD for positive direction.

pub fn vertical_numpad() -> Self

The VirtualAxis using the vertical numpad key mappings.

• KeyCode::Numpad2 for negative direction.
• KeyCode::Numpad8 for positive direction.

pub fn horizontal_numpad() -> Self

The VirtualAxis using the horizontal numpad key mappings.

• KeyCode::Numpad4 for negative direction.
• KeyCode::Numpad6 for positive direction.

pub fn dpad_x() -> Self

The VirtualAxis using the horizontal D-Pad button mappings. No processing is applied to raw data from the gamepad.

• GamepadButton::DPadLeft for negative direction.
• GamepadButton::DPadRight for positive direction.

pub fn dpad_y() -> Self

The VirtualAxis using the vertical D-Pad button mappings. No processing is applied to raw data from the gamepad.

• GamepadButton::DPadDown for negative direction.
• GamepadButton::DPadUp for positive direction.

pub fn action_pad_x() -> Self

The VirtualAxis using the horizontal action pad button mappings. No processing is applied to raw data from the gamepad.

• GamepadButton::West for negative direction.
• GamepadButton::East for positive direction.

pub fn action_pad_y() -> Self

The VirtualAxis using the vertical action pad button mappings. No processing is applied to raw data from the gamepad.

• GamepadButton::South for negative direction.
• GamepadButton::North for positive direction.

Trait Implementations

impl Axislike for VirtualAxis

fn value(&self, input_store: &CentralInputStore, gamepad: Entity) -> f32

Retrieves the current value of this axis after processing by the associated processors.

fn set_value_as_gamepad( &self, world: &mut World, value: f32, gamepad: Option<Entity>, )

Sets the value of corresponding button based on the given value.

When value is non-zero, set its absolute value to the value of:

• the negative button if the value is negative;
• the positive button if the value is positive.

fn set_value(&self, world: &mut World, value: f32)

Simulate an axis-like input by sending the appropriate event.

impl Clone for VirtualAxis

fn clone(&self) -> VirtualAxis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VirtualAxis

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for VirtualAxis

where VirtualAxis: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AxisProcessor>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for VirtualAxis

where VirtualAxis: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AxisProcessor>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Hash for VirtualAxis

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 VirtualAxis

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for VirtualAxis

where VirtualAxis: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AxisProcessor>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for VirtualAxis

where VirtualAxis: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AxisProcessor>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl<'de> RegisterTypeTag<'de, dyn Axislike> for VirtualAxis

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn Axislike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for VirtualAxis

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for VirtualAxis

where VirtualAxis: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AxisProcessor>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for VirtualAxis

where VirtualAxis: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for VirtualAxis

where VirtualAxis: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AxisProcessor>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UserInput for VirtualAxis

fn kind(&self) -> InputControlKind

VirtualAxis acts as a virtual axis input.

fn decompose(&self) -> BasicInputs

VirtualAxis represents a compositions of two buttons.

impl WithAxisProcessingPipelineExt for VirtualAxis

fn reset_processing_pipeline(self) -> Self

Resets the processing pipeline, removing any currently applied processors.

fn replace_processing_pipeline( self, processors: impl IntoIterator<Item = AxisProcessor>, ) -> Self

Replaces the current processing pipeline with the given AxisProcessors.

fn with_processor(self, processor: impl Into<AxisProcessor>) -> Self

Appends the given AxisProcessor as the next processing step.

fn digital(self) -> Self

Appends an AxisProcessor::Digital processor as the next processing step, similar to f32::signum but returning 0.0 for zero values.

fn inverted(self) -> Self

Appends an AxisProcessor::Inverted processor as the next processing step, flipping the sign of values on the axis.

fn sensitivity(self, sensitivity: f32) -> Self

Appends an AxisProcessor::Sensitivity processor as the next processing step, multiplying values on the axis with the given sensitivity factor.

fn with_bounds(self, min: f32, max: f32) -> Self

Appends an AxisBounds processor as the next processing step, restricting values within the range [min, max] on the axis.

fn with_bounds_symmetric(self, threshold: f32) -> Self

Appends an AxisBounds processor as the next processing step, restricting values within the range [-threshold, threshold].

fn at_least(self, min: f32) -> Self

Appends an AxisBounds processor as the next processing step, restricting values to a minimum value.

fn at_most(self, max: f32) -> Self

Appends an AxisBounds processor as the next processing step, restricting values to a maximum value.

fn with_deadzone(self, negative_max: f32, positive_min: f32) -> Self

Appends an AxisDeadZone processor as the next processing step, excluding values within the dead zone range [negative_max, positive_min] on the axis, treating them as zeros, then normalizing non-excluded input values into the “live zone”, the remaining range within the AxisBounds::magnitude(1.0) after dead zone exclusion.

fn with_deadzone_symmetric(self, threshold: f32) -> Self

Appends an AxisDeadZone processor as the next processing step, excluding values within the dead zone range [-threshold, threshold] on the axis, treating them as zeros, then normalizing non-excluded input values into the “live zone”, the remaining range within the AxisBounds::magnitude(1.0) after dead zone exclusion.

fn only_positive(self, positive_min: f32) -> Self

Appends an AxisDeadZone processor as the next processing step, only passing positive values that greater than positive_min and then normalizing them into the “live zone” range [positive_min, 1.0].

fn only_negative(self, negative_max: f32) -> Self

Appends an AxisDeadZone processor as the next processing step, only passing negative values that less than negative_max and then normalizing them into the “live zone” range [-1.0, negative_max].

fn with_deadzone_unscaled(self, negative_max: f32, positive_min: f32) -> Self

Appends an AxisExclusion processor as the next processing step, ignoring values within the dead zone range [negative_max, positive_min] on the axis, treating them as zeros.

fn with_deadzone_symmetric_unscaled(self, threshold: f32) -> Self

Appends an AxisExclusion processor as the next processing step, ignoring values within the dead zone range [-threshold, threshold] on the axis, treating them as zeros.

fn only_positive_unscaled(self, positive_min: f32) -> Self

Appends an AxisExclusion processor as the next processing step, only passing positive values that greater than positive_min.

fn only_negative_unscaled(self, negative_max: f32) -> Self

Appends an AxisExclusion processor as the next processing step, only passing negative values that less than negative_max.

impl Eq for VirtualAxis

impl StructuralPartialEq for VirtualAxis