Struct RapierDiagnosticsPlugin 

pub struct RapierDiagnosticsPlugin {
    pub max_history_length: usize,
    pub per_context: bool,
    /* private fields */
}

Plugin registering Bevy Diagnostics measuring the simulation of every Rapier context.

The measurements are taken after each physics update that executed at least one simulation step, from RapierContextSimulation::step_stats (which relies on Rapier’s counters) and from the current state of the contexts. They can be displayed, for example, with Bevy’s LogDiagnosticsPlugin.

The diagnostics at the paths of the associated constants (e.g. Self::STEP_TIME) are sums over all the contexts (counts and timings alike), so they measure the whole physics workload of the app. Enable Self::per_context to also measure each context separately at the paths returned by Self::context_path, registered when a context is first measured.

Only Self::STEP_TIME and the counts are measured by default: the other timings rely on Rapier’s internal profiler and are only registered if the profiler feature is enabled. This plugin enables the PhysicsPipeline::counters of every context.

Fields

max_history_length: usize

The maximum number of measurements kept in the history of each diagnostic.

per_context: bool

Whether each context is also measured separately, at the paths returned by Self::context_path (default: false).

Implementations

impl RapierDiagnosticsPlugin

pub const STEP_TIME: DiagnosticPath

Total wall-clock time spent running the simulation steps of a physics update, in milliseconds.

pub const STEPS: DiagnosticPath

Number of simulation steps (including substeps) executed by a physics update.

pub const COLLISION_DETECTION_TIME: DiagnosticPath

Time spent on collision detection, in milliseconds (requires the profiler feature).

pub const BROAD_PHASE_TIME: DiagnosticPath

Time spent in the broad-phase, in milliseconds (requires the profiler feature).

pub const NARROW_PHASE_TIME: DiagnosticPath

Time spent in the narrow-phase, in milliseconds (requires the profiler feature).

pub const ISLAND_CONSTRUCTION_TIME: DiagnosticPath

Time spent building the simulation islands, in milliseconds (requires the profiler feature).

pub const SOLVER_TIME: DiagnosticPath

Time spent in the constraints solver, in milliseconds (requires the profiler feature).

pub const CCD_TIME: DiagnosticPath

Time spent on Continuous Collision Detection, in milliseconds (requires the profiler feature).

pub const UPDATE_TIME: DiagnosticPath

Time spent updating the rigid-bodies’ positions and velocities, in milliseconds (requires the profiler feature).

pub const CCD_SUBSTEPS: DiagnosticPath

Number of CCD substeps executed by a physics update (zero when the CCD didn’t need to act).

pub const RIGID_BODIES: DiagnosticPath

Number of rigid-bodies.

pub const ACTIVE_BODIES: DiagnosticPath

Number of awake (active) dynamic and kinematic rigid-bodies.

pub const COLLIDERS: DiagnosticPath

Number of colliders.

pub const IMPULSE_JOINTS: DiagnosticPath

Number of impulse joints.

pub const MULTIBODY_JOINTS: DiagnosticPath

Number of multibody joints.

pub const CONTACT_PAIRS: DiagnosticPath

Number of contact pairs tracked by the narrow-phase (touching or not) after the last step.

pub const ACTIVE_CONTACT_PAIRS: DiagnosticPath

Number of contact pairs with at least one active contact.

pub const CONTACT_CONSTRAINTS: DiagnosticPath

Number of contact points (soft-body contacts included) handed to the constraints solver by a physics update.

pub const SOLVER_CONSTRAINTS: DiagnosticPath

Number of contact manifolds and impulse joints handed to the constraints solver by a physics update. The contacts and joints of sleeping bodies aren’t counted.

pub const INTERSECTIONS: DiagnosticPath

Number of intersecting sensor pairs.

pub fn in_schedule(self, schedule: impl ScheduleLabel) -> Self

Measures the diagnostics in the given schedule (default: PostUpdate).

This should be the schedule the physics runs in (see RapierPhysicsPlugin::in_schedule).

pub fn with_per_context_diagnostics(self, per_context: bool) -> Self

Also measures each context separately (see Self::per_context).

pub fn context_path(path: &DiagnosticPath, context: Entity) -> DiagnosticPath

The path of the diagnostic measuring path (one of the associated constants, e.g. Self::STEP_TIME) for the context context only, e.g. rapier/12v0/step_time.

These diagnostics are only measured if Self::per_context is enabled.

Trait Implementations

impl Default for RapierDiagnosticsPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for RapierDiagnosticsPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.