address

RELEASES.md

@@ -1,5 +1,11 @@
 # Release Notes
 
+## Version 0.16.0 (Unreleased)
+
+### Usability (0.16.0)
+
+- added `threshold` value for `GamepadControlDirection`, `MouseMoveDirection`, and `MouseScrollDirection` to be considered pressed.
+
 ## Version 0.15.1
 
 ### Enhancements (0.15.1)
@@ -25,10 +31,6 @@
 
 - Reflect `Component` and `Resource`, which enables accessing the data in the type registry
 
-#### Inputs
-
-- added `threshold` value for `GamepadControlDirection`, `MouseMoveDirection`, and `MouseScrollDirection` to be considered pressed.
-
 #### ActionDiffEvent
 
 - Implement `MapEntities`, which lets networking crates translate owner entity IDs between ECS worlds

src/axislike.rs

@@ -26,10 +26,11 @@ impl AxisDirection {
     }
 
     /// Checks if the given `value` represents an active input in this direction,
-    /// considering the specified `threshold`.
+    /// considering the specified `threshold` (Must be non-negative).
     #[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,
@@ -153,7 +154,7 @@ impl DualAxisDirection {
     }
 
     /// Checks if the given `value` represents an active input in this direction,
-    /// considering the specified `threshold`.
+    /// considering the specified `threshold` (Must be non-negative).
     #[must_use]
     #[inline]
     pub fn is_active(&self, value: Vec2, threshold: f32) -> bool {

src/user_input/gamepad.rs

@@ -82,6 +82,7 @@ pub struct GamepadControlDirection {
     pub direction: AxisDirection,
 
     /// The threshold value for the direction to be considered pressed.
+    /// Must be non-negative.
     pub threshold: f32,
 }
 
@@ -106,9 +107,10 @@ impl GamepadControlDirection {
         }
     }
 
-    /// Sets the `threshold` value.
+    /// Sets the `threshold` value. Must be non-negative.
     #[inline]
     pub const fn threshold(mut self, threshold: f32) -> Self {
+        assert!(threshold >= 0.0);
         self.threshold = threshold;
         self
     }

src/user_input/mouse.rs

@@ -119,13 +119,15 @@ pub struct MouseMoveDirection {
     pub direction: DualAxisDirection,
 
     /// The threshold value for the direction to be considered pressed.
+    /// Must be non-negative.
     pub threshold: f32,
 }
 
 impl MouseMoveDirection {
-    /// Sets the `threshold` value.
+    /// Sets the `threshold` value. Must be non-negative.
     #[inline]
     pub const fn threshold(mut self, threshold: f32) -> Self {
+        assert!(threshold >= 0.0);
         self.threshold = threshold;
         self
     }
@@ -469,13 +471,15 @@ pub struct MouseScrollDirection {
     pub direction: DualAxisDirection,
 
     /// The threshold value for the direction to be considered pressed.
+    /// Must be non-negative.
     pub threshold: f32,
 }
 
 impl MouseScrollDirection {
-    /// Sets the `threshold` value.
+    /// Sets the `threshold` value. Must be non-negative.
     #[inline]
     pub const fn threshold(mut self, threshold: f32) -> Self {
+        assert!(threshold >= 0.0);
         self.threshold = threshold;
         self
     }