Class ThreeViewer

constructor

• new ThreeViewer(options): ThreeViewer

• Create a viewer instance for using the webgi viewer SDK.

  Parameters

  • options: ThreeViewerOptions

    ThreeViewerOptions

  Returns ThreeViewer

Readonly assetManager

Readonly debug

enabled

maxFramePerLoop

Readonly plugins

renderEnabled

Readonly renderManager

renderStats

Readonly resizeObserver

Readonly type

uiConfig

Static Readonly ConfigTypeSlug

Static Console

Static Dialog

Static Readonly VERSION

canvas

• get canvas(): HTMLCanvasElement

• Get the HTML Canvas Element where the viewer is rendering

  Returns HTMLCanvasElement

console

• get console(): IConsoleWrapper

• Returns IConsoleWrapper

container

• get container(): HTMLElement

• Get the HTML Element containing the canvas

  Returns HTMLElement

dialog

• get dialog(): IDialogWrapper

• Returns IDialogWrapper

materialManager

• get materialManager(): MaterialManager<"">

• Returns MaterialManager<"">

renderer

• get renderer(): ViewerRenderManager

• The renderer for the viewer that's attached to the canvas. This is wrapper around WebGLRenderer and EffectComposer and manages post-processing passes and rendering logic

  Deprecated

  • use renderManager instead

  Returns ViewerRenderManager

scene

• get scene(): RootScene

• Scene with object hierarchy used for rendering

  Returns RootScene

addPlugin

• addPlugin<T>(plugin, ...args): Promise<T>

• Add a plugin to the viewer.

  Type Parameters

  • T extends IViewerPlugin<ThreeViewer, boolean, T>

  Parameters

  • plugin: T | Class<T>

    The instance of the plugin to add or the class of the plugin to add.

  • Rest ...args: any[]

    Arguments for the constructor of the plugin, in case a class is passed.

  Returns Promise<T>

  • The plugin added.

addPluginSync

• addPluginSync<T>(plugin, ...args): T

• Add a plugin to the viewer(sync).

  Type Parameters

  • T extends IViewerPluginSync<ThreeViewer, T>

  Parameters

  • plugin: T | Class<T>

  • Rest ...args: any[]

  Returns T

addPlugins

• addPlugins(plugins): Promise<void>

• Add multiple plugins to the viewer.

  Parameters

  • plugins: (IViewerPlugin<ThreeViewer, boolean> | Class<IViewerPlugin<ThreeViewer, boolean>>)[]

    List of plugin instances or classes

  Returns Promise<void>

addPluginsSync

• addPluginsSync(plugins): void

• Add multiple plugins to the viewer(sync).

  Parameters

  • plugins: (IViewerPluginSync<ThreeViewer> | Class<IViewerPluginSync<ThreeViewer>>)[]

    List of plugin instances or classes

  Returns void

addSceneObject

• addSceneObject<T>(imported, options?): Promise<T>

• Add an object to the scene model root. If an imported scene model root is passed, it will be loaded with viewer configuration, unless importConfig is false

  Type Parameters

  • T extends Object3D<Event, string> | RootSceneImportResult | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = RootSceneImportResult

  Parameters

  • imported: T

  • Optional options: AddObjectOptions

  Returns Promise<T>

deserializePlugins

• deserializePlugins(plugins, meta?): ThreeViewer

• Deserialize all the plugins and their settings from a preset. Used in fromJSON.

  Parameters

  • plugins: any[]

    The output of serializePlugins.

  • Optional meta: SerializationMetaType

    The meta object.

  Returns ThreeViewer

dispose

• dispose(): void

• Disposes the viewer and frees up all resource and events. Do not use the viewer after calling dispose.

  Note

  • If you want to reuse the viewer, set viewer.enabled to false instead, then set it to true again when required. To dispose all the objects, materials in the scene use viewer.scene.disposeSceneModels() This function is not fully implemented yet. There might be some memory leaks.

  Todo

  • return promise?

  Returns void

doOnce

• doOnce<TRet>(event, func): Promise<TRet>

• Type Parameters

  • TRet

  Parameters

  • event: "update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "addPlugin" | "renderEnabled" | "renderDisabled"

  • func: ((...args) => TRet)

    • • (...args): TRet

      • Parameters

        • Rest ...args: any[]

        Returns TRet

  Returns Promise<TRet>

export

• export(obj?, options?): Promise<undefined | BlobExt>

• Exports an object/mesh/material/texture/render-target/plugin-preset/viewer to a blob. If no object is given, a glb is exported with the current viewer state.

  Parameters

  • Optional obj: ITexture | ThreeViewer | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | IRenderTarget | IViewerPlugin<ThreeViewer, boolean>

  • Optional options: ExportFileOptions

  Returns Promise<undefined | BlobExt>

exportConfig

• exportConfig(binary?, pluginFilter?): ISerializedViewerConfig

• Serialize all the viewer and plugin settings.

  Parameters

  • binary: boolean = false

    Indicate that the output will be converted and saved as binary data. (default: false)

  • Optional pluginFilter: string[]

    List of PluginType to include. If empty, no plugins will be serialized. If undefined, all plugins will be serialized.

  Returns ISerializedViewerConfig

exportPluginConfig

• exportPluginConfig(plugin?): ISerializedConfig | Record<string, never>

• Serialize a single plugin settings.

  Parameters

  • Optional plugin: string | IViewerPlugin<ThreeViewer, boolean> | Class<IViewerPlugin<ThreeViewer, boolean>>

  Returns ISerializedConfig | Record<string, never>

exportPluginsConfig

• exportPluginsConfig(filter?): ISerializedViewerConfig

• Serialize multiple plugin settings.

  Parameters

  • Optional filter: string[]

    List of PluginType to include. If empty, no plugins will be serialized. If undefined, all plugins will be serialized.

  Returns ISerializedViewerConfig

exportScene

• exportScene(options?): Promise<undefined | BlobExt>

• Export the scene to a file (default: glb with viewer config) and return a blob

  Parameters

  • Optional options: ExportFileOptions

  Returns Promise<undefined | BlobExt>

fitToView

• fitToView(selected?, distanceMultiplier?, duration?, ease?): Promise<void>

• Parameters

  • Optional selected: Object3D<Event, string>

  • distanceMultiplier: number = 1.5

  • Optional duration: number

  • Optional ease: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

  Returns Promise<void>

fromJSON

• fromJSON(data, meta?): null | ThreeViewer

• Deserialize all the viewer and plugin settings.

  Note

  use async importConfig to import a json/config exported with exportConfig or toJSON.

  Parameters

  • data: ISerializedViewerConfig

    The serialized JSON object retured from toJSON.

  • Optional meta: SerializationMetaType

    The meta object

  Returns null | ThreeViewer

getManager

• getManager(): undefined | AssetManager

• Deprecated

  use assetManager instead. Gets the Asset manager, contains useful functions for managing, loading and inserting assets.

  Returns undefined | AssetManager

getOrAddPlugin

• getOrAddPlugin<T>(type, ...args): Promise<T>

• Get the Plugin by a constructor type or add a new plugin of the specified type if it doesn't exist.

  Type Parameters

  • T extends IViewerPlugin<ThreeViewer, boolean, T>

  Parameters

  • type: Class<T>

  • Rest ...args: any[]

    arguments for the constructor of the plugin, used when a new plugin is created.

  Returns Promise<T>

getOrAddPluginSync

• getOrAddPluginSync<T>(type, ...args): T

• Get the Plugin by a constructor type or add a new plugin to the viewer of the specified type if it doesn't exist(sync).

  Type Parameters

  • T extends IViewerPluginSync<ThreeViewer, T>

  Parameters

  • type: Class<T>

  • Rest ...args: any[]

    arguments for the constructor of the plugin, used when a new plugin is created.

  Returns T

getPlugin

• getPlugin<T>(type): undefined | T

• Get the Plugin by a constructor type or by the string type. Use string type if the plugin is not a dependency and you don't want to bundle the plugin.

  Type Parameters

  • T extends IViewerPlugin<ThreeViewer, boolean, T>

  Parameters

  • type: string | Class<T>

    The class of the plugin to get, or the string type of the plugin to get which is in the static PluginType property of the plugin

  Returns undefined | T

  • The plugin of the specified type.

getPluginByType

• getPluginByType<T>(type): undefined | T

• Get the Plugin by the string type.

  Deprecated

  • Use getPlugin instead.

  Type Parameters

  • T extends IViewerPlugin<ThreeViewer, boolean, T>

  Parameters

  • type: string

  Returns undefined | T

getScreenshotBlob

• getScreenshotBlob(__namedParameters?): Promise<null | Blob>

• Parameters

  • __namedParameters: {
        mimeType: undefined | string;
        quality: undefined | number;
    } = {}

    • mimeType: undefined | string

    • quality: undefined | number

  Returns Promise<null | Blob>

getScreenshotDataUrl

• getScreenshotDataUrl(__namedParameters?): Promise<null | string>

• Parameters

  • __namedParameters: {
        mimeType: undefined | string;
        quality: undefined | number;
    } = {}

    • mimeType: undefined | string

    • quality: undefined | number

  Returns Promise<null | string>

import

• import<T>(obj, options?): Promise<undefined | T>

• Imports an object/model/material/texture/viewer-config/plugin-preset/... to the viewer scene from url or an IAsset object. Same as importSingle

  Type Parameters

  • T extends ImportResult = ImportResult

  Parameters

  • obj: null | string | IAsset

  • Optional options: ImportAddOptions

  Returns Promise<undefined | T>

importConfig

• importConfig(json): Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

• Deserialize and import all the viewer and plugin settings, exported with exportConfig.

  Parameters

  • json: ISerializedConfig | ISerializedViewerConfig

  Returns Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

importPluginConfig

• importPluginConfig(json, plugin?): Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

• Deserialize and import a single plugin settings. Can also use importConfig to import only plugin config.

  Parameters

  • json: ISerializedConfig

  • Optional plugin: IViewerPlugin<ThreeViewer, boolean>

  Returns Promise<undefined | IViewerPlugin<ThreeViewer, boolean>>

load

• load<T>(obj, options?): Promise<undefined | T>

• Add an object/model/material/viewer-config/plugin-preset/... to the viewer scene from url or an IAsset object. Same as addAssetSingle

  Type Parameters

  • T extends ImportResult = ImportResult

  Parameters

  • obj: null | string | IAsset

  • Optional options: ImportAddOptions

  Returns Promise<undefined | T>

loadConfigResources

• loadConfigResources(json, extraResources?): Promise<any>

• Parameters

  • json: Partial<SerializationMetaType>

  • Optional extraResources: Partial<SerializationResourcesType>

  Returns Promise<any>

removePlugin

• removePlugin(p, dispose?): Promise<void>

• Remove a plugin instance or a plugin class. Works similar to addPlugin

  Parameters

  • p: IViewerPlugin<ThreeViewer, false>

  • dispose: boolean = true

  Returns Promise<void>

removePluginSync

• removePluginSync(p, dispose?): void

• Remove a plugin instance or a plugin class(sync). Works similar to addPluginSync

  Parameters

  • p: IViewerPluginSync<ThreeViewer>

  • dispose: boolean = true

  Returns void

resize

• resize(): void

• Mark that the canvas is resized. If the size is changed, the renderer and all render targets are resized. This happens before the render of the next frame.

  Returns void

serializePlugins

• serializePlugins(meta, filter?): any[]

• Serialize all the plugins and their settings to save or create presets. Used in toJSON.

  Parameters

  • meta: SerializationMetaType

    The meta object.

  • Optional filter: string[]

    List of PluginType for the to include. If empty, no plugins will be serialized. If undefined, all plugins will be serialized.

  Returns any[]

setBackgroundMap

• setBackgroundMap(map, __namedParameters?): Promise<null | ITexture>

• Set the background image of the scene from url or an IAsset object.

  Parameters

  • map: undefined | null | string | ITexture | IAsset

  • __namedParameters: {
        forceImport?: boolean;
        importedFile?: IFile;
        mimeType?: string;
        pathOverride?: string;
        reimportDisposed?: boolean;
    } & {
        _testDataTextureComplete?: boolean;
        autoImportZipContents?: boolean;
        forceImporterReprocess?: boolean;
        generateMipmaps?: boolean;
        processImported?: boolean;
        processRaw?: boolean;
        rootPath?: string;
    } & AnyOptions & LoadFileOptions & {
        setBackground?: boolean;
    } = {}

  Returns Promise<null | ITexture>

setDirty

• setDirty(source?, event?): void

• Set the viewer to dirty and trigger render of the next frame.

  Parameters

  • Optional source: any

    The source of the dirty event. like plugin or 3d object

  • Optional event: Event

    The event that triggered the dirty event.

  Returns void

setEnvironmentMap

• setEnvironmentMap(map, __namedParameters?): Promise<null | ITexture>

• Set the environment map of the scene from url or an IAsset object.

  Parameters

  • map: undefined | null | string | ITexture | IAsset

  • __namedParameters: {
        forceImport?: boolean;
        importedFile?: IFile;
        mimeType?: string;
        pathOverride?: string;
        reimportDisposed?: boolean;
    } & {
        _testDataTextureComplete?: boolean;
        autoImportZipContents?: boolean;
        forceImporterReprocess?: boolean;
        generateMipmaps?: boolean;
        processImported?: boolean;
        processRaw?: boolean;
        rootPath?: string;
    } & AnyOptions & LoadFileOptions & {
        setBackground?: boolean;
    } = {}

  Returns Promise<null | ITexture>

setSize

• setSize(size?): void

• Set size of the canvas and update the renderer. If no width/height is passed, canvas is set to 100% of the container.

  Parameters

  • Optional size: {
        height?: number;
        width?: number;
    }

    • Optional height?: number

    • Optional width?: number

  Returns void

toJSON

• toJSON(binary?, pluginFilter?): ISerializedViewerConfig

• Serialize all the viewer and plugin settings and versions.

  Parameters

  • binary: boolean = true

    Indicate that the output will be converted and saved as binary data. (default: true)

  • Optional pluginFilter: string[]

    List of PluginType to include. If empty, no plugins will be serialized. If undefined, all plugins will be serialized.

  Returns ISerializedViewerConfig

  • Serializable JSON object.

traverseSceneObjects

• traverseSceneObjects<T>(callback): void

• Traverse all objects in scene model root.

  Type Parameters

  • T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

  Parameters

  • callback: ((o) => void)

    • • (o): void

      • Parameters

        • o: T

        Returns void

  Returns void