API Reference › frontend-devTools› Tools › FrustumDecorator

FrustumDecorator Class

Decorates the viewport with a graphical depiction of a Frustum. This is obviously only useful when drawn inside a viewport using a different Frustum. Options for doing so include:

  • Having more than one viewport, and drawing the frustum of one viewport inside the other viewports; and
  • Allowing the user to take a snapshot of the current frustum, then navigate the view to inspect it within the same viewport.

Implements

Methods

Name Description
decorate(context: DecorateContext): void Implement this method to add Decorations into the supplied DecorateContext.  
disable(): void Static Remove the decoration from the specified viewport.  
enable(vp: Viewport, options?: FrustumDecorationOptions): void Static Add the decoration to the specified viewport.  

Properties

Name Type Description
isEnabled Accessor Static ReadOnly boolean    
useCachedDecorations Readonly "true" This will allow the render system to cache and reuse the decorations created by this decorator's decorate() method.  

Defined in

Last Updated: 17 December, 2024