Class Frustum

Index

Constructors

Accessors

bottom far farBottomLeft farBottomRight farTopLeft farTopRight left near nearBottomLeft nearBottomRight nearTopLeft nearTopRight right top

Methods

isAABBInside isPointInside isSphereInside render setFromNearPlane

Constructors

constructor

new Frustum(): Frustum
Returns Frustum

Accessors

bottom

get bottom(): Plane
get bottom plane

Returns Plane
set bottom(plane: Plane): void
set bottom plane
Parameters
- plane: Plane
Returns void

far

get far(): Plane
get far plane

Returns Plane
set far(plane: Plane): void
set far plane
Parameters
- plane: Plane
Returns void

farBottomLeft

get farBottomLeft(): vec3
get vec3 point of farBottomLeft Corner

Returns vec3
set farBottomLeft(corner: vec3): void
set vec3 point of farBottomLeft Corner
Parameters
- corner: vec3
Returns void

farBottomRight

get farBottomRight(): vec3
get vec3 point of farBottomRight Corner

Returns vec3
set farBottomRight(corner: vec3): void
set vec3 point of farBottomRight Corner
Parameters
- corner: vec3
Returns void

farTopLeft

get farTopLeft(): vec3
get vec3 point of farTopLeft Corner

Returns vec3
set farTopLeft(corner: vec3): void
set vec3 point of farTopLeft Corner
Parameters
- corner: vec3
Returns void

farTopRight

get farTopRight(): vec3
get vec3 point of farTopRight Corner

Returns vec3
set farTopRight(corner: vec3): void
set vec3 point of farTopRight Corner
Parameters
- corner: vec3
Returns void

left

get left(): Plane
get left plane

Returns Plane
set left(plane: Plane): void
set left plane
Parameters
- plane: Plane
Returns void

near

get near(): Plane
get near plane

Returns Plane
set near(plane: Plane): void
set near plane
Parameters
- plane: Plane
Returns void

nearBottomLeft

get nearBottomLeft(): vec3
get vec3 point of nearBottomLeft Corner

Returns vec3
set nearBottomLeft(corner: vec3): void
set vec3 point of nearBottomLeft Corner
Parameters
- corner: vec3
Returns void

nearBottomRight

get nearBottomRight(): vec3
get vec3 point of nearBottomRight Corner

Returns vec3
set nearBottomRight(corner: vec3): void
set vec3 point of nearBottomRight Corner
Parameters
- corner: vec3
Returns void

nearTopLeft

get nearTopLeft(): vec3
get vec3 point of nearTopLeft Corner

Returns vec3
set nearTopLeft(corner: vec3): void
set vec3 point of nearTopLeft Corner
Parameters
- corner: vec3
Returns void

nearTopRight

get nearTopRight(): vec3
get vec3 point of nearTopRight Corner

Returns vec3
set nearTopRight(corner: vec3): void
set vec3 point of nearTopRight Corner
Parameters
- corner: vec3
Returns void

right

get right(): Plane
get right plane

Returns Plane
set right(plane: Plane): void
set right plane
Parameters
- plane: Plane
Returns void

top

get top(): Plane
get top plane

Returns Plane
set top(plane: Plane): void
set top plane
Parameters
- plane: Plane
Returns void

Methods

isAABBInside

isAABBInside(aabbMin: vec3, aabbMax: vec3): boolean
Parameters
- aabbMin: vec3
  minimum extent
- aabbMax: vec3
  maximum extent
Returns boolean
whether or not a box defined by aabbMin and aabbMax is visible in frustum

isPointInside

isPointInside(point: vec3): boolean
Parameters
- point: vec3
  position in world space
Returns boolean
whether or not given vector is visible through frustum

isSphereInside

isSphereInside(position: vec3, radius: number): boolean
Parameters
- position: vec3
  position of sphere
- radius: number
  radius of sphere
Returns boolean
whether or not sphere is visible in frustum

render

render(): void
Debug Rendering

Returns void

setFromNearPlane

setFromNearPlane(
    cameraProvider: WorldCameraFinderProvider,
    cameraFar: number,
    size: vec2,
    transform: Transform,
): void
Parameters
- cameraProvider: WorldCameraFinderProvider
  from WorldCameraFinderProvider
- cameraFar: number
  camera far render distance
- size: vec2
  of near plane
- transform: Transform
  of near plane
Returns void