Options
All
  • Public
  • Public/Protected
  • All
Menu

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

  • 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

  • get showLines(): boolean
  • set showLines(show: boolean): void
  • true to display the edges of the frustum

    Returns boolean

  • true to display the edges of the frustum

    Parameters

    • show: boolean

    Returns void

  • get showPlanes(): boolean
  • set showPlanes(show: boolean): void
  • true to display the planes of the frustum

    Returns boolean

  • true to display the planes of the frustum

    Parameters

    • show: boolean

    Returns void

  • get transparency(): number
  • set transparency(alpha: number): void
  • Gets or sets the transparency of the frustum planes

    Returns number

  • Gets or sets the transparency of the frustum planes

    Parameters

    • alpha: number

    Returns void

Methods

  • dispose(): void
  • Dispose of the class / remove the frustum view

    Returns void

  • hide(): void
  • Hides the frustum

    Returns void

  • show(): void
  • Shows the frustum

    Returns void

  • update(): void
  • Updates the frustum. Call this method to update the frustum view if the light has changed position/direction

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme