Selectables

Methods and properties related to gpu picking. Basically “given a rendered pixel what object does that pixel represent”.

Index

Methods

• attach
• detach
• getVisiblesInSight
• idOf
• pick

Methods

attach

• attach(mesh: Mesh | Icon, o?: AttachOption): number

• Attaches custom BabylonJS meshes so they can be “picked”.

  ---

  Parameters

  • mesh: Mesh | Icon

  • optionalo: AttachOption

  Returns number

detach

• detach(mesh: Mesh | Icon): boolean

• Detaches a previously attached BabylonJS mesh from “pick” operations.

  ---

  Parameters

  • mesh: Mesh | Icon

  Returns boolean

getVisiblesInSight

• getVisiblesInSight(o?: GetVisibleInSightOptions): VisibleSelectable[]
• getVisiblesInSight(inSightCamera?: Camera, textureSizePow2?: number, isDistanceCullingEnabled?: boolean): VisibleSelectable[]
• getVisiblesInSight(inSightCamera?: Camera | GetVisibleInSightOptions, textureSizePow2?: number, isDistanceCullingEnabled?: boolean): VisibleSelectable[]

• Renders objects and checks which objects are in sight from given camera.

  ---

  Parameters

  • optionalo: GetVisibleInSightOptions

  Returns VisibleSelectable[]

idOf

• idOf(meshOrIcon: Mesh | Icon): number

• Get unique “pick” id of mesh or icon. It is only valid as long as the item has been registered with attach. It will be 0 if not attached.

  ---

  Parameters

  • meshOrIcon: Mesh | Icon

    mesh or icon to get id for.

  Returns number

  0 if not attached, otherwise unique “pick” id.

pick

• pick(o: PickOption): PickResult
• pick(picker: TargetCamera, textureSizePow2?: number, doIntersectionTestOnGeometry?: boolean, saveRenderedGpuPickingSceneTexture?: boolean): PickResult

• Performs an intersection test in the world (finds objects below a specific screen coordinate or that intersect a ray).

  ---

  Parameters

  • o: PickOption

    Options to use for pick operation.

  Returns PickResult

  Intersection information.