Class Viewer

constructor

• new Viewer(canvas: HTMLCanvasElement, logger?: ILogger): UltraViewer.Viewer

• Constructs a new Viewer instance.

  Parameters

  • canvas: HTMLCanvasElement

    The HTML canvas element for rendering.
  • Optionallogger: ILogger

    Optional logger for logging messages.

  Returns UltraViewer.Viewer

Readonlycolors

Readonlyrpc

ReadonlysectionBox

camera

• get camera(): ICamera

• The camera API for controlling camera movements and settings.

  Returns ICamera

decoder

• get decoder(): IDecoder

• Returns IDecoder

inputs

• get inputs(): IInputs

• The input API for handling user input events.

  Returns IInputs

onStateChanged

• get onStateChanged(): ISimpleEvent<ClientState>

• Event that is triggered when the viewer's connection status changes.

  Returns ISimpleEvent<ClientState>

  An event that emits the current ClientStatus.

renderer

• get renderer(): IRenderer

• Returns IRenderer

selection

• get selection(): ViewerSelection

• Returns ViewerSelection

serverUrl

• get serverUrl(): string

• Gets the current URL to which the viewer is connected.

  Returns string

  The URL as a string, or undefined if not connected.

state

• get state(): ClientState

• Gets the current connection status of the viewer.

  Returns ClientState

  The current ClientStatus.

viewport

• get viewport(): IViewport

• The viewport API for managing the rendering viewport.

  Returns IViewport

vims

• get vims(): IReadonlyVimCollection

• Returns IReadonlyVimCollection

clearVims

• clearVims(): void

• Clears all loaded VIMs from the viewer.

  Returns void

connect

• connect(settings?: ConnectionSettings): Promise<boolean>

• Connects to a VIM Ultra server.

  Parameters

  • Optionalsettings: ConnectionSettings

  Returns Promise<boolean>

  A promise that resolves when the connection is established.

disconnect

• disconnect(): void

• Disconnects from the current VIM Ultra server.

  Returns void

dispose

• dispose(): void

• Disposes all resources used by the viewer and disconnects from the server.

  Returns void

loadVim

• loadVim(source: UltraViewer.VimSource): ILoadRequest

• Requests the server to load the given URL or file path.

  Parameters

  • source: UltraViewer.VimSource

    The path or URL to the VIM file.

  Returns ILoadRequest

  A load request object that can be used to wait for the load to complete.

unloadVim

• unloadVim(vim: UltraViewer.Vim): void

• Unloads the given VIM from the viewer.

  Parameters

  • vim: UltraViewer.Vim

    The VIM instance to unload.

  Returns void

StaticcreateWithCanvas

• createWithCanvas(parent: HTMLElement, logger?: ILogger): UltraViewer.Viewer

• Creates a Viewer instance with a new canvas element appended to the given parent element.

  Parameters

  • parent: HTMLElement

    The parent HTML element to which the canvas will be appended.
  • Optionallogger: ILogger

    Optional logger for logging messages.

  Returns UltraViewer.Viewer

  A new instance of the Viewer class.