Module: Core-API

Classes

• WebGiViewerElement
• AViewerPlugin
• BaseRenderer
• CameraController
• EffectComposer2
• DirectionalLight2
• SpotLight2
• PointLight2
• AmbientLight2
• Object3DModel
• OrbitControls3
• RootScene
• AAssetManagerProcessStatePlugin
• AMaterialManager
• AssetManagerLoadingBarPlugin
• AssetManagerPlugin
• AssetManagerBasicPopupPlugin
• LoadingScreenPlugin
• SimpleDataSource
• SimpleAssetList
• AssetImporter
• Importer
• MaterialExtender
• MaterialManager
• MeshBasicMaterial2
• MeshStandardMaterial2
• ViewerApp

Interfaces

• ICameraControls
• AddObjectOptions
• IMaterialManager
• IMaterialTemplate
• ILoader
• IExportParser
• IImporter
• IExporter
• IAssetSearchQuery
• IAsset
• IAssetList
• IDataSource
• IAssetExporter
• IAssetManager
• ImportFileOptions
• IAssetImporter
• AssetManagerOptions
• MaterialExtension
• AddModelOptions
• IWidget
• IScene
• IRenderOptions
• IShaderPropertiesUpdater
• CreateRenderTargetOptions
• IEffectComposer
• IRenderer
• ICameraOptions
• IPerspectiveCameraOptions
• IOrthographicCameraOptions
• ICamera
• IModel
• ILight
• IMaterial
• IPass
• IFilter
• ITexture
• IRenderTarget
• IViewerApp
• IViewerPlugin
• IViewerPluginSync
• IViewerPluginAsync
• UiObjectConfig
• IUiConfigContainer
• IGBufferUpdater
• IViewerAppOptions

Enumerations

• ViewerState

Type aliases

HTMLElementEventMap2

Ƭ HTMLElementEventMap2: HTMLElementEventMap & { initialized: Event }

Defined in

webgi/examples/runtime/WebGiViewerElement.ts:320

---

TOrbitControlsEvents

Ƭ TOrbitControlsEvents: "change" | "end" | "start"

Defined in

webgi/src/core/threejs/CameraController.ts:26

---

TControlsCtor

Ƭ TControlsCtor: (camera: Camera, domElement: HTMLElement | Document) => TCameraControls

Type declaration

▸ (camera, domElement): TCameraControls

Parameters

Name	Type
camera	Camera
domElement	HTMLElement | Document

Returns

TCameraControls

Defined in

webgi/src/core/threejs/CameraController.ts:27

---

TCameraControls

Ƭ TCameraControls: ICameraControls<"change" | string>

Defined in

webgi/src/core/threejs/CameraController.ts:37

---

Object3DModelOptions

Ƭ Object3DModelOptions: AddModelOptions & { pseudoCenter?: boolean ; autoCenter?: boolean ; license?: string }

Defined in

webgi/src/core/threejs/Object3DModel.ts:9

---

IMaterialGenerator

Ƭ IMaterialGenerator: (params: any, oldMaterial: any) => IMaterial

Type declaration

▸ (params, oldMaterial): IMaterial

Parameters

Name	Type
params	any
oldMaterial	any

Returns

IMaterial

Defined in

webgi/src/extras/asset_manager/AMaterialManager.ts:51

---

IAssetID

Ƭ IAssetID: string

Defined in

webgi/src/extras/asset_manager/AssetManager.ts:29

---

ExportFileOptions

Ƭ ExportFileOptions: { exportExt?: string ; viewerConfig?: boolean } & GLTFExporter2Options & AnyOptions

Defined in

webgi/src/extras/asset_manager/AssetManager.ts:58

---

ProcessImportedOptions

Ƭ ProcessImportedOptions: { processImported?: boolean ; forceImporterReprocess?: boolean ; rootPath?: string ; generateMipmaps?: boolean ; _testDataTextureComplete?: boolean } & Object3DModelOptions & AnyOptions

Defined in

webgi/src/extras/asset_manager/AssetManager.ts:75

---

ImportFilesOptions

Ƭ ImportFilesOptions: ProcessImportedOptions & ImportFileOptions & { allowedExtensions?: string[] }

Defined in

webgi/src/extras/asset_manager/AssetManager.ts:92

---

ImportAssetOptions

Ƭ ImportAssetOptions: { forceImport?: boolean ; reimportDisposed?: boolean ; pathOverride?: string ; importedFile?: IFile } & ProcessImportedOptions & ImportFileOptions & AnyOptions

Defined in

webgi/src/extras/asset_manager/AssetManager.ts:94

---

ImportAddOptions

Ƭ ImportAddOptions: ImportAssetOptions & AddModelOptions & AddObjectOptions

Defined in

webgi/src/extras/asset_manager/AssetManagerPlugin.ts:31

---

AddImportedOptions

Ƭ AddImportedOptions: ProcessImportedOptions & AddObjectOptions & AddModelOptions

Defined in

webgi/src/extras/asset_manager/AssetManagerPlugin.ts:32

---

AssetImportEventTypes

Ƭ AssetImportEventTypes: "onLoad" | "onProgress" | "onStop" | "onError" | "onStart" | "loaderCreate" | "importFile" | "importFiles" | "processFileStart" | "processFileEnd"

Defined in

webgi/src/extras/asset_manager/importer/threejs/AssetImporter.ts:43

---

TAssetTypes

Ƭ TAssetTypes: "model" | "texture" | "light" | "material"

Defined in

webgi/src/interfaces.ts:32

---

IFile

Ƭ IFile: Partial<File> & { name: string ; type: string ; objectUrl?: string ; importId?: string ; ext?: string }

Defined in

webgi/src/interfaces.ts:34

---

ISceneObject

Ƭ ISceneObject<T>: IModel<T> | ILight<T> | ITexture<T> | IMaterial<T> & IUiConfigContainer

Type parameters

Name	Type
T	any

Defined in

webgi/src/interfaces.ts:51

---

TSceneEvents

Ƭ TSceneEvents: "sceneUpdate" | "addSceneObject" | "update" | "textureAdded" | "activeCameraChange" | "textureUpdate" | "renderCameraChange" | "activeCameraUpdate" | "sceneMaterialUpdate" | "environmentChanged" | "select" | "objectUpdate" | "materialUpdate" | "materialChanged" | "setView" | "activateMain" | "backgroundChanged"

Defined in

webgi/src/interfaces.ts:66

---

TCameraControlsMode

Ƭ TCameraControlsMode: "" | "orbit" | "deviceOrientation" | "firstPerson" | "pointerLock" | string

Defined in

webgi/src/interfaces.ts:217

---

IGeometry

Ƭ IGeometry: any

Others

Defined in

webgi/src/interfaces.ts:302

---

IShader

Ƭ IShader: IEventDispatcher<string>

Defined in

webgi/src/interfaces.ts:362

---

IPassID

Ƭ IPassID: string

Defined in

webgi/src/interfaces.ts:364

---

TUiRefreshModes

Ƭ TUiRefreshModes: "preRender" | "postRender" | "preFrame" | "postFrame"

UI

Defined in

webgi/src/interfaces.ts:547

---

UiObjectType

Ƭ UiObjectType: string

Defined in

webgi/src/interfaces.ts:548

---

TViewerScreenShaderFrag

Ƭ TViewerScreenShaderFrag: string | [string, string] | { pars?: string ; main: string }

Defined in

webgi/src/viewer/ViewerApp.ts:70

---

TViewerScreenShader

Ƭ TViewerScreenShader: TViewerScreenShaderFrag | ShaderPass2

Defined in

webgi/src/viewer/ViewerApp.ts:71

---

EnvMapBackground

Ƭ EnvMapBackground: "envMapBackground"

Type for {@see envMapBackground}

deprecated will be removed

Defined in

webgi/src/viewer/ViewerApp.ts:1186

Functions

makeFilter

▸ makeFilter<Tid, TPass>(viewer, filter, updaters?): IFilter<TPass, Tid>

Type parameters

Name	Type
Tid	extends string
TPass	extends IPass<TPass>

Parameters

Name	Type
viewer	IViewerApp
filter	PartialPick<IFilter<TPass, Tid>, "passId" | "passObject">
updaters?	(undefined | IShaderPropertiesUpdater)[] | () => (undefined | IShaderPropertiesUpdater)[]

Returns

IFilter<TPass, Tid>

Defined in

webgi/src/core/AViewerPlugin.ts:114

---

createRenderTargetKey

▸ createRenderTargetKey(op?): string

Parameters

Name	Type
op	CreateRenderTargetOptions

Returns

string

Defined in

webgi/src/core/threejs/BaseRenderer.ts:767

---

setupObject3dModel

▸ setupObject3dModel(obj, modelProcessor): IModel<Object3D<Event, string>>

Setup an Object3DModel with a model processor

Parameters

Name	Type
obj	IModel<Object3D<Event, string>>
modelProcessor	(m: IModel<any>) => undefined | IModel<any>

Returns

IModel<Object3D<Event, string>>

Defined in

webgi/src/core/threejs/Object3DModel.ts:226

---

setupIModel

▸ setupIModel(object, parent?, modelProcessor?): IModel & Object3D

Converts three.js Object3D to IModel, setup object events, adds utility methods, and runs model processor.

Parameters

Name	Type
object	Object3D<Event, string> & IModel<any>
parent?	IModel<any>
modelProcessor?	(m: IModel<any>) => undefined | IModel<any>

Returns

IModel & Object3D

Defined in

webgi/src/core/threejs/iModelSetup.ts:12

---

setMeshMaterial

▸ setMeshMaterial(mesh, material): IMaterial[]

Parameters

Name	Type
mesh	Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]> & IModel<any> & Line<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]> & IModel<any>
material	undefined | null | IMaterial<any> | IMaterial<any>[]

Returns

IMaterial[]

Defined in

webgi/src/core/threejs/iModelSetup.ts:247

---

setMeshGeometry

▸ setMeshGeometry(mesh, geometry, force?): BufferGeometry | undefined

Parameters

Name	Type	Default value
mesh	Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]> & IModel<any> & Line<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]> & IModel<any>	undefined
geometry	undefined | null | BufferGeometry<NormalBufferAttributes, Event, string>	undefined
force	boolean	false

Returns

BufferGeometry | undefined

Defined in

webgi/src/core/threejs/iModelSetup.ts:292

---

copyObject3DUserData

▸ copyObject3DUserData(dest, source): any

Parameters

Name	Type
dest	any
source	any

Returns

any

Defined in

webgi/src/core/threejs/iModelSetup.ts:324

---

getTextureDataType

▸ getTextureDataType(renderer?): TextureDataType

Parameters

Name	Type
renderer?	WebGLRenderer

Returns

TextureDataType

Defined in

webgi/src/extras/asset_manager/importer/threejs/AssetImporter.ts:632

---

makeSamplerUi

▸ makeSamplerUi<T>(mat, map): UiObjectConfig<any, string>

Type parameters

Name	Type
T	extends IMaterial<any, T> & { map: null | Texture }

Parameters

Name	Type
mat	T
map	keyof T

Returns

UiObjectConfig<any, string>

Defined in

webgi/src/extras/asset_manager/threejs/materialUtils.ts:20

---

copyMaterialUserData

▸ copyMaterialUserData(dest, source, isRoot?): any

Parameters

Name	Type	Default value
dest	any	undefined
source	any	undefined
isRoot	boolean	true

Returns

any

Defined in

webgi/src/extras/asset_manager/threejs/materialUtils.ts:198

---

copyTextureUserData

▸ copyTextureUserData(dest, source): any

Parameters

Name	Type
dest	any
source	any

Returns

any

Defined in

webgi/src/extras/asset_manager/threejs/materialUtils.ts:218

---

uiConfig

▸ uiConfig(uiType?, params?): PropertyDecorator

Parameters

Name	Type
uiType?	string
params?	AnyOptions

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:7

---

uiToggle

▸ uiToggle(label?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:28

---

uiMonitor

▸ uiMonitor(label?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:31

---

uiSlider

▸ uiSlider(label?, bounds?, stepSize?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
bounds?	[number, number]
stepSize?	number
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:34

---

uiVector

▸ uiVector(label?, bounds?, stepSize?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
bounds?	[number, number]
stepSize?	number
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:37

---

uiDropdown

▸ uiDropdown(label?, children?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
children?	ValOrFunc<UiObjectConfig<any, string>[], any[]>
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:40

---

uiButton

▸ uiButton(label?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:44

---

uiInput

▸ uiInput(label?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:47

---

uiColor

▸ uiColor(label?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:50

---

uiImage

▸ uiImage(label?, params?): PropertyDecorator

Parameters

Name	Type
label?	string
params?	any

Returns

PropertyDecorator

Defined in

webgi/src/ui/uiConfigDecorators.ts:53

---

generateUiConfig

▸ generateUiConfig(obj): UiObjectConfig[]

Parameters

Name	Type
obj	any

Returns

UiObjectConfig[]

Defined in

webgi/src/ui/uiConfigDecorators.ts:57

---

generateUiFolder

▸ generateUiFolder(label, obj, params?, type?): UiObjectConfig

Parameters

Name	Type	Default value
label	string	undefined
obj	any	undefined
params	any	{}
type	string	'folder'

Returns

UiObjectConfig

Defined in

webgi/src/ui/uiConfigDecorators.ts:145

---

uiFolder

▸ uiFolder(label, params?, type?): <T>(constructor: T) => { prototype: __class<any> } & T

Parameters

Name	Type	Default value
label	string	undefined
params?	any	undefined
type	string	'folder'

Returns

fn

▸ <T>(constructor): { prototype: __class<any> } & T

Type parameters

Name	Type
T	extends (...args: any[]) => any

Parameters

Name	Type
constructor	T

Returns

{ prototype: __class<any> } & T

Defined in

webgi/src/ui/uiConfigDecorators.ts:155

---

uiPanel

▸ uiPanel(label, params?): <T>(constructor: T) => { prototype: __class<any> } & T

Parameters

Name	Type
label	string
params?	any

Returns

fn

▸ <T>(constructor): { prototype: __class<any> } & T

Type parameters

Name	Type
T	extends (...args: any[]) => any

Parameters

Name	Type
constructor	T

Returns

{ prototype: __class<any> } & T

Defined in

webgi/src/ui/uiConfigDecorators.ts:163

---

valueToUiType

▸ valueToUiType(val): null | "input" | "button" | "folder" | "checkbox" | "number" | "vec" | "color" | "image"

Parameters

Name	Type
val	any

Returns

null | "input" | "button" | "folder" | "checkbox" | "number" | "vec" | "color" | "image"

Defined in

webgi/src/ui/uiConfigDecorators.ts:167

Variables

iGeometryIgnoredUserData

• Const iGeometryIgnoredUserData: string[]

Defined in

webgi/src/core/threejs/iModelSetup.ts:322

---

iModelIgnoredUserData

• Const iModelIgnoredUserData: string[]

Defined in

webgi/src/core/threejs/iModelSetup.ts:323

---

basicMaterialPropList

• Const basicMaterialPropList: Object

Type declaration

Name	Type
name	string
blending	1
side	0
vertexColors	boolean
opacity	number
transparent	boolean
blendSrc	204
blendDst	205
blendEquation	100
blendSrcAlpha	null
blendDstAlpha	null
blendEquationAlpha	null
depthFunc	3
depthTest	boolean
depthWrite	boolean
stencilWriteMask	number
stencilFunc	519
stencilRef	number
stencilFuncMask	number
stencilFail	7680
stencilZFail	7680
stencilZPass	7680
stencilWrite	boolean
clippingPlanes	null
clipIntersection	boolean
clipShadows	boolean
shadowSide	null
colorWrite	boolean
precision	null
polygonOffset	boolean
polygonOffsetFactor	number
polygonOffsetUnits	number
dithering	boolean
alphaToCoverage	boolean
premultipliedAlpha	boolean
forceSinglePass	boolean
visible	boolean
toneMapped	boolean
userData	{}
alphaTest	number
color	string
map	null
lightMap	null
lightMapIntensity	number
aoMap	null
aoMapIntensity	number
specularMap	null
alphaMap	null
envMap	null
combine	0
reflectivity	number
refractionRatio	number
wireframe	boolean
wireframeLinewidth	number
wireframeLinecap	string
wireframeLinejoin	string
skinning	boolean
fog	boolean

Defined in

webgi/src/extras/asset_manager/threejs/MeshBasicMaterial2.ts:34

---

standardMaterialPropList

• Const standardMaterialPropList: Object

Type declaration

Name	Type
name	string
blending	1
side	0
vertexColors	boolean
opacity	number
transparent	boolean
blendSrc	204
blendDst	205
blendEquation	100
blendSrcAlpha	null
blendDstAlpha	null
blendEquationAlpha	null
depthFunc	3
depthTest	boolean
depthWrite	boolean
stencilWriteMask	number
stencilFunc	519
stencilRef	number
stencilFuncMask	number
stencilFail	7680
stencilZFail	7680
stencilZPass	7680
stencilWrite	boolean
clippingPlanes	null
clipIntersection	boolean
clipShadows	boolean
shadowSide	null
colorWrite	boolean
precision	null
polygonOffset	boolean
polygonOffsetFactor	number
polygonOffsetUnits	number
dithering	boolean
alphaToCoverage	boolean
premultipliedAlpha	boolean
forceSinglePass	boolean
visible	boolean
toneMapped	boolean
userData	{}
alphaTest	number
color	string
roughness	number
metalness	number
map	null
lightMap	null
lightMapIntensity	number
aoMap	null
aoMapIntensity	number
emissive	string
emissiveIntensity	number
emissiveMap	null
bumpMap	null
bumpScale	number
normalMap	null
normalMapType	0
normalScale	Vector2
displacementMap	null
displacementScale	number
displacementBias	number
roughnessMap	null
metalnessMap	null
alphaMap	null
envMap	null
envMapIntensity	number
wireframe	boolean
wireframeLinewidth	number
wireframeLinecap	string
wireframeLinejoin	string
flatShading	boolean
fog	boolean

Defined in

webgi/src/extras/asset_manager/threejs/MeshStandardMaterial2.ts:52

---

physicalMaterialPropList

• Const physicalMaterialPropList: Object

Type declaration

Name	Type
name	string
blending	1
side	0
vertexColors	boolean
opacity	number
transparent	boolean
blendSrc	204
blendDst	205
blendEquation	100
blendSrcAlpha	null
blendDstAlpha	null
blendEquationAlpha	null
depthFunc	3
depthTest	boolean
depthWrite	boolean
stencilWriteMask	number
stencilFunc	519
stencilRef	number
stencilFuncMask	number
stencilFail	7680
stencilZFail	7680
stencilZPass	7680
stencilWrite	boolean
clippingPlanes	null
clipIntersection	boolean
clipShadows	boolean
shadowSide	null
colorWrite	boolean
precision	null
polygonOffset	boolean
polygonOffsetFactor	number
polygonOffsetUnits	number
dithering	boolean
alphaToCoverage	boolean
premultipliedAlpha	boolean
forceSinglePass	boolean
visible	boolean
toneMapped	boolean
userData	{}
alphaTest	number
color	string
roughness	number
metalness	number
map	null
lightMap	null
lightMapIntensity	number
aoMap	null
aoMapIntensity	number
emissive	string
emissiveIntensity	number
emissiveMap	null
bumpMap	null
bumpScale	number
normalMap	null
normalMapType	0
normalScale	Vector2
displacementMap	null
displacementScale	number
displacementBias	number
roughnessMap	null
metalnessMap	null
alphaMap	null
envMap	null
envMapIntensity	number
wireframe	boolean
wireframeLinewidth	number
wireframeLinecap	string
wireframeLinejoin	string
flatShading	boolean
fog	boolean
clearcoat	number
clearcoatMap	null
clearcoatRoughness	number
clearcoatRoughnessMap	null
clearcoatNormalScale	Vector2
clearcoatNormalMap	null
reflectivity	number
iridescence	number
iridescenceMap	null
iridescenceIOR	number
iridescenceThicknessRange	number[]
iridescenceThicknessMap	null
sheen	number
sheenColor	Color
sheenColorMap	null
sheenRoughness	number
sheenRoughnessMap	null
transmission	number
transmissionMap	null
thickness	number
thicknessMap	null
attenuationDistance	number
attenuationColor	Color
specularIntensity	number
specularIntensityMap	null
specularColor	Color
specularColorMap	null

Defined in

webgi/src/extras/asset_manager/threejs/MeshStandardMaterial2.ts:105

---

iMaterialIgnoredUserData

• Const iMaterialIgnoredUserData: string[]

Defined in

webgi/src/extras/asset_manager/threejs/materialUtils.ts:196

---

iTextureIgnoredUserData

• Const iTextureIgnoredUserData: string[]

Defined in

webgi/src/extras/asset_manager/threejs/materialUtils.ts:217

---

envMapBackground

• Const envMapBackground: EnvMapBackground = 'envMapBackground'

Special value for background to use the environment map.

deprecated will be removed, use 'environment' instead by passing into {@see RootScene.setBackground}

Defined in

webgi/src/viewer/ViewerApp.ts:1192