Struct leafwing_input_manager::axislike::DualAxisData

pub struct DualAxisData { /* private fields */ }

A wrapped Vec2 that represents the combination of two input axes.

The neutral origin is always at 0, 0. When working with gamepad axes, both x and y values are bounded by [-1.0, 1.0]. For other input axes (such as mousewheel data), this may not be true!

This struct should store the processed form of your raw inputs in a device-agnostic fashion. Any deadzone correction, rescaling or drift-correction should be done at an earlier level.

Implementations

impl DualAxisData

pub fn new(x: f32, y: f32) -> DualAxisData

Creates a new DualAxisData from the provided (x,y) coordinates

pub fn from_xy(xy: Vec2) -> DualAxisData

Creates a new DualAxisData directly from a Vec2

pub fn merged_with(&self, other: DualAxisData) -> DualAxisData

Merge the state of this DualAxisData with another.

This is useful if you have multiple sticks bound to the same game action, and you want to get their combined position.

Warning

This method can result in values with a greater maximum magnitude than expected! Use DualAxisData::clamp_length to limit the resulting direction.

impl DualAxisData

pub fn x(&self) -> f32

The value along the x-axis, typically ranging from -1 to 1

pub fn y(&self) -> f32

The value along the y-axis, typically ranging from -1 to 1

pub fn xy(&self) -> Vec2

The (x, y) values, each typically ranging from -1 to 1

pub fn direction(&self) -> Option<Direction>

The Direction that this axis is pointing towards, if any

If the axis is neutral (x,y) = (0,0), a (0, 0) None will be returned

pub fn rotation(&self) -> Option<Rotation>

The Rotation (measured clockwise from midnight) that this axis is pointing towards, if any

If the axis is neutral (x,y) = (0,0), this will be None

pub fn length(&self) -> f32

How far from the origin is this axis’s position?

Typically bounded by 0 and 1.

If you only need to compare relative magnitudes, use magnitude_squared instead for faster computation.

pub fn length_squared(&self) -> f32

The square of the axis’ magnitude

Typically bounded by 0 and 1.

This is faster than magnitude, as it avoids a square root, but will generally have less natural behavior.

pub fn clamp_length(&mut self, max: f32)

Clamps the magnitude of the axis

Trait Implementations

impl Clone for DualAxisData

fn clone(&self) -> DualAxisData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DualAxisData

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

Formats the value using the given formatter.

impl Default for DualAxisData

fn default() -> DualAxisData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DualAxisData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DualAxisData> for Vec2

fn from(data: DualAxisData) -> Vec2

Converts to this type from the input type.

impl FromReflect for DualAxisData

where Vec2: FromReflect,

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 DualAxisData

where Vec2: FromReflect,

fn get_type_registration() -> TypeRegistration

impl PartialEq for DualAxisData

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

where Vec2: FromReflect,

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_ref(&self) -> ReflectRef<'_>

Returns an 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 type_name(&self) -> &str

👎Deprecated since 0.12.0: view the method documentation to find alternatives to this method.

Returns the type path of the underlying type.

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 DualAxisData

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 DualAxisData

where Vec2: FromReflect,

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 DualAxisData

where Vec2: FromReflect,

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 DualAxisData

where Vec2: FromReflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for DualAxisData

impl StructuralPartialEq for DualAxisData