Animation · function

restPose

Write the rest pose — no translation, identity rotation, unit scale — into an existing pose.

Explained in Animation.

function restPose(jointCount: number, out: Pose): void
import { restPose } from '@driftengine/animation';

Parameters

ParameterTypeDescription
jointCountnumber
outPose

In depth

Separate from createPose so a caller can return a pose to rest without allocating a second one, which is what a state machine does when it re-enters a state.