Atlas Engine
API Referencebezel

SweepResult

Movement sweep contacts, nearest contact, and resulting end position.

Module: bezel

Movement sweep contacts, nearest contact, and resulting end position.

Declaration

export type SweepResult = {
        /**
         * The collection of hits.
         */
        hits: SweepHit[];
        /**
         * The closest, or `null` when unavailable.
         */
        closest: SweepHit | null;
        /**
         * Whether the query found at least one contact.
         */
        hitAny: boolean;
        /**
         * The end position.
         */
        endPosition: Position3d;
    };

Properties

hits

The collection of hits.

hits: SweepHit[];

closest

The closest, or null when unavailable.

closest: SweepHit | null;

hitAny

Whether the query found at least one contact.

hitAny: boolean;

endPosition

The end position.

endPosition: Position3d;

On this page