@pmndrs/bvh
    Preparing search index...

    Interface BvhPrimitiveBoundsTreeOptions

    Options of computeBoundsTree({ type: PointsBVH, ... }) and the constructors: three-mesh-bvh's, mapped where they map.

    interface BvhPrimitiveBoundsTreeOptions {
        indirect?: boolean;
        layout?: BvhPrimitiveLayout;
        maxDepth?: number;
        maxLeafSize?: number;
        maxLeafTris?: number;
        onProgress?: (progress: number) => void;
        range?: unknown;
        setBoundingBox?: boolean;
        strategy?: number;
        targetLeafSize?: number;
        useSharedArrayBuffer?: boolean;
        verbose?: boolean;
    }
    Index
    indirect? layout? maxDepth? maxLeafSize? maxLeafTris? onProgress? range? setBoundingBox? strategy? targetLeafSize? useSharedArrayBuffer? verbose?
    indirect?: boolean

    Accepted and ignored: the geometry's index is never touched (each record carries its entry).

    layout?: BvhPrimitiveLayout

    A tree already built for this geometry (CpuPointsBvh.deserialize(bytes).layout): the build is skipped.

    maxDepth?: number

    Accepted, not honoured: past depth 40 the builder splits at the median, which keeps trees shallow.

    maxLeafSize?: number

    Largest leaf, in primitives: 1 to 8 (10, three-mesh-bvh's default, gives 8). Default 8.

    maxLeafTris?: number

    three-mesh-bvh's deprecated name for maxLeafSize.

    onProgress?: (progress: number) => void

    Called with 0 before the build and 1 after it.

    range?: unknown

    Not supported: the tree holds every entry, and raycasts follow the draw range. Throws when set.

    setBoundingBox?: boolean

    Sets geometry.boundingBox from the tree when the geometry has none. Default true.

    strategy?: number

    Accepted for three-mesh-bvh code (0, 1, 2); every value builds the same tree, a centre split (three-mesh-bvh's default CENTER). Other values throw.

    targetLeafSize?: number

    three-mesh-bvh 0.9's name for maxLeafSize; wins over the other two.

    useSharedArrayBuffer?: boolean

    Accepted and ignored.

    verbose?: boolean

    Accepted and ignored.

    Settings
    Member Visibility

    On This Page
    Properties