Class GLTFLoaderPlugin

Viewer plugin that loads models from glTF.

Hierarchy

Plugin
- GLTFLoaderPlugin

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GLTFLoaderPlugin(viewer: Viewer, cfg?: GLTFLoaderPluginConfiguration): GLTFLoaderPlugin

Overrides Plugin.constructor
- Defined in plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts:95
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: GLTFLoaderPluginConfiguration
  
  Plugin configuration.
Returns GLTFLoaderPlugin

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Accessors

dataSource

get dataSource(): IGLTFDefaultDataSource
set dataSource(arg: IGLTFDefaultDataSource): void

- Defined in plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts:113
Gets the custom data source through which the GLTFLoaderPlugin can load metadata, glTF and binary attachments.

Default value is {@link GLTFDefaultDataSource}, which loads via an XMLHttpRequest.

Returns IGLTFDefaultDataSource
- Defined in plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts:104
Sets a custom data source through which the GLTFLoaderPlugin can load metadata, glTF and binary attachments.

Default value is {@link GLTFDefaultDataSource}, which loads via an XMLHttpRequest.

Parameters
- arg: IGLTFDefaultDataSource
Returns void

objectDefaults

get objectDefaults(): IFCObjectDefaults
set objectDefaults(arg: IFCObjectDefaults): void

- Defined in plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts:131
Gets map of initial default states for each loaded Entity that represents an object.

Default value is IFCObjectDefaults.

Returns IFCObjectDefaults
- Defined in plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts:122
Sets map of initial default states for each loaded Entity that represents an object.

Default value is IFCObjectDefaults.

Parameters
- arg: IFCObjectDefaults
Returns void

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: LoadGLTFModel): Entity

- Defined in plugins/GLTFLoaderPlugin/GLTFLoaderPlugin.d.ts:139
Loads a glTF model from a file into this GLTFLoaderPlugin's Viewer.

Parameters
- params: LoadGLTFModel
  
  Loading parameters.
Returns Entity
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