AutoMovie API
    Preparing search index...

    The attachment props with an optional prepared parent rig.

    interface IProps {
        bone: AutoMovieHumanoidBone;
        child: string;
        duration: number;
        fps?: number;
        jointAxes?: Partial<Record<AutoMovieHumanoidBone, IAutoMovieJointAxes>>;
        offset?: IAutoMovieRigidTransform;
        parentMotion?: IAutoMovieMotion;
        parentSkeleton: IAutoMovieSkeleton;
        parentTransform: IAutoMovieTransform;
        parentTransformAt?: (t: number) => IAutoMovieTransform | null;
        poseResolution?: IAutoMovieSkeletonPoseResolution.IRig;
        restFrames?: Partial<Record<AutoMovieHumanoidBone, IAutoMovieRestFrame>>;
        shotDuration: number;
        start: number;
    }

    Hierarchy (View Summary)

    Index

    The parent bone the child rides.

    child: string

    The coupled child's scene node: the clip's target.

    duration: number

    Length of the coupling in seconds; must be finite and positive.

    fps?: number

    Samples per second of the baked follow; defaults to 30.

    jointAxes?: Partial<Record<AutoMovieHumanoidBone, IAutoMovieJointAxes>>

    Clinical-axis remap for the parent's FK, such as HUMANOID_JOINT_AXES.

    Child frame in the posed bone, with finite metre translation and a unit rotation. Defaults to the identity.

    parentMotion?: IAutoMovieMotion

    The parent's compiled pose motion; absent, the parent holds its rest pose.

    parentSkeleton: IAutoMovieSkeleton

    The parent's rig, for the per-frame FK.

    parentTransform: IAutoMovieTransform

    The parent's staged world placement.

    parentTransformAt?: (t: number) => IAutoMovieTransform | null

    The parent's ridden world frame at shot-local second t, or null before its coupling starts. The staged parentTransform applies when no ridden frame exists. Omit for a parent that holds its staged placement throughout. Called synchronously once per baked key, including both endpoints; neither the callback nor returned frame is retained. Exceptions abort baking.

    Explicit immutable snapshot of this exact parent rig and clinical mappings, kept unchanged throughout the bake. Omission preserves raw full FK.

    restFrames?: Partial<Record<AutoMovieHumanoidBone, IAutoMovieRestFrame>>

    Per-rig clinical rest-frame remap for the parent's FK.

    shotDuration: number

    The shot's length in seconds, which the clip's duration spans.

    start: number

    Shot-local second the coupling begins.