Timer Class

A game timer identified by a TimerId. More...

Declaration

class helios::engine::runtime::timing::Timer { ... }

Public Constructors Index

	Timer (const helios::engine::runtime::timing::types::TimerId timerId)
	Constructs a Timer with the given identifier. More...

Public Member Functions Index

helios::engine::runtime::timing::types::TimerId	timerId () const noexcept
	Returns the timer identifier. More...
void	reset (const TimerState state=TimerState::Undefined) noexcept
	Resets the elapsed time to zero and sets timer state to Undefined. More...
void	restart () noexcept
	Resets timer by resetting its internal counter and setting its state to TimerState::Running. More...
void	cancel () noexcept
	Cancels this timer by setting its state to TimerState::Cancelled. More...
void	setDuration (float duration)
	Sets the duration limit. More...
float	duration () const noexcept
	Returns the duration limit. More...
float	elapsed () const noexcept
	Returns the accumulated elapsed time. More...
TimerState	state () const noexcept
	Returns the current timer state. More...
void	setState (const TimerState state) noexcept
	Sets the timer state. More...
bool	shouldUpdate () const noexcept
	Returns whether this timer should accumulate time. More...
bool	isFinished () const noexcept
	Returns whether this timer's internal state represents the Finished-state. More...
TimerRevision	timerRevision () const noexcept
	Returns the current revision counter. More...
void	update (const float ft)
	Advances the timer by the given frame time. More...

Private Member Attributes Index

TimerRevision	timerRevision_ {}
	Monotonically increasing revision counter, incremented on each update. More...
TimerId	timerId_
	Unique identifier for this timer. More...
float	elapsed_ {}
	Accumulated elapsed time in seconds. More...
TimerState	timerState_ {}
	Current state of the timer. More...
float	duration_ = 0.0f
	Optional duration limit in seconds. More...

Description

A game timer identified by a TimerId.

Tracks elapsed time while in the Running state. Each update increments a revision counter that observers can use to detect changes.

See Also

TimerManager

See Also

TimerBindingComponent

Definition at line 27 of file Timer.ixx.

Public Constructors

Timer()

helios::engine::runtime::timing::Timer::Timer (const helios::engine::runtime::timing::types::TimerId timerId)

inline explicit

Constructs a Timer with the given identifier.

Parameters

timerId

The unique identifier for this timer.

Definition at line 61 of file Timer.ixx.

61 explicit Timer(const helios::engine::runtime::timing::types::TimerId timerId)

62 : timerId_{timerId} {}

Public Member Functions

cancel()

void helios::engine::runtime::timing::Timer::cancel ()

inline noexcept

Cancels this timer by setting its state to TimerState::Cancelled.

See Also

reset

Definition at line 98 of file Timer.ixx.

98 void cancel() noexcept {

99 reset(TimerState::Cancelled);

100 }

Reference reset.

duration()

float helios::engine::runtime::timing::Timer::duration ()

inline noexcept

Returns the duration limit.

Returns

The duration in seconds.

Definition at line 116 of file Timer.ixx.

116 [[nodiscard]] float duration() const noexcept {

117 return duration_;

118 }

Referenced by setDuration.

elapsed()

float helios::engine::runtime::timing::Timer::elapsed ()

inline noexcept

Returns the accumulated elapsed time.

Returns

Elapsed time in seconds.

Definition at line 125 of file Timer.ixx.

125 [[nodiscard]] float elapsed() const noexcept {

126 return elapsed_;

127 }

isFinished()

bool helios::engine::runtime::timing::Timer::isFinished ()

inline noexcept

Returns whether this timer's internal state represents the Finished-state.

Returns

True if the timer is finished.

Definition at line 162 of file Timer.ixx.

162 [[nodiscard]] bool isFinished() const noexcept {

163 return (timerState_ == TimerState::Finished);

164 }

reset()

void helios::engine::runtime::timing::Timer::reset (const TimerState state=TimerState::Undefined)

inline noexcept

Resets the elapsed time to zero and sets timer state to Undefined.

Parameters

state

The new TimerState the timer should be resetted to.

Definition at line 78 of file Timer.ixx.

78 void reset(const TimerState state = TimerState::Undefined) noexcept {

79 elapsed_ = 0.0f;

80 setState(state);

81 }

References setState and state.

Referenced by cancel and restart.

restart()

void helios::engine::runtime::timing::Timer::restart ()

inline noexcept

Resets timer by resetting its internal counter and setting its state to TimerState::Running.

See Also

reset

Definition at line 89 of file Timer.ixx.

89 void restart() noexcept {

90 reset(TimerState::Running);

91 }

Reference reset.

setDuration()

void helios::engine::runtime::timing::Timer::setDuration (float duration)

inline

Sets the duration limit.

Parameters

duration

Duration in seconds.

Definition at line 107 of file Timer.ixx.

107 void setDuration(float duration) {

108 duration_ = duration;

109 }

Reference duration.

setState()

void helios::engine::runtime::timing::Timer::setState (const TimerState state)

inline noexcept

Sets the timer state.

Parameters

state

The new TimerState.

Definition at line 143 of file Timer.ixx.

143 void setState(const TimerState state) noexcept {

144 timerState_ = state;

145 timerRevision_++;

146 }

Reference state.

Referenced by reset.

shouldUpdate()

bool helios::engine::runtime::timing::Timer::shouldUpdate ()

inline noexcept

Returns whether this timer should accumulate time.

Returns

True if the timer is in the Running state.

Definition at line 153 of file Timer.ixx.

153 [[nodiscard]] bool shouldUpdate() const noexcept {

154 return (timerState_ == TimerState::Running);

155 }

Referenced by update.

state()

TimerState helios::engine::runtime::timing::Timer::state ()

inline noexcept

Returns the current timer state.

Returns

The current TimerState.

Definition at line 134 of file Timer.ixx.

134 [[nodiscard]] TimerState state() const noexcept {

135 return timerState_;

136 }

Referenced by reset and setState.

timerId()

helios::engine::runtime::timing::types::TimerId helios::engine::runtime::timing::Timer::timerId ()

inline noexcept

Returns the timer identifier.

Returns

The TimerId assigned to this timer.

Definition at line 69 of file Timer.ixx.

69 [[nodiscard]] helios::engine::runtime::timing::types::TimerId timerId() const noexcept {

70 return timerId_;

71 }

timerRevision()

TimerRevision helios::engine::runtime::timing::Timer::timerRevision ()

inline noexcept

Returns the current revision counter.

Returns

The TimerRevision value.

Definition at line 171 of file Timer.ixx.

171 [[nodiscard]] TimerRevision timerRevision() const noexcept {

172 return timerRevision_;

173 }

update()

void helios::engine::runtime::timing::Timer::update (const float ft)

inline

Advances the timer by the given frame time.

Only accumulates time when the timer is in the Running state. Increments the revision counter on each successful update.

Parameters

ft	Frame time in seconds.

Definition at line 183 of file Timer.ixx.

183 void update(const float ft) {

184 if (!shouldUpdate() || ft == 0.0f) {

185 return;

186 }

187 timerRevision_++;

188 elapsed_ += ft;

189 }

References helios::engine::runtime::registerComponents and shouldUpdate.

Private Member Attributes

duration_

float helios::engine::runtime::timing::Timer::duration_ = 0.0f

Optional duration limit in seconds.

Definition at line 52 of file Timer.ixx.

52 float duration_ = 0.0f;

elapsed_

float helios::engine::runtime::timing::Timer::elapsed_ {}

Accumulated elapsed time in seconds.

Definition at line 42 of file Timer.ixx.

42 float elapsed_{};

timerId_

TimerId helios::engine::runtime::timing::Timer::timerId_

Unique identifier for this timer.

Definition at line 37 of file Timer.ixx.

37 TimerId timerId_;

timerRevision_

TimerRevision helios::engine::runtime::timing::Timer::timerRevision_ {}

Monotonically increasing revision counter, incremented on each update.

Definition at line 32 of file Timer.ixx.

32 TimerRevision timerRevision_{};

timerState_

TimerState helios::engine::runtime::timing::Timer::timerState_ {}

Current state of the timer.

Definition at line 47 of file Timer.ixx.

47 TimerState timerState_{};

---

The documentation for this class was generated from the following file:

• Timer.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.