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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
//! Scrub sources: externally-driven values sampled once per frame.
//!
//! Trait objects are appropriate here because the set of scrub source
//! implementations is open (host-supplied; it cannot be enumerated at
//! compile time). Contrast with [`crate::motion::Easing`], which is a closed
//! enum with no trait object.
use BTreeMap;
/// A value source the frame evaluator queries each frame. Implementations
/// include pointer position, scroll offset, and audio-clock timestamps.
///
/// # Examples
///
/// ```
/// use drishti::motion::ScrubSource;
///
/// #[derive(Debug)]
/// struct Pointer(f32);
///
/// impl ScrubSource for Pointer {
/// fn value(&self) -> f32 {
/// self.0
/// }
/// }
///
/// assert_eq!(Pointer(0.25).value(), 0.25);
/// ```
/// Map from scrub source id to its source.
///
/// # Examples
///
/// ```
/// use drishti::motion::{ConstantScrub, HashScrubMap, ScrubSource, ScrubSourceMap};
///
/// let mut map = HashScrubMap::new();
/// map.insert(String::from("pointer"), Box::new(ConstantScrub::new(0.5)));
/// let hit = map.get("pointer").map(|source| source.value());
/// assert_eq!(hit, Some(0.5));
/// assert!(map.get("scroll").is_none());
/// ```
/// Empty map used in unit tests: every lookup misses.
///
/// The struct is `non_exhaustive`, so external code builds it through
/// [`EmptyScrubMap::new`] rather than the unit value.
///
/// # Examples
///
/// ```
/// use drishti::motion::{EmptyScrubMap, ScrubSourceMap};
///
/// let map = EmptyScrubMap::new();
/// assert!(map.get("anything").is_none());
/// ```
;
/// Constant scrub source: returns the same value every frame.
///
/// # Examples
///
/// ```
/// use drishti::motion::{ConstantScrub, ScrubSource};
///
/// let source = ConstantScrub::new(0.75);
/// assert_eq!(source.value(), 0.75);
/// assert_eq!(source.value(), 0.75);
/// ```
;
/// Map-backed scrub sources for tests and conformance fixtures.
///
/// Named for the kernel type; the backing map is ordered so multi-source
/// lookups iterate deterministically.
///
/// # Examples
///
/// ```
/// use drishti::motion::{ConstantScrub, HashScrubMap, ScrubSource, ScrubSourceMap};
///
/// let mut map = HashScrubMap::new();
/// map.insert(String::from("scroll"), Box::new(ConstantScrub::new(0.2)));
/// assert_eq!(map.get("scroll").map(|source| source.value()), Some(0.2));
/// ```