Skip to main content

Module: Core-API

Classes

Interfaces

Enumerations

Type aliases

HTMLElementEventMap2

Ƭ HTMLElementEventMap2: HTMLElementEventMap & { initialized: Event }


TOrbitControlsEvents

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


TControlsCtor

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

Type declaration

▸ (camera, domElement): TCameraControls

Parameters
NameType
cameraCamera
domElementHTMLElement | Document
Returns

TCameraControls


TCameraControls

Ƭ TCameraControls: ICameraControls


Object3DModelOptions

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


IMaterialGenerator

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

Type declaration

▸ (params, oldMaterial): IMaterial

Parameters
NameType
paramsany
oldMaterialany
Returns

IMaterial


IAssetID

Ƭ IAssetID: string


ExportFileOptions

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


ProcessImportedOptions

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


ImportFilesOptions

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


ImportAssetOptions

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


ImportAddOptions

Ƭ ImportAddOptions: ImportAssetOptions & AddModelOptions & AddObjectOptions


AddImportedOptions

Ƭ AddImportedOptions: ProcessImportedOptions & AddObjectOptions & AddModelOptions


AssetImportEventTypes

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


TAssetTypes

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


IFile

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


ISceneObject

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

Type parameters

NameType
Tany

TCameraControlsMode

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


IGeometry

Ƭ IGeometry: any

Others


IShader

Ƭ IShader: IEventDispatcher<string>


IPassID

Ƭ IPassID: string


TUiRefreshModes

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

UI


UiObjectType

Ƭ UiObjectType: string


TViewerScreenShaderFrag

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


TViewerScreenShader

Ƭ TViewerScreenShader: TViewerScreenShaderFrag | ShaderPass2


EnvMapBackground

Ƭ EnvMapBackground: "envMapBackground"

Type for {@see envMapBackground}

deprecated will be removed

Functions

makeFilter

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

Type parameters

NameType
Tidextends string
TPassextends IPass<TPass>

Parameters

NameType
viewerViewerApp
filterPartialPick<IFilter<TPass, Tid>, "passId" | "passObject">
updaters?(undefined | IShaderPropertiesUpdater)[] | () => (undefined | IShaderPropertiesUpdater)[]

Returns

IFilter<TPass, Tid>


createRenderTargetKey

createRenderTargetKey(op?): string

Parameters

NameType
opCreateRenderTargetOptions

Returns

string


setupObject3dModel

setupObject3dModel(obj, modelProcessor): IModel<Object3D<Object3DEventMap>, IObject3DEventMap>

Setup an Object3DModel with a model processor

Parameters

NameType
objIModel<Object3D<Object3DEventMap>, IObject3DEventMap>
modelProcessor(m: IModel<any, IObject3DEventMap>) => undefined | IModel<any, IObject3DEventMap>

Returns

IModel<Object3D<Object3DEventMap>, IObject3DEventMap>


setupIModel

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

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

Parameters

NameType
objectObject3D<Object3DEventMap> & IModel<any, IObject3DEventMap>
parent?IModel<any, IObject3DEventMap>
modelProcessor?(m: IModel<any, IObject3DEventMap>) => undefined | IModel<any, IObject3DEventMap>

Returns

IModel & Object3D


setMeshMaterial

setMeshMaterial(mesh, material): IMaterial[]

Parameters

NameType
meshIModel<any, IObject3DEventMap>
materialundefined | null | IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Returns

IMaterial[]


setMeshGeometry

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

Parameters

NameTypeDefault value
meshIModel<any, IObject3DEventMap>undefined
geometryundefined | null | BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>undefined
forcebooleanfalse

Returns

BufferGeometry | undefined


copyObject3DUserData

copyObject3DUserData(dest, source): any

Parameters

NameType
destany
sourceany

Returns

any


getTextureDataType

getTextureDataType(renderer?): TextureDataType

Parameters

NameType
renderer?WebGLRenderer

Returns

TextureDataType


makeSamplerUi

makeSamplerUi<T>(mat, map, label?, hidden?, setDirty?): UiObjectConfig<any, string>

Type parameters

NameType
Textends IMaterial<any, IMaterialEventMap, T>

Parameters

NameType
matT
mapkeyof T
label?string
hidden?() => boolean
setDirty?() => any

Returns

UiObjectConfig<any, string>


copyMaterialUserData

copyMaterialUserData(dest, source, isRoot?): any

Parameters

NameTypeDefault value
destanyundefined
sourceanyundefined
isRootbooleantrue

Returns

any


copyTextureUserData

copyTextureUserData(dest, source): any

Parameters

NameType
destany
sourceany

Returns

any


uiConfig

uiConfig(uiType?, params?): PropertyDecorator

Parameters

NameType
uiType?string
params?AnyOptions

Returns

PropertyDecorator


uiToggle

uiToggle(label?, params?): PropertyDecorator

Parameters

NameType
label?string
params?any

Returns

PropertyDecorator


uiMonitor

uiMonitor(label?, params?): PropertyDecorator

Parameters

NameType
label?string
params?any

Returns

PropertyDecorator


uiSlider

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

Parameters

NameType
label?string
bounds?[number, number]
stepSize?number
params?any

Returns

PropertyDecorator


uiVector

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

Parameters

NameType
label?string
bounds?[number, number]
stepSize?number
params?any

Returns

PropertyDecorator


uiDropdown

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

Parameters

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

Returns

PropertyDecorator


uiButton

uiButton(label?, params?): PropertyDecorator

Parameters

NameType
label?string
params?any

Returns

PropertyDecorator


uiInput

uiInput(label?, params?): PropertyDecorator

Parameters

NameType
label?string
params?any

Returns

PropertyDecorator


uiColor

uiColor(label?, params?): PropertyDecorator

Parameters

NameType
label?string
params?any

Returns

PropertyDecorator


uiImage

uiImage(label?, params?): PropertyDecorator

Parameters

NameType
label?string
params?any

Returns

PropertyDecorator


generateUiConfig

generateUiConfig(obj): UiObjectConfig[]

Parameters

NameType
objany

Returns

UiObjectConfig[]


generateUiFolder

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

Parameters

NameTypeDefault value
labelstringundefined
objanyundefined
paramsany{}
typestring'folder'
dynamicbooleanfalse

Returns

UiObjectConfig


uiFolder

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

Parameters

NameTypeDefault value
labelstringundefined
params?anyundefined
typestring'folder'

Returns

fn

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

Type parameters
NameType
Textends (...args: any[]) => any
Parameters
NameType
constructorT
Returns

{ prototype: __class<any> } & T


uiPanel

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

Parameters

NameType
labelstring
params?any

Returns

fn

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

Type parameters
NameType
Textends (...args: any[]) => any
Parameters
NameType
constructorT
Returns

{ prototype: __class<any> } & T


valueToUiType

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

Parameters

NameType
valany

Returns

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

Variables

iGeometryIgnoredUserData

Const iGeometryIgnoredUserData: string[]


iModelIgnoredUserData

Const iModelIgnoredUserData: string[]


basicMaterialPropList

Const basicMaterialPropList: Object

Type declaration

NameType
namestring
blending1
side0
vertexColorsboolean
opacitynumber
transparentboolean
blendSrc204
blendDst205
blendEquation100
blendSrcAlphanull
blendDstAlphanull
blendEquationAlphanull
depthFunc3
depthTestboolean
depthWriteboolean
stencilWriteMasknumber
stencilFunc519
stencilRefnumber
stencilFuncMasknumber
stencilFail7680
stencilZFail7680
stencilZPass7680
stencilWriteboolean
clippingPlanesnull
clipIntersectionboolean
clipShadowsboolean
shadowSidenull
colorWriteboolean
precisionnull
polygonOffsetboolean
polygonOffsetFactornumber
polygonOffsetUnitsnumber
ditheringboolean
alphaToCoverageboolean
premultipliedAlphaboolean
forceSinglePassboolean
visibleboolean
toneMappedboolean
userData{}
alphaTestnumber
alphaHashboolean
colorstring
mapnull
lightMapnull
lightMapIntensitynumber
aoMapnull
aoMapIntensitynumber
specularMapnull
alphaMapnull
envMapnull
combine0
reflectivitynumber
refractionRationumber
wireframeboolean
wireframeLinewidthnumber
wireframeLinecapstring
wireframeLinejoinstring
skinningboolean
fogboolean

standardMaterialPropList

Const standardMaterialPropList: Object

Type declaration

NameType
namestring
blending1
side0
vertexColorsboolean
opacitynumber
transparentboolean
blendSrc204
blendDst205
blendEquation100
blendSrcAlphanull
blendDstAlphanull
blendEquationAlphanull
depthFunc3
depthTestboolean
depthWriteboolean
stencilWriteMasknumber
stencilFunc519
stencilRefnumber
stencilFuncMasknumber
stencilFail7680
stencilZFail7680
stencilZPass7680
stencilWriteboolean
clippingPlanesnull
clipIntersectionboolean
clipShadowsboolean
shadowSidenull
colorWriteboolean
precisionnull
polygonOffsetboolean
polygonOffsetFactornumber
polygonOffsetUnitsnumber
ditheringboolean
alphaToCoverageboolean
premultipliedAlphaboolean
forceSinglePassboolean
visibleboolean
toneMappedboolean
userData{}
alphaTestnumber
alphaHashboolean
colorstring
roughnessnumber
metalnessnumber
mapnull
lightMapnull
lightMapIntensitynumber
aoMapnull
aoMapIntensitynumber
emissivestring
emissiveIntensitynumber
emissiveMapnull
bumpMapnull
bumpScalenumber
normalMapnull
normalMapType0
normalScaleVector2
displacementMapnull
displacementScalenumber
displacementBiasnumber
roughnessMapnull
metalnessMapnull
alphaMapnull
envMapnull
envMapIntensitynumber
wireframeboolean
wireframeLinewidthnumber
wireframeLinecapstring
wireframeLinejoinstring
flatShadingboolean
fogboolean

physicalMaterialPropList

Const physicalMaterialPropList: Object

Type declaration

NameType
namestring
blending1
side0
vertexColorsboolean
opacitynumber
transparentboolean
blendSrc204
blendDst205
blendEquation100
blendSrcAlphanull
blendDstAlphanull
blendEquationAlphanull
depthFunc3
depthTestboolean
depthWriteboolean
stencilWriteMasknumber
stencilFunc519
stencilRefnumber
stencilFuncMasknumber
stencilFail7680
stencilZFail7680
stencilZPass7680
stencilWriteboolean
clippingPlanesnull
clipIntersectionboolean
clipShadowsboolean
shadowSidenull
colorWriteboolean
precisionnull
polygonOffsetboolean
polygonOffsetFactornumber
polygonOffsetUnitsnumber
ditheringboolean
alphaToCoverageboolean
premultipliedAlphaboolean
forceSinglePassboolean
visibleboolean
toneMappedboolean
userData{}
alphaTestnumber
alphaHashboolean
colorstring
roughnessnumber
metalnessnumber
mapnull
lightMapnull
lightMapIntensitynumber
aoMapnull
aoMapIntensitynumber
emissivestring
emissiveIntensitynumber
emissiveMapnull
bumpMapnull
bumpScalenumber
normalMapnull
normalMapType0
normalScaleVector2
displacementMapnull
displacementScalenumber
displacementBiasnumber
roughnessMapnull
metalnessMapnull
alphaMapnull
envMapnull
envMapIntensitynumber
wireframeboolean
wireframeLinewidthnumber
wireframeLinecapstring
wireframeLinejoinstring
flatShadingboolean
fogboolean
clearcoatnumber
clearcoatMapnull
clearcoatRoughnessnumber
clearcoatRoughnessMapnull
clearcoatNormalScaleVector2
clearcoatNormalMapnull
reflectivitynumber
iridescencenumber
iridescenceMapnull
iridescenceIORnumber
iridescenceThicknessRangenumber[]
iridescenceThicknessMapnull
sheennumber
sheenColorColor
sheenColorMapnull
sheenRoughnessnumber
sheenRoughnessMapnull
transmissionnumber
transmissionMapnull
thicknessnumber
thicknessMapnull
attenuationDistancenumber
attenuationColorColor
specularIntensitynumber
specularIntensityMapnull
specularColorColor
specularColorMapnull

iMaterialIgnoredUserData

Const iMaterialIgnoredUserData: string[]


iTextureIgnoredUserData

Const iTextureIgnoredUserData: string[]


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}