Skip to main content

SimStats

oxiphysics_python::world_api

Struct SimStats

pub struct SimStats {
    pub body_count: usize,
    pub sleeping_count: usize,
    pub awake_count: usize,
    pub contact_count: usize,
    pub simulation_time: f64,
    pub total_kinetic_energy: f64,
    pub max_linear_speed: f64,
    pub max_angular_speed: f64,
}

Expand description

Per-step simulation performance and state statistics.

Retrieved via PyPhysicsWorld::stats() after each step() call.

Fields§

§body_count: usize

Total number of active (non-removed) bodies.

§sleeping_count: usize

Number of bodies currently sleeping.

§awake_count: usize

Number of bodies that are awake (body_count - sleeping_count).

§contact_count: usize

Number of contacts detected in the most recent step.

§simulation_time: f64

Accumulated simulation time (seconds).

§total_kinetic_energy: f64

Total kinetic energy summed over all dynamic bodies (½mv²).

§max_linear_speed: f64

Largest linear speed among all dynamic bodies.

§max_angular_speed: f64

Largest angular speed among all dynamic bodies.

Trait Implementations§

impl Clone for SimStats

fn clone(&self) -> SimStats

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for SimStats

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for SimStats

fn default() -> SimStats

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for SimStats

impl RefUnwindSafe for SimStats

impl Send for SimStats

impl Sync for SimStats

impl Unpin for SimStats

impl UnsafeUnpin for SimStats

impl UnwindSafe for SimStats

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.