Skip to main content

RuntimeStepContext

Struct RuntimeStepContext 

Source
#[non_exhaustive]
pub struct RuntimeStepContext<'a> { pub priority: i32, pub dt: f32, pub scene: &'a Scene, pub writeback: &'a mut TransformWriteback, pub output: &'a mut RuntimeOutput, pub pick_hit: Option<PickHit>, pub resources: &'a mut RuntimeResources, }
Expand description

Context passed to each plugin during its execution step.

Provides read-only scene access and write access to the transform writeback buffer, output accumulator, and shared resource registry. To write transforms, call TransformWriteback::set on self.writeback. To share state between plugins, use self.resources.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§priority: i32

The numeric priority of the plugin executing in this context.

§dt: f32

Delta time for this step. For plugins in the simulate range with a fixed timestep this is the fixed step size, not the wall dt.

§scene: &'a Scene

Read-only scene access. To write transforms, use writeback.

§writeback: &'a mut TransformWriteback

Accumulate transform writes here. The runtime flushes them to the scene after the writeback phase.

§output: &'a mut RuntimeOutput

Accumulate selection changes and contact events here.

§pick_hit: Option<PickHit>

Forwarded from RuntimeFrameContext for plugins that need the current pick result.

§resources: &'a mut RuntimeResources

Shared typed resource registry. Plugins use this to coordinate through engine-owned state without custom wiring in the application.

In submit (called with &RuntimeStepContext), only get and contains are accessible through the shared reference. In step, collect, and on_event (called with &mut RuntimeStepContext), full insert/get_mut/remove access is available.

Implementations§

Source§

impl<'a> RuntimeStepContext<'a>

Source

pub fn as_simulation(&mut self, step_index: u64) -> SimulationStepContext<'_>

Construct a SimulationStepContext from this context.

Pass the step count from super::ViewportRuntime::step_index so the simulation context reflects the current runtime step. The runtime does not thread the step index into RuntimeStepContext automatically – you must supply it.

fn step(&mut self, ctx: &mut RuntimeStepContext) {
    let sim = ctx.as_simulation(runtime.step_index());
    // use sim.step_index for deterministic seeding or replay
}

Note: within a fixed-timestep frame that runs N simulate steps, runtime.step_index() returns the count at the start of that frame. If you need a per-sub-step index (0..N) within a single frame, maintain a local counter in your plugin.

Passing an incorrect value does not cause undefined behavior, but physics code that uses step_index for deterministic seeding or replay will produce wrong results.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for RuntimeStepContext<'a>

§

impl<'a> !Sync for RuntimeStepContext<'a>

§

impl<'a> !UnwindSafe for RuntimeStepContext<'a>

§

impl<'a> Freeze for RuntimeStepContext<'a>

§

impl<'a> Send for RuntimeStepContext<'a>

§

impl<'a> Unpin for RuntimeStepContext<'a>

§

impl<'a> UnsafeUnpin for RuntimeStepContext<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

Source§

type Error = Infallible

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

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

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more