AutoMovie API
    Preparing search index...

    Interface IAutoMovieMotionCoupling

    How one role of a meeting bears another (#3437): the borne role's contacts on the bearer's regions, each with the share of the borne weight it carries, and the borne mass with its centre, which the bearer's balance takes in.

    interface IAutoMovieMotionCoupling {
        anchor: AutoMovieHumanoidBone;
        bearer: string;
        bearers?: Readonly<
            Record<
                string,
                {
                    anchor: AutoMovieHumanoidBone;
                    position: IAutoMovieVector3;
                    rotation: IAutoMovieQuaternion;
                },
            >,
        >;
        borne: string;
        centre: IAutoMovieVector3;
        contacts: readonly IAutoMovieMotionCoupling.IContact[];
        key: {
            legs: readonly [number, number, number];
            position: IAutoMovieVector3;
            rotation: IAutoMovieQuaternion;
            stance: { depth: number; incline: number };
        };
        mass: number;
    }
    Index

    The bearer's bone the key and the holds are stated in: the bone the borne body's resting region lies on, so the borne body rides that bone.

    bearer: string

    The bearing role's name.

    bearers?: Readonly<
        Record<
            string,
            {
                anchor: AutoMovieHumanoidBone;
                position: IAutoMovieVector3;
                rotation: IAutoMovieQuaternion;
            },
        >,
    >

    Each further bearer's anchor frame in the first bearer's anchor frame at the key pose, by role, with that anchor bone: a borne body walked between two helpers. None when one body bears alone.

    borne: string

    The borne role's name.

    The borne centre of mass in the bearer's anchor frame, metres.

    contacts: readonly IAutoMovieMotionCoupling.IContact[]

    The borne role's contacts on the bearer.

    key: {
        legs: readonly [number, number, number];
        position: IAutoMovieVector3;
        rotation: IAutoMovieQuaternion;
        stance: { depth: number; incline: number };
    }

    The borne body's root frame in the bearer's anchor frame at the coupling's key pose, its legs there and the bearer's stance it was placed on.

    Type Declaration

    • legs: readonly [number, number, number]

      Both legs' hip flexion, knee flexion and hip abduction, degrees: the carry's own, changed least so the bearer's arms reach the holds.

    • position: IAutoMovieVector3

      Metres.

    • rotation: IAutoMovieQuaternion

      Unit quaternion.

    • stance: { depth: number; incline: number }

      The first bearer's stance: its trunk's forward inclination, degrees, shared by the lumbopelvic rhythm, and how far it lowers by bending its knees, a share of a squat's drop in [0, 1]. Upright, both none, changed least so its arms reach the holds.

      • depth: number

        Lowering as a share of the body's squat drop in [0, 1]; zero is the standing alignment.

      • incline: number

        Forward trunk inclination in degrees.

    mass: number

    The borne mass the bearer carries, kilograms.