@babylonjs/core|

Class Frustum

Represents a camera frustum

Index

Constructors

Methods

GetBottomPlaneToRef GetFarPlaneToRef GetLeftPlaneToRef GetNearPlaneToRef GetPlanes GetPlanesToRef GetRightPlaneToRef GetTopPlaneToRef IsPointInFrustum

Constructors

constructor

new Frustum(): Frustum

Returns Frustum

Methods

`Static`GetBottomPlaneToRef

GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void
Gets the bottom frustum plane transformed by the transform matrix
Parameters
- transform: DeepImmutable<Matrix>
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  the resulting frustum plane
Returns void
- Defined in packages/dev/core/src/Maths/math.frustum.ts:98

`Static`GetFarPlaneToRef

GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void
Gets the far frustum plane transformed by the transform matrix
Parameters
- transform: DeepImmutable<Matrix>
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  the resulting frustum plane
Returns void
- Defined in packages/dev/core/src/Maths/math.frustum.ts:42

`Static`GetLeftPlaneToRef

GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void
Gets the left frustum plane transformed by the transform matrix
Parameters
- transform: DeepImmutable<Matrix>
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  the resulting frustum plane
Returns void
- Defined in packages/dev/core/src/Maths/math.frustum.ts:56

`Static`GetNearPlaneToRef

GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void
Gets the near frustum plane transformed by the transform matrix
Parameters
- transform: DeepImmutable<Matrix>
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  the resulting frustum plane
Returns void
- Defined in packages/dev/core/src/Maths/math.frustum.ts:28

`Static`GetPlanes

GetPlanes(transform: DeepImmutable<Matrix>): Plane[]
Gets the planes representing the frustum
Parameters
- transform: DeepImmutable<Matrix>
  matrix to be applied to the returned planes
Returns Plane[]
a new array of 6 Frustum planes computed by the given transformation matrix.
- Defined in packages/dev/core/src/Maths/math.frustum.ts:14

`Static`GetPlanesToRef

GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void
Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
Parameters
- transform: DeepImmutable<Matrix>
  transformation matrix to be applied to the resulting frustum planes
- frustumPlanes: Plane[]
  the resulting frustum planes
Returns void
- Defined in packages/dev/core/src/Maths/math.frustum.ts:112

`Static`GetRightPlaneToRef

GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void
Gets the right frustum plane transformed by the transform matrix
Parameters
- transform: DeepImmutable<Matrix>
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  the resulting frustum plane
Returns void
- Defined in packages/dev/core/src/Maths/math.frustum.ts:70

`Static`GetTopPlaneToRef

GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void
Gets the top frustum plane transformed by the transform matrix
Parameters
- transform: DeepImmutable<Matrix>
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  the resulting frustum plane
Returns void
- Defined in packages/dev/core/src/Maths/math.frustum.ts:84

`Static`IsPointInFrustum

IsPointInFrustum(
point: Vector3,
frustumPlanes: DeepImmutableObject<Plane>[],
): boolean
Tests if a point is located between the frustum planes.
Parameters
- point: Vector3
  defines the point to test
- frustumPlanes: DeepImmutableObject<Plane>[]
  defines the frustum planes to test
Returns boolean
true if the point is located between the frustum planes
- Defined in packages/dev/core/src/Maths/math.frustum.ts:138