DirectionalLightFrustumViewer

Class DirectionalLightFrustumViewer

Class used to render a debug view of the frustum for a directional light

see: https://playground.babylonjs.com/#7EFGSG#4
since: 5.0.0

Hierarchy

DirectionalLightFrustumViewer

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new DirectionalLightFrustumViewer(light: DirectionalLight, camera: Camera): DirectionalLightFrustumViewer

- Defined in .temp/docdirectory/doc.d.ts:14886
Creates a new frustum viewer

Parameters
- light: DirectionalLight
  
  directional light to display the frustum for
- camera: Camera
  
  camera used to retrieve the minZ / maxZ values if the shadowMinZ/shadowMaxZ values of the light are not setup
Returns DirectionalLightFrustumViewer

Accessors

showLines

get showLines(): boolean
set showLines(show: boolean): any

- Defined in .temp/docdirectory/doc.d.ts:14879
true to display the edges of the frustum

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:14880
true to display the edges of the frustum

Parameters
- show: boolean
Returns any

showPlanes

get showPlanes(): boolean
set showPlanes(show: boolean): any

- Defined in .temp/docdirectory/doc.d.ts:14885
true to display the planes of the frustum

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:14886
true to display the planes of the frustum

Parameters
- show: boolean
Returns any

transparency

get transparency(): number
set transparency(alpha: number): any

- Defined in .temp/docdirectory/doc.d.ts:14873
Gets or sets the transparency of the frustum planes

Returns number
- Defined in .temp/docdirectory/doc.d.ts:14874
Gets or sets the transparency of the frustum planes

Parameters
- alpha: number
Returns any

Methods

disposeSearch playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:14909
Dispose of the class / remove the frustum view

Returns void

hideSearch playground for hide

hide(): void

- Defined in .temp/docdirectory/doc.d.ts:14900
Hides the frustum

Returns void

showSearch playground for show

show(): void

- Defined in .temp/docdirectory/doc.d.ts:14896
Shows the frustum

Returns void

updateSearch playground for update

update(): void

- Defined in .temp/docdirectory/doc.d.ts:14905
Updates the frustum. Call this method to update the frustum view if the light has changed position/direction

Returns void