Struct AnimationPlugin 

pub struct AnimationPlugin { /* private fields */ }

A plugin that drives node transforms from keyframed animation tracks.

Runs in the [RuntimePhase::Animate] phase. Each frame it advances the playhead by dt * speed and writes the interpolated transform for each track via crate::TransformWriteback.

Example

use viewport_lib::{AnimationPlugin, AnimationTrack, Keyframe, ViewportRuntime};

let mut anim = AnimationPlugin::new();
anim.add_track(AnimationTrack {
    node_id: my_node,
    keyframes: vec![
        Keyframe { time: 0.0, transform: start_transform },
        Keyframe { time: 2.0, transform: end_transform },
    ],
    looping: true,
});

let runtime = ViewportRuntime::new().with_plugin(anim);

Implementations

impl AnimationPlugin

pub fn new() -> Self

Create a new AnimationPlugin with no tracks. Starts playing at speed 1.

pub fn add_track(&mut self, track: AnimationTrack)

Add an animation track.

pub fn play(&mut self)

Start or resume playback.

pub fn pause(&mut self)

Pause playback. Transforms remain at the current time.

pub fn reset(&mut self)

Reset the playhead to time zero.

pub fn set_speed(&mut self, speed: f32)

Set playback speed. Negative values play backward.

pub fn time(&self) -> f32

Current playhead position in seconds.

pub fn is_playing(&self) -> bool

True if the plugin is currently advancing the playhead each step.

pub fn duration(&self) -> f32

Duration of the longest track in seconds.

Trait Implementations

impl Default for AnimationPlugin

fn default() -> Self

Returns the “default value” for a type.

impl RuntimePlugin for AnimationPlugin

fn priority(&self) -> i32

Numeric execution priority. Lower values run first. Use the constants in phase as base values and offset within a band if needed.

fn step(&mut self, ctx: &mut RuntimeStepContext<'_>)

Called once per phase execution.

fn type_name(&self) -> &'static str

A stable name for this plugin, used to key per-plugin timing in RuntimeStats. Defaults to the concrete type name; override to disambiguate when several plugins share a type or to give a friendlier label.

fn submit(&mut self, _ctx: &RuntimeStepContext<'_>)

Called once per frame before the step loop, in priority order.

fn collect(&mut self, _ctx: &mut RuntimeStepContext<'_>)

Called once per frame after the step loop, in priority order.

fn on_event(&mut self, _event: &RuntimeEvent, _ctx: &mut RuntimeStepContext<'_>)

Called for each lifecycle event before the step loop.