Babylon.js API documentation|

Class RayHelper

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.

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

Hierarchy

RayHelper

Index

Constructors

constructor

Properties

ray

Methods

Constructors

constructor

new RayHelper(ray: Ray): RayHelper

- Defined in .temp/docdirectory/doc.d.ts:15668
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.

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

Parameters
- ray: Ray
  
  Defines the ray we are currently trying to visualize
Returns RayHelper

Properties

ray Search playground for ray

ray: Nullable<Ray>

Defines the ray we are currently trying to visualize.

Methods

attachToMesh Search playground for attachToMesh

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

- Defined in .temp/docdirectory/doc.d.ts:15687
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
- Optional meshSpaceDirection: Vector3
  
  Defines the direction of the Ray in mesh space (local space of the mesh node)
- Optional meshSpaceOrigin: Vector3
  
  Defines the origin of the Ray in mesh space (local space of the mesh node)
- Optional length: number
  
  Defines the length of the ray
Returns void

detachFromMesh Search playground for detachFromMesh

detachFromMesh(): void

- Defined in .temp/docdirectory/doc.d.ts:15691
Detach the ray helper from the mesh it has previously been attached to.

Returns void

dispose Search playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:15696
Dispose the helper and release its associated resources.

Returns void

hide Search playground for hide

hide(): void

- Defined in .temp/docdirectory/doc.d.ts:15678
Hides the ray we are debugging.

Returns void

show Search playground for show

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

- Defined in .temp/docdirectory/doc.d.ts:15674
Shows the ray we are willing to debug.

Parameters
- scene: Scene
  
  Defines the scene the ray needs to be rendered in
- Optional color: Color3
  
  Defines the color the ray needs to be rendered in
Returns void

Static CreateAndShow Search playground for CreateAndShow

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

- Defined in .temp/docdirectory/doc.d.ts:15660
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.