UserInput as trait #346

paul-hansen · 2023-05-16T19:06:02Z

Description

Change our UserInput enum to be a trait. Adds the ability for other libraries to add new inputs that can be mapped to our actions. Also removes all UserInput instances being the size of the largest variant (which was inflated due to Chords using PetiteSets stored on the stack)

Closes: #321

Current Status

Good progress has been made but still some major things to finish implementing such as deserialization.

TODO

alice-i-cecile · 2023-05-16T19:22:50Z

src/input_map.rs

@@ -78,7 +78,7 @@ use std::marker::PhantomData;
 pub struct InputMap<A: Actionlike> {
 /// The raw vector of [PetitSet]s used to store the input mapping,
 /// indexed by the `Actionlike::id` of `A`
- map: Vec<PetitSet<UserInput, 16>>,
+ map: Vec<PetitSet<Box<dyn InputLikeObject>, 16>>,


We should just swap to a HashMap here now that we're no longer trying to stack-allocate. Will simplify a lot of code.

I'm pretty sure petitset can be killed as a dependency completely.

I assume we still want "slots" so the inputs are ordered and we can have a "secondary" input in index 1 without the "primary" index 0 being populated. Probably accomplish this with a HashMap<usize, Box<dyn InputLikeObject>?

What would you think of having a type that wraps the HashMap so we can make it more clear what the purpose of the usize is? Named something like Bindings? That way when we call things like InputMap::get we return our Bindings struct instead of a hashmap with a usize as key that is somewhat unclear what the purpose is.

paul-hansen · 2023-05-21T21:41:40Z

Rebased on main to fix conflict.

The minimal and physical_key_bindings examples are working again!

I think something that needs some thought is ButtonLike and AxisLike, currently they are just marker traits that could easily be replaced with a bool. I feel like they could be doing more. Maybe split up the InputStreams Trait into those traits or something, not sure if that's possible yet. I'll probably implement Gamepad next since that has axes, and might give some insight.

alice-i-cecile · 2023-05-22T20:57:19Z

I would expect we want a method to create a Buttonlike input from an Axislike input :) We may also want to split it into Buttonlike / SingleAxislike / DualAxislike instead: I think that the methods I really want from something that behaves like an axis tend to depend on the number of dimensions.

# Objective Add a get_unclamped method to [Axis](https://docs.rs/bevy/0.10.1/bevy/input/struct.Axis.html) to allow it to be used in cases where being able to get a precise relative movement is important. For example, camera zoom with the mouse wheel. This would make it possible for libraries like leafwing input manager to leverage `Axis` for mouse motion and mouse wheel axis mapping. I tried to use it my PR here Leafwing-Studios/leafwing-input-manager#346 but will likely have to revert that and read the mouse wheel events for now which is what prompted this PR. ## Solution Instead of clamping the axis value when it is set, it now stores the raw value and clamps it in the `get` method. This allows a simple get_unclamped method that just returns the raw value. ## Changelog - Added a get_unclamped method to Axis that can return values outside of -1.0 to 1.0

paul-hansen · 2023-06-24T17:04:03Z

@alice-i-cecile could use some input on the direction you want to go with deadzones. It used to be that SingleAxis would store the positive_low and negative_low values for deadzone. Now that SingleAxisLike is a trait, we can implement it for GamepadAxis and directly insert that into the mapping instead of converting it into a SingleAxis first which seems like a win. But now it's unclear where to handle the deadzone.

Here's the solutions I've thought of so far:

Let GamepadAxis be inserted directly and don't do anything with deadzones in that case, but keep the SingleAxis around as a wrapper struct that also implements SingleAxisLike can optionally be used to apply deadzones.
Try to prevent GamepadAxis being inserted directly into the input map and force the user to wrap it in SingleAxis first so they have to set the deadzones, e.g. making SingleAxisLike not implement InputLikeObject
Add methods to the SingleAxisLike trait for setting the deadzone values and let the implementation handle what it does with those values. For example, for GamepadAxis it would update Bevy's AxisSettings

Feel free to take some time to respond, I have other things I can keep working on with this.

Currently non-functional and very messy/incomplete. Looking for input on how to solve the need to be able to Serialize InputLike but unable to do so while using dynamic dispatch.

Might be ways to make this cleaner, for now just trying to work towards compiling to make sure the InputLike trait idea works out.

I don't think this makes sense with the new InputLike trait as we don't know all the possible input types. InputLike::raw_inputs instead returns the individual inputs for InputLike collections.

It got re-added again as an empty file during a rebase on main.

Previously had implemented InputLikeObject for Box<InputLikeObject> to allow accepting boxed or unboxed InputLikeObjects, but it also created the potential to accidentally double box. By implementing From<InputLikeObject> for Box<InputLikeObject> and having methods take impl Into<Box<InputLikeObject> we can accept both without double boxing potential.

alice-i-cecile · 2023-06-25T00:46:09Z

Preference is for 3 if we can swing it: it definitely feels like managing deadzones is within the domain of the trait.

Was fully qualified due to a conflict that no longer exists.

src/clashing_inputs.rs

# Conflicts: # src/action_state.rs # src/systems.rs

# Conflicts: # benches/input_map.rs # examples/multiplayer.rs # src/action_state.rs # src/axislike.rs # src/clashing_inputs.rs # src/input_map.rs # src/input_mocking.rs # src/input_streams.rs # src/user_input.rs # tests/clashes.rs # tests/gamepad_axis.rs # tests/mouse_motion.rs # tests/mouse_wheel.rs

paul-hansen · 2023-08-04T18:04:14Z

I might not get back to this seriously before mid September, working more hours to get a demo done for our game for a convention. If anyone wants to pick it up before then I'd be happy to answer any questions.

Current status is that it passes all the tests except for the deadzone ones because that isn't re-implemented yet. Checklist on original post has been updated with some other things that need finished like docs, migration guide etc.
Deadzones might require some bigger changes, especially if we want to keep the functionality from #370 since I think we would have to store something alongside inputs for the deadzone settings instead of only storing the trait object we get from integrations.

paul-hansen · 2023-09-15T00:20:00Z

I think I'll have to bow out of heading this up. I've been trying to merge or rebase from main but there are enough conflicting changes it might be cleaner to start over and just look at the InputLike and InputLikeObject traits from this PR as a starting point. As it stands, I don't think I can spare the time to commit to that sadly. In hindsight, it might be worth considering a feature freeze or forking the project as a new crate or something while taking on this much of a refactor to avoid having to re-implement changes that gets added while working on it.

Hopefully this was still valuable as an experiment to show a way it could be done using traits.

Closing this PR for now, but if anyone wants to try and resurrect the branch as their own or anything you're more than welcome to use it. I'm also open to doing work related to it if there are ideas on how to make it simpler or break it into smaller changes that could be merged incrementally.

alice-i-cecile · 2023-09-15T00:42:13Z

Sounds good <3 thanks for doing this investigation; I'll take a crack at this next time I'm in the mood for something crunchy.

alice-i-cecile added code-quality Make the code faster or prettier performance Code go brrr controversial Requires a heightened standard of review labels May 16, 2023

alice-i-cecile reviewed May 16, 2023

View reviewed changes

paul-hansen force-pushed the userinput-as-trait branch from cd0bf92 to 876f284 Compare May 21, 2023 21:31

paul-hansen force-pushed the userinput-as-trait branch from 61da50f to d193141 Compare June 10, 2023 23:05

paul-hansen mentioned this pull request Jun 17, 2023

Add get_unclamped to Axis bevyengine/bevy#8871

Merged

paul-hansen added 18 commits June 24, 2023 17:07

WIP Experimenting with InputLike trait instead of UserInput

9fd68c5

Currently non-functional and very messy/incomplete. Looking for input on how to solve the need to be able to Serialize InputLike but unable to do so while using dynamic dispatch.

WIP implemented Serialize for the new InputLike trait

9deea9c

Might be ways to make this cleaner, for now just trying to work towards compiling to make sure the InputLike trait idea works out.

Start of a custom input example

3bd3a5c

Somewhat failed attempt at input streams trait

06badbb

Input streams and custom_input example working

58fca70

Some minor code cleanup

29af8f6

Remove input_mocking module

ea26927

Implement InputLike and InputStreams for Keycode, minimal_example works

37cb8da

Remove RawInput struct

18e6013

I don't think this makes sense with the new InputLike trait as we don't know all the possible input types. InputLike::raw_inputs instead returns the individual inputs for InputLike collections.

Remove unused inport

92a90ff

Make input_like a directory in prep for splitting out implementations

cf0cec3

Move InputLike implementations into their own files, add ScanCode impl

71d10a0

Remove input_mocking.rs again

d155363

It got re-added again as an empty file during a rebase on main.

Remove InputStreams trait in favor of ButtonLike & Dual/SingleAxisLike

42a65f9

Provide a default implementation for InputLikeObject::raw_inputs & len

942cfd6

Remove unnecessary cloning when implementing as_button/axis methods

b4a80bf

Chords implementation with the new InputLike trait

fc2be3f

Fix errors/warnings in benchmarks

159a88e

paul-hansen force-pushed the userinput-as-trait branch from 96eeb26 to 159a88e Compare June 24, 2023 22:07

paul-hansen added 13 commits June 24, 2023 21:06

Fix gamepad_swapping test

ca536a3

Fix action_state_driver test

386742f

Fix mouse_drag test

aa973f9

Fix same order warnings for InputLikeObject implementations

a21fc73

Add MouseMotionDirection Input resource to app and a system to update it

481988d

Fix mouse motion tests

4ae4cf7

Fix todo for virtual dpad as_serialize

76bcaca

Progress on fixing clashes

db1d93d

Call clone_dyn directly in VirtualDPad impl

1c98fe6

Was fully qualified due to a conflict that no longer exists.

Progress on clashing for InputLike

ee4eb8c

Fix arrow_keys() to use KeyCode like in main

4a90caa

Fix virtual dpad clashes

cf84953

Fix doc tests

e6ddc91

paul-hansen commented Jul 2, 2023

View reviewed changes

src/clashing_inputs.rs Outdated Show resolved Hide resolved

paul-hansen added 6 commits July 1, 2023 21:09

Coerce single input chords into the single input

2296197

Merge remote-tracking branch 'upstream/main' into userinput-as-trait

0a408e0

# Conflicts: # src/action_state.rs # src/systems.rs

Bevy 0.11 fixes after merging main

54f6063

Fixes for new clippy warnings after updating to Rust 1.71

a11707c

Documentation fixes

e2caefe

paul-hansen closed this Sep 15, 2023

alice-i-cecile mentioned this pull request Oct 17, 2023

Remove petitset dependency #400

Merged

Shute052 mentioned this pull request Feb 22, 2024

Refactoring underlying architecture to support various input types #483

Closed

6 tasks

Shute052 mentioned this pull request Apr 5, 2024

Refactor UserInput and InputKind variants into separate implementations #490

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UserInput as trait #346

UserInput as trait #346

paul-hansen commented May 16, 2023 •

edited

Loading

alice-i-cecile May 16, 2023 •

edited

Loading

paul-hansen May 21, 2023

paul-hansen May 21, 2023 •

edited

Loading

paul-hansen commented May 21, 2023

alice-i-cecile commented May 22, 2023

paul-hansen commented Jun 24, 2023 •

edited

Loading

alice-i-cecile commented Jun 25, 2023

paul-hansen commented Aug 4, 2023 •

edited

Loading

paul-hansen commented Sep 15, 2023

alice-i-cecile commented Sep 15, 2023

UserInput as trait #346

UserInput as trait #346

Conversation

paul-hansen commented May 16, 2023 • edited Loading

Description

Current Status

TODO

alice-i-cecile May 16, 2023 • edited Loading

Choose a reason for hiding this comment

paul-hansen May 21, 2023

Choose a reason for hiding this comment

paul-hansen May 21, 2023 • edited Loading

Choose a reason for hiding this comment

paul-hansen commented May 21, 2023

alice-i-cecile commented May 22, 2023

paul-hansen commented Jun 24, 2023 • edited Loading

alice-i-cecile commented Jun 25, 2023

paul-hansen commented Aug 4, 2023 • edited Loading

paul-hansen commented Sep 15, 2023

alice-i-cecile commented Sep 15, 2023

paul-hansen commented May 16, 2023 •

edited

Loading

alice-i-cecile May 16, 2023 •

edited

Loading

paul-hansen May 21, 2023 •

edited

Loading

paul-hansen commented Jun 24, 2023 •

edited

Loading

paul-hansen commented Aug 4, 2023 •

edited

Loading