Struct leafwing_input_manager::axislike::SingleAxis

source · [−]

pub struct SingleAxis {
    pub axis_type: AxisType,
    pub positive_low: f32,
    pub negative_low: f32,
    pub value: Option<f32>,
}

Expand description

A single directional axis with a configurable trigger zone.

These can be stored in a InputKind to create a virtual button.

Warning

positive_low must be greater than or equal to negative_low for this type to be validly constructed.

Fields

axis_type: AxisType

The axis that is being checked.

positive_low: f32

Any axis value higher than this will trigger the input.

negative_low: f32

Any axis value lower than this will trigger the input.

value: Option<f32>

The target value for this input, used for input mocking.

WARNING: this field is ignored for the sake of Eq and Hash

Implementations

source

impl SingleAxis

source

pub fn symmetric(axis_type: impl Into<AxisType>, threshold: f32) -> SingleAxis

Creates a SingleAxis with both positive_low and negative_low set to threshold.

source

pub fn from_value(axis_type: impl Into<AxisType>, value: f32) -> SingleAxis

Creates a SingleAxis with the specified axis_type and value.

All thresholds are set to 0.0. Primarily useful for input mocking.

source

pub const fn mouse_wheel_x() -> SingleAxis

Creates a SingleAxis corresponding to horizontal MouseWheel movement

source

pub const fn mouse_wheel_y() -> SingleAxis

Creates a SingleAxis corresponding to vertical MouseWheel movement

source

pub const fn mouse_motion_x() -> SingleAxis

Creates a SingleAxis corresponding to horizontal MouseMotion movement

source

pub const fn mouse_motion_y() -> SingleAxis

Creates a SingleAxis corresponding to vertical MouseMotion movement

Trait Implementations

source

impl Clone for SingleAxis

source

fn clone(&self) -> SingleAxis

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for SingleAxis

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for SingleAxis

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl From<SingleAxis> for InputKind

source

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

source

impl From<SingleAxis> for UserInput

source

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

source

impl Hash for SingleAxis

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<SingleAxis> for SingleAxis

source

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

source

impl Serialize for SingleAxis

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl Copy for SingleAxis

source

impl Eq for SingleAxis

Auto Trait Implementations

impl RefUnwindSafe for SingleAxis

impl Send for SingleAxis

impl Sync for SingleAxis

impl Unpin for SingleAxis

impl UnwindSafe for SingleAxis

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for T where
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

Return the T [ShaderType] for self. When used in [AsBindGroup] derives, it is safe to assume that all images in self exist. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> DynEq for T where
T: Any + Eq,

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

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<T> DynHash for T where
T: DynEq + Hash,

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

fn dyn_hash(&self, state: &mut dyn Hasher)

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Serialize for T where
T: Serialize + ?Sized,

source

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct leafwing_input_manager::axislike::SingleAxis

Fields

Implementations

impl SingleAxis

pub fn symmetric(axis_type: impl Into<AxisType>, threshold: f32) -> SingleAxis

pub fn from_value(axis_type: impl Into<AxisType>, value: f32) -> SingleAxis

pub const fn mouse_wheel_x() -> SingleAxis

pub const fn mouse_wheel_y() -> SingleAxis

pub const fn mouse_motion_x() -> SingleAxis

pub const fn mouse_motion_y() -> SingleAxis

Trait Implementations

impl Clone for SingleAxis

fn clone(&self) -> SingleAxis

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

impl Debug for SingleAxis

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

impl<'de> Deserialize<'de> for SingleAxis

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl From<SingleAxis> for InputKind

fn from(input: SingleAxis) -> Self

impl From<SingleAxis> for UserInput

fn from(input: SingleAxis) -> Self

impl Hash for SingleAxis

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

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl PartialEq<SingleAxis> for SingleAxis

fn eq(&self, other: &Self) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Serialize for SingleAxis

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

impl Copy for SingleAxis

impl Eq for SingleAxis

Auto Trait Implementations

impl RefUnwindSafe for SingleAxis

impl Send for SingleAxis

impl Sync for SingleAxis

impl Unpin for SingleAxis

impl UnwindSafe for SingleAxis

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T, U> AsBindGroupShaderType<U> for T where U: ShaderType, &'a T: for<'a> Into<U>,

fn as_bind_group_shader_type( &self, _images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>) -> U

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for T where T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> DynEq for T where T: Any + Eq,

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

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<T> DynHash for T where T: DynEq + Hash,

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

fn dyn_hash(&self, state: &mut dyn Hasher)

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Serialize for T where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> DynEq for T where
T: Any + Eq,

impl<T> DynHash for T where
T: DynEq + Hash,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> Serialize for T where
T: Serialize + ?Sized,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

impl<T> Event for T where
T: 'static + Send + Sync,

impl<T> Resource for T where
T: 'static + Send + Sync,

impl<T> StateData for T where
T: 'static + Send + Sync + Clone + Eq + Debug + Hash,