Struct DualAxisSensitivity

pub struct DualAxisSensitivity(/* private fields */);

Scales dual-axis input values using a specified multiplier to fine-tune the responsiveness of control.

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

let value = Vec2::new(1.5, 2.5);
let Vec2 { x, y } = value;

// Negated X and halved Y
let neg_x_half_y = DualAxisSensitivity::new(-1.0, 0.5);
assert_eq!(neg_x_half_y.scale(value).x, -x);
assert_eq!(neg_x_half_y.scale(value).y, 0.5 * y);

// Doubled X and doubled Y
let double = DualAxisSensitivity::all(2.0);
assert_eq!(double.scale(value), 2.0 * value);

// Halved X
let half_x = DualAxisSensitivity::only_x(0.5);
assert_eq!(half_x.scale(value).x, 0.5 * x);
assert_eq!(half_x.scale(value).y, y);

// Negated and doubled Y
let neg_double_y = DualAxisSensitivity::only_y(-2.0);
assert_eq!(neg_double_y.scale(value).x, x);
assert_eq!(neg_double_y.scale(value).y, -2.0 * y);

Implementations

impl DualAxisSensitivity

pub const fn new(sensitivity_x: f32, sensitivity_y: f32) -> Self

Creates a DualAxisSensitivity with the given values for each axis separately.

pub const fn all(sensitivity: f32) -> Self

Creates a DualAxisSensitivity with the same value for both axes.

pub const fn only_x(sensitivity: f32) -> Self

Creates a DualAxisSensitivity that only affects the X-axis using the given value.

pub const fn only_y(sensitivity: f32) -> Self

Creates a DualAxisSensitivity that only affects the Y-axis using the given value.

pub fn sensitivities(&self) -> Vec2

Returns the sensitivity values.

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

Multiples the input_value by the specified sensitivity vector.

Trait Implementations

impl Clone for DualAxisSensitivity

fn clone(&self) -> DualAxisSensitivity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DualAxisSensitivity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DualAxisSensitivity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DualAxisSensitivity> for DualAxisProcessor

fn from(value: DualAxisSensitivity) -> Self

Converts to this type from the input type.

impl FromReflect for DualAxisSensitivity

where Self: Any + Send + Sync, Vec2: 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 DualAxisSensitivity

where Self: Any + Send + Sync, Vec2: 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 DualAxisSensitivity

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 DualAxisSensitivity

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

where Self: Any + Send + Sync, Vec2: 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 DualAxisSensitivity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TupleStruct for DualAxisSensitivity

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath + RegisterForReflection,

fn field(&self, index: usize) -> Option<&dyn Reflect>

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

fn field_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 field_len(&self) -> usize

Returns the number of fields in the tuple struct.

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

Returns an iterator over the values of the tuple struct’s fields.

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

impl TypePath for DualAxisSensitivity

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 DualAxisSensitivity

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for DualAxisSensitivity

impl Eq for DualAxisSensitivity

impl StructuralPartialEq for DualAxisSensitivity