leafwing_input_manager::user_input::keyboard

Struct KeyboardVirtualDPad

pub struct KeyboardVirtualDPad { /* private fields */ }

Expand description

A virtual dual-axis control constructed from four KeyCodes. Each key 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-key combinations.

§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::prelude::*;
use leafwing_input_manager::user_input::testing_utils::FetchUserInput;
use leafwing_input_manager::plugin::{AccumulatorPlugin, CentralInputStorePlugin};

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

// Define a virtual D-pad using the arrow keys
let input = KeyboardVirtualDPad::ARROW_KEYS;

// Pressing an arrow key activates the corresponding axis
KeyCode::ArrowUp.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 = KeyboardVirtualDPad::ARROW_KEYS.sensitivity_y(2.0);
assert_eq!(app.read_dual_axis_values(doubled), Vec2::new(0.0, 2.0));

Struct KeyboardVirtualDPadCopy item path

§Value Processing

Implementations§

impl KeyboardVirtualDPad

pub const ARROW_KEYS: Self = _

pub const WASD: Self = _

pub const NUMPAD: Self = _

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

Trait Implementations§

impl Clone for KeyboardVirtualDPad

fn clone(&self) -> KeyboardVirtualDPad

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

impl Debug for KeyboardVirtualDPad

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

impl<'de> Deserialize<'de> for KeyboardVirtualDPad

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

impl DualAxislike for KeyboardVirtualDPad

fn axis_pair(&self, input_store: &CentralInputStore, _gamepad: Gamepad) -> Vec2

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

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

impl FromReflect for KeyboardVirtualDPadwhere Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

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

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

impl GetTypeRegistration for KeyboardVirtualDPadwhere Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

fn register_type_dependencies(registry: &mut TypeRegistry)

impl Hash for KeyboardVirtualDPad

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 KeyboardVirtualDPad

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

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

impl Reflect for KeyboardVirtualDPadwhere Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

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

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 clone_value(&self) -> Box<dyn Reflect>

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

fn try_apply(&mut self, value: &dyn Reflect) -> 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 reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

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

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

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

fn serializable(&self) -> Option<Serializable<'_>>

fn is_dynamic(&self) -> bool

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

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

impl Serialize for KeyboardVirtualDPad

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

impl Struct for KeyboardVirtualDPadwhere Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

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

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

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

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

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

fn field_len(&self) -> usize

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

fn clone_dynamic(&self) -> DynamicStruct

impl TypePath for KeyboardVirtualDPadwhere Self: Any + Send + Sync,

fn type_path() -> &'static str

fn short_type_path() -> &'static str

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

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

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

impl Typed for KeyboardVirtualDPadwhere Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

impl UserInput for KeyboardVirtualDPad

fn kind(&self) -> InputControlKind

fn decompose(&self) -> BasicInputs

impl WithDualAxisProcessingPipelineExt for KeyboardVirtualDPad

fn reset_processing_pipeline(self) -> Self

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

Struct KeyboardVirtualDPad

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

impl FromReflect for KeyboardVirtualDPad
where Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

impl GetTypeRegistration for KeyboardVirtualDPad
where Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

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

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

impl Reflect for KeyboardVirtualDPad
where Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

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

impl Struct for KeyboardVirtualDPad
where Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

impl TypePath for KeyboardVirtualDPad
where Self: Any + Send + Sync,

impl Typed for KeyboardVirtualDPad
where Self: Any + Send + Sync, KeyCode: FromReflect + TypePath + RegisterForReflection, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

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

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,