bevy_input_bindings 0.0.2

High level, flexible and shareable input binding library for the Bevy game engine
Documentation 
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

use bevy::input::gamepad::{Gamepad, GamepadAxis, GamepadButton};
use bevy::reflect::Reflect;
use std::time::Duration;

use crate::repeat::Repeat;

pub trait TriggerTrait {
    fn is_triggered(&mut self, gamepad: &Gamepad, dt: &Duration) -> bool;
}

/// Triggers the action whenever the defined button has just been pressed
#[derive(Clone, Debug, Reflect)]
pub struct ButtonPressed {
    button: GamepadButton,
    repeat: Option<Repeat>,
}

impl ButtonPressed {
    pub fn new(button: GamepadButton) -> Self {
        Self {
            button,
            repeat: None,
        }
    }

    /// Repeat the trigger as long as the button is pressed, with delays between each actions.
    pub fn with_repeat(
        mut self,
        duration_before_first_repeat: Duration,
        duration_between_repeat: Duration,
    ) -> Self {
        self.repeat = Some(Repeat::new(duration_before_first_repeat, duration_between_repeat));
        self
    }
}

impl TriggerTrait for ButtonPressed {
    fn is_triggered(&mut self, gamepad: &Gamepad, dt: &Duration) -> bool {
        let Some(repeat) = &mut self.repeat else {
            return gamepad.just_pressed(self.button);
        };
        if gamepad.just_pressed(self.button) {
            repeat.reset();
            return true;
        }
        let signal = gamepad.pressed(self.button);
        return repeat.is_triggered(signal, dt);
    }
}

/// Triggers the action whenever the defined button has just been released
#[derive(Clone, Debug, Reflect)]
pub struct ButtonJustReleased {
    button: GamepadButton,
}

impl ButtonJustReleased {
    pub fn new(button: GamepadButton) -> Self {
        Self {
            button,
        }
    }
}

impl TriggerTrait for ButtonJustReleased {
    fn is_triggered(&mut self, gamepad: &Gamepad, _dt: &Duration) -> bool {
        gamepad.just_released(self.button)
    }
}

/// Triggers the action whenever the defined axis goes above (or lower) a custom value.
/// The action can only be triggered again after the value has been lower (or higher) to a second
/// value.
#[derive(Clone, Debug, Reflect)]
pub struct Hysteresis {
    axis: GamepadAxis,
    above: bool,
    lower: f32,
    higher: f32,
    active: bool,
    repeat: Option<Repeat>,
}

impl Hysteresis {
    pub fn new_above(axis: GamepadAxis, lower: f32, higher: f32) -> Self {
        Self {
            axis,
            above: true,
            lower,
            higher,
            active: false,
            repeat: None,
        }
    }

    pub fn new_below(axis: GamepadAxis, lower: f32, higher: f32) -> Self {
        Self {
            axis,
            above: false,
            lower,
            higher,
            active: false,
            repeat: None,
        }
    }

    /// Repeat the trigger as long as the hysteresis is active, with delays between each actions.
    pub fn with_repeat(
        mut self,
        duration_before_first_repeat: Duration,
        duration_between_repeat: Duration,
    ) -> Self {
        self.repeat = Some(Repeat::new(duration_before_first_repeat, duration_between_repeat));
        self
    }
}

impl TriggerTrait for Hysteresis {
    fn is_triggered(&mut self, gamepad: &Gamepad, dt: &Duration) -> bool {
        // Get axis value
        let value = gamepad.get(self.axis.clone()).unwrap_or(0.0);
        let last_active = self.active.clone();
        // Compute signal
        if self.above {
            if self.active && value < self.lower {
                self.active = false;
            } else if !self.active && value > self.higher {
                self.active = true;
            }
        } else {
            if self.active && value > self.lower {
                self.active = false;
            } else if !self.active && value < self.higher {
                self.active = true;
            }
        }
        // Compute repeat
        if let Some(repeat) = &mut self.repeat {
            if last_active != self.active {
                repeat.reset();
                return self.active;
            }
            return repeat.is_triggered(self.active, dt);
        }
        if last_active != self.active {
            return self.active;
        } else {
            return false;
        }
    }
}