Enum DualAxisProcessor

#[non_exhaustive]
pub enum DualAxisProcessor {
    Digital,
    Inverted(DualAxisInverted),
    Sensitivity(DualAxisSensitivity),
    ValueBounds(DualAxisBounds),
    Exclusion(DualAxisExclusion),
    DeadZone(DualAxisDeadZone),
    CircleBounds(CircleBounds),
    CircleExclusion(CircleExclusion),
    CircleDeadZone(CircleDeadZone),
    Custom(Box<dyn CustomDualAxisProcessor>),
}

A processor for dual-axis input values, accepting a Vec2 input and producing a Vec2 output.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Digital

Converts input values into three discrete values along each axis, similar to Vec2::signum() but returning 0.0 for zero values.

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

// 1.0 for positive values
assert_eq!(DualAxisProcessor::Digital.process(Vec2::splat(2.5)), Vec2::ONE);
assert_eq!(DualAxisProcessor::Digital.process(Vec2::splat(0.5)), Vec2::ONE);

// 0.0 for zero values
assert_eq!(DualAxisProcessor::Digital.process(Vec2::ZERO), Vec2::ZERO);
assert_eq!(DualAxisProcessor::Digital.process(-Vec2::ZERO), Vec2::ZERO);

// -1.0 for negative values
assert_eq!(DualAxisProcessor::Digital.process(Vec2::splat(-0.5)), Vec2::NEG_ONE);
assert_eq!(DualAxisProcessor::Digital.process(Vec2::splat(-2.5)), Vec2::NEG_ONE);

// Mixed digital values
assert_eq!(DualAxisProcessor::Digital.process(Vec2::new(0.5, -0.5)), Vec2::new(1.0, -1.0));
assert_eq!(DualAxisProcessor::Digital.process(Vec2::new(-0.5, 0.5)), Vec2::new(-1.0, 1.0));

Inverted(DualAxisInverted)

A wrapper around DualAxisInverted to represent inversion.

Sensitivity(DualAxisSensitivity)

A wrapper around DualAxisSensitivity to represent sensitivity.

ValueBounds(DualAxisBounds)

A wrapper around DualAxisBounds to represent value bounds.

Exclusion(DualAxisExclusion)

A wrapper around DualAxisExclusion to represent unscaled deadzone.

DeadZone(DualAxisDeadZone)

A wrapper around DualAxisDeadZone to represent scaled deadzone.

CircleBounds(CircleBounds)

A wrapper around CircleBounds to represent circular value bounds.

CircleExclusion(CircleExclusion)

A wrapper around CircleExclusion to represent unscaled deadzone.

CircleDeadZone(CircleDeadZone)

A wrapper around CircleDeadZone to represent scaled deadzone.

Custom(Box<dyn CustomDualAxisProcessor>)

A user-defined processor that implements CustomDualAxisProcessor.

Implementations

impl DualAxisProcessor

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

Computes the result by processing the input_value.

Trait Implementations

impl Clone for DualAxisProcessor

fn clone(&self) -> DualAxisProcessor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DualAxisProcessor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DualAxisProcessor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Enum for DualAxisProcessor

where Self: Any + Send + Sync, DualAxisInverted: FromReflect + TypePath + RegisterForReflection, DualAxisSensitivity: FromReflect + TypePath + RegisterForReflection, DualAxisBounds: FromReflect + TypePath + RegisterForReflection, DualAxisExclusion: FromReflect + TypePath + RegisterForReflection, DualAxisDeadZone: FromReflect + TypePath + RegisterForReflection, CircleBounds: FromReflect + TypePath + RegisterForReflection, CircleExclusion: FromReflect + TypePath + RegisterForReflection, CircleDeadZone: FromReflect + TypePath + RegisterForReflection, Box<dyn CustomDualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

fn field(&self, __name_param: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl From<AxisBounds> for DualAxisProcessor

fn from(bounds: AxisBounds) -> 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 From<AxisExclusion> for DualAxisProcessor

fn from(exclusion: AxisExclusion) -> Self

Converts to this type from the input type.

impl From<CircleBounds> for DualAxisProcessor

fn from(value: CircleBounds) -> Self

Converts to this type from the input type.

impl From<CircleDeadZone> for DualAxisProcessor

fn from(value: CircleDeadZone) -> Self

Converts to this type from the input type.

impl From<CircleExclusion> for DualAxisProcessor

fn from(value: CircleExclusion) -> Self

Converts to this type from the input type.

impl From<DualAxisBounds> for DualAxisProcessor

fn from(value: DualAxisBounds) -> Self

Converts to this type from the input type.

impl From<DualAxisDeadZone> for DualAxisProcessor

fn from(value: DualAxisDeadZone) -> Self

Converts to this type from the input type.

impl From<DualAxisExclusion> for DualAxisProcessor

fn from(value: DualAxisExclusion) -> Self

Converts to this type from the input type.

impl From<DualAxisInverted> for DualAxisProcessor

fn from(value: DualAxisInverted) -> Self

Converts to this type from the input type.

impl From<DualAxisSensitivity> for DualAxisProcessor

fn from(value: DualAxisSensitivity) -> Self

Converts to this type from the input type.

impl<P: CustomDualAxisProcessor> From<P> for DualAxisProcessor

fn from(value: P) -> Self

Converts to this type from the input type.

impl FromReflect for DualAxisProcessor

where Self: Any + Send + Sync, DualAxisInverted: FromReflect + TypePath + RegisterForReflection, DualAxisSensitivity: FromReflect + TypePath + RegisterForReflection, DualAxisBounds: FromReflect + TypePath + RegisterForReflection, DualAxisExclusion: FromReflect + TypePath + RegisterForReflection, DualAxisDeadZone: FromReflect + TypePath + RegisterForReflection, CircleBounds: FromReflect + TypePath + RegisterForReflection, CircleExclusion: FromReflect + TypePath + RegisterForReflection, CircleDeadZone: FromReflect + TypePath + RegisterForReflection, Box<dyn CustomDualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(__param0: &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 DualAxisProcessor

where Self: Any + Send + Sync, DualAxisInverted: FromReflect + TypePath + RegisterForReflection, DualAxisSensitivity: FromReflect + TypePath + RegisterForReflection, DualAxisBounds: FromReflect + TypePath + RegisterForReflection, DualAxisExclusion: FromReflect + TypePath + RegisterForReflection, DualAxisDeadZone: FromReflect + TypePath + RegisterForReflection, CircleBounds: FromReflect + TypePath + RegisterForReflection, CircleExclusion: FromReflect + TypePath + RegisterForReflection, CircleDeadZone: FromReflect + TypePath + RegisterForReflection, Box<dyn CustomDualAxisProcessor>: 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 DualAxisProcessor

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 DualAxisProcessor

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

where Self: Any + Send + Sync, DualAxisInverted: FromReflect + TypePath + RegisterForReflection, DualAxisSensitivity: FromReflect + TypePath + RegisterForReflection, DualAxisBounds: FromReflect + TypePath + RegisterForReflection, DualAxisExclusion: FromReflect + TypePath + RegisterForReflection, DualAxisDeadZone: FromReflect + TypePath + RegisterForReflection, CircleBounds: FromReflect + TypePath + RegisterForReflection, CircleExclusion: FromReflect + TypePath + RegisterForReflection, CircleDeadZone: FromReflect + TypePath + RegisterForReflection, Box<dyn CustomDualAxisProcessor>: 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_param: 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_param: &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_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the 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 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 DualAxisProcessor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypePath for DualAxisProcessor

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 DualAxisProcessor

where Self: Any + Send + Sync, DualAxisInverted: FromReflect + TypePath + RegisterForReflection, DualAxisSensitivity: FromReflect + TypePath + RegisterForReflection, DualAxisBounds: FromReflect + TypePath + RegisterForReflection, DualAxisExclusion: FromReflect + TypePath + RegisterForReflection, DualAxisDeadZone: FromReflect + TypePath + RegisterForReflection, CircleBounds: FromReflect + TypePath + RegisterForReflection, CircleExclusion: FromReflect + TypePath + RegisterForReflection, CircleDeadZone: FromReflect + TypePath + RegisterForReflection, Box<dyn CustomDualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for DualAxisProcessor

impl StructuralPartialEq for DualAxisProcessor