Babylon.js API documentation|

Class Frustum

Represents a camera frustum

Hierarchy

Frustum

Index

Constructors

constructor

Methods

Constructors

constructor

new Frustum(): Frustum

Returns Frustum

Methods

Static GetBottomPlaneToRef Search playground for GetBottomPlaneToRef

GetBottomPlaneToRef(transform: DeepImmutableObject<Matrix>, frustumPlane: Plane): void

- Defined in .temp/docdirectory/doc.d.ts:59152
Gets the bottom frustum plane transformed by the transform matrix

Parameters
- transform: DeepImmutableObject<Matrix>
  
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  
  the resulting frustum plane
Returns void

Static GetFarPlaneToRef Search playground for GetFarPlaneToRef

GetFarPlaneToRef(transform: DeepImmutableObject<Matrix>, frustumPlane: Plane): void

- Defined in .temp/docdirectory/doc.d.ts:59128
Gets the far frustum plane transformed by the transform matrix

Parameters
- transform: DeepImmutableObject<Matrix>
  
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  
  the resulting frustum plane
Returns void

Static GetLeftPlaneToRef Search playground for GetLeftPlaneToRef

GetLeftPlaneToRef(transform: DeepImmutableObject<Matrix>, frustumPlane: Plane): void

- Defined in .temp/docdirectory/doc.d.ts:59134
Gets the left frustum plane transformed by the transform matrix

Parameters
- transform: DeepImmutableObject<Matrix>
  
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  
  the resulting frustum plane
Returns void

Static GetNearPlaneToRef Search playground for GetNearPlaneToRef

GetNearPlaneToRef(transform: DeepImmutableObject<Matrix>, frustumPlane: Plane): void

- Defined in .temp/docdirectory/doc.d.ts:59122
Gets the near frustum plane transformed by the transform matrix

Parameters
- transform: DeepImmutableObject<Matrix>
  
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  
  the resulting frustum plane
Returns void

Static GetPlanes Search playground for GetPlanes

GetPlanes(transform: DeepImmutableObject<Matrix>): Plane[]

- Defined in .temp/docdirectory/doc.d.ts:59116
Gets the planes representing the frustum

Parameters
- transform: DeepImmutableObject<Matrix>
  
  matrix to be applied to the returned planes
Returns Plane[]
a new array of 6 Frustum planes computed by the given transformation matrix.

Static GetPlanesToRef Search playground for GetPlanesToRef

GetPlanesToRef(transform: DeepImmutableObject<Matrix>, frustumPlanes: Plane[]): void

- Defined in .temp/docdirectory/doc.d.ts:59158
Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.

Parameters
- transform: DeepImmutableObject<Matrix>
  
  transformation matrix to be applied to the resulting frustum planes
- frustumPlanes: Plane[]
  
  the resulting frustum planes
Returns void

Static GetRightPlaneToRef Search playground for GetRightPlaneToRef

GetRightPlaneToRef(transform: DeepImmutableObject<Matrix>, frustumPlane: Plane): void

- Defined in .temp/docdirectory/doc.d.ts:59140
Gets the right frustum plane transformed by the transform matrix

Parameters
- transform: DeepImmutableObject<Matrix>
  
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  
  the resulting frustum plane
Returns void

Static GetTopPlaneToRef Search playground for GetTopPlaneToRef

GetTopPlaneToRef(transform: DeepImmutableObject<Matrix>, frustumPlane: Plane): void

- Defined in .temp/docdirectory/doc.d.ts:59146
Gets the top frustum plane transformed by the transform matrix

Parameters
- transform: DeepImmutableObject<Matrix>
  
  transformation matrix to be applied to the resulting frustum plane
- frustumPlane: Plane
  
  the resulting frustum plane
Returns void

Static IsPointInFrustum Search playground for IsPointInFrustum

IsPointInFrustum(point: Vector3, frustumPlanes: DeepImmutableObject<Plane>[]): boolean

- Defined in .temp/docdirectory/doc.d.ts:59165
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