Struct ClipPlayerPlugin 

pub struct ClipPlayerPlugin {
    pub clip: AnimationClip,
    pub bind_pose: Pose,
    pub speed: f32,
    pub looping: bool,
    pub playhead: f32,
    pub playing: bool,
}

Runtime plugin that samples an AnimationClip each step and writes the resulting Pose into RuntimeResources for super::SkeletonPlugin to consume.

Runs at phase::ANIMATE, which is before the POST_SIM phase where SkeletonPlugin reads the pose.

The plugin starts each frame from a clone of bind_pose, then overlays the clip’s animated channels. Joints not touched by the clip keep their bind values; channels not touched by the clip on an animated joint keep their bind values too. This means a clip can be authored to drive only the channels it cares about and the bind pose supplies everything else.

Example

let bind_pose = /* Pose with joint 1 placed at its bind world transform */;
let clip = AnimationClip { duration: 2.0, tracks: vec![/* ... */] };
let player = ClipPlayerPlugin::new(clip, bind_pose);
let runtime = ViewportRuntime::new()
    .with_plugin(player)
    .with_plugin(skeleton_plugin);

Fields

clip: AnimationClip

Clip whose tracks are sampled and applied each step.

bind_pose: Pose

Per-frame baseline. Cloned each step before the clip is applied.

speed: f32

Playback speed multiplier. 1.0 = real time. Negative values play in reverse.

looping: bool

Whether playback wraps at clip.duration. Non-looping playback clamps the playhead at the endpoints.

playhead: f32

Current play position in seconds.

playing: bool

When false, the playhead does not advance. Manual seeks via playhead still take effect.

Implementations

impl ClipPlayerPlugin

pub fn new(clip: AnimationClip, bind_pose: Pose) -> Self

Create a player that loops clip over bind_pose at real-time speed.

pub fn with_speed(self, speed: f32) -> Self

Set the playback speed multiplier.

pub fn with_looping(self, looping: bool) -> Self

Set whether playback loops at clip.duration.

Trait Implementations

impl RuntimePlugin for ClipPlayerPlugin

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.