Trait CustomAxisProcessor

pub trait CustomAxisProcessor:
    Send
    + Sync
    + Debug
    + DynClone
    + DynEq
    + DynHash
    + Reflect
    + Serialize {
    // Required method
    fn process(&self, input_value: f32) -> f32;
}

A trait for creating custom processor that handles single-axis input values, accepting a f32 input and producing a f32 output.

Examples

use std::hash::{Hash, Hasher};
use bevy::prelude::*;
use bevy::math::FloatOrd;
use serde::{Deserialize, Serialize};
use leafwing_input_manager::prelude::*;

/// Doubles the input, takes the absolute value,
/// and discards results that meet the specified condition.
// If your processor includes fields not implemented Eq and Hash,
// implementation is necessary as shown below.
// Otherwise, you can derive Eq and Hash directly.
#[derive(Debug, Clone, Copy, PartialEq, Reflect, Serialize, Deserialize)]
pub struct DoubleAbsoluteValueThenIgnored(pub f32);

// Add this attribute for ensuring proper serialization and deserialization.
#[serde_typetag]
impl CustomAxisProcessor for DoubleAbsoluteValueThenIgnored {
    fn process(&self, input_value: f32) -> f32 {
        // Implement the logic just like you would in a normal function.

        // You can use other processors within this function.
        let value = AxisProcessor::Sensitivity(2.0).process(input_value);

        let value = value.abs();
        if value == self.0 {
            0.0
        } else {
            value
        }
    }
}

// Unfortunately, manual implementation is required due to the float field.
impl Eq for DoubleAbsoluteValueThenIgnored {}
impl Hash for DoubleAbsoluteValueThenIgnored {
    fn hash<H: Hasher>(&self, state: &mut H) {
        // Encapsulate the float field for hashing.
        FloatOrd(self.0).hash(state);
    }
}

// Remember to register your processor - it will ensure everything works smoothly!
let mut app = App::new();
app.register_axis_processor::<DoubleAbsoluteValueThenIgnored>();

// Now you can use it!
let processor = DoubleAbsoluteValueThenIgnored(4.0);

// Rejected!
assert_eq!(processor.process(2.0), 0.0);
assert_eq!(processor.process(-2.0), 0.0);

// Others are just doubled absolute value.
assert_eq!(processor.process(6.0), 12.0);
assert_eq!(processor.process(4.0), 8.0);
assert_eq!(processor.process(0.0), 0.0);
assert_eq!(processor.process(-4.0), 8.0);
assert_eq!(processor.process(-6.0), 12.0);

// The ways to create an AxisProcessor.
let axis_processor = AxisProcessor::Custom(Box::new(processor));
assert_eq!(axis_processor, AxisProcessor::from(processor));

Required Methods

fn process(&self, input_value: f32) -> f32

Computes the result by processing the input_value.

Trait Implementations

impl<'de> Deserialize<'de> for Box<dyn CustomAxisProcessor>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for Box<dyn CustomAxisProcessor>

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 Box<dyn CustomAxisProcessor>

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> Hash for dyn CustomAxisProcessor + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn CustomAxisProcessor + Send + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn CustomAxisProcessor + Send + Sync + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn CustomAxisProcessor + Sync + 'hash

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

impl<'eq> PartialEq<&Box<dyn CustomAxisProcessor + 'eq>> for Box<dyn CustomAxisProcessor + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq<&Box<dyn CustomAxisProcessor + Send + 'eq>> for Box<dyn CustomAxisProcessor + Send + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq<&Box<dyn CustomAxisProcessor + Sync + Send + 'eq>> for Box<dyn CustomAxisProcessor + Send + Sync + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq<&Box<dyn CustomAxisProcessor + Sync + 'eq>> for Box<dyn CustomAxisProcessor + Sync + 'eq>

fn eq(&self, other: &&Self) -> 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<'eq> PartialEq for dyn CustomAxisProcessor + 'eq

fn eq(&self, other: &Self) -> 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<'eq> PartialEq for dyn CustomAxisProcessor + Send + 'eq

fn eq(&self, other: &Self) -> 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<'eq> PartialEq for dyn CustomAxisProcessor + Send + Sync + 'eq

fn eq(&self, other: &Self) -> 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<'eq> PartialEq for dyn CustomAxisProcessor + Sync + 'eq

fn eq(&self, other: &Self) -> 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 Box<dyn CustomAxisProcessor>

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

Applies a reflected value to this 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.

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 clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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 debug(&self, f: &mut Formatter<'_>) -> Result

Debug formatter for the value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this 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<'a> Serialize for dyn CustomAxisProcessor + 'a

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 Box<dyn CustomAxisProcessor>

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 Box<dyn CustomAxisProcessor>

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<'eq> Eq for dyn CustomAxisProcessor + 'eq

impl<'eq> Eq for dyn CustomAxisProcessor + Send + 'eq

impl<'eq> Eq for dyn CustomAxisProcessor + Send + Sync + 'eq

impl<'eq> Eq for dyn CustomAxisProcessor + Sync + 'eq

Implementors