#[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
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.priority: i32The numeric priority of the plugin executing in this context.
dt: f32Delta 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 SceneRead-only scene access. To write transforms, use writeback.
writeback: &'a mut TransformWritebackAccumulate transform writes here. The runtime flushes them to the scene after the writeback phase.
output: &'a mut RuntimeOutputAccumulate selection changes and contact events here.
pick_hit: Option<PickHit>Forwarded from RuntimeFrameContext for plugins that need the current pick result.
resources: &'a mut RuntimeResourcesShared 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>
impl<'a> RuntimeStepContext<'a>
Sourcepub fn as_simulation(&mut self, step_index: u64) -> SimulationStepContext<'_>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSend for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.