Class Viewer

constructor

• new Viewer(settings?: RecursivePartial<ViewerSettings>): WebglViewer.Viewer

• Parameters

  • Optionalsettings: RecursivePartial<ViewerSettings>

  Returns WebglViewer.Viewer

Readonlyenvironment

gizmos

Readonlyinputs

Readonlymaterials

Readonlyraycaster

Readonlyrenderer

Readonlyselection

Readonlysettings

Readonlyviewport

camera

• get camera(): ICamera

• The interface for manipulating the viewer's camera.

  Returns ICamera

onVimLoaded

• get onVimLoaded(): ISignal

• A signal that is dispatched when a new Vim object is loaded or unloaded.

  Returns ISignal

vimCount

• get vimCount(): number

• The number of Vim objects currently loaded in the viewer.

  Returns number

vims

• get vims(): WebglViewer.Vim[]

• Retrieves an array containing all currently loaded Vim objects.

  Returns WebglViewer.Vim[]

  An array of all Vim objects currently loaded in the viewer.

add

• add(vim: WebglViewer.Vim): void

• Adds a Vim object to the renderer, triggering the appropriate actions and dispatching events upon successful addition.

  Parameters

  • vim: WebglViewer.Vim

    The Vim object to add to the renderer.

  Returns void

  Throws

  If the Vim object is already added or if loading the Vim would exceed maximum geometry memory.

clear

• clear(): void

• Removes all Vim objects from the viewer, clearing the scene.

  Returns void

dispose

• dispose(): void

• Cleans up and releases resources associated with the viewer.

  Returns void

remove

• remove(vim: WebglViewer.Vim): void

• Unloads the given Vim object from the viewer, updating the scene and triggering necessary actions.

  Parameters

  • vim: WebglViewer.Vim

    The Vim object to remove from the viewer.

  Returns void

  Throws

  If attempting to remove a Vim object that is not present in the viewer.