input-actions 0.1.1

An input system for binding PC & Gamepad inputs to application actions
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

use crate::binding::ActionMap;
use std::collections::HashMap;

/// An identifier representing the way device inputs are mapped
/// to [`actions`](`crate::action::Action`) via [`action maps`](ActionMap).
pub type LayoutId = Option<&'static str>;

/// An identifier representing [`ActionSet`], a set of bindings to a given action for each supported [`LayoutId`].
/// Can be toggled on/off per user via [`System::mark_action_set_enabled`](crate::System::mark_action_set_enabled).
pub type ActionSetId = Option<&'static str>;

/// Represented by [`ActionSetId`].
/// This is a collection of [`bindings`](ActionMap) per [`layout`](LayoutId)
/// which are bound to a specific [`action`](crate::action::Action).
#[derive(Debug, Clone)]
pub struct ActionSet(HashMap<LayoutId, ActionMap>);

impl Default for ActionSet {
	fn default() -> Self {
		Self(HashMap::new())
	}
}

impl ActionSet {
	/// Associates a layout with a map of action to device bindings.
	pub fn with(mut self, layout: LayoutId, map: ActionMap) -> Self {
		self.0.insert(layout, map);
		self
	}

	pub(crate) fn get(&self, layout: &LayoutId) -> Option<&ActionMap> {
		self.0.get(layout)
	}
}