import time
from typing import Tuple
from moderngl_window.timers.base import BaseTimer
[docs]
class Timer(BaseTimer):
"""Timer based on python ``time``."""
[docs]
def __init__(self, **kwargs):
self._start_time = None
self._stop_time = None
self._pause_time = None
self._last_frame = None
self._offset = 0
@property
def is_paused(self) -> bool:
"""bool: The pause state of the timer"""
return self._pause_time is not None
@property
def is_running(self) -> bool:
"""bool: Is the timer currently running?"""
return self._pause_time is None
@property
def time(self) -> float:
"""Get or set the current time.
This can be used to jump around in the timeline.
Returns:
The current time in seconds
"""
if self._start_time is None:
return 0.0
if self.is_paused:
return self._pause_time - self._offset - self._start_time
return time.time() - self._start_time - self._offset
@time.setter
def time(self, value: float):
if value < 0:
value = 0
self._offset += self.time - value
[docs]
def next_frame(self) -> Tuple[float, float]:
"""
Get the time and frametime for the next frame.
This should only be called once per frame.
Returns:
Tuple[float, float]: current time and frametime
"""
current = self.time
delta, self._last_frame = current - self._last_frame, current
return current, delta
[docs]
def start(self):
"""Start the timer by recoding the current ``time.time()``
preparing to report the number of seconds since this timestamp.
"""
if self._start_time is None:
self._start_time = time.time()
self._last_frame = 0.0
else:
self._offset += time.time() - self._pause_time
self._pause_time = None
[docs]
def pause(self):
"""Pause the timer by setting the internal pause time using ``time.time()``"""
self._pause_time = time.time()
[docs]
def toggle_pause(self):
"""Toggle the paused state"""
if self.is_paused:
self.start()
else:
self.pause()
[docs]
def stop(self) -> Tuple[float, float]:
"""
Stop the timer. Should only be called once when stopping the timer.
Returns:
Tuple[float, float]: Current position in the timer, actual running duration
"""
self._stop_time = time.time()
return (
self._stop_time - self._start_time - self._offset,
self._stop_time - self._start_time,
)