1use crate::utils::time::now_ms;
4
5#[derive(Debug, Clone)]
26pub struct Timer {
27 previous_time: f64,
28 current_time: f64,
29 start_time: f64,
30 delta: f64,
31 elapsed: f64,
32 timescale: f64,
33}
34
35impl Default for Timer {
36 fn default() -> Self {
37 Self::new()
38 }
39}
40
41impl Timer {
42 pub fn new() -> Self {
46 Self {
47 previous_time: 0.0,
48 current_time: 0.0,
49 start_time: now_ms(),
50 delta: 0.0,
51 elapsed: 0.0,
52 timescale: 1.0,
53 }
54 }
55
56 pub fn get_delta(&self) -> f64 {
58 self.delta / 1000.0
59 }
60
61 pub fn get_elapsed(&self) -> f64 {
63 self.elapsed / 1000.0
64 }
65
66 pub fn get_timescale(&self) -> f64 {
68 self.timescale
69 }
70
71 pub fn set_timescale(&mut self, timescale: f64) -> &mut Self {
73 self.timescale = timescale;
74 self
75 }
76
77 pub fn reset(&mut self) -> &mut Self {
80 self.current_time = now_ms() - self.start_time;
81 self
82 }
83
84 pub fn update(&mut self) -> &mut Self {
86 self.update_with(None)
87 }
88
89 pub fn update_with(&mut self, timestamp: Option<f64>) -> &mut Self {
96 self.previous_time = self.current_time;
97 self.current_time = timestamp.unwrap_or_else(now_ms) - self.start_time;
98
99 self.delta = (self.current_time - self.previous_time) * self.timescale;
100 self.elapsed += self.delta;
102
103 self
104 }
105}
106
107#[cfg(test)]
108mod tests {
109 use super::*;
110 use crate::testing::pin_time;
111
112 #[test]
113 fn a_pinned_clock_gives_a_zero_delta_forever() {
114 pin_time(Some(0.0));
115 let mut timer = Timer::new();
116 for _ in 0..4 {
117 timer.update();
118 assert_eq!(timer.get_delta(), 0.0);
119 assert_eq!(timer.get_elapsed(), 0.0);
120 }
121 pin_time(None);
122 }
123
124 #[test]
125 fn deltas_accumulate_into_elapsed() {
126 pin_time(Some(1000.0));
127 let mut timer = Timer::new();
128
129 pin_time(Some(1016.0));
130 timer.update();
131 assert!((timer.get_delta() - 0.016).abs() < 1e-12);
132 assert!((timer.get_elapsed() - 0.016).abs() < 1e-12);
133
134 pin_time(Some(1048.0));
135 timer.update();
136 assert!((timer.get_delta() - 0.032).abs() < 1e-12);
137 assert!((timer.get_elapsed() - 0.048).abs() < 1e-12);
138
139 pin_time(None);
140 }
141
142 #[test]
143 fn timescale_scales_the_delta() {
144 pin_time(Some(0.0));
145 let mut timer = Timer::new();
146 timer.set_timescale(0.5);
147
148 pin_time(Some(100.0));
149 timer.update();
150 assert!((timer.get_delta() - 0.05).abs() < 1e-12);
151
152 pin_time(None);
153 }
154
155 #[test]
156 fn reset_drops_the_gap_since_the_last_update() {
157 pin_time(Some(0.0));
158 let mut timer = Timer::new();
159
160 pin_time(Some(10_000.0));
162 timer.reset();
163 pin_time(Some(10_016.0));
164 timer.update();
165 assert!((timer.get_delta() - 0.016).abs() < 1e-12);
166
167 pin_time(None);
168 }
169
170 #[test]
171 fn an_explicit_timestamp_replaces_the_clock() {
172 pin_time(Some(0.0));
173 let mut timer = Timer::new();
174 timer.update_with(Some(500.0));
175 assert!((timer.get_delta() - 0.5).abs() < 1e-12);
176 pin_time(None);
177 }
178}