Struct MouseScrollDirection

pub struct MouseScrollDirection(pub DualAxisDirection);

Provides button-like behavior for mouse wheel scrolling in cardinal directions.

use bevy::prelude::*;
use bevy::input::InputPlugin;
use leafwing_input_manager::plugin::{AccumulatorPlugin, CentralInputStorePlugin};
use leafwing_input_manager::prelude::*;
use leafwing_input_manager::user_input::testing_utils::FetchUserInput;

let mut app = App::new();
app.add_plugins((InputPlugin, AccumulatorPlugin, CentralInputStorePlugin));

// Positive Y-axis scrolling
let input = MouseScrollDirection::UP;

// Scrolling in the opposite direction doesn't activate the input
MouseScrollAxis::Y.set_value(app.world_mut(), -5.0);
app.update();
assert!(!app.read_pressed(input));

// Scrolling in the chosen direction activates the input
MouseScrollAxis::Y.set_value(app.world_mut(), 5.0);
app.update();
assert!(app.read_pressed(input));

Tuple Fields

0: DualAxisDirection

Implementations

impl MouseScrollDirection

pub const UP: Self = _

Movement in the upward direction.

pub const DOWN: Self = _

Movement in the downward direction.

pub const LEFT: Self = _

Movement in the leftward direction.

pub const RIGHT: Self = _

Movement in the rightward direction.

Trait Implementations

impl Buttonlike for MouseScrollDirection

fn pressed(&self, input_store: &CentralInputStore, _gamepad: Gamepad) -> bool

Checks if there is any recent mouse wheel movement along the specified direction.

fn press(&self, world: &mut World)

Sends a MouseWheel event with a magnitude of 1.0 px in the direction defined by self.

Note

The window field will be filled with a placeholder value.

fn release(&self, _world: &mut World)

This method has no effect.

As mouse scroll directions are determined based on the recent change in mouse scrolling, no action other than waiting for the next frame is necessary to release the input.

fn released(&self, input_store: &CentralInputStore, gamepad: Gamepad) -> bool

Checks if the input is currently inactive.

fn press_as_gamepad(&self, world: &mut World, _gamepad: Option<Gamepad>)

Simulate a press of the buttonlike input, pretending to be the provided Gamepad.

fn release_as_gamepad(&self, world: &mut World, _gamepad: Option<Gamepad>)

Simulate a release of the buttonlike input, pretending to be the provided Gamepad.

impl Clone for MouseScrollDirection

fn clone(&self) -> MouseScrollDirection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseScrollDirection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MouseScrollDirection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for MouseScrollDirection

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

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

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 MouseScrollDirection

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

where Self: Any + Send + Sync, DualAxisDirection: 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<'de> RegisterTypeTag<'de, dyn Buttonlike> for MouseScrollDirection

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn Buttonlike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for MouseScrollDirection

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 MouseScrollDirection

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

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 MouseScrollDirection

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UserInput for MouseScrollDirection

fn kind(&self) -> InputControlKind

MouseScrollDirection acts as a virtual button.

fn decompose(&self) -> BasicInputs

MouseScrollDirection represents a simple virtual button.

impl Copy for MouseScrollDirection

impl Eq for MouseScrollDirection

impl StructuralPartialEq for MouseScrollDirection