bevy_pretty_nice_input 0.7.3

An action- and component-based input crate for Bevy
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

use std::marker::PhantomData;

use bevy::prelude::*;

use crate::conditions::Condition;

/// Wrapper for each supported datatype returned from bindings.
#[derive(Clone, Copy, Debug, PartialEq, Reflect)]
#[reflect(Clone, Debug, PartialEq)]
pub enum ActionData {
    Axis1D(f32),
    Axis2D(Vec2),
    Axis3D(Vec3),
}

impl ActionData {
    pub fn x(x: f32) -> Self {
        ActionData::Axis1D(x)
    }

    pub fn xy(x: f32, y: f32) -> Self {
        ActionData::Axis2D(Vec2::new(x, y))
    }

    pub fn xyz(x: f32, y: f32, z: f32) -> Self {
        ActionData::Axis3D(Vec3::new(x, y, z))
    }
}

impl ActionData {
    pub fn as_1d(&self) -> Option<f32> {
        if let ActionData::Axis1D(value) = self {
            Some(*value)
        } else {
            None
        }
    }

    pub fn as_1d_ok(&self) -> Result<f32> {
        match self {
            ActionData::Axis1D(value) => Ok(*value),
            ActionData::Axis2D(_) => Err(BevyError::from("Expected Axis1D, found Axis2D")),
            ActionData::Axis3D(_) => Err(BevyError::from("Expected Axis1D, found Axis3D")),
        }
    }

    pub fn as_2d(&self) -> Option<Vec2> {
        if let ActionData::Axis2D(value) = self {
            Some(*value)
        } else {
            None
        }
    }

    pub fn as_2d_ok(&self) -> Result<Vec2> {
        match self {
            ActionData::Axis1D(_) => Err(BevyError::from("Expected Axis2D, found Axis1D")),
            ActionData::Axis2D(value) => Ok(*value),
            ActionData::Axis3D(_) => Err(BevyError::from("Expected Axis2D, found Axis3D")),
        }
    }

    pub fn as_3d(&self) -> Option<Vec3> {
        if let ActionData::Axis3D(value) = self {
            Some(*value)
        } else {
            None
        }
    }

    pub fn as_3d_ok(&self) -> Result<Vec3> {
        match self {
            ActionData::Axis1D(_) => Err(BevyError::from("Expected Axis3D, found Axis1D")),
            ActionData::Axis2D(_) => Err(BevyError::from("Expected Axis3D, found Axis2D")),
            ActionData::Axis3D(value) => Ok(*value),
        }
    }

    pub fn is_zero(&self) -> bool {
        match self {
            ActionData::Axis1D(value) => *value == 0.0,
            ActionData::Axis2D(value) => *value == Vec2::ZERO,
            ActionData::Axis3D(value) => *value == Vec3::ZERO,
        }
    }

    pub fn zeroed(&self) -> Self {
        match self {
            ActionData::Axis1D(_) => ActionData::Axis1D(0.0),
            ActionData::Axis2D(_) => ActionData::Axis2D(Vec2::ZERO),
            ActionData::Axis3D(_) => ActionData::Axis3D(Vec3::ZERO),
        }
    }

    pub fn length(&self) -> f32 {
        match self {
            ActionData::Axis1D(value) => value.abs(),
            ActionData::Axis2D(value) => value.length(),
            ActionData::Axis3D(value) => value.length(),
        }
    }

    pub fn is_pressed_with(&self, threshold: f32) -> bool {
        self.length() > threshold
    }

    pub fn debug_name(&self) -> &'static str {
        match self {
            ActionData::Axis1D(_) => "Axis1D",
            ActionData::Axis2D(_) => "Axis2D",
            ActionData::Axis3D(_) => "Axis3D",
        }
    }
}

#[derive(Component, Debug, Reflect)]
#[reflect(Component, Debug)]
pub struct PrevActionData(pub ActionData);

#[derive(Component, Default, Debug, Reflect)]
#[reflect(Component, Default, Debug)]
pub struct PrevAction2Data(pub Option<ActionData>);

/// Abstraction layer for bindings, so you can change the bindings at any time without changing the usage of that binding's action.
pub trait Action: Send + Sync + 'static {
    /// Which filter determines how enabled/disabled input is processed.
    ///
    /// Generally, this should either be [`IsInputEnabled`](crate::prelude::IsInputEnabled) or [`IsInputEnabledInvalidate`](crate::prelude::IsInputEnabledInvalidate).
    type EnableFilter: Condition;
}

#[derive(Component, Debug, Reflect)]
#[reflect(Component)]
#[relationship_target(relationship = ActionOf<A>, linked_spawn)]
pub struct Actions<A: Action>(#[relationship] Vec<Entity>, PhantomData<A>);

#[derive(Component, Debug, Reflect)]
#[reflect(Component)]
#[relationship(relationship_target = Actions<A>)]
pub struct ActionOf<A: Action>(#[relationship] pub Entity, PhantomData<A>);