AutoMovie API
    Preparing search index...

    What a digit fit reads.

    interface IInput {
        bones: readonly AutoMovieHumanoidBone[];
        coupling?: number;
        effector: {
            bone: AutoMovieHumanoidBone;
            normal: IAutoMovieVector3;
            point: IAutoMovieVector3;
        };
        jointAxes?: Partial<Record<AutoMovieHumanoidBone, IAutoMovieJointAxes>>;
        normal?: IAutoMovieVector3;
        pose: IAutoMoviePose;
        prepared?: IAutoMoviePoseResolution;
        rate?: number;
        restFrames?: Partial<Record<AutoMovieHumanoidBone, IAutoMovieRestFrame>>;
        rig?: IAutoMovieSkeletonPoseResolution.IRig;
        skeleton: IAutoMovieSkeleton;
        target: IAutoMovieVector3;
        topology?: IAutoMovieSkeletonTopology;
    }
    Index
    bones: readonly AutoMovieHumanoidBone[]

    The digit's joints, proximal to distal: a finger's three, or the thumb's metacarpal, proximal and distal.

    coupling?: number

    Dimensionless distal/middle flexion ratio for the second and third listed bones, a secondary task after point placement. Omission or fewer than three bones disables it; the caller supplies a finite value.

    effector: {
        bone: AutoMovieHumanoidBone;
        normal: IAutoMovieVector3;
        point: IAutoMovieVector3;
    }

    The point brought to the target, in its bone's rest frame relative to the bone's joint, metres, with the outward unit normal there: a region frame of the digit's tip or pad.

    Type Declaration

    • bone: AutoMovieHumanoidBone

      Resolvable bone carrying the tip or pad; normally the last listed digit bone.

    • normal: IAutoMovieVector3

      Outward unit direction in the same bone-rest frame; rotated into world space without normalization.

    • point: IAutoMovieVector3

      Bone-rest-frame offset from its joint, metres. Its length also scales secondary orientation/coupling residuals.

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

    The joint axes the pose is read with, as resolvePose takes them; the skeleton's own when absent.

    The world direction the effector's normal is turned onto, when the contact needs one (a pad laid on a key faces against the key's normal); none when absent.

    The posed body: its root, arm and hand place the digit's base; its own entries for the digit's joints are the fit's start.

    Exact FK workspace borrowed only for this synchronous fit, or a local one when absent. It never enters the result.

    rate?: number

    Desired radial extension rate near full reach, positive finite degrees per metre. Derives a soft-IK band from the chain's smallest full-extension hinge curvature; targets in that band are eased short of full reach, and residual still measures the original target. Other constrained-IK basin changes are not bounded by this value. No softening when absent.

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

    The rest frames the pose's clinical angles are lifted by, as resolvePose takes them; none when absent.

    Explicit immutable snapshot of this exact skeleton, axes and clinical frames. Borrowed only while those dependencies remain unchanged; without it, raw FK retains live admission.

    The rig.

    The target, world metres.

    The rig's topology, when the caller has it.