Struct MouseScroll

pub struct MouseScroll { /* private fields */ }

Amount of mouse wheel scrolling on both axes.

Value Processing

You can customize how the values are processed using a pipeline of processors. See WithDualAxisProcessingPipelineExt for details.

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));

let input = MouseScroll::default();

// Scrolling on either axis activates the input
MouseScrollAxis::Y.set_value(app.world_mut(), 3.0);
app.update();
assert_eq!(app.read_dual_axis_values(input), Vec2::new(0.0, 3.0));

// You can configure a processing pipeline (e.g., doubling the Y value)
let doubled = MouseScroll::default().sensitivity_y(2.0);
assert_eq!(app.read_dual_axis_values(doubled), Vec2::new(0.0, 6.0));

Trait Implementations

impl Clone for MouseScroll

fn clone(&self) -> MouseScroll

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseScroll

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

Formats the value using the given formatter.

impl Default for MouseScroll

fn default() -> MouseScroll

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MouseScroll

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DualAxislike for MouseScroll

fn axis_pair(&self, input_store: &CentralInputStore, _gamepad: Gamepad) -> Vec2

Retrieves the mouse scroll movement on both axes after processing by the associated processors.

fn set_axis_pair(&self, world: &mut World, value: Vec2)

Sends a MouseWheel event with the specified displacement in pixels.

Note

The window field will be filled with a placeholder value.

fn set_axis_pair_as_gamepad( &self, world: &mut World, value: Vec2, _gamepad: Option<Gamepad>, )

Simulate a dual-axis-like input, pretending to be the provided Gamepad.

impl FromReflect for MouseScroll

where Self: Any + Send + Sync, Vec<DualAxisProcessor>: 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 MouseScroll

where Self: Any + Send + Sync, Vec<DualAxisProcessor>: 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 MouseScroll

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 MouseScroll

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

where Self: Any + Send + Sync, Vec<DualAxisProcessor>: 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 DualAxislike> for MouseScroll

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

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for MouseScroll

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for MouseScroll

where Self: Any + Send + Sync, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

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

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>

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>

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>

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 MouseScroll

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 MouseScroll

where Self: Any + Send + Sync, Vec<DualAxisProcessor>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UpdatableInput for MouseScroll

type SourceData = AccumulatedMouseScroll

The resource data that must be fetched from the world in order to update the user input.

fn compute( central_input_store: ResMut<'_, CentralInputStore>, source_data: Res<'_, Self::SourceData>, )

A system that updates the central store of user input based on the state of the world.

impl UserInput for MouseScroll

fn kind(&self) -> InputControlKind

MouseScroll acts as an axis input.

fn decompose(&self) -> BasicInputs

MouseScroll represents a composition of four MouseScrollDirections.

impl WithDualAxisProcessingPipelineExt for MouseScroll

fn reset_processing_pipeline(self) -> Self

Resets the processing pipeline, removing any currently applied processors.

fn replace_processing_pipeline( self, processors: impl IntoIterator<Item = DualAxisProcessor>, ) -> Self

Replaces the current processing pipeline with the given DualAxisProcessors.

fn with_processor(self, processor: impl Into<DualAxisProcessor>) -> Self

Appends the given DualAxisProcessor as the next processing step.

fn digital(self) -> Self

Appends an DualAxisProcessor::Digital processor as the next processing step, similar to Vec2::signum but returning 0.0 for zero values.

fn inverted(self) -> Self

Appends a DualAxisInverted::ALL processor as the next processing step, flipping the sign of values on both axes.

fn inverted_x(self) -> Self

Appends a DualAxisInverted::ONLY_X processor as the next processing step, only flipping the sign of the X-axis values.

fn inverted_y(self) -> Self

Appends a DualAxisInverted::ONLY_Y processor as the next processing step, only flipping the sign of the Y-axis values.

fn sensitivity(self, sensitivity: f32) -> Self

Appends a DualAxisSensitivity processor as the next processing step, multiplying values on both axes with the given sensitivity factor.

fn sensitivity_x(self, sensitivity: f32) -> Self

Appends a DualAxisSensitivity processor as the next processing step, only multiplying the X-axis values with the given sensitivity factor.

fn sensitivity_y(self, sensitivity: f32) -> Self

Appends a DualAxisSensitivity processor as the next processing step, only multiplying the Y-axis values with the given sensitivity factor.

fn with_bounds(self, min: f32, max: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting values within the same range [min, max] on both axes.

fn with_bounds_symmetric(self, threshold: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting values within the same range [-threshold, threshold] on both axes.

fn with_bounds_x(self, min: f32, max: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, only restricting values within the range [min, max] on the X-axis.

fn with_bounds_x_symmetric(self, threshold: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting values within the range [-threshold, threshold] on the X-axis.

fn with_bounds_y(self, min: f32, max: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, only restricting values within the range [min, max] on the Y-axis.

fn with_bounds_y_symmetric(self, threshold: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting values within the range [-threshold, threshold] on the Y-axis.

fn at_least(self, min: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting values to a minimum value on both axes.

fn at_least_only_x(self, min: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting X values to a minimum value.

fn at_least_only_y(self, min: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting Y values to a minimum value.

fn at_most(self, min: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting values to a maximum value on both axes.

fn at_most_only_x(self, min: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting X values to a maximum value.

fn at_most_only_y(self, min: f32) -> Self

Appends a DualAxisBounds processor as the next processing step, restricting Y values to a maximum value.

fn with_circle_bounds(self, max: f32) -> Self

Appends a CircleBounds processor as the next processing step, restricting values to a max magnitude.

fn with_deadzone(self, negative_max: f32, positive_min: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, excluding values within the dead zone range [negative_max, positive_min] on both axes, treating them as zeros, then normalizing non-excluded input values into the “live zone”, the remaining range within the DualAxisBounds::symmetric_all(1.0) after dead zone exclusion.

fn with_deadzone_symmetric(self, threshold: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, excluding values within the dead zone range [-threshold, threshold] on both axes, treating them as zeros, then normalizing non-excluded input values into the “live zone”, the remaining range within the DualAxisBounds::symmetric_all(1.0) after dead zone exclusion.

fn only_positive(self, positive_min: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, only passing positive values that greater than positive_min on both axes and then normalizing them into the “live zone” range [positive_min, 1.0].

fn only_negative(self, negative_max: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, only passing negative values that less than negative_max on both axes and then normalizing them into the “live zone” range [-1.0, negative_max].

fn with_deadzone_x(self, negative_max: f32, positive_min: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, excluding values within the range [negative_max, positive_min] on the X-axis, treating them as zeros, then normalizing non-excluded X values into the “live zone”, the remaining range within the AxisBounds::symmetric(1.0) after dead zone exclusion.

fn with_deadzone_x_symmetric(self, threshold: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, excluding values within the range [-threshold, threshold] on the X-axis, treating them as zeros, then normalizing non-excluded X values into the “live zone”, the remaining range within the AxisBounds::symmetric(1.0) after dead zone exclusion.

fn only_positive_x(self, positive_min: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, only excluding X values that less than or equal to positive_min, treating them as zeros and then normalizing non-excluded X values into the “live zone” range [positive_min, 1.0].

fn only_negative_x(self, negative_max: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, only excluding X values that greater than or equal to negative_max, treating them as zeros and then normalizing non-excluded X values into the “live zone” range [-1.0, negative_max].

fn with_deadzone_y(self, negative_max: f32, positive_min: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, excluding values within the range [negative_max, positive_min] on the Y-axis, treating them as zeros, then normalizing non-excluded Y values into the “live zone”, the remaining range within the AxisBounds::symmetric(1.0) after dead zone exclusion.

fn with_deadzone_y_symmetric(self, threshold: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, excluding values within the range [-threshold, threshold] on the Y-axis, treating them as zeros, then normalizing non-excluded Y values into the “live zone”, the remaining range within the AxisBounds::symmetric(1.0) after dead zone exclusion.

fn only_positive_y(self, positive_min: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, only excluding Y values that less than or equal to positive_min, treating them as zeros and then normalizing non-excluded Y values into the range [positive_min, 1.0].

fn only_negative_y(self, negative_max: f32) -> Self

Appends a DualAxisDeadZone processor as the next processing step, only excluding Y values that greater than or equal to negative_max, treating them as zeros and then normalizing non-excluded Y values into the range [-1.0, negative_max].

fn with_circle_deadzone(self, min: f32) -> Self

Appends a CircleDeadZone processor as the next processing step, ignoring values below a min magnitude, treating them as zeros, then normalizing non-excluded input values into the “live zone”, the remaining range within the CircleBounds::new(1.0) after dead zone exclusion.

fn with_deadzone_unscaled(self, negative_max: f32, positive_min: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, ignoring values within the range [negative_max, positive_min] on both axes, treating them as zeros.

fn with_deadzone_symmetric_unscaled(self, threshold: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, ignoring values within the range [-threshold, threshold] on both axes, treating them as zeros.

fn only_positive_unscaled(self, positive_min: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only passing positive values that greater than positive_min on both axes, treating them as zeros.

fn only_negative_unscaled(self, negative_max: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only passing negative values that less than negative_max on both axes, treating them as zeros.

fn with_deadzone_x_unscaled(self, negative_max: f32, positive_min: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only ignoring values within the range [negative_max, positive_min] on the X-axis, treating them as zeros.

fn with_deadzone_x_symmetric_unscaled(self, threshold: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only ignoring values within the range [-threshold, threshold] on the X-axis, treating them as zeros.

fn only_positive_x_unscaled(self, positive_min: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only excluding X values that less than or equal to positive_min, treating them as zeros.

fn only_negative_x_unscaled(self, negative_max: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only excluding X values that greater than or equal to negative_max, treating them as zeros.

fn with_deadzone_y_unscaled(self, negative_max: f32, positive_min: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only ignoring values within the range [negative_max, positive_min] on the Y-axis, treating them as zeros.

fn with_deadzone_y_symmetric_unscaled(self, threshold: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only ignoring values within the range [-threshold, threshold] on the Y-axis, treating them as zeros.

fn only_positive_y_unscaled(self, positive_min: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only excluding Y values that less than or equal to positive_min, treating them as zeros.

fn only_negative_y_unscaled(self, negative_max: f32) -> Self

Appends a DualAxisExclusion processor as the next processing step, only excluding Y values that greater than or equal to negative_max, treating them as zeros.

fn with_circle_deadzone_unscaled(self, min: f32) -> Self

Appends a CircleExclusion processor as the next processing step, ignoring values below a min magnitude, treating them as zeros.

impl Eq for MouseScroll

impl StructuralPartialEq for MouseScroll