leafwing_input_manager::user_input::virtual_axial

Struct VirtualDPad

pub struct VirtualDPad {
    pub up: Box<dyn Buttonlike>,
    pub down: Box<dyn Buttonlike>,
    pub left: Box<dyn Buttonlike>,
    pub right: Box<dyn Buttonlike>,
    pub processors: Vec<DualAxisProcessor>,
}

Expand description

A virtual dual-axis control constructed from four Buttonlikes. Each button represents a specific direction (up, down, left, right), functioning similarly to a directional pad (D-pad) on both X and Y axes, and offering intermediate diagonals by means of two-button combinations.

By default, it reads from any connected gamepad. Use the InputMap::set_gamepad for specific ones.

§Value Processing

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

The raw axis values are determined based on the state of the associated buttons:

-1.0 if only the negative button is currently pressed (Down/Left).
1.0 if only the positive button is currently pressed (Up/Right).
0.0 if neither button is pressed, or both are pressed simultaneously.

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

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

// Define a virtual D-pad using the WASD keys
let input = VirtualDPad::wasd();

// Pressing the W key activates the corresponding axis
KeyCode::KeyW.press(app.world_mut());
app.update();
assert_eq!(app.read_dual_axis_values(input), Vec2::new(0.0, 1.0));

// You can configure a processing pipeline (e.g., doubling the Y value)
let doubled = VirtualDPad::wasd().sensitivity_y(2.0);
assert_eq!(app.read_dual_axis_values(doubled), Vec2::new(0.0, 2.0));

Fields§

§up: Box<dyn Buttonlike>

The button for the upward direction.

§down: Box<dyn Buttonlike>

The button for the downward direction.

§left: Box<dyn Buttonlike>

The button for the leftward direction.

§right: Box<dyn Buttonlike>

The button for the rightward direction.

§processors: Vec<DualAxisProcessor>

A processing pipeline that handles input values.

Struct VirtualDPad Copy item path

§Value Processing

Fields§

Implementations§

impl VirtualDPad

pub fn new( up: impl Buttonlike, down: impl Buttonlike, left: impl Buttonlike, right: impl Buttonlike, ) -> Self

pub fn arrow_keys() -> Self

pub fn wasd() -> Self

pub fn numpad() -> Self

pub fn dpad() -> Self

pub fn action_pad() -> Self

Trait Implementations§

impl Clone for VirtualDPad

fn clone(&self) -> VirtualDPad

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

impl Debug for VirtualDPad

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

impl<'de> Deserialize<'de> for VirtualDPad

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

impl DualAxislike for VirtualDPad

fn get_axis_pair( &self, input_store: &CentralInputStore, gamepad: Entity, ) -> Option<Vec2>

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

fn axis_pair(&self, input_store: &CentralInputStore, gamepad: Entity) -> Vec2

fn set_axis_pair(&self, world: &mut World, value: Vec2)

impl FromReflect for VirtualDPad

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

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

impl GetTypeRegistration for VirtualDPad

fn get_type_registration() -> TypeRegistration

fn register_type_dependencies(registry: &mut TypeRegistry)

impl Hash for VirtualDPad

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl PartialEq for VirtualDPad

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

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

impl PartialReflect for VirtualDPad

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

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

fn reflect_kind(&self) -> ReflectKind

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

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

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

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

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

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

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

fn as_partial_reflect(&self) -> &dyn PartialReflect

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

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

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

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

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

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>where T: 'static, Self: Sized + TypePath,

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

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

fn is_dynamic(&self) -> bool

impl Reflect for VirtualDPad

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

fn as_any(&self) -> &dyn Any

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

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

fn as_reflect(&self) -> &dyn Reflect

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

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

impl<'de> RegisterTypeTag<'de, dyn DualAxislike> for VirtualDPad

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

impl Serialize for VirtualDPad

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

impl Struct for VirtualDPad

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

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

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

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

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

fn field_len(&self) -> usize

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

fn to_dynamic_struct(&self) -> DynamicStruct

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

impl TypePath for VirtualDPad

Struct VirtualDPad

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

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>
where T: 'static, Self: Sized + TypePath,

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