AutoMovie API
    Preparing search index...

    One span in which a prop is held in a hand or worn on a bone.

    interface IGrip {
        bone?: AutoMovieHumanoidBone;
        capture?: ICapture;
        from: number;
        inHand?: (
            share: number,
        ) => { position: IAutoMovieVector3; rotation: IAutoMovieQuaternion };
        mount?: { point: string; prop: string };
        offset?: IAutoMovieRigidTransform;
        side: "left" | "right";
        subject: string;
        to: number;
    }
    Index

    The bone it is worn on; held in the hand when absent.

    capture?: ICapture

    The exact launch this staged grip captures when it starts.

    from: number

    The span's first film second.

    inHand?: (
        share: number,
    ) => { position: IAutoMovieVector3; rotation: IAutoMovieQuaternion }

    The grip window's in-hand motion of the prop, composed on offset by the span's share (IAutoMovieMotionHumanContactWindow.inHand); none when the prop keeps its offset.

    Type Declaration

      • (share: number): { position: IAutoMovieVector3; rotation: IAutoMovieQuaternion }
      • A grip's in-hand motion of the held object (#3447): a rigid displacement in the hand's frame at a share of this window from 0 to 1, metres, the identity at 0. The performance composes it before the offset it stored at closure (position R_d p + t_d, rotation R_d R), so a pen turned into a writing grip or a coin rolled across the fingers moves in the hand while the hand holds it. It must be a pure function of the share. Absent, the object keeps the offset it had at closure.

        Parameters

        • share: number

          The share of the window, in [0, 1].

        Returns { position: IAutoMovieVector3; rotation: IAutoMovieQuaternion }

        The object's displacement in the hand's frame.

        • position: IAutoMovieVector3

          Prop displacement in the holding hand's frame, metres; zero at share 0.

        • rotation: IAutoMovieQuaternion

          Prop rotation in the holding hand's frame, unit quaternion; identity at share 0.

    mount?: { point: string; prop: string }

    The other prop's socket it rides (IAutoMovieMotionHumanActionPlan.mounts); held in the hand or worn when absent.

    Type Declaration

    • point: string

      Socket affordance id on the other prop used by the mount.

    • prop: string

      Scene subject id of the OTHER prop whose socket this grip rides.

    The prop's frame in the hand's or the bone's frame, kept from the span's start.

    side: "left" | "right"

    The holding hand; for a worn span, the side of nothing and unread.

    subject: string

    The person who holds or wears it.

    to: number

    The span's last film second.