Class Ray3

constructor

• new Ray3(origin?: Vector3, direction?: Vector3): Ray3

  Constructor of the Ray3 class

  Parameters

  • origin: Vector3 = ...

    The origin of the ray

  • direction: Vector3 = ...

    The direction of the ray

  Returns Ray3

direction

origin

clone

• clone(): Ray3

  Create a copy of the ray

  Returns Ray3

  Ray3 object containing a copy of the original ray

createLocalRay

• createLocalRay(transform: Node3): Ray3

  Creates a new Ray object in the local space of a given Transform

  Parameters

  • transform: Node3

    The Transform object to create the local ray from

  Returns Ray3

  The ray in the local space of the Transform

intersectsAxisAlignedBoundingBox

• intersectsAxisAlignedBoundingBox(transform: Node3): Vector3 | null

  Checks if the Ray intersects an Axis-Aligned Bounding Box

  Parameters

  • transform: Node3

    The Transform of the Axis-Aligned Bounding Box

  Returns Vector3 | null

  A Vector3 containing the intersection point or null if there is no intersection

intersectsBox

• intersectsBox(box: BoundingBox3): Vector3 | null

  Checks if the Ray intersects a Box Reference: https://www.scratchapixel.com/lessons/3d-basic-rendering/minimal-ray-tracer-rendering-simple-shapes/ray-box-intersection

  Parameters

  • box: BoundingBox3

    The Box to check for intersection

  Returns Vector3 | null

  A Vector3 containing the intersection point or null if there is no intersection

intersectsMesh3

• intersectsMesh3(mesh: Mesh3): Vector3 | null

  Computes a brute force intersection test between a ray and a mesh

  Parameters

  • mesh: Mesh3

    The mesh to test the intersection against

  Returns Vector3 | null

  The intersection point if the ray intersects the mesh, otherwise null

intersectsOrientedBoundingBox

• intersectsOrientedBoundingBox(transform: Node3): Vector3 | null

  Checks if the Ray intersects an Oriented Bounding Box

  Parameters

  • transform: Node3

    The Transform of the Oriented Bounding Box

  Returns Vector3 | null

  A Vector3 containing the intersection point or null if there is no intersection

intersectsOrientedBoundingSphere

• intersectsOrientedBoundingSphere(transform: Node3): Vector3 | null

  Computes the intersection between a ray and an oriented bounding sphere

  Parameters

  • transform: Node3

    The transformation of the bounding sphere

  Returns Vector3 | null

  The intersection point if the ray intersects the bounding sphere, otherwise null

intersectsPlane

• intersectsPlane(plane: Plane3): Vector3 | null

  Checks if the Ray intersects a Plane Reference: https://www.scratchapixel.com/lessons/3d-basic-rendering/minimal-ray-tracer-rendering-simple-shapes/ray-plane-and-ray-disk-intersection

  Parameters

  • plane: Plane3

    The Plane to check for intersection

  Returns Vector3 | null

  A Vector3 containing the intersection point or null if there is no intersection

intersectsSphere

• intersectsSphere(sphere: BoundingSphere): Vector3 | null

  Checks if the Ray intersects a Sphere Reference: https://www.scratchapixel.com/lessons/3d-basic-rendering/minimal-ray-tracer-rendering-simple-shapes/ray-sphere-intersection

  Parameters

  • sphere: BoundingSphere

    The Sphere to check for intersection

  Returns Vector3 | null

  A Vector3 containing the intersection point or null if there is no intersection

intersectsTriangle

• intersectsTriangle(
      vertex0: Vector3,
      vertex1: Vector3,
      vertex2: Vector3,
  ): Vector3 | null

  Implementation of the Möller–Trumbore triangle intersection algorithm https://en.wikipedia.org/wiki/Möller–Trumbore_intersection_algorithm

  Parameters

  • vertex0: Vector3

    Vector3 object representing the first vertex of the triangle

  • vertex1: Vector3

    Vector3 object representing the second vertex of the triangle

  • vertex2: Vector3

    Vector3 object representing the third vertex of the triangle

  Returns Vector3 | null

  The intersection point if the ray intersects the triangle, otherwise null

intersectsTriangles

• intersectsTriangles(
      vertices: number[] | Vector3[],
      indices: number[],
  ): Vector3 | null

  Computes the intersection between a ray and a series of triangles

  Parameters

  • vertices: number[] | Vector3[]

    Array of either Vector3 objects or numbers representing the vertex positions

  • indices: number[]

    Array of indices representing the triangle faces

  Returns Vector3 | null

  The intersection point if the ray intersects the triangles, otherwise null

set

• set(origin: Vector3, direction: Vector3): void

  Sets the origin and direction of the Ray

  Parameters

  • origin: Vector3

    The origin of the Ray

  • direction: Vector3

    The direction of the Ray

  Returns void

setPickRay

• setPickRay(deviceCoords: Vector2, camera: Camera): void

  Sets the Ray based on the device coordinates and camera

  Parameters

  • deviceCoords: Vector2

    A Vector2 containing the device coordinates

  • camera: Camera

    The Camera used to set the Ray

  Returns void