@pmndrs/bvh
    Preparing search index...

    Class MeshBVHHelper

    three-mesh-bvh's older name for BVHHelper (it warns there; not here). drei's story uses it.

    Hierarchy (View Summary)

    Index
    • Parameters

      • OptionalmeshOrBvh: Object3D<Object3DEventMap> | BvhHelperTree | null
      • OptionalbvhOrDepth: number | BvhHelperTree | null
      • depth: number = 10

      Returns MeshBVHHelper

    bvh: BvhHelperTree | null
    depth: number
    displayEdges: boolean = true
    displayParents: boolean = false
    edgeMaterial: LineBasicMaterial
    instanceId: number = 0
    mesh: Object3D<Object3DEventMap> | null
    meshMaterial: MeshBasicMaterial
    • get color(): Color

      edgeMaterial.color, shared with meshMaterial.

      Returns Color

    • get opacity(): number

      Both materials' opacity.

      Returns number

    • set opacity(value: number): void

      Parameters

      • value: number

      Returns void

    • Copies the given object into this object.

      Parameters

      • source: this
      • Optionalrecursive: boolean

        If set to true, descendants of the object are copied next to the existing ones. If set to false, descendants are left unchanged. Default is true.

      Returns this

      Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

    • Rebuilds the boxes from the tree as it is now, with the current depth, displayParents and displayEdges.

      Returns void

    • Follows the mesh: its world matrix relative to this helper's parent (and the instance's matrix).

      Parameters

      • Optionalforce: boolean

      Returns void