Type alias VimComponentRef

VimComponentRef: {
    camera: ComponentCamera;
    container: VimComponentContainer;
    contextMenu: ContextMenuRef;
    isolation: Isolation;
    loader: ComponentLoader;
    message: MessageRef;
    settings: SettingsRef;
    viewer: VIM.Viewer;
}

Root-level API of the Vim component.

Type declaration

  • camera: ComponentCamera

    Camera API to interact with the viewer camera at a higher level.

  • container: VimComponentContainer

    HTML structure containing the component.

  • contextMenu: ContextMenuRef

    Context menu API managing the content and behavior of the context menu.

  • isolation: Isolation

    Isolation API managing isolation state in the component.

  • loader: ComponentLoader

    Vim WebGL loader to download VIMs.

  • message: MessageRef

    Message API to interact with the loading box.

  • settings: SettingsRef

    Settings API managing settings applied to the component.

  • viewer: VIM.Viewer

    Vim WebGL viewer around which the WebGL component is built.

Generated using TypeDoc