Class STLLoaderPlugin

Viewer plugin that loads models from STL files.

Hierarchy

Plugin
- STLLoaderPlugin

Index

Constructors

constructor

Properties

Accessors

dataSource

Methods

Constructors

constructor

new STLLoaderPlugin(viewer: Viewer, cfg?: STLLoaderPluginCOnfiguration): STLLoaderPlugin

Overrides Plugin.constructor
- Defined in plugins/STLLoaderPlugin/STLLoaderPlugin.d.ts:61
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: STLLoaderPluginCOnfiguration
Returns STLLoaderPlugin

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(): ISTLDefaultDataSource
set dataSource(arg: ISTLDefaultDataSource): void

- Defined in plugins/STLLoaderPlugin/STLLoaderPlugin.d.ts:79
Gets the custom data source through which the STLLoaderPlugin can load STL files.

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

Returns ISTLDefaultDataSource
- Defined in plugins/STLLoaderPlugin/STLLoaderPlugin.d.ts:70
Sets a custom data source through which the STLLoaderPlugin can load STL files.

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

Parameters
- arg: ISTLDefaultDataSource
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: LoadSTLModel): VBOSceneModel

- Defined in plugins/STLLoaderPlugin/STLLoaderPlugin.d.ts:87
Loads an STL model from a file into this STLLoaderPlugin's Viewer.

Parameters
- params: LoadSTLModel
  
  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