1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
//! Tools for working with directional axis-like user inputs (game sticks, D-Pads and emulated equivalents)
use bevy::prelude::{Reflect, Vec2};
use serde::{Deserialize, Serialize};
/// The directions for single-axis inputs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Reflect, Serialize, Deserialize)]
#[must_use]
pub enum AxisDirection {
/// Negative direction.
Negative,
/// Positive direction.
Positive,
}
impl AxisDirection {
/// Returns the full active value along an axis.
#[must_use]
#[inline]
pub fn full_active_value(&self) -> f32 {
match self {
Self::Negative => -1.0,
Self::Positive => 1.0,
}
}
/// Checks if the given `value` represents an active input in this direction,
/// considering the specified `threshold`.
///
/// # Requirements
///
/// - `threshold` >= `0.0`.
///
/// # Panics
///
/// Panics if the requirement isn't met.
#[must_use]
#[inline]
pub fn is_active(&self, value: f32, threshold: f32) -> bool {
assert!(threshold >= 0.0);
match self {
Self::Negative => value < -threshold,
Self::Positive => value > threshold,
}
}
}
/// An axis for dual-axis inputs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Reflect, Serialize, Deserialize)]
#[must_use]
pub enum DualAxisType {
/// The X-axis (typically horizontal movement).
X,
/// The Y-axis (typically vertical movement).
Y,
}
impl DualAxisType {
/// Returns both X and Y axes.
#[inline]
pub const fn axes() -> [Self; 2] {
[Self::X, Self::Y]
}
/// Returns the positive and negative [`DualAxisDirection`]s for the current axis.
#[inline]
pub const fn directions(&self) -> [DualAxisDirection; 2] {
[self.negative(), self.positive()]
}
/// Returns the negative [`DualAxisDirection`] for the current axis.
#[inline]
pub const fn negative(&self) -> DualAxisDirection {
match self {
Self::X => DualAxisDirection::Left,
Self::Y => DualAxisDirection::Down,
}
}
/// Returns the positive [`DualAxisDirection`] for the current axis.
#[inline]
pub const fn positive(&self) -> DualAxisDirection {
match self {
Self::X => DualAxisDirection::Right,
Self::Y => DualAxisDirection::Up,
}
}
/// Returns the value along the current axis.
#[must_use]
#[inline]
pub const fn get_value(&self, value: Vec2) -> f32 {
match self {
Self::X => value.x,
Self::Y => value.y,
}
}
/// Creates a [`Vec2`] with the specified `value` on this axis and `0.0` on the other.
#[must_use]
#[inline]
pub const fn dual_axis_value(&self, value: f32) -> Vec2 {
match self {
Self::X => Vec2::new(value, 0.0),
Self::Y => Vec2::new(0.0, value),
}
}
}
/// The directions for dual-axis inputs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Reflect, Serialize, Deserialize)]
#[must_use]
pub enum DualAxisDirection {
/// Upward direction.
Up,
/// Downward direction.
Down,
/// Leftward direction.
Left,
/// Rightward direction.
Right,
}
impl DualAxisDirection {
/// Returns the [`DualAxisType`] associated with this direction.
#[inline]
pub fn axis(&self) -> DualAxisType {
match self {
Self::Up => DualAxisType::Y,
Self::Down => DualAxisType::Y,
Self::Left => DualAxisType::X,
Self::Right => DualAxisType::X,
}
}
/// Returns the [`AxisDirection`] (positive or negative) on the axis.
#[inline]
pub fn axis_direction(&self) -> AxisDirection {
match self {
Self::Up => AxisDirection::Positive,
Self::Down => AxisDirection::Negative,
Self::Left => AxisDirection::Negative,
Self::Right => AxisDirection::Positive,
}
}
/// Returns the full active value along both axes.
#[must_use]
#[inline]
pub fn full_active_value(&self) -> Vec2 {
match self {
Self::Up => Vec2::Y,
Self::Down => Vec2::NEG_Y,
Self::Left => Vec2::NEG_X,
Self::Right => Vec2::X,
}
}
/// Checks if the given `value` represents an active input in this direction,
/// considering the specified `threshold`.
///
/// # Requirements
///
/// - `threshold` >= `0.0`.
///
/// # Panics
///
/// Panics if the requirement isn't met.
#[must_use]
#[inline]
pub fn is_active(&self, value: Vec2, threshold: f32) -> bool {
let axis_value = self.axis().get_value(value);
self.axis_direction().is_active(axis_value, threshold)
}
}