Struct bevy::input::gamepad::AxisSettings

pub struct AxisSettings { /* private fields */ }

Settings for a GamepadAxis.

It is used inside of the GamepadSettings to define the sensitivity range and threshold for an axis. Values that are higher than livezone_upperbound will be rounded up to 1.0. Values that are lower than livezone_lowerbound will be rounded down to -1.0. Values that are in-between deadzone_lowerbound and deadzone_upperbound will be rounded to 0.0. Otherwise, values will not be rounded.

The valid range is [-1.0, 1.0].

Implementations

impl AxisSettings

pub fn new( livezone_lowerbound: f32, deadzone_lowerbound: f32, deadzone_upperbound: f32, livezone_upperbound: f32, threshold: f32 ) -> Result<AxisSettings, AxisSettingsError>

Creates a new AxisSettings instance.

Arguments

• livezone_lowerbound - the value below which inputs will be rounded down to -1.0.
• deadzone_lowerbound - the value above which negative inputs will be rounded up to 0.0.
• deadzone_upperbound - the value below which positive inputs will be rounded down to 0.0.
• livezone_upperbound - the value above which inputs will be rounded up to 1.0.
• threshold - the minimum value by which input must change before the change is registered.

Restrictions:

• -1.0 <= livezone_lowerbound <= deadzone_lowerbound <= 0.0
• 0.0 <= deadzone_upperbound <= livezone_upperbound <= 1.0
• 0.0 <= threshold <= 2.0

Errors

Returns an AxisSettingsError if any restrictions on the zone values are not met. If the zone restrictions are met, but the threshold value restrictions are not met, returns AxisSettingsError::Threshold.

pub fn livezone_upperbound(&self) -> f32

Get the value above which inputs will be rounded up to 1.0.

pub fn try_set_livezone_upperbound( &mut self, value: f32 ) -> Result<(), AxisSettingsError>

Try to set the value above which inputs will be rounded up to 1.0.

Errors

If the value passed is less than the dead zone upper bound, returns AxisSettingsError::DeadZoneUpperBoundGreaterThanLiveZoneUpperBound. If the value passed is not in range [0.0..=1.0], returns AxisSettingsError::LiveZoneUpperBoundOutOfRange.

pub fn set_livezone_upperbound(&mut self, value: f32) -> f32

Try to set the value above which inputs will be rounded up to 1.0. If the value passed is negative or less than deadzone_upperbound, the value will not be changed.

Returns the new value of livezone_upperbound.

pub fn deadzone_upperbound(&self) -> f32

Get the value below which positive inputs will be rounded down to 0.0.

pub fn try_set_deadzone_upperbound( &mut self, value: f32 ) -> Result<(), AxisSettingsError>

Try to set the value below which positive inputs will be rounded down to 0.0.

Errors

If the value passed is greater than the live zone upper bound, returns AxisSettingsError::DeadZoneUpperBoundGreaterThanLiveZoneUpperBound. If the value passed is not in range [0.0..=1.0], returns AxisSettingsError::DeadZoneUpperBoundOutOfRange.

pub fn set_deadzone_upperbound(&mut self, value: f32) -> f32

Try to set the value below which positive inputs will be rounded down to 0.0. If the value passed is negative or greater than livezone_upperbound, the value will not be changed.

Returns the new value of deadzone_upperbound.

pub fn livezone_lowerbound(&self) -> f32

Get the value below which negative inputs will be rounded down to -1.0.

pub fn try_set_livezone_lowerbound( &mut self, value: f32 ) -> Result<(), AxisSettingsError>

Try to set the value below which negative inputs will be rounded down to -1.0.

Errors

If the value passed is less than the dead zone lower bound, returns AxisSettingsError::LiveZoneLowerBoundGreaterThanDeadZoneLowerBound. If the value passed is not in range [-1.0..=0.0], returns AxisSettingsError::LiveZoneLowerBoundOutOfRange.

pub fn set_livezone_lowerbound(&mut self, value: f32) -> f32

Try to set the value below which negative inputs will be rounded down to -1.0. If the value passed is positive or greater than deadzone_lowerbound, the value will not be changed.

Returns the new value of livezone_lowerbound.

pub fn deadzone_lowerbound(&self) -> f32

Get the value above which inputs will be rounded up to 0.0.

pub fn try_set_deadzone_lowerbound( &mut self, value: f32 ) -> Result<(), AxisSettingsError>

Try to set the value above which inputs will be rounded up to 0.0.

Errors

If the value passed is less than the live zone lower bound, returns AxisSettingsError::LiveZoneLowerBoundGreaterThanDeadZoneLowerBound. If the value passed is not in range [-1.0..=0.0], returns AxisSettingsError::DeadZoneLowerBoundOutOfRange.

pub fn set_deadzone_lowerbound(&mut self, value: f32) -> f32

Try to set the value above which inputs will be rounded up to 0.0. If the value passed is less than -1.0 or less than livezone_lowerbound, the value will not be changed.

Returns the new value of deadzone_lowerbound.

pub fn threshold(&self) -> f32

Get the minimum value by which input must change before the change is registered.

pub fn try_set_threshold(&mut self, value: f32) -> Result<(), AxisSettingsError>

Try to set the minimum value by which input must change before the change is registered.

Errors

If the value passed is not within [0.0..=2.0], returns GamepadSettingsError::AxisThreshold.

pub fn set_threshold(&mut self, value: f32) -> f32

Try to set the minimum value by which input must change before the changes will be applied. If the value passed is not within [0.0..=2.0], the value will not be changed.

Returns the new value of threshold.

pub fn clamp(&self, new_value: f32) -> f32

Clamps the raw_value according to the AxisSettings.

pub fn filter(&self, new_value: f32, old_value: Option<f32>) -> Option<f32>

Filters the new_value based on the old_value, according to the AxisSettings.

Returns the clamped new_value if the change exceeds the settings threshold, and None otherwise.

Trait Implementations

impl Clone for AxisSettings

fn clone(&self) -> AxisSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AxisSettings

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

Formats the value using the given formatter.

impl Default for AxisSettings

fn default() -> AxisSettings

Returns the “default value” for a type.

impl FromReflect for AxisSettings

where AxisSettings: Any + Send + Sync, f32: FromReflect + TypePath,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<AxisSettings>

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 AxisSettings

where AxisSettings: Any + Send + Sync, f32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl PartialEq for AxisSettings

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

where AxisSettings: Any + Send + Sync, 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<AxisSettings>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<AxisSettings>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

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 + 'static))

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<AxisSettings>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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 Struct for AxisSettings

where AxisSettings: Any + Send + Sync, f32: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

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 + 'static)>

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 + 'static)>

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 + 'static)>

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 AxisSettings

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

where AxisSettings: Any + Send + Sync, f32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl StructuralPartialEq for AxisSettings