Class RayCast`Abstract`

No description provided.

Index

Constructors

Methods

intersectAABB intersectTriangle models scene

Constructors

constructor

new RayCast(): RayCast

No description provided.

Returns RayCast

Methods

`Static`intersectAABB

intersectAABB(
    rayOrigin: IReadonlyVector3,
    rayDirection: IReadonlyVector3,
    aabb: IReadonlyAxisAlignedBoundingBox,
): number | undefined
Test for intersection between a ray and an AxisAlignedBoundingBox (AABB).
Parameters
- rayOrigin: IReadonlyVector3
  Origin of the ray being cast.
- rayDirection: IReadonlyVector3
  Direction of the ray being cast. Does not need to be normalized.
- aabb: IReadonlyAxisAlignedBoundingBox
  AxisAlignedBoundingBox to cast against.
Returns number | undefined
Intersection point expressed as a scalar of rayDirection, or undefined if no intersection.

`Static`intersectTriangle

intersectTriangle(
    rayOrigin: IReadonlyVector3,
    rayDirection: IReadonlyVector3,
    triangle: Triangle,
): number | undefined
Test for intersection between a ray and a Triangle.
Parameters
- rayOrigin: IReadonlyVector3
  Origin of the ray being cast.
- rayDirection: IReadonlyVector3
  Direction of the ray being cast. Does not need to be normalized.
- triangle: Triangle
  Triangle to cast against.
Returns number | undefined
Intersection point expressed as a scalar of rayDirection, or undefined if no intersection.

`Static`models

models(
    rayOrigin: Vector3,
    rayDirection: Vector3,
    models: ModelNode[],
    mode?: RayCastMode,
): RayCastResult | undefined
Ray cast against a set of ModelNode instances and return the closest result.
Parameters
- rayOrigin: Vector3
  Origin of the ray being cast.
- rayDirection: Vector3
  Direction of the ray being cast. Does not need to be normalized.
- models: ModelNode[]
  Array of models to cast against.
- mode: RayCastMode = RayCastMode.Bounded
  Ray casting mode e.g. whether the cast should be limited by the length of rayDirection. See RayCastMode for details.
Returns RayCastResult | undefined
Information about the ray intersection including target ModelNode, hit position, and hit distance, or undefined if no intersection.

`Static`scene

scene(
    rayOrigin: Vector3,
    rayDirection: Vector3,
    scene: IScene,
    mode?: RayCastMode,
): RayCastResult | undefined
Ray cast against all ModelNode instances in a scene and return the closest result.
Parameters
- rayOrigin: Vector3
  Origin of the ray being cast.
- rayDirection: Vector3
  Direction of the ray being cast. Does not need to be normalized.
- scene: IScene
  Scene to cast against.
- mode: RayCastMode = RayCastMode.Bounded
  Ray casting mode e.g. whether the cast should be limited by the length of rayDirection. See RayCastMode for details.
Returns RayCastResult | undefined
Information about the ray intersection including target ModelNode, hit position, and hit distance, or undefined if no intersection.