UpdateInfo Struct Reference

Information passed to systems on the update callback. More...

#include <Types.hh>

Public Attributes
std::chrono::steady_clock::duration	dt {0}
	Simulation time handled during a single update.
uint64_t	iterations {0}
	Total number of elapsed simulation iterations.
bool	paused {true}
	True if simulation is paused, which means the simulation time is not currently running, but systems are still being updated. It is the responsibilty of a system update appropriately based on the status of paused. For example, a physics systems should not update state when paused is true.
std::chrono::steady_clock::duration	realTime {0}
	Total wall clock time elapsed while simulation is running. This will not increase while paused.
std::chrono::steady_clock::duration	simTime {0}
	Total time elapsed in simulation. This will not increase while paused.

Detailed Description

Information passed to systems on the update callback.

Todo:

(louise) Update descriptions once reset is supported.

Member Data Documentation

dt

std::chrono::steady_clock::duration dt {0}

Simulation time handled during a single update.

iterations

uint64_t iterations {0}

Total number of elapsed simulation iterations.

paused

bool paused {true}

True if simulation is paused, which means the simulation time is not currently running, but systems are still being updated. It is the responsibilty of a system update appropriately based on the status of paused. For example, a physics systems should not update state when paused is true.

realTime

std::chrono::steady_clock::duration realTime {0}

Total wall clock time elapsed while simulation is running. This will not increase while paused.

simTime

std::chrono::steady_clock::duration simTime {0}

Total time elapsed in simulation. This will not increase while paused.

---

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

• include/gz/sim/Types.hh