Class BabylonBvhPicker

constructor

• new BabylonBvhPicker(
      source: Scene | readonly AbstractMesh[],
      options: BabylonBvhPickerOptions & { builder: TinyBvhBuilder },
  ): BabylonBvhPicker

  options.builder is required here; create loads one.

  Parameters

  • source: Scene | readonly AbstractMesh[]
  • options: BabylonBvhPickerOptions & { builder: TinyBvhBuilder }

  Returns BabylonBvhPicker

Readonlysource

cpuScene

• get cpuScene(): CpuSceneBvh | null

  The core scene (null for a scene without triangles).

  Returns CpuSceneBvh | null

instanceCount

• get instanceCount(): number

  Instances (meshes and InstancedMeshes) the picker sees.

  Returns number

scene

• get scene(): BvhBabylonScene

  The scene as last read: meshes, instances, and the Babylon objects behind them.

  Returns BvhBabylonScene

Staticcreate

• create(
      source: Scene | readonly AbstractMesh[],
      options?: BabylonBvhPickerOptions,
  ): Promise<BabylonBvhPicker>

  Loads tinybvh (WebAssembly), then builds the picker.

  Parameters

  • source: Scene | readonly AbstractMesh[]
  • options: BabylonBvhPickerOptions = {}

  Returns Promise<BabylonBvhPicker>

pick

• pick(x: number, y: number, options?: BvhPickOptions): PickingInfo

  scene.pick(x, y): the closest triangle under the pixel (x, y) of the scene's canvas, cast from options.camera or the active camera.

  Parameters

  • x: number
  • y: number
  • options: BvhPickOptions = {}

  Returns PickingInfo

pickWithRay

• pickWithRay(ray: Ray, options?: BvhPickOptions): PickingInfo

  The closest triangle along ray, as scene.pickWithRay returns it (a PickingInfo with hit false on a miss). The ray's length limits it.

  Parameters

  • ray: Ray
  • options: BvhPickOptions = {}

  Returns PickingInfo

sourceOf

• sourceOf(instanceIndex: number): BvhBabylonSource | null

  The Babylon object behind instance instanceIndex (a hit's instance).

  Parameters

  • instanceIndex: number

  Returns BvhBabylonSource | null

update

• update(options?: { rebuild?: boolean }): boolean

  Reads the scene again (world matrices, visibility, isPickable, added and removed meshes) and builds trees for geometry it has not seen. rebuild: true rebuilds every tree (after editing vertex data in place). Returns whether any mesh was built.

  Parameters

  • options: { rebuild?: boolean } = {}

  Returns boolean