Class Renderer

Manages how vim objects are added and removed from the THREE.Scene to be rendered

Hierarchy

Renderer

Implements

IRenderer

Index

Constructors

Properties

antialias renderer section textRenderer

Accessors

background estimatedMemory needsUpdate onBoxUpdated onSceneUpdated samples skipAntialias textEnabled

Methods

add clear dispose getBoundingBox notifySceneUpdate remove render updateBox

Constructors

constructor

new Renderer(scene: RenderScene, viewport: Viewport, materials: ViewerMaterials, camera: Camera, settings: Settings): Renderer
Parameters
- scene: RenderScene
- viewport: Viewport
- materials: ViewerMaterials
- camera: Camera
- settings: Settings
Returns Renderer
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:84

Properties

antialias

antialias: boolean = true

Determines whether antialias will be applied to rendering or not.

`Readonly` renderer

renderer: WebGLRenderer

The THREE WebGL renderer.

`Readonly` section

section: RenderingSection

Interface to interact with section box directly without using the gizmo.

`Readonly` textRenderer

textRenderer: CSS2DRenderer

The THREE sample ui renderer

Accessors

background

get background(): Color | Texture
Gets or sets the background color or texture of the scene.

Returns Color | Texture
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:145
set background(color: Color | Texture): void
Parameters
- color: Color | Texture
Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:149

estimatedMemory

get estimatedMemory(): number
Returns an estimate of the memory used by the renderer.

Returns number
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:276

needsUpdate

get needsUpdate(): boolean
Indicates whether the scene needs to be re-rendered. Can only be set to true. Cleared on each render.

Returns boolean
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:63
set needsUpdate(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:67

onBoxUpdated

get onBoxUpdated(): ISignal
Signal dispatched when bounding box is updated.

Returns ISignal
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:164

onSceneUpdated

get onSceneUpdated(): ISignal
Signal dispatched at the end of each frame if the scene was updated, such as visibility changes.

Returns ISignal
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:157

samples

get samples(): number
Determines the target sample count on the rendering target. Higher number increases quality.

Returns number
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:284
set samples(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:288

skipAntialias

get skipAntialias(): boolean
Indicates whether the next render should skip antialiasing. Useful for expensive operations such as the section box. Can only be set to true. Cleared on each render.

Returns boolean
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:76
set skipAntialias(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:80

textEnabled

get textEnabled(): boolean
Determines whether text rendering is enabled or not.

Returns boolean
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:171
set textEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:175

Methods

add

add(target: Object3D<Event> | Scene): boolean
Adds an object to be rendered.
Parameters
- target: Object3D<Event> | Scene
  
  The object or scene to add for rendering.
Returns boolean
Implementation of IRenderer.add
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:240

clear

clear(): void
Clears all objects from rendering.

Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:268

dispose

dispose(): void
Removes all objects from rendering and disposes the WebGL context.

Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:133

getBoundingBox

getBoundingBox(target?: Box3): Box3
Returns the bounding box encompassing all rendered objects.

Returns
The bounding box encompassing all rendered objects.
Parameters
- target: Box3 = ...
  
  Box in which to copy the result. A new instance is created if undefined.
Returns Box3
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:187

notifySceneUpdate

notifySceneUpdate(): void
Notifies that a scene was updated this frame.

Returns void
Implementation of IRenderer.notifySceneUpdate
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:202

remove

remove(target: Object3D<Event> | Scene): void
Removes an object from rendering.
Parameters
- target: Object3D<Event> | Scene
  
  The object or scene to remove from rendering.
Returns void
Implementation of IRenderer.remove
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:260

render

render(): void
Renders what is in the camera's view.

Returns void
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:210

updateBox

updateBox(box: Box3): void
Updates the global rendering bounding box.
Parameters
- box: Box3
  
  The new bounding box.
Returns void
Implementation of IRenderer.updateBox
- Defined in src/vim-webgl-viewer/rendering/renderer.ts:195

Generated using TypeDoc