#[non_exhaustive]pub struct RuntimeOutput {
pub node_transform_ops: Vec<NodeTransformOp>,
pub selection_ops: Vec<SelectionOp>,
pub contact_events: Vec<ContactEvent>,
pub camera_follow_target: Option<Vec3>,
pub camera_commands: Vec<CameraCommand>,
pub events: RuntimeEventBus,
pub skinned_mesh_updates: Vec<SkinnedMeshUpdate>,
pub skinned_pose_updates: Vec<SkinnedPoseUpdate>,
}Expand description
Output produced by one call to super::ViewportRuntime::step.
node_transform_ops have already been applied to the scene and the snapshot
table when this is returned. The other fields are for the app to read and
act on as needed.
Plugin-authored events of any type are collected in events. Use
output.events.read::<T>() or output.events.drain::<T>() to consume them.
Plugin-authored camera changes are in camera_commands; apply them with
output.apply_camera_commands(&mut camera).
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.node_transform_ops: Vec<NodeTransformOp>Transform ops applied to the scene during this step.
selection_ops: Vec<SelectionOp>Selection changes produced by runtime plugins, already applied to the
app-owned Selection.
contact_events: Vec<ContactEvent>Contact events from physics plugins. Empty if no physics plugin is active.
camera_follow_target: Option<Vec3>Suggested camera center computed from the active super::CameraFollow binding.
Some when a CameraFollow::Node target was resolved this step; None
when no follow binding is set or the target node was not found. Apply to
camera.center for orbit-camera follow behavior.
camera_commands: Vec<CameraCommand>Camera commands emitted by plugins this frame. Apply with
Self::apply_camera_commands. Empty when no camera plugin is active.
events: RuntimeEventBusGeneric typed event bus. Plugins emit events via ctx.output.events.emit(MyEvent { .. }).
The app reads them after step() via output.events.read::<MyEvent>() or
output.events.drain::<MyEvent>(). Events are cleared each frame because
RuntimeOutput is constructed fresh on every step call.
skinned_mesh_updates: Vec<SkinnedMeshUpdate>Per-mesh deformation updates from skinning plugins on the CPU path.
Apply after step() by calling write_mesh_positions_normals on each
entry. Empty when no super::plugins::SkeletonPlugin is active on the
CPU path.
skinned_pose_updates: Vec<SkinnedPoseUpdate>Per-instance joint palette updates from skinning plugins on the GPU
path. Apply after step() by calling
crate::ViewportGpuResources::set_skin_palette on each entry. Empty
when no skinning plugin is active on the GPU path.
Implementations§
Source§impl RuntimeOutput
impl RuntimeOutput
Sourcepub fn apply_camera_commands(&self, camera: &mut Camera)
pub fn apply_camera_commands(&self, camera: &mut Camera)
Apply all camera commands in emission order to camera.
Call this after super::ViewportRuntime::step returns, before rendering.
Has no effect if camera_commands is empty.
Commands are applied sequentially: each one builds on the result of the
previous. A BlendToward command blends from whatever state the camera
is in after all prior commands, not from the frame-start state.
Trait Implementations§
Source§impl Default for RuntimeOutput
impl Default for RuntimeOutput
Source§fn default() -> RuntimeOutput
fn default() -> RuntimeOutput
Auto Trait Implementations§
impl !RefUnwindSafe for RuntimeOutput
impl !Sync for RuntimeOutput
impl !UnwindSafe for RuntimeOutput
impl Freeze for RuntimeOutput
impl Send for RuntimeOutput
impl Unpin for RuntimeOutput
impl UnsafeUnpin for RuntimeOutput
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.