Class BVHHelper

constructor

• new BVHHelper(
      meshOrBvh?: Object3D<Object3DEventMap> | BvhHelperTree | null,
      bvhOrDepth?: number | BvhHelperTree | null,
      depth?: number,
  ): BVHHelper

  Parameters

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

  Returns BVHHelper

bvh

depth

displayEdges

displayParents

ReadonlyedgeMaterial

instanceId

mesh

ReadonlymeshMaterial

color

• get color(): Color

  edgeMaterial.color, shared with meshMaterial.

  Returns Color

opacity

• get opacity(): number

  Both materials' opacity.

  Returns number

• set opacity(value: number): void

  Parameters

  • value: number

  Returns void

clone

• clone(): this

  Returns a clone of this object and optionally all descendants.

  Returns this

copy

• copy(source: this, recursive?: boolean): this

  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

  Remarks

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

dispose

• dispose(): void

  Disposes of the materials and the box geometry.

  Returns void

update

• update(): void

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

  Returns void

updateMatrixWorld

• updateMatrixWorld(force?: boolean): void

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

  Parameters

  • Optionalforce: boolean

  Returns void