Options
All
  • Public
  • Public/Protected
  • All
Menu

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/babylon101/raycasts#debugging

Hierarchy

  • RayHelper

Index

Constructors

constructor

  • 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/babylon101/raycasts#debugging

    Parameters

    • ray: Ray

      Defines the ray we are currently tryin to visualize

    Returns RayHelper

Properties

raySearch playground for ray

Defines the ray we are currently tryin to visualize.

Methods

attachToMeshSearch playground for attachToMesh

  • 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

detachFromMeshSearch playground for detachFromMesh

  • detachFromMesh(): void
  • Detach the ray helper from the mesh it has previously been attached to.

    Returns void

disposeSearch playground for dispose

  • dispose(): void
  • Dispose the helper and release its associated resources.

    Returns void

hideSearch playground for hide

  • hide(): void
  • Hides the ray we are debugging.

    Returns void

showSearch playground for show

  • 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 CreateAndShowSearch playground for CreateAndShow

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

    Parameters

    • ray: Ray

      Defines the ray we are currently tryin 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.

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Static method