kite3d/io.github.yuroyami.kite3d.math/Frustum

Frustum

class Frustum(p0: Plane = Plane(), p1: Plane = Plane(), p2: Plane = Plane(), p3: Plane = Plane(), p4: Plane = Plane(), p5: Plane = Plane())

Frustums are used to determine what is inside the camera's field of view. They help speed up the rendering process. Objects which lie outside a camera's frustum can safely be excluded from rendering.

This class is mainly intended for use internally by a renderer.

Frustums are mutable and not thread-safe. Use each instance from one thread only.

The constructor stores the given Plane instances by reference.

There is no intersectsObject or intersectsSprite. Test the object's bounding sphere or box with intersectsSphere or intersectsBox instead.

Parameters

The first plane that encloses the frustum.

The second plane that encloses the frustum.

The third plane that encloses the frustum.

The fourth plane that encloses the frustum.

The fifth plane that encloses the frustum.

The sixth plane that encloses the frustum.

Constructors

Frustum

constructor(p0: Plane = Plane(), p1: Plane = Plane(), p2: Plane = Plane(), p3: Plane = Plane(), p4: Plane = Plane(), p5: Plane = Plane())

Properties

planes

val planes: Array<Plane>

The six planes that enclose the frustum. Change them in place or with set.

Functions

clone

fun clone(): Frustum

Returns a new frustum with copied values from this instance.

containsPoint

fun containsPoint(point: Vector3): Boolean

Returns true if the given point lies within the frustum.

copy

fun copy(frustum: Frustum): Frustum

Copies the values of the given frustum to this instance.

intersectsBox

fun intersectsBox(box: Box3): Boolean

Returns true if the given bounding box is intersecting this frustum.

intersectsSphere

fun intersectsSphere(sphere: Sphere): Boolean

Returns true if the given bounding sphere is intersecting this frustum.

set

fun set(p0: Plane, p1: Plane, p2: Plane, p3: Plane, p4: Plane, p5: Plane): Frustum

Sets the frustum planes by copying the given planes.

setFromProjectionMatrix

fun setFromProjectionMatrix(m: Matrix4, coordinateSystem: CoordinateSystem = CoordinateSystem.WebGL, reversedDepth: Boolean = false): Frustum

Sets the frustum planes from the given projection matrix.