Struct leafwing_input_manager::axislike::VirtualDPad

pub struct VirtualDPad {
    pub up: InputKind,
    pub down: InputKind,
    pub left: InputKind,
    pub right: InputKind,
}

A virtual DPad that you can get an DualAxis from.

Typically, you don’t want to store a DualAxis in this type, even though it can be stored as an InputKind.

Instead, use it directly as InputKind::DualAxis!

Fields

up: InputKind

The input that represents the up direction in this virtual DPad

down: InputKind

The input that represents the down direction in this virtual DPad

left: InputKind

The input that represents the left direction in this virtual DPad

right: InputKind

The input that represents the right direction in this virtual DPad

Implementations

impl VirtualDPad

pub const fn arrow_keys() -> VirtualDPad

Generates a VirtualDPad corresponding to the arrow keyboard keycodes

pub const fn wasd() -> VirtualDPad

Generates a VirtualDPad corresponding to the WASD keys on the standard US QWERTY layout.

Note that on other keyboard layouts, different keys need to be pressed. The location of the keys is the same on all keyboard layouts. This ensures that the classic triangular shape is retained on all layouts, which enables comfortable movement controls.

pub const fn dpad() -> VirtualDPad

Generates a VirtualDPad corresponding to the DPad on a gamepad

pub const fn gamepad_face_buttons() -> VirtualDPad

Generates a VirtualDPad corresponding to the face buttons on a gamepad

North corresponds to up, west corresponds to left, east corresponds to right, south corresponds to down

pub const fn mouse_wheel() -> VirtualDPad

Generates a VirtualDPad corresponding to discretized mousewheel movements

pub const fn mouse_motion() -> VirtualDPad

Generates a VirtualDPad corresponding to discretized mouse motions

pub fn inverted_y(self) -> Self

Returns this VirtualDPad but with up and down swapped.

pub fn inverted_x(self) -> Self

Returns this VirtualDPad but with left and right swapped.

pub fn inverted(self) -> Self

Returns this VirtualDPad but with inverted inputs.

Trait Implementations

impl Clone for VirtualDPad

fn clone(&self) -> VirtualDPad

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualDPad

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<VirtualDPad> for UserInput

fn from(input: VirtualDPad) -> Self

Converts to this type from the input type.

impl FromReflect for VirtualDPad

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for VirtualDPad

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Hash for VirtualDPad

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 VirtualDPad

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for VirtualDPad

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

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

Returns the [TypeInfo] of the type represented by this value.

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 reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

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

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

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

Returns a “partial equality” comparison result.

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 serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for VirtualDPad

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 VirtualDPad

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

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

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

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

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

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

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

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a [DynamicStruct].

impl TypePath for VirtualDPad

where Self: 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 VirtualDPad

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for VirtualDPad

impl StructuralPartialEq for VirtualDPad