AutoMovie API
    Preparing search index...

    Interface IAutoMovieFootfallPattern

    Contact timing and support geometry for arbitrary articulated limbs.

    Chains use actual profile bone identities in proximal-to-distal order. Phase and duty are cycle fractions; stride tables map nonnegative metres-per-second speeds to positive metre lengths. admitPhysicalSupportPattern checks finite coordinates, existing distinct carriers, consecutive chains, at most 64 floor witnesses per limb and strictly increasing nonempty stride samples. Its stepping mode requires at least one limb beyond minimumSupports. Omitted localPoint selects the bone origin; omitted contacts selects the endpoint carrier.

    interface IAutoMovieFootfallPattern {
        id: string;
        limbs: {
            bone: string;
            chain: string[];
            contacts?: string[];
            duty: number;
            floorPoints?: { bone: string; localPoint: IAutoMovieVector3 }[];
            localPoint?: IAutoMovieVector3;
            offset: { forward: number; left: number };
            phase: number;
            reach?: { middle: string; root: string; tip: string };
            stride: { length: number; speed: number }[];
        }[];
        minimumSupports: number;
    }
    Index
    id: string

    Stable description identity.

    limbs: {
        bone: string;
        chain: string[];
        contacts?: string[];
        duty: number;
        floorPoints?: { bone: string; localPoint: IAutoMovieVector3 }[];
        localPoint?: IAutoMovieVector3;
        offset: { forward: number; left: number };
        phase: number;
        reach?: { middle: string; root: string; tip: string };
        stride: { length: number; speed: number }[];
    }[]

    Nonempty unique support limbs.

    Type Declaration

    • bone: string

      Arbitrary bone id of the support endpoint.

    • chain: string[]

      Proximal-to-distal chain, ending at bone.

    • Optionalcontacts?: string[]

      Segment colliders belonging to this support patch; defaults to the endpoint alone.

    • duty: number

      Planted fraction in [0,1]; zero declares no mandatory planted dwell.

    • OptionalfloorPoints?: { bone: string; localPoint: IAutoMovieVector3 }[]

      Actual local surface witnesses which share the floor while planted; omission fits only the lowest convex point.

    • OptionallocalPoint?: IAutoMovieVector3

      Bone-local support endpoint in metres; omission selects the bone origin.

    • offset: { forward: number; left: number }

      Neutral support location in the forward/left plane, metres.

      • forward: number

        Metres along the body's declared forward direction.

      • left: number

        Metres along the body's declared left direction.

    • phase: number

      Relative lift phase in [0,1).

    • Optionalreach?: { middle: string; root: string; tip: string }

      Optional two-link reach witness; distal offset from tip to support stays rigid during root-reach planning.

      • middle: string

        Middle joint.

      • root: string

        First joint.

      • tip: string

        Last joint.

    • stride: { length: number; speed: number }[]

      Increasing speed samples with positive stride lengths.

    minimumSupports: number

    Minimum simultaneous planted supports; zero explicitly permits suspension.