AutoMovie API
    Preparing search index...

    Where and why a path is blocked.

    interface IBlock {
        aperture?: string;
        at: IAutoMovieVector3;
        cause: "solid" | "narrow" | "headroom";
        distance: number;
        short?: { has: number; needs: number };
        subject: string;
    }
    Index
    aperture?: string

    The opening the path goes through, for narrow and headroom.

    Where the path first meets the obstacle's footprint, world metres on the floor.

    cause: "solid" | "narrow" | "headroom"

    Why: a solid with no opening on the path, an opening narrower than the body, or one lower than it.

    distance: number

    How far along the path that is, metres from its start.

    short?: { has: number; needs: number }

    The measure that falls short and what it would have to be, metres, for narrow and headroom.

    Type Declaration

    • has: number

      Available geometric clearance in metres.

    • needs: number

      Required geometric clearance in metres.

    subject: string

    The obstacle.