Class: Frustum

Constructor

new Frustum(options)

Parameters:

Name	Type	Description
`options`	*

Source: camera/Frustum.ts, line 37

Methods

containsBox(box) → {boolean}

Returns true if the box intersects or is inside the frustum.

Parameters:

Name	Type	Description
`box`	Box	Bounding box.

Source: camera/Frustum.ts, line 544

Returns:

true when the box is not fully outside.

Type:: boolean

containsPoint(point) → {boolean}

Returns true if the point is inside the frustum.

Parameters:

Name	Type	Description
`point`	Vec3	Cartesian point.

Source: camera/Frustum.ts, line 466

Returns:

true when the point is inside.

Type:: boolean

containsSphere(sphere) → {boolean}

Returns true if the sphere is inside the frustum.

Parameters:

Name	Type	Description
`sphere`	Sphere	Bounding sphere.

Source: camera/Frustum.ts, line 510

Returns:

true when the sphere is inside.

Type:: boolean

containsSphere2(center, radius) → {boolean}

Returns true if the sphere is inside the frustum.

Parameters:

Name	Type	Description
`center`	Vec3	Sphere center.
`radius`	number	Sphere radius.

Source: camera/Frustum.ts, line 527

Returns:

true when the sphere is inside.

Type:: boolean

containsSphereBottomExc(sphere) → {boolean}

Returns true if the sphere is inside the frustum, ignoring the bottom plane.

Parameters:

Name	Type	Description
`sphere`	Sphere	Bounding sphere.

Source: camera/Frustum.ts, line 482

Returns:

true when the sphere passes all checked planes.

Type:: boolean

containsSphereButtom(sphere) → {boolean}

Checks sphere intersection with the bottom frustum plane only.

Parameters:

Name	Type	Description
`sphere`	Sphere	Bounding sphere.

Source: camera/Frustum.ts, line 498

Returns:

true when the sphere is not clipped by the bottom plane.

Type:: boolean

getBackwardPlane() → {NumberArray4}

Returns backward clipping plane.

Source: camera/Frustum.ts, line 218

Returns:

Backward clipping plane coefficients.

Type:: NumberArray4

getBottomPlane() → {NumberArray4}

Returns bottom clipping plane.

Source: camera/Frustum.ts, line 200

Returns:

Bottom clipping plane coefficients.

Type:: NumberArray4

getForwardPlane() → {NumberArray4}

Returns forward clipping plane.

Source: camera/Frustum.ts, line 227

Returns:

Forward clipping plane coefficients.

Type:: NumberArray4

getInverseProjectionMatrix() → {NumberArray16}

Returns inverse projection matrix.

Source: camera/Frustum.ts, line 263

Returns:

Inverse projection matrix values.

Type:: NumberArray16

getLeftPlane() → {NumberArray4}

Returns left clipping plane.

Source: camera/Frustum.ts, line 191

Returns:

Left clipping plane coefficients.

Type:: NumberArray4

getProjectionMatrix() → {NumberArray16}

Returns projection matrix.

Source: camera/Frustum.ts, line 254

Returns:

Projection matrix values.

Type:: NumberArray16

getProjectionViewMatrix() → {NumberArray16}

Returns projection-view matrix.

Source: camera/Frustum.ts, line 236

Returns:

Projection-view matrix values.

Type:: NumberArray16

getProjectionViewRTEMatrix() → {NumberArray16}

Returns projection-view RTE matrix.

Source: camera/Frustum.ts, line 245

Returns:

Projection-view RTE matrix values.

Type:: NumberArray16

getRightPlane() → {NumberArray4}

Returns right clipping plane.

Source: camera/Frustum.ts, line 182

Returns:

Right clipping plane coefficients.

Type:: NumberArray4

getTopPlane() → {NumberArray4}

Returns top clipping plane.

Source: camera/Frustum.ts, line 209

Returns:

Top clipping plane coefficients.

Type:: NumberArray4

setNearFar(near, faropt)

Updates near and far clipping planes.

Parameters:

Name	Type	Attributes	Default	Description
`near`	number			Near clipping plane distance.
`far`	number	<optional>	this.far	Far clipping plane distance.

Source: camera/Frustum.ts, line 362

setOrthoBounds(left, right, bottom, top)

Updates orthographic projection bounds and rebuilds projection matrices. Keeps the current near and far clipping planes unchanged.

Parameters:

Name	Type	Description
`left`	number	Left orthographic bound.
`right`	number	Right orthographic bound.
`bottom`	number	Bottom orthographic bound.
`top`	number	Top orthographic bound.

Source: camera/Frustum.ts, line 327

setOrthoProjection(left, right, bottom, top, near, far)

Updates orthographic projection bounds and clipping planes in one projection rebuild.

Parameters:

Name	Type	Description
`left`	number	Left orthographic bound.
`right`	number	Right orthographic bound.
`bottom`	number	Bottom orthographic bound.
`top`	number	Top orthographic bound.
`near`	number	Near clipping plane distance.
`far`	number	Far clipping plane distance.

Source: camera/Frustum.ts, line 340

setProjectionMatrix(viewAngle, aspect, near, far, isOrthographicopt, focusDistanceopt, reverseDepthopt, depthZeroToOneopt)

Sets up camera projection matrix.

Parameters:

Name	Type	Attributes	Default	Description
`viewAngle`	number			Camera vertical field of view angle in degrees.
`aspect`	number			Viewport aspect ratio (`width / height`).
`near`	number			Near clipping plane distance.
`far`	number			Far clipping plane distance.
`isOrthographic`	boolean	<optional>	false	Enables orthographic projection mode.
`focusDistance`	number	<optional>	10	Reference distance used to compute orthographic frustum size.
`reverseDepth`	boolean	<optional>	false	Enables reverse-Z infinite perspective projection.
`depthZeroToOne`	boolean	<optional>	false	Uses `[0, 1]` NDC depth range for reverse-Z projection.

Source: camera/Frustum.ts, line 272

setProjectionViewRTEMatrix(viewRTEMatrix)

Updates projection-view RTE matrix.

Parameters:

Name	Type	Description
`viewRTEMatrix`	Mat4	View matrix in RTE coordinates.

Source: camera/Frustum.ts, line 403

setViewMatrix(viewMatrix)

Camera's projection matrix values.

Parameters:

Name	Type	Description
`viewMatrix`	Mat4	View matrix.

Source: camera/Frustum.ts, line 412