Struct CircleDeadZone

pub struct CircleDeadZone { /* private fields */ }

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

It is worth considering that this normalizer reduces input values on diagonals. If that is not your goal, you might want to explore alternative normalizers.

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

// Exclude magnitudes less than or equal to 0.2
let deadzone = CircleDeadZone::new(0.2);

for x in -300..300 {
    let x = x as f32 * 0.01;
    for y in -300..300 {
        let y = y as f32 * 0.01;
        let value = Vec2::new(x, y);

        // Values within the dead zone are treated as zeros.
        if value.length() <= 0.2 {
            assert!(deadzone.within_exclusion(value));
            assert_eq!(deadzone.normalize(value), Vec2::ZERO);
        }

        // Values within the live zone are scaled linearly.
        else if value.length() <= 1.0 {
            assert!(deadzone.within_livezone(value));

            let expected_scale = f32::inverse_lerp(0.2, 1.0, value.length());
            let expected = value.normalize() * expected_scale;
            let delta = (deadzone.normalize(value) - expected).abs();
            assert!(delta.x <= 0.00001);
            assert!(delta.y <= 0.00001);
        }

        // Values outside the bounds are restricted to the region.
        else {
            assert!(!deadzone.within_bounds(value));

            let expected = value.clamp_length_max(1.0);
            let delta = (deadzone.normalize(value) - expected).abs();
            assert!(delta.x <= 0.00001);
            assert!(delta.y <= 0.00001);
        }
    }
}

Implementations

impl CircleDeadZone

pub const ZERO: Self

Zero-size CircleDeadZone, only restricting values to a maximum magnitude of 1.0.

pub fn new(threshold: f32) -> Self

Creates a CircleDeadZone that excludes input values below a minimum magnitude.

Requirements

• threshold >= 0.0.

Panics

Panics if the requirements aren’t met.

pub fn radius(&self) -> f32

Returns the radius of the circle.

pub fn exclusion(&self) -> CircleExclusion

Returns the CircleExclusion used by this deadzone.

pub fn bounds(&self) -> CircleBounds

Returns the CircleBounds used by this deadzone.

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

Returns the minimum and maximum radii of the live zone used by this deadzone.

In simple terms, this returns (self.radius, bounds.radius).

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

Is the given input_value within the exclusion range?

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

Is the given input_value within the bounds?

pub fn within_livezone(&self, input_value: Vec2) -> bool

Is the given input_value within the live zone?

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

Normalizes input values into the live zone.

Trait Implementations

impl Clone for CircleDeadZone

fn clone(&self) -> CircleDeadZone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircleDeadZone

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

Formats the value using the given formatter.

impl Default for CircleDeadZone

fn default() -> Self

Creates a CircleDeadZone that excludes input values below a minimum magnitude of 0.1.

impl<'de> Deserialize<'de> for CircleDeadZone

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CircleDeadZone> for DualAxisProcessor

fn from(value: CircleDeadZone) -> Self

Converts to this type from the input type.

impl FromReflect for CircleDeadZone

where CircleDeadZone: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for CircleDeadZone

where CircleDeadZone: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + 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 CircleDeadZone

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 CircleDeadZone

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

where CircleDeadZone: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

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 is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for CircleDeadZone

where CircleDeadZone: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Serialize for CircleDeadZone

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 CircleDeadZone

where CircleDeadZone: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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

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

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

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

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

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

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

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for CircleDeadZone

where CircleDeadZone: 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 CircleDeadZone

where CircleDeadZone: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for CircleDeadZone

impl Eq for CircleDeadZone

impl StructuralPartialEq for CircleDeadZone