AutoMovie API
    Preparing search index...

    The solve's props: the interface demand with optional readers and projectors an operation prepared once for this same chain.

    Hierarchy (View Summary)

    Index

    Unit world rotation immediately before the mid joint's articulation: resolved mid world rotation times inverse current articulation.

    clamps?: {
        effector: (joint: IAutoMovieJointPose) => IAutoMovieJointPose;
        lower: (joint: IAutoMovieJointPose) => IAutoMovieJointPose;
    }

    Optional reusable ROM projectors. Called synchronously and repeatedly, never retained; must return the same bone in clinical degrees without mutating the argument. Exceptions propagate. Omission constructs both projectors from skeleton.

    Type Declaration

    composeLower?: (
        joint: Pick<IAutoMovieJointPose, AutoMovieClinicalAxis>,
    ) => IAutoMovieQuaternion

    The mid bone's prepared clinical composition on its basis; absent, the solve composes it directly.

    Current effector articulation in clinical degrees, used to choose the nearby twist branch and its clamp.

    effectorBasis: IAutoMovieJointAxes

    Already normalized effector clinical basis used to measure its rotation residual.

    effectorFrame: IAutoMovieRestFrame | undefined

    Effector clinical-to-rig angle frame; undefined leaves its angles rest-relative.

    effectorRest: IAutoMovieQuaternion

    Unit rest rotation from the mid bone to the effector bone, composed before the effector articulation.

    effectorRestInverse?: IAutoMovieQuaternion

    The inverse of effectorRest, already computed; absent, the solve inverts it.

    Current mid-joint articulation in clinical degrees; the solve changes its twist and preserves its other coordinates before clamping.

    Already normalized mid-joint clinical basis; intended for a distal twist such as forearm pronation.

    lowerFrame: IAutoMovieRestFrame | undefined

    Mid-joint clinical-to-rig angle frame; undefined leaves its angles rest-relative.

    The effector's fixed-source readers (prepare); absent, the solve prepares them.

    projectEffector?: (rotation: IAutoMovieQuaternion) => IAutoMovieJointPose

    The effector's clinical projection of a raw rotation; absent, the solve prepares it from the effector's basis and frame.

    projectEffectorWithQuaternion?: (
        rotation: IAutoMovieQuaternion,
    ) => IAutoMoviePrepareJointRotationProjection.IProjection

    The same projection paired with its raw quaternion; absent, the prepared projector's own paired reader is used.

    readArticulated?: () => IAutoMovieQuaternion

    The mid bone's articulated rotation at joint; absent, it is composed from the joint.

    readHeldInverse?: (heldRaw: IAutoMovieQuaternion) => IAutoMovieQuaternion

    The inverse of a held rotation; absent, the solve inverts it.

    readHeldRotation?: () => IAutoMovieQuaternion

    The effector's held world rotation; absent, it is composed from above and the mid bone.

    readUntwisted?: () => IAutoMovieQuaternion

    The mid bone's rotation with its twist removed; absent, it is composed from the joint.

    Requested effector world orientation, unit quaternion in the same world frame as above.

    Skeleton supplying effective ROM when the corresponding precomputed clamp is absent.