Class XML3DLoaderPlugin

Viewer plugin that loads models from 3DXML files.

Hierarchy

Plugin
- XML3DLoaderPlugin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new XML3DLoaderPlugin(viewer: Viewer, cfg?: XML3DLoaderPluginConfiguration): XML3DLoaderPlugin

Overrides Plugin.constructor
- Defined in plugins/XML3DLoaderPlugin/XML3DLoaderPlugin.d.ts:48
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: XML3DLoaderPluginConfiguration
  
  Plugin configuration.
Returns XML3DLoaderPlugin

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

supportedSchemas

supportedSchemas: string[]

Supported 3DXML schema versions

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Methods

destroy

destroy(): void

Inherited from Plugin.destroy
- Defined in viewer/Plugin.d.ts:68
Destroys this Plugin and removes it from its Viewer.

Returns void

error

error(msg: string): void

Inherited from Plugin.error
- Defined in viewer/Plugin.d.ts:63
Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

fire

fire(event: string, value: any): void

Inherited from Plugin.fire
- Defined in viewer/Plugin.d.ts:42
Fires an event at this Plugin.

Parameters
- event: string
  
  The event type name
- value: any
  
  The event parameters
Returns void

load

load(params: LoadXML3DModel): VBOSceneModel

- Defined in plugins/XML3DLoaderPlugin/XML3DLoaderPlugin.d.ts:64
Loads a 3DXML model from a file into this XML3DLoaderPlugin's Viewer.

Creates a tree of Entitys within the Viewer's Scene that represents the model.

Parameters
- params: LoadXML3DModel
  
  Loading parameters.
Returns VBOSceneModel
Entity representing the model, which will have Entity.isModel set true and will be registered by Entity.id in Scene.models

log

log(msg: string): void

Inherited from Plugin.log
- Defined in viewer/Plugin.d.ts:49
Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

on

on(event: string, callback: () => void): void

Inherited from Plugin.on
- Defined in viewer/Plugin.d.ts:35
Subscribes to an event fired at this Plugin.

Parameters
- event: string
  
  The event
- callback: () => void
  
  Callback fired on the event
  - - (): void
    - Returns void
Returns void

warn

warn(msg: string): void

Inherited from Plugin.warn
- Defined in viewer/Plugin.d.ts:56
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

Generated using TypeDoc