Class Viewer

Viewer and loader for vim files.

Hierarchy

  • Viewer

Constructors

constructor

Properties

gizmos inputs materials raycaster renderer selection settings viewport

Accessors

camera environment onVimLoaded vimCount vims

Methods

add clear dispose remove

Constructors

constructor

Properties

gizmos

gizmos: Gizmos

The collection of gizmos available for visualization and interaction within the viewer.

Readonly inputs

inputs: Input

The interface for manipulating default viewer inputs.

Readonly materials

materials: ViewerMaterials

The materials used by the viewer to render the vims.

Readonly raycaster

raycaster: Raycaster

The interface for performing raycasting into the scene to find objects.

Readonly renderer

renderer: Renderer

The renderer used by the viewer for rendering scenes.

Readonly selection

selection: Selection

The interface for managing viewer selection.

Readonly settings

settings: Settings

The settings configuration used by the viewer.

Readonly viewport

viewport: Viewport

The interface for managing the HTML canvas viewport.

Accessors

camera

environment

onVimLoaded

vimCount

vims

  • get vims(): Vim[]

  • Retrieves an array containing all currently loaded Vim objects.

    Returns

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

    Returns Vim[]

Methods

add

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

    Throws

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

    Parameters

    • vim: Vim

      The Vim object to add to the renderer.

    Returns void

clear

dispose

remove

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

    Throws

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

    Parameters

    • vim: Vim

      The Vim object to remove from the viewer.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc