import {Ray} from 'math-ds'

public class | source

Ray

A ray.

Constructor Summary

Public Constructor
public	constructor(origin: Vector3, direction: Vector3) Constructs a new ray.

Member Summary

Public Members
public	direction: Vector3 The direction.
public	origin: Vector3 The origin.

Method Summary

Public Methods
public	applyMatrix4(m: Matrix4): Ray Applies the given matrix to this ray.
public	at(t: Number, target: Vector3): Vector3 Computes a point along the ray based on a given scalar t.
public	clone(): Ray Clones this ray.
public	closestPointToPoint(p: Vector3, target: Vector3): Vector3 Finds the closest point along this ray to a given point.
public	copy(r: Ray): Ray Copies the given ray.
public	distanceSquaredToPoint(p: Vector3): Number Calculates the squared distance from this ray to the given point.
public	distanceSquaredToSegment(v0: Vector3, v1: Vector3, pointOnRay: Vector3, pointOnSegment: Vector3): Number Calculates the distance from this ray to a given line segment.
public	distanceToPlane(p: Plane): Number Calculates the distance from this ray to the given plane.
public	distanceToPoint(p: Vector3): Number Calculates the distance from this ray to the given point.
public	equals(r: Ray): Boolean Checks if this ray equals the given one.
public	intersectBox(b: Plane, target: Vector3): Vector3 Finds the point where this ray intersects the given box.
public	intersectPlane(p: Plane, target: Vector3): Vector3 Finds the point where this ray intersects the given plane.
public	intersectSphere(s: Sphere, target: Vector3): Vector3 Finds the point where this ray intersects the given sphere.
public	intersectTriangle(a: Vector3, b: Vector3, c: Vector3, backfaceCulling: Boolean, target: Vector3): Vector3 Finds the point where this ray intersects the given triangle.
public	intersectsBox(b: Box3): Boolean Determines whether this ray intersects the given box.
public	intersectsPlane(p: Plane): Boolean Determines whether this ray intersects the given plane.
public	intersectsSphere(s: Sphere): Boolean Determines whether this ray intersects the given sphere.
public	lookAt(target: Vector3): Ray Rotates this ray to look at the given target.
public	recast(t: Number): Ray Moves the origin along the ray by a given scalar t.
public	set(origin: Vector3, direction: Vector3): Ray Sets the origin and the direction.

Public Constructors

public constructor(origin: Vector3, direction: Vector3) source

Constructs a new ray.

Params:

Name	Type	Attribute	Description
origin	Vector3	optional	The origin.
direction	Vector3	optional	The direction.

Public Members

public direction: Vector3 source

The direction.

public origin: Vector3 source

The origin.

Public Methods

public applyMatrix4(m: Matrix4): Ray source

Applies the given matrix to this ray.

Params:

Name	Type	Attribute	Description
m	Matrix4		A matrix.

Return:

Ray

This ray.

public at(t: Number, target: Vector3): Vector3 source

Computes a point along the ray based on a given scalar t.

Params:

Name	Type	Attribute	Description
t	Number		The scalar.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

The point.

public clone(): Ray source

Clones this ray.

Return:

Ray	The cloned ray.

public closestPointToPoint(p: Vector3, target: Vector3): Vector3 source

Finds the closest point along this ray to a given point.

Params:

Name	Type	Attribute	Description
p	Vector3		A point.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

The point.

public copy(r: Ray): Ray source

Copies the given ray.

Params:

Name	Type	Attribute	Description
r	Ray		A ray.

Return:

Ray

This ray.

public distanceSquaredToPoint(p: Vector3): Number source

Calculates the squared distance from this ray to the given point.

Params:

Name	Type	Attribute	Description
p	Vector3		The point.

Return:

Number

The squared distance.

public distanceSquaredToSegment(v0: Vector3, v1: Vector3, pointOnRay: Vector3, pointOnSegment: Vector3): Number source

Calculates the distance from this ray to a given line segment.

Based on: http://www.geometrictools.com/GTEngine/Include/Mathematics/GteDistRaySegment.h

Params:

Name	Type	Attribute	Description
v0	Vector3		The start of the segment.
v1	Vector3		The end of the segment.
pointOnRay	Vector3	optional	If provided, the point on this Ray that is closest to the segment will be stored in this vector.
pointOnSegment	Vector3	optional	If provided, the point on the line segment that is closest to this ray will be stored in this vector.

Return:

Number

The smallest distance between the ray and the segment defined by v0 and v1.

public distanceToPlane(p: Plane): Number source

Calculates the distance from this ray to the given plane.

Params:

Name	Type	Attribute	Description
p	Plane		The plane.

Return:

Number

The distance, or null if the denominator is zero.

public distanceToPoint(p: Vector3): Number source

Calculates the distance from this ray to the given point.

Params:

Name	Type	Attribute	Description
p	Vector3		The point.

Return:

Number

The distance.

public equals(r: Ray): Boolean source

Checks if this ray equals the given one.

Params:

Name	Type	Attribute	Description
r	Ray		A ray.

Return:

Boolean

Whether the rays are equal.

public intersectBox(b: Plane, target: Vector3): Vector3 source

Finds the point where this ray intersects the given box.

Params:

Name	Type	Attribute	Description
b	Plane		A box.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

The point of intersection, or null if there is none.

public intersectPlane(p: Plane, target: Vector3): Vector3 source

Finds the point where this ray intersects the given plane.

Params:

Name	Type	Attribute	Description
p	Plane		A plane.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

The point of intersection, or null if there is none.

public intersectSphere(s: Sphere, target: Vector3): Vector3 source

Finds the point where this ray intersects the given sphere.

Params:

Name	Type	Attribute	Description
s	Sphere		A sphere.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.

Return:

Vector3

The point of intersection, or null if there is none.

public intersectTriangle(a: Vector3, b: Vector3, c: Vector3, backfaceCulling: Boolean, target: Vector3): Vector3 source

Finds the point where this ray intersects the given triangle.

Based on: http://www.geometrictools.com/GTEngine/Include/Mathematics/GteIntrRay3Triangle3.h

Params:

Name	Type	Attribute	Description
a	Vector3		A triangle vertex.
b	Vector3		A triangle vertex.
c	Vector3		A triangle vertex.
backfaceCulling	Boolean	optional default: false	Whether backface culling should be considered.
target	Vector3	optional	A target vector. If none is provided, a new one will be created.