Skip to main content

Sim

Struct Sim 

Source
pub struct Sim {
    pub world: World,
    pub step: Duration,
    pub max_steps: u32,
    /* private fields */
}
Expand description

Fixed-step sim state. Game registers systems, feeds wall time with step, reads world for the snapshot.

Fields§

§world: World

Entity/component store. Game crates add their own components here.

§step: Duration

Fixed step size. Default 60 Hz.

Each tick adds this to SimTime. Set before first step.

§max_steps: u32

Max ticks per step call. Default 8.

Caps catch-up after hitches. Excess wall time is dropped. Clamped to a minimum of 1 so the sim keeps moving.

Implementations§

Source§

impl Sim

Source

pub fn new(step: Duration) -> Self

Source

pub fn with_default_step() -> Self

60 Hz fixed-step sim.

Source

pub fn add_system<M>(&mut self, system: impl IntoSystem<(), (), M>) -> &mut Self

Register a system into the per-step schedule.

Source

pub fn add_chained_systems<M>( &mut self, systems: impl IntoScheduleConfigs<ScheduleSystem, M>, ) -> &mut Self

Register systems with a fixed execution order.

Use one (a, b, c).chain() tuple for pipelines that need order.

Source

pub fn step(&mut self, dt: Duration) -> u32

Advance by dt wall time. Returns ticks run.

Small dt banks for later. Large dt runs up to max_steps ticks, then drops leftover whole steps. Example:

ⓘ
let steps = sim.step(frame_dt);
Source

pub fn leftover(&self) -> Duration

Unconsumed time carried to the next frame. Below one step.

Source

pub fn alpha(&self) -> f32

Blend factor accumulator / step, clamped to 0..1. Zero step returns 0.0. For render blending between snapshots: keep the previous snapshot and lerp toward the current one by this alpha (NT motion at 30 Hz sim on 144 Hz display needs it; without it every fast mover judders on 4-5 identical frames then jumps).

Source

pub fn tick(&mut self)

Run the schedule once, advancing sim time by one step. Tick-model games drive this directly instead of step.

Auto Trait Implementations§

§

impl !Freeze for Sim

§

impl !RefUnwindSafe for Sim

§

impl !UnwindSafe for Sim

§

impl Send for Sim

§

impl Sync for Sim

§

impl Unpin for Sim

§

impl UnsafeUnpin for Sim

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.