Class: Ray ​

Ray

Constructors ​

• constructor

Properties ​

• origin
• length

Accessors ​

• direction

Methods ​

• clone
• intersectBox
• pointAt
• copy
• setApproxDirection
• setOrigin
• getOrigin
• getPoint
• sqrDistToPoint
• applyMatrix
• pointInTriangle
• intersectTriangle
• intersectSphere
• intersectionSegment

Constructors ​

constructor ​

• new Ray(origin?, dir?)

Build a new ray object

Parameters ​

Defined in ​

src/math/Ray.ts:34

Properties ​

origin ​

• origin: Vector3

Ray starting point

Defined in ​

src/math/Ray.ts:16

length ​

• length: number = Number.MAX_VALUE

length

Defined in ​

src/math/Ray.ts:21

Accessors ​

direction ​

• get direction(): Vector3

Ray direction

Returns ​

Vector3

Defined in ​

src/math/Ray.ts:43

• set direction(dir): void

Parameters ​

Returns ​

void

Defined in ​

src/math/Ray.ts:47

Methods ​

clone ​

▸ clone(): Ray

Clone a new Ray object

Returns ​

Ray

Defined in ​

src/math/Ray.ts:56

intersectBox ​

▸ intersectBox(box, target?): Vector3

Determine whether it intersects a bounding box

Parameters ​

Returns ​

Vector3

whether intersect

Defined in ​

src/math/Ray.ts:69

pointAt ​

▸ pointAt(t, target?): Vector3

Calculate a point on the ray

Parameters ​

Returns ​

Vector3

result

Defined in ​

src/math/Ray.ts:120

copy ​

▸ copy(src): Ray

Sets the ray to be a copy of the original ray

Parameters ​

Returns ​

Ray

New ray object

Defined in ​

src/math/Ray.ts:133

setApproxDirection ​

▸ setApproxDirection(dir): void

Fast to the approximate ray direction

Parameters ​

Returns ​

void

Defined in ​

src/math/Ray.ts:145

setOrigin ​

▸ setOrigin(origin): void

Set ray origin

Parameters ​

Returns ​

void

Defined in ​

src/math/Ray.ts:153

getOrigin ​

▸ getOrigin(): Vector3

Get ray origin

Returns ​

Vector3

Defined in ​

src/math/Ray.ts:160

getPoint ​

▸ getPoint(t): Vector3

Gets the point at the specified position on the ray

Parameters ​

Returns ​

Vector3

Returns a point at the specified location

Defined in ​

src/math/Ray.ts:169

sqrDistToPoint ​

▸ sqrDistToPoint(P): number

Calculate the distance from a point

Parameters ​

Returns ​

number

result

Defined in ​

src/math/Ray.ts:179

applyMatrix ​

▸ applyMatrix(mat4): void

Applied matrix transformation

Parameters ​

Returns ​

void

Defined in ​

src/math/Ray.ts:195

pointInTriangle ​

▸ pointInTriangle(P, A, B, C): boolean

Calculates whether a specified point is inside a triangle

Parameters ​

Returns ​

boolean

whether it is inside a triangle

Defined in ​

src/math/Ray.ts:212

intersectTriangle ​

▸ intersectTriangle(orig, dir, face): Vector3

Determine whether a ray intersects a triangle

Parameters ​

Returns ​

Vector3

point of intersection

Defined in ​

src/math/Ray.ts:257

intersectSphere ​

▸ intersectSphere(o, dir, center, radius): Vector3

Determine whether a ray intersects the sphere

Parameters ​

Returns ​

Vector3

point of intersection

Defined in ​

src/math/Ray.ts:320

intersectionSegment ​

▸ intersectionSegment(sega, segb, threshold): Object

A test of the intersection between a ray and a given line segment within a given tolerance (threshold)

Parameters ​

Returns ​

Object

If there is an intersection, then the distance from the ray origin to the intersection, if there is no intersection, is -1

Defined in ​

src/math/Ray.ts:352