AutoMovie API
    Preparing search index...

    What the arm is read against at one instant (HumanArmFrame.of). The frame is memoised by base-object identity, upper-arm bone and alone flag. Mutating the base or body does not invalidate that cache: producers and consumers must keep the borrowed input geometry and returned arrays stable during reuse. surface, owners, segments and corners have equal lengths and correspond by index.

    interface IFrame {
        body: {
            bone: AutoMovieHumanoidBone;
            corner: number;
            part: number;
            point: IAutoMovieVector3;
        }[];
        bounds: Record<
            "upper"
            | "lower"
            | "hand",
            { centre: IAutoMovieVector3; radius: number },
        >;
        colliders: {
            bone: AutoMovieHumanoidBone;
            owner: "upper" | "lower" | "hand";
            part: number;
            pose: IAutoMovieRigidTransform;
            shapes: readonly IAutoMoviePhysicalShape[];
        }[];
        corners: number[];
        owners: ("upper" | "lower" | "hand")[];
        parent: { position: IAutoMovieVector3; rotation: IAutoMovieQuaternion };
        related: boolean[][];
        resting: ReadonlySet<number>;
        segments: number[];
        shapes: IAutoMovieMotionHumanArmGeometry.IShape[];
        shoulder?: IAutoMovieVector3;
        surface: IAutoMovieVector3[];
        tip: IAutoMovieVector3;
    }
    Index
    body: {
        bone: AutoMovieHumanoidBone;
        corner: number;
        part: number;
        point: IAutoMovieVector3;
    }[]

    World collider corners outside the moving arms, including external bodies.

    Type Declaration

    • bone: AutoMovieHumanoidBone

      Bone carrying the obstacle collider probe.

    • corner: number

      Zero-based probe index within that collider part.

    • part: number

      Zero-based collider-part index in the combined own-body then external-body audit table.

    • point: IAutoMovieVector3

      Obstacle probe position in world metres.

    bounds: Record<
        "upper"
        | "lower"
        | "hand",
        { centre: IAutoMovieVector3; radius: number },
    >

    Broad-phase spheres about each segment's local surface probes.

    colliders: {
        bone: AutoMovieHumanoidBone;
        owner: "upper" | "lower" | "hand";
        part: number;
        pose: IAutoMovieRigidTransform;
        shapes: readonly IAutoMoviePhysicalShape[];
    }[]

    Actual arm colliders in their carrying arm segment's local frame.

    Type Declaration

    corners: number[]

    Each surface probe's corner index within that part.

    owners: ("upper" | "lower" | "hand")[]

    The segment carrying each corresponding surface probe.

    parent: { position: IAutoMovieVector3; rotation: IAutoMovieQuaternion }

    The shoulder parent's unit world rotation and world position, metres.

    Type Declaration

    related: boolean[][]

    Own-body part pairs that share a joint or are the same part.

    resting: ReadonlySet<number>

    The external parts the hand rests on in this frame (the base's rests, by frame part index): their pairs with the hand are its contact, not a collision.

    segments: number[]

    Each surface probe's own-body audit part index.

    Posed obstruction shapes in the world.

    Actual full-FK shoulder position for this same parent/rest frame, when already available; otherwise chain placement computes it.

    Collider probes in the frame of their owning arm segment, metres.

    Mapped MiddleDistal bone origin in hand-local metres; zero when that distal bone is absent. This is a bone origin, not a measured physical fingertip.