Struct SimulationSnapshot 

pub struct SimulationSnapshot {
    pub version: u32,
    pub time: f64,
    pub gravity: [f64; 3],
    pub bodies: Vec<SimBodyState>,
    pub contacts: Vec<PyContactResult>,
    pub sleeping_count: usize,
    pub description: Option<String>,
    pub metadata: HashMap<String, String>,
}

A complete snapshot of simulation state at a particular moment.

Fields

version: u32

Snapshot format version (currently 1).

time: f64

Simulation time when the snapshot was taken.

gravity: [f64; 3]

Gravity vector [gx, gy, gz] at snapshot time.

bodies: Vec<SimBodyState>

State of every live body at snapshot time.

contacts: Vec<PyContactResult>

Contacts active at snapshot time (informational).

sleeping_count: usize

Number of sleeping bodies at snapshot time.

description: Option<String>

Optional human-readable description.

metadata: HashMap<String, String>

Arbitrary key-value metadata.

Implementations

impl SimulationSnapshot

pub const FORMAT_VERSION: u32 = 1

Current snapshot format version.

pub fn empty() -> Self

Create an empty snapshot at time zero.

pub fn body_count(&self) -> usize

Number of active bodies in this snapshot.

pub fn sleeping_count(&self) -> usize

Number of sleeping bodies in this snapshot.

pub fn find_body(&self, handle: u32) -> Option<&SimBodyState>

Find a body by its handle.

pub fn find_by_tag(&self, tag: &str) -> Option<&SimBodyState>

Find a body by its tag.

pub fn total_kinetic_energy_proxy(&self) -> f64

Total kinetic-energy proxy across all non-sleeping bodies.

pub fn to_pretty_json(&self) -> String

Return the snapshot as a pretty-printed JSON string.

pub fn to_json(&self) -> String

Serialize to compact JSON.

pub fn from_json(json: &str) -> Result<Self, Error>

Deserialize from JSON.

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a metadata key-value pair.

pub fn with_description(self, desc: impl Into<String>) -> Self

Set a human-readable description.

pub fn to_msgpack(&self) -> Vec<u8>

Serialize to MessagePack bytes.

pub fn from_msgpack(data: &[u8]) -> Result<Self, Error>

Deserialize from MessagePack bytes.

pub fn static_body_count(&self) -> usize

Count of static bodies.

pub fn dynamic_body_count(&self) -> usize

Count of dynamic (non-static) bodies.

pub fn handles(&self) -> Vec<u32>

All body handles.

pub fn find_by_tag_prefix(&self, prefix: &str) -> Vec<&SimBodyState>

Filter bodies by tag prefix.

impl SimulationSnapshot

pub fn diff( &self, other: &SimulationSnapshot, position_threshold: f64, ) -> SnapshotDiff

Compute the diff between self (snapshot A) and other (snapshot B).

A body is considered “moved” if its position changed by more than position_threshold.

Trait Implementations

impl Clone for SimulationSnapshot

fn clone(&self) -> SimulationSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimulationSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SimulationSnapshot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SimulationSnapshot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.