PickingInfo

Information about the result of picking within a scene See https://doc.babylonjs.com/babylon101/picking_collisions

Hierarchy

  • PickingInfo

Index

Properties

bu

bu: number

(See getTextureCoordinates) The barycentric U coordinate that is used when calulating the texture coordinates of the collision.

bv

bv: number

(See getTextureCoordinates) The barycentric V coordinate that is used when calulating the texture coordinates of the collision.

distance

distance: number

Distance away where the pick collided

faceId

faceId: number

The id of the face on the mesh that was picked

hit

hit: boolean

If the pick collided with an object

originMesh

originMesh: Nullable<AbstractMesh>

If a mesh was used to do the picking (eg. 6dof controller) this will be populated.

pickedMesh

pickedMesh: Nullable<AbstractMesh>

The mesh corresponding the the pick collision

pickedPoint

pickedPoint: Nullable<Vector3>

The location of pick collision

pickedSprite

pickedSprite: Nullable<Sprite>

If a sprite was picked, this will be the sprite the pick collided with

ray

The ray that was used to perform the picking.

subMeshId

subMeshId: number

Id of the the submesh that was picked

Methods

getNormal

  • getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>
  • Gets the normal correspodning to the face the pick collided with

    Parameters

    • Optional useWorldCoordinates: boolean

      If the resulting normal should be relative to the world (default: false)

    • Optional useVerticesNormals: boolean

      If the vertices normals should be used to calculate the normal instead of the normal map

    Returns Nullable<Vector3>

    The normal correspodning to the face the pick collided with

getTextureCoordinates

  • Gets the texture coordinates of where the pick occured

    Returns Nullable<Vector2>

    the vector containing the coordnates of the texture

Generated using TypeDoc