Documentation - v19.12.0-dev
    Preparing search index...

    Interface BoxTreeSnapshot<TIdentifier>

    Immutable, shareable representation of a BoxTree at a point in time.

    interface BoxTreeSnapshot<TIdentifier extends string | number = string | number> {
        buffer: SharedArrayBuffer;
        identifiers: (TIdentifier | null)[];
        layout: {
            header: { ROOT: 0; STRIDE: 1 };
            node: {
                LEFT: 7;
                MAX_X: 3;
                MAX_Y: 4;
                MAX_Z: 5;
                MIN_X: 0;
                MIN_Y: 1;
                MIN_Z: 2;
                OBJID: 9;
                PARENT: 6;
                RIGHT: 8;
                STRIDE: 10;
            };
            notDefined: -1;
        };
        nodeCount: number;
        root: number;
    }

    Type Parameters

    • TIdentifier extends string | number = string | number
    Index

    Properties

    buffer identifiers layout nodeCount root

    Properties

    buffer: SharedArrayBuffer
    identifiers: (TIdentifier | null)[]

    For each leaf, identifiers[nodeIndex] contains its stable object identifier. Leaf nodes store their own nodeIndex in the buffer's OBJECT_ID field. Entries for internal nodes or unused slots are null.

    layout: {
        header: { ROOT: 0; STRIDE: 1 };
        node: {
            LEFT: 7;
            MAX_X: 3;
            MAX_Y: 4;
            MAX_Z: 5;
            MIN_X: 0;
            MIN_Y: 1;
            MIN_Z: 2;
            OBJID: 9;
            PARENT: 6;
            RIGHT: 8;
            STRIDE: 10;
        };
        notDefined: -1;
    }

    Layout needed to decode the packed buffer without importing the viewer runtime.

    nodeCount: number
    root: number

    Settings

    Member Visibility

    On This Page

    Properties