Class AssimpJsPlugin

AssimpJsPlugin

Helper plugin to load the assimp.js library from a CDN and provide a method to convert files using Assimp.js.

Assimpjs - https://github.com/kovacsv/assimpjs Fork with a custom build to support fbx export - https://github.com/repalash/assimpjs

Hierarchy

AViewerPluginSync
- AssimpJsPlugin

Constructors

constructor

new AssimpJsPlugin(initOnAdd?: boolean): AssimpJsPlugin
Parameters
- initOnAdd: boolean = true
Returns AssimpJsPlugin
Overrides AViewerPluginSync.constructor
- Defined in plugins/assimpjs/src/AssimpJsPlugin.ts:34

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_scriptElement

_scriptElement?: HTMLScriptElement

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

`Optional`ajs

ajs?: AssimpJsInterface

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: never[] = []

enabled

enabled: boolean = true

exportSelected

exportSelected: boolean = true

initOnAdd

initOnAdd: boolean

isViewerPluginSync

isViewerPluginSync: true = ...

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static`LIBRARY_PATH

LIBRARY_PATH: string = ...

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: string = 'SamplePlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

convertFiles

convertFiles(
files: Record<string, ArrayBuffer>,
format?: "fbx" | "gltf2" | "glb2" | "assjson",
): undefined | Blob
Parameters
- files: Record<string, ArrayBuffer>
- format: "fbx" | "gltf2" | "glb2" | "assjson" = 'glb2'
Returns undefined | Blob
- Defined in plugins/assimpjs/src/AssimpJsPlugin.ts:79

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportAsFbx

exportAsFbx(
    object?: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
): Promise<void>
Parameters
- Optionalobject: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
Returns Promise<void>
- Defined in plugins/assimpjs/src/AssimpJsPlugin.ts:136

exportAsGlb

exportAsGlb(
    object?: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
): Promise<void>
Parameters
- Optionalobject: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
Returns Promise<void>
- Defined in plugins/assimpjs/src/AssimpJsPlugin.ts:144

exportModel

exportModel(
    format?: "fbx" | "gltf2" | "glb2" | "assjson",
    object?: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
    options?: ExportFileOptions,
): Promise<undefined | File>
Parameters
- format: "fbx" | "gltf2" | "glb2" | "assjson" = 'glb2'
- Optionalobject: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
- options: ExportFileOptions = ...
Returns Promise<undefined | File>
- Defined in plugins/assimpjs/src/AssimpJsPlugin.ts:107

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): null | AssimpJsPlugin | Promise<null | AssimpJsPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | AssimpJsPlugin | Promise<null | AssimpJsPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:63

init

init(): Promise<undefined | AssimpJsInterface>
Returns Promise<undefined | AssimpJsInterface>
- Defined in plugins/assimpjs/src/AssimpJsPlugin.ts:42

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/assimpjs/src/AssimpJsPlugin.ts:72

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onRemove
- Defined in src/viewer/AViewerPlugin.ts:152

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:90

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:39

Class AssimpJsPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AssimpJsPlugin

Properties

Protected_dirty

Protected Optional_scriptElement

Protected Optional_viewer

Protected_viewerListeners

Optionalajs

constructor

dependencies

enabled

exportSelected

initOnAdd

isViewerPluginSync

OptionaluiConfig

StaticLIBRARY_PATH

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

convertFiles

Parameters

Returns undefined | Blob

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportAsFbx

Parameters

Returns Promise<void>

exportAsGlb

Parameters

Returns Promise<void>

exportModel

Parameters

Returns Promise<undefined | File>

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | AssimpJsPlugin | Promise<null | AssimpJsPlugin>

importState

Parameters

Returns Promise<void>

init

Returns Promise<undefined | AssimpJsInterface>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

`Protected`_dirty

`Protected` `Optional`_scriptElement

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`ajs

`Optional`uiConfig

`Static`LIBRARY_PATH

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty