Struct leafwing_input_manager::axislike::SingleAxis

pub struct SingleAxis {
    pub axis_type: AxisType,
    pub positive_low: f32,
    pub negative_low: f32,
    pub inverted: bool,
    pub sensitivity: f32,
    pub value: Option<f32>,
}

A single directional axis with a configurable trigger zone.

These can be stored in a InputKind to create a virtual button.

Warning

positive_low must be greater than or equal to negative_low for this type to be validly constructed.

Fields

axis_type: AxisType

The axis that is being checked.

positive_low: f32

Any axis value higher than this will trigger the input.

negative_low: f32

Any axis value lower than this will trigger the input.

inverted: bool

Whether to invert output values from this axis.

sensitivity: f32

How sensitive the axis is to input values.

Since sensitivity is a multiplier, any value >1.0 will increase sensitivity while any value <1.0 will decrease sensitivity. This value should always be strictly positive: a value of 0 will cause the axis to stop functioning, while negative values will invert the direction.

value: Option<f32>

The target value for this input, used for input mocking.

WARNING: this field is ignored for the sake of Eq and Hash

Implementations

impl SingleAxis

pub const fn with_threshold( axis_type: AxisType, negative_low: f32, positive_low: f32 ) -> SingleAxis

Creates a SingleAxis with the given positive_low and negative_low thresholds.

pub fn symmetric(axis_type: impl Into<AxisType>, threshold: f32) -> SingleAxis

Creates a SingleAxis with both positive_low and negative_low set to threshold.

pub fn from_value(axis_type: impl Into<AxisType>, value: f32) -> SingleAxis

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 mouse_wheel_x() -> SingleAxis

Creates a SingleAxis corresponding to horizontal MouseWheel movement

pub const fn mouse_wheel_y() -> SingleAxis

Creates a SingleAxis corresponding to vertical MouseWheel movement

pub const fn mouse_motion_x() -> SingleAxis

Creates a SingleAxis corresponding to horizontal MouseMotion movement

pub const fn mouse_motion_y() -> SingleAxis

Creates a SingleAxis corresponding to vertical MouseMotion movement

pub fn negative_only( axis_type: impl Into<AxisType>, threshold: f32 ) -> SingleAxis

Creates a SingleAxis with the axis_type and negative_low set to threshold.

Positive values will not trigger the input.

pub fn positive_only( axis_type: impl Into<AxisType>, threshold: f32 ) -> SingleAxis

Creates a SingleAxis with the axis_type and positive_low set to threshold.

Negative values will not trigger the input.

pub fn with_deadzone(self, deadzone: f32) -> SingleAxis

Returns this SingleAxis with the deadzone set to the specified value

pub fn with_sensitivity(self, sensitivity: f32) -> SingleAxis

Returns this SingleAxis with the sensitivity set to the specified value

pub fn inverted(self) -> Self

Returns this SingleAxis inverted.

Trait Implementations

impl Clone for SingleAxis

fn clone(&self) -> SingleAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SingleAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SingleAxis

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SingleAxis> for InputKind

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

impl From<SingleAxis> for UserInput

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

impl FromReflect for SingleAxis

where Self: Any + Send + Sync, AxisType: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<f32>: 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 SingleAxis

where Self: Any + Send + Sync, AxisType: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<f32>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Hash for SingleAxis

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 SingleAxis

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

where Self: Any + Send + Sync, AxisType: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<f32>: 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 SingleAxis

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 SingleAxis

where Self: Any + Send + Sync, AxisType: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<f32>: 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 SingleAxis

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 SingleAxis

where Self: Any + Send + Sync, AxisType: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<f32>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for SingleAxis

impl Eq for SingleAxis