bevy_ios_impact 0.6.0

allows using ios ImpactFeedback API to generate haptic device vibrations
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

use bevy_ecs::resource::Resource;

use crate::FeedbackStyle;
use crate::inner::SharedGenerators;

/// bevy resource: offers interaction with ios impact feedback generators from bevy systems.
///
/// on platforms other than ios this becomes a no-op
#[derive(Resource, Clone, Debug)]
pub struct ImpactResource {
    inner: Option<SharedGenerators>,
}

impl Default for ImpactResource {
    fn default() -> Self {
        Self::new(true)
    }
}

impl ImpactResource {
    /// initialize based on config variable.
    /// ideally for loading up based on saved settings value
    pub fn new(enabled: bool) -> Self {
        Self {
            inner: if enabled {
                Some(Default::default())
            } else {
                None
            },
        }
    }
}

impl ImpactResource {
    /// allows disabling impacts without checking in user-code whether or not to call the `impact` APIs
    pub fn disable(&mut self) {
        self.inner = None;
    }

    /// enable impacts
    pub fn enable(&mut self) {
        if self.inner.is_none() {
            self.inner = Some(Default::default());
        }
    }

    /// allows fetching enabled state
    pub fn enabled(&self) -> bool {
        self.inner.is_some()
    }

    /// toggles enabled state and returns state it toggled to
    pub fn toggle(&mut self) -> bool {
        if self.inner.is_none() {
            self.enabled();
            true
        } else {
            self.disable();
            false
        }
    }

    /// Prepares the Taptic engine.
    /// According to apple docs the engine might be asleep if not prepared, which could leads to delays.
    /// If not used via eg. [impact] the engine will go back to sleep to save battery.
    ///
    /// refer to apple documentation for more details:
    /// see <https://developer.apple.com/documentation/uikit/uifeedbackgenerator/2369818-prepare?language=objc>
    ///
    /// on platforms other than ios this becomes a no-op.
    pub fn prepare(&mut self) {
        if let Some(inner) = &self.inner {
            inner.prepare();
        }
    }

    /// Triggers an impact with the given `style`.
    ///
    /// refer to apple documentation for more details:
    /// see <https://developer.apple.com/documentation/uikit/uiimpactfeedbackgenerator/2374286-impactoccurred?language=objc>
    ///
    /// on platforms other than ios this becomes a no-op.
    pub fn impact(&mut self, style: FeedbackStyle) {
        if let Some(inner) = &self.inner {
            inner.impact(style);
        }
    }

    /// Triggers an impact with the given `style` and `intensity`
    ///
    /// refer to apple documentation for more details:
    /// see <https://developer.apple.com/documentation/uikit/uiimpactfeedbackgenerator/2374286-impactoccurredwithintensity?language=objc>
    ///
    /// on platforms other than ios this becomes a no-op.
    pub fn impact_with_intensity(&mut self, style: FeedbackStyle, intensity: f64) {
        if let Some(inner) = &self.inner {
            inner.impact_with_intensity(style, intensity);
        }
    }
}