Class RayHelper

constructor

• new RayHelper(ray: Ray): RayHelper

  Instantiate a new ray helper. As raycast might be hard to debug, the RayHelper can help rendering the different rays in order to better appreciate the issue one might have.

  Parameters

  • ray: Ray

    Defines the ray we are currently trying to visualize

  Returns RayHelper

  See

  https://doc.babylonjs.com/features/featuresDeepDive/mesh/interactions/picking_collisions#debugging

ray

attachToMesh

• attachToMesh(
      mesh: AbstractMesh,
      meshSpaceDirection?: Vector3,
      meshSpaceOrigin?: Vector3,
      length?: number,
  ): void

  Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.

  Parameters

  • mesh: AbstractMesh

    Defines the mesh we want the helper attached to

  • OptionalmeshSpaceDirection: Vector3

    Defines the direction of the Ray in mesh space (local space of the mesh node)

  • OptionalmeshSpaceOrigin: Vector3

    Defines the origin of the Ray in mesh space (local space of the mesh node)

  • Optionallength: number

    Defines the length of the ray

  Returns void

detachFromMesh

• detachFromMesh(): void

  Detach the ray helper from the mesh it has previously been attached to.

  Returns void

dispose

• dispose(): void

  Dispose the helper and release its associated resources.

  Returns void

hide

• hide(): void

  Hides the ray we are debugging.

  Returns void

show

• show(scene: Scene, color?: Color3): void

  Shows the ray we are willing to debug.

  Parameters

  • scene: Scene

    Defines the scene the ray needs to be rendered in

  • Optionalcolor: Color3

    Defines the color the ray needs to be rendered in

  Returns void

StaticCreateAndShow

• CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper

  Helper function to create a colored helper in a scene in one line.

  Parameters

  • ray: Ray

    Defines the ray we are currently trying to visualize

  • scene: Scene

    Defines the scene the ray is used in

  • color: Color3

    Defines the color we want to see the ray in

  Returns RayHelper

  The newly created ray helper.