Struct AxisDeadZone

pub struct AxisDeadZone { /* private fields */ }

A scaled version of AxisExclusion with the bounds set to AxisBounds::magnitude(1.0) that normalizes non-excluded input values into the “live zone”, the remaining range within the bounds after dead zone exclusion.

Examples

use bevy::prelude::*;
use leafwing_input_manager::prelude::*;

// Exclude values between -0.2 and 0.3
let deadzone = AxisDeadZone::new(-0.2, 0.3);

// Another way to create an AxisDeadzone.
let exclusion = AxisExclusion::new(-0.2, 0.3);
assert_eq!(exclusion.scaled(), deadzone);

// The ways to create an AxisProcessor.
let processor = AxisProcessor::from(deadzone);
assert_eq!(processor, AxisProcessor::DeadZone(deadzone));

// The bounds after normalization.
let bounds = deadzone.bounds();
assert_eq!(bounds.min(), -1.0);
assert_eq!(bounds.max(), 1.0);

for value in -300..300 {
    let value = value as f32 * 0.01;

    // Values within the dead zone are treated as zero.
    if -0.2 <= value && value <= 0.3 {
        assert!(deadzone.within_exclusion(value));
        assert_eq!(deadzone.normalize(value), 0.0);
    }

    // Values within the live zone are scaled linearly.
    else if -1.0 <= value && value < -0.2 {
        assert!(deadzone.within_livezone_lower(value));

        let expected = f32::inverse_lerp(-1.0, -0.2, value) - 1.0;
        assert!((deadzone.normalize(value) - expected).abs() <= f32::EPSILON);
    } else if 0.3 < value && value <= 1.0 {
        assert!(deadzone.within_livezone_upper(value));

        let expected = f32::inverse_lerp(0.3, 1.0, value);
        assert!((deadzone.normalize(value) - expected).abs() <= f32::EPSILON);
    }

    // Values outside the bounds are restricted to the range.
    else {
        assert!(!deadzone.within_bounds(value));
        assert_eq!(deadzone.normalize(value), value.clamp(-1.0, 1.0));
    }
}

Implementations

impl AxisDeadZone

pub const fn extend_dual(self) -> DualAxisDeadZone

Creates a DualAxisDeadZone using self for both axes.

pub const fn extend_dual_only_x(self) -> DualAxisDeadZone

Creates a DualAxisDeadZone only using self for the X-axis.

pub const fn extend_dual_only_y(self) -> DualAxisDeadZone

Creates a DualAxisDeadZone only using self to the Y-axis.

pub const fn extend_dual_with_x(self, deadzone_x: Self) -> DualAxisDeadZone

Creates a DualAxisDeadZone using self to the Y-axis with the given bounds_x to the X-axis.

pub const fn extend_dual_with_y(self, deadzone_y: Self) -> DualAxisDeadZone

Creates a DualAxisDeadZone using self to the X-axis with the given bounds_y to the Y-axis.

impl AxisDeadZone

pub const ZERO: Self = _

Zero-size AxisDeadZone, only restricting values to the range [-1.0, 1.0].

pub fn new(negative_max: f32, positive_min: f32) -> Self

Creates an AxisDeadZone that excludes input values within the range [negative_max, positive_min] and then normalizes non-excluded input values into the valid range [-1.0, 1.0].

Requirements

• negative_max <= 0.0 <= positive_min.

Panics

Panics if the requirements aren’t met.

pub fn symmetric(threshold: f32) -> Self

Creates an AxisDeadZone that excludes input values within the range [-threshold, threshold] and then normalizes non-excluded input values into the valid range [-1.0, 1.0].

Requirements

• threshold >= 0.0.

Panics

Panics if the requirements aren’t met.

pub fn only_positive(positive_min: f32) -> Self

Creates an AxisDeadZone that only passes positive values that greater than positive_min and then normalizes them into the valid range [-1.0, 1.0].

Requirements

• positive_min >= 0.0.

Panics

Panics if the requirements aren’t met.

pub fn only_negative(negative_max: f32) -> Self

Creates an AxisDeadZone that only passes negative values that less than negative_max and then normalizes them into the valid range [-1.0, 1.0].

Requirements

• negative_max <= 0.0.

Panics

Panics if the requirements aren’t met.

pub fn exclusion(&self) -> AxisExclusion

Returns the AxisExclusion used by this deadzone.

pub fn bounds(&self) -> AxisBounds

Returns the AxisBounds used by this deadzone.

pub fn livezone_lower_min_max(&self) -> (f32, f32)

Returns the minimum and maximum bounds of the lower live zone used for normalization.

In simple terms, this returns (bounds.min, exclusion.min).

pub fn livezone_upper_min_max(&self) -> (f32, f32)

Returns the minimum and maximum bounds of the upper live zone used for normalization.

In simple terms, this returns (exclusion.max, bounds.max).

pub fn within_exclusion(&self, input_value: f32) -> bool

Is the given input_value within the exclusion range?

pub fn within_bounds(&self, input_value: f32) -> bool

Is the given input_value within the bounds?

pub fn within_livezone_lower(&self, input_value: f32) -> bool

Is the given input_value within the lower live zone?

pub fn within_livezone_upper(&self, input_value: f32) -> bool

Is the given input_value within the upper live zone?

pub fn normalize(&self, input_value: f32) -> f32

Normalizes input values into the live zone.

Trait Implementations

impl Clone for AxisDeadZone

fn clone(&self) -> AxisDeadZone

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AxisDeadZone

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

Formats the value using the given formatter.

impl Default for AxisDeadZone

fn default() -> Self

Creates an AxisDeadZone that excludes input values within the deadzone [-0.1, 0.1].

impl<'de> Deserialize<'de> for AxisDeadZone

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AxisDeadZone> for AxisProcessor

fn from(value: AxisDeadZone) -> Self

Converts to this type from the input type.

impl From<AxisDeadZone> for DualAxisProcessor

fn from(deadzone: AxisDeadZone) -> Self

Converts to this type from the input type.

impl FromReflect for AxisDeadZone

where Self: Any + Send + Sync, AxisExclusion: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection,

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 AxisDeadZone

where Self: Any + Send + Sync, AxisExclusion: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Hash for AxisDeadZone

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 AxisDeadZone

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for AxisDeadZone

where Self: Any + Send + Sync, AxisExclusion: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection,

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 try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply 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 apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

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 AxisDeadZone

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 AxisDeadZone

where Self: Any + Send + Sync, AxisExclusion: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection,

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 AxisDeadZone

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 AxisDeadZone

where Self: Any + Send + Sync, AxisExclusion: FromReflect + TypePath + RegisterForReflection, f32: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for AxisDeadZone

impl Eq for AxisDeadZone

impl StructuralPartialEq for AxisDeadZone