Skip to main content

RuntimeOutput

Struct RuntimeOutput 

Source
#[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
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.
§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: RuntimeEventBus

Generic 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

Source

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

Source§

fn default() -> RuntimeOutput

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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