Struct leafwing_input_manager::axislike::DualAxis

pub struct DualAxis {
    pub x: SingleAxis,
    pub y: SingleAxis,
    pub deadzone: DeadZoneShape,
}

Two directional axes combined as one input.

These can be stored in a VirtualDPad, which is itself stored in an InputKind for consumption.

This input will generate a DualAxis which can be read with ActionState::axis_pair.

Warning

positive_low must be greater than or equal to negative_low for both x and y for this type to be validly constructed.

Fields

x: SingleAxis

The axis representing horizontal movement.

y: SingleAxis

The axis representing vertical movement.

deadzone: DeadZoneShape

The shape of the deadzone

Implementations

impl DualAxis

pub const DEFAULT_DEADZONE: f32 = 0.100000001f32

The default size of the deadzone used by constructor methods.

This cannot be changed, but the struct can be easily manually constructed.

pub const DEFAULT_DEADZONE_SHAPE: DeadZoneShape = _

The default shape of the deadzone used by constructor methods.

This cannot be changed, but the struct can be easily manually constructed.

pub const ZERO_DEADZONE_SHAPE: DeadZoneShape = _

A deadzone with a size of 0.0 used by constructor methods.

This cannot be changed, but the struct can be easily manually constructed.

pub fn symmetric( x_axis_type: impl Into<AxisType>, y_axis_type: impl Into<AxisType>, deadzone_shape: DeadZoneShape ) -> DualAxis

Creates a DualAxis with both positive_low and negative_low in both axes set to threshold with a deadzone_shape.

pub fn from_value( x_axis_type: impl Into<AxisType>, y_axis_type: impl Into<AxisType>, x_value: f32, y_value: f32 ) -> DualAxis

Creates a SingleAxis with the specified axis_type and value.

All thresholds are set to 0.0. Primarily useful for input mocking.

pub const fn left_stick() -> DualAxis

Creates a DualAxis for the left analogue stick of the gamepad.

pub const fn right_stick() -> DualAxis

Creates a DualAxis for the right analogue stick of the gamepad.

pub const fn mouse_wheel() -> DualAxis

Creates a DualAxis corresponding to horizontal and vertical MouseWheel movement

pub const fn mouse_motion() -> DualAxis

Creates a DualAxis corresponding to horizontal and vertical MouseMotion movement

pub fn with_deadzone(self, deadzone: DeadZoneShape) -> DualAxis

Returns this DualAxis with the deadzone set to the specified values and shape

pub fn with_sensitivity( self, x_sensitivity: f32, y_sensitivity: f32 ) -> DualAxis

Returns this DualAxis with the sensitivity set to the specified values

pub fn inverted_x(self) -> DualAxis

Returns this DualAxis with an inverted X-axis.

pub fn inverted_y(self) -> DualAxis

Returns this DualAxis with an inverted Y-axis.

pub fn inverted(self) -> DualAxis

Returns this DualAxis with both axes inverted.

Trait Implementations

impl Clone for DualAxis

fn clone(&self) -> DualAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DualAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DualAxis

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DualAxis> for InputKind

fn from(input: DualAxis) -> Self

Converts to this type from the input type.

impl From<DualAxis> for UserInput

fn from(input: DualAxis) -> Self

Converts to this type from the input type.

impl FromReflect for DualAxis

where Self: Any + Send + Sync, SingleAxis: FromReflect + TypePath, DeadZoneShape: 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 DualAxis

where Self: Any + Send + Sync, SingleAxis: FromReflect + TypePath, DeadZoneShape: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Hash for DualAxis

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 DualAxis

fn eq(&self, other: &DualAxis) -> 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 DualAxis

where Self: Any + Send + Sync, SingleAxis: FromReflect + TypePath, DeadZoneShape: 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 DualAxis

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 DualAxis

where Self: Any + Send + Sync, SingleAxis: FromReflect + TypePath, DeadZoneShape: 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 DualAxis

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 DualAxis

where Self: Any + Send + Sync, SingleAxis: FromReflect + TypePath, DeadZoneShape: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for DualAxis

impl Eq for DualAxis

impl StructuralPartialEq for DualAxis