Instance
-
class
Sc.Instance()
Properties
Methods
_loseWebGlContext()addCuttingSection()addDrawContext()addLight()advanceExportToSvg()advanceVolumeSelection()attachModels()attachScsBuffer()attachScsModelByKey()beginConvexPolyhedronSelection()beginExportToSvg()beginRayDrillSelection()beginScreenAreaSelection()beginSphereSelection()clearLights()createFloorplanMesh()cuttingSectionLimits()debug_log()debug_stateFailure()debug_sync()demandMeshInstances()detachInclusions()disableCapping()disconnectNetwork()enableCapping()endComparison()endVolumeSelection()explode()exportToSvg()feedScsBuffer()flushMetaDataCache()getAmbientOcclusionEnabled()getAmbientOcclusionRadius()getBackFacesVisible()getBackgroundGradient()getCamera()getCameraPromise()getCappedInstances()getCuttingSections()getDefaultDepthRange()getElementCount()getEyeDomeLightingBlurEdgeDistance()getEyeDomeLightingBlurInterval()getEyeDomeLightingBlurSamples()getEyeDomeLightingEnabled()getEyeDomeLightingOpacity()getEyeDomeLightingShadingEdgeDistance()getFaceWindingFlipped()getFacesVisible()getFrontFacesVisible()getInteractiveDrawLimitIncreaseEnabled()getLight()getLightKeys()getLinesVisible()getLooseBounding()getMetaData()getMinFrameRate()getNetworkVersion()getPointShape()getPointSize()getPointSizeUnit()getPointsVisible()getStatistics()getStreamVersion()getStreamedBounding()getTriangleCount()load()markAllMeshInstancesInteresting()markCameraAsEmpty()meshInstanceKeyInfo()metaDataKeyInfo()modelKeysFromInclusionKeys()onResize()pauseCapping()primaryModelKey()queueRedraw()registerBimInstances()removeAllCuttingSections()removeCuttingSections()removeDrawContext()removeLight()replaceCuttingSection()requestGroups()requestImages()requestMeshInstances()requestMeshInstancesByGroup()resetExplode()resetToEmpty()resumeCapping()resumeDrawing()screenSelectByRay()serverSideRendering()setAmbientLightColor()setAmbientOcclusionBias()setAmbientOcclusionBlurInterval()setAmbientOcclusionBlurSamples()setAmbientOcclusionContrast()setAmbientOcclusionEdgeDistance()setAmbientOcclusionEnabled()setAmbientOcclusionIntensity()setAmbientOcclusionNoiseSize()setAmbientOcclusionOpacity()setAmbientOcclusionRadius()setAmbientOcclusionSamples()setAntiAliasingMode()setBackFacesVisible()setBackgroundColor()setBackgroundGradient()setBloomBlurInterval()setBloomBlurSamples()setBloomEnabled()setBloomIntensity()setBloomIntensityScale()setBloomLayerCount()setBloomThreshold()setBloomThresholdRampWidth()setBoundingDebugLevel()setBoundingPreviewColor()setBoundingPreviewEjected()setBoundingPreviewEjectedColor()setBoundingPreviewTested()setBoundingPreviewTestedColor()setBoundingPreviewUnderdraw()setBoundingPreviewUnderdrawColor()setCamera()setCappingIdleHookEnabled()setClumpingEnabled()setComparisonColors()setCurrentView()setDefaultDepthRange()setDefaultGloss()setDefaultMirror()setDefaultSpecularMix()setDefaultSphereMap()setDisplayIncompleteFrames()setDrawIdleDelay()setDrawMode()setDrawStrategy()setEventHandler()setEyeDomeLightingBlurEdgeDistance()setEyeDomeLightingBlurInterval()setEyeDomeLightingBlurSamples()setEyeDomeLightingEnabled()setEyeDomeLightingOpacity()setEyeDomeLightingShadingEdgeDistance()setFaceWindingFlipped()setFacesVisible()setFixedDrawLimit()setFrontFacesVisible()setGoochBaseColorProminence()setGoochBlue()setGoochLuminanceShiftStrength()setGoochYellow()setGroundPlane()setGroundPlaneWithPosition()setHardEdgeColor()setHardEdgeOpacity()setHardEdgeThreshold()setHardEdgeThresholdRampWidth()setHardEdgesEnabled()setHiddenLineHiddenLineColor()setHiddenLineHighlightedElementFillColor()setHiddenLineHighlightedElementOutlineColor()setHiddenLineHighlightedInstanceFillColor()setHiddenLineHighlightedInstanceOutlineColor()setHiddenLineVisibleLineColor()setHighlightColorizeCompression()setHighlightMode()setHighlightedElementColor()setHighlightedElementFilter()setHighlightedElementOutlineColor()setHighlightedInstanceColor()setHighlightedInstanceFilter()setHighlightedInstanceOutlineColor()setImageBasedLightingEnabled()setImageBasedLightingEnvironment()setImageBasedLightingEnvironmentToDefault()setImageBasedLightingIntensity()setImageBasedLightingMatrix()setInstancingEnabled()setInteractiveDrawLimitIncreaseEnabled()setInteractiveDrawLimitIncreaseInterval()setLightingEnabled()setLineJitterEnabled()setLineJitterFrequency()setLineJitterInstanceCount()setLineJitterRadius()setLinesVisible()setMeshLevel()setMetallicRoughnessMaterialOverride()setMinDrawLimit()setMinFrameRate()setMinIncrementalFrameRate()setMinInteractiveFrameRate()setPointShape()setPointSize()setPointVisibilityTest()setPointsVisible()setPostInputDelay()setSilhouetteColor()setSilhouetteEnabled()setSilhouetteOpacity()setSilhouetteThreshold()setSilhouetteThresholdRampWidth()setSimpleReflectionAttenuation()setSimpleReflectionBlurInterval()setSimpleReflectionBlurSamples()setSimpleReflectionEnabled()setSimpleReflectionFadeAngle()setSimpleReflectionOpacity()setSimpleShadowBlurInterval()setSimpleShadowBlurSamples()setSimpleShadowColor()setSimpleShadowEnabled()setSimpleShadowInteractiveUpdateEnabled()setSimpleShadowOpacity()setSimpleShadowResolution()setSsrQuality()setStreamCutoffScale()setStreamIdleMarker()setToonBandCount()setToonSpecularFactor()setTransparencyMode()setUnhighlightedColor()setUnhighlightedFilter()setVisibilityByAttachment()setXRayMaterial()setXRayOpacity()setXRayTransparencyMode()shutDown()startComparison()startExplode()suspendDrawing()testPointVisibility()throttleLoad()triangulatePolygon()truncateMetaData()unsetAllColors()unsetAllHighlighted()unsetAllOpacity()unsetAllXRay()unsetCurrentView()unsetEventHandler()unsetXRayMaterial()updateLight()waitForImageDecoding()worldSelectByRay()
Properties
-
Instance.Image Type: ImageInterface
-
Instance.Matrix Type: MatrixInterface
-
Instance.MeshData Type: MeshDataInterface
-
Instance.MeshDataBuilder Type: function -
Instance.MeshDataBuilder() Return type: MeshDataBuilder
-
-
Instance.MeshInstance Type: MeshInstanceInterface
-
Instance.Overlay Type: OverlayInterface
-
Instance.allowHighDpi Type: boolean
-
Instance.canvas Type: OffscreenCanvas | HTMLCanvasElement
-
Instance.containers Type: Map <ViewKey, Element>
-
Instance.wrappers Type: Map <ViewKey, HTMLDivElement>
Methods
addCuttingSection
-
Instance.addCuttingSection(cuttingPlanes) Arguments: - cuttingPlanes (
[Vector4]()) – None
Return type: Promise <CuttingSectionKey>
- cuttingPlanes (
addLight
-
Instance.addLight(viewKey, type, space, position, color) Arguments: - viewKey (
ViewKey()) – None - type (
LightType()) – None - space (
LightSpace()) – None - position (
Vector3()) – None - color (
Vector3()) – None
Return type: Promise <LightKey>
- viewKey (
advanceVolumeSelection
-
Instance.advanceVolumeSelection(handle, batchCapacity) Arguments: - handle (
number()) – None - batchCapacity (
number()) – None
Return type: Promise <InstanceIncs>
- handle (
attachModels
-
Instance.attachModels(attachScope, modelNameWithTransform, attachMeasurementUnit, attachInvisibly) Arguments: - attachScope (
AttachScope()) – None - modelNameWithTransform (
[(string, Matrix12)]()) – None - attachMeasurementUnit (
number()) – None - attachInvisibly (
boolean()) – None
Return type: Promise <void>
- attachScope (
attachScsBuffer
-
Instance.attachScsBuffer(attachScope, buffer, inclusionMatrix, attachMeasurementUnit, attachInvisibly, resolveOnFullyLoaded, cancelUnitMatrix) Arguments: - attachScope (
AttachScope()) – None - buffer (
Uint8Array()) – None - inclusionMatrix (
Matrix12()) – None - attachMeasurementUnit (
number()) – None - attachInvisibly (
boolean()) – None - resolveOnFullyLoaded (
boolean()) – None - cancelUnitMatrix (
boolean()) – None
Return type: Promise <void>
- attachScope (
attachScsModelByKey
-
Instance.attachScsModelByKey(attachScope, matrix, modelKey, attachMeasurementUnit, attachInvisibly) Arguments: - attachScope (
AttachScope()) – None - matrix (
Matrix12()) – None - modelKey (
ModelKey()) – None - attachMeasurementUnit (
number()) – None - attachInvisibly (
boolean()) – None
Return type: InclusionKey
- attachScope (
beginConvexPolyhedronSelection
-
Instance.beginConvexPolyhedronSelection(volumePlaneCoeffs, heuristicOrigin, config, viewKey) Arguments: - volumePlaneCoeffs (
[Vector4]()) – None - heuristicOrigin (
Vector3()) – None - config (
VolumeSelectionConfig()) – None - viewKey (
ViewKey()) – None
Return type: Promise <number>
- volumePlaneCoeffs (
beginExportToSvg
-
Instance.beginExportToSvg(config) Arguments: - config (
SvgConfig()) – None
Return type: Promise <void>
- config (
beginRayDrillSelection
-
Instance.beginRayDrillSelection(viewKey, rayCssOriginX, rayCssOriginY, rayCssBoxRadius, config) Arguments: - viewKey (
ViewKey()) – None - rayCssOriginX (
number()) – None - rayCssOriginY (
number()) – None - rayCssBoxRadius (
number()) – None - config (
VolumeSelectionConfig()) – None
Return type: Promise <number>
- viewKey (
beginScreenAreaSelection
-
Instance.beginScreenAreaSelection(viewKey, areaCssMinX, areaCssMinY, areaCssMaxX, areaCssMaxY, config) Arguments: - viewKey (
ViewKey()) – None - areaCssMinX (
number()) – None - areaCssMinY (
number()) – None - areaCssMaxX (
number()) – None - areaCssMaxY (
number()) – None - config (
VolumeSelectionConfig()) – None
Return type: Promise <number>
- viewKey (
beginSphereSelection
-
Instance.beginSphereSelection(viewKey, sphereCenter, sphereRadius, config) Arguments: - viewKey (
ViewKey()) – None - sphereCenter (
Vector3()) – None - sphereRadius (
number()) – None - config (
VolumeSelectionConfig()) – None
Return type: Promise <number>
- viewKey (
createFloorplanMesh
-
Instance.createFloorplanMesh(incs) Arguments: - incs (
InstanceIncs()) – None
Return type: Promise <InstanceIncs>
- incs (
debug_log
-
Instance.debug_log(message) Arguments: - message (
string()) – None
Return type: Promise <void>
- message (
debug_stateFailure
-
Instance.debug_stateFailure(stateFailureValue) Arguments: - stateFailureValue (
number()) – None
Return type: Promise <void>
- stateFailureValue (
demandMeshInstances
-
Instance.demandMeshInstances(incs) Arguments: - incs (
InstanceIncs()) – None
Return type: void
- incs (
detachInclusions
-
Instance.detachInclusions(inclusionKeys) Arguments: - inclusionKeys (
[InclusionKey]()) – None
Return type: Promise <void>
- inclusionKeys (
disableCapping
-
Instance.disableCapping(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
enableCapping
-
Instance.enableCapping(viewKey, lineColor, faceColor, quantizationGranularity) Arguments: - viewKey (
ViewKey()) – None - lineColor (
Vector4()) – None - faceColor (
Vector4()) – None - quantizationGranularity (
number()) – None
Return type: void
- viewKey (
endComparison
-
Instance.endComparison(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
endVolumeSelection
-
Instance.endVolumeSelection(handle) Arguments: - handle (
number()) – None
Return type: void
- handle (
exportToSvg
-
Instance.exportToSvg(config) Arguments: - config (
SvgConfig()) – None
Return type: Promise <[number]>
- config (
feedScsBuffer
-
Instance.feedScsBuffer(attachScope, buffer) Arguments: - attachScope (
AttachScope()) – None - buffer (
null | Uint8Array()) – None
Return type: void
- attachScope (
getAmbientOcclusionEnabled
-
Instance.getAmbientOcclusionEnabled(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getAmbientOcclusionRadius
-
Instance.getAmbientOcclusionRadius(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getBackFacesVisible
-
Instance.getBackFacesVisible(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getBackgroundGradient
-
Instance.getBackgroundGradient(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <(Vector4, Vector4)>
- viewKey (
getCameraPromise
-
Instance.getCameraPromise(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <Camera>
- viewKey (
getCuttingSections
-
Instance.getCuttingSections(sectionKeys) Arguments: - sectionKeys (
[CuttingSectionKey]()) – None
Return type: Promise <[Vector4]>
- sectionKeys (
getDefaultDepthRange
-
Instance.getDefaultDepthRange(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <Range>
- viewKey (
getEyeDomeLightingBlurEdgeDistance
-
Instance.getEyeDomeLightingBlurEdgeDistance(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getEyeDomeLightingBlurInterval
-
Instance.getEyeDomeLightingBlurInterval(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getEyeDomeLightingBlurSamples
-
Instance.getEyeDomeLightingBlurSamples(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getEyeDomeLightingEnabled
-
Instance.getEyeDomeLightingEnabled(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getEyeDomeLightingOpacity
-
Instance.getEyeDomeLightingOpacity(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getEyeDomeLightingShadingEdgeDistance
-
Instance.getEyeDomeLightingShadingEdgeDistance(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getFaceWindingFlipped
-
Instance.getFaceWindingFlipped(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getFacesVisible
-
Instance.getFacesVisible(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getFrontFacesVisible
-
Instance.getFrontFacesVisible(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getInteractiveDrawLimitIncreaseEnabled
-
Instance.getInteractiveDrawLimitIncreaseEnabled(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getLight
-
Instance.getLight(viewKey, key) Arguments: - viewKey (
ViewKey()) – None - key (
LightKey()) – None
Return type: Promise <Light>
- viewKey (
getLightKeys
-
Instance.getLightKeys(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <[LightKey]>
- viewKey (
getLinesVisible
-
Instance.getLinesVisible(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
getMetaData
-
Instance.getMetaData(ids) Arguments: - ids (
DataIds()) – None
Return type: Promise <[Uint8Array]>
- ids (
getMinFrameRate
-
Instance.getMinFrameRate(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getPointShape
-
Instance.getPointShape(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <PointShape>
- viewKey (
getPointSize
-
Instance.getPointSize(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <number>
- viewKey (
getPointSizeUnit
-
Instance.getPointSizeUnit(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <PointSizeUnit>
- viewKey (
getPointsVisible
-
Instance.getPointsVisible(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: Promise <boolean>
- viewKey (
load
-
Instance.load(configuration) Arguments: - configuration (
LoadConfig()) – None
Return type: SessionType
- configuration (
markAllMeshInstancesInteresting
-
Instance.markAllMeshInstancesInteresting(interesting) Arguments: - interesting (
boolean()) – None
Return type: void
- interesting (
markCameraAsEmpty
-
Instance.markCameraAsEmpty(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
meshInstanceKeyInfo
-
Instance.meshInstanceKeyInfo(modelKeyOrAttachScope, byModel, keyCountOnly) Arguments: - modelKeyOrAttachScope (
ModelKey | AttachScope()) – None - byModel (
boolean()) – None - keyCountOnly (
boolean()) – None
Return type: Promise <(number) | [ModelKey | InstanceKey]>
- modelKeyOrAttachScope (
metaDataKeyInfo
-
Instance.metaDataKeyInfo(modelKeyOrAttachScope, byModel, keyCountOnly) Arguments: - modelKeyOrAttachScope (
ModelKey | AttachScope()) – None - byModel (
boolean()) – None - keyCountOnly (
boolean()) – None
Return type: Promise <(number) | [ModelKey | DataKey]>
- modelKeyOrAttachScope (
modelKeysFromInclusionKeys
-
Instance.modelKeysFromInclusionKeys(inclusionKeys) Arguments: - inclusionKeys (
[InclusionKey]()) – None
Return type: Promise <[ModelKey]>
- inclusionKeys (
registerBimInstances
-
Instance.registerBimInstances(incs, bimType) Arguments: - incs (
InstanceIncs()) – None - bimType (
BimType()) – None
Return type: void
- incs (
removeCuttingSections
-
Instance.removeCuttingSections(sectionHandles) Arguments: - sectionHandles (
[CuttingSectionKey]()) – None
Return type: Promise <void>
- sectionHandles (
removeDrawContext
-
Instance.removeDrawContext(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
removeLight
-
Instance.removeLight(viewKey, key) Arguments: - viewKey (
ViewKey()) – None - key (
LightKey()) – None
Return type: void
- viewKey (
replaceCuttingSection
-
Instance.replaceCuttingSection(cuttingPlanes, key) Arguments: - cuttingPlanes (
[Vector4]()) – None - key (
CuttingSectionKey()) – None
Return type: Promise <void>
- cuttingPlanes (
requestGroups
-
Instance.requestGroups(groupIds, obtainDependentGroups) Arguments: - groupIds (
GroupIds()) – None - obtainDependentGroups (
boolean()) – None
Return type: Promise <void>
- groupIds (
requestImages
-
Instance.requestImages(imageIds, wantThumbnails) Arguments: - imageIds (
ImageIds()) – None - wantThumbnails (
boolean()) – None
Return type: Promise <void>
- imageIds (
requestMeshInstances
-
Instance.requestMeshInstances(incs, withMeshData, ignoreFailure) Arguments: - incs (
InstanceIncs()) – None - withMeshData (
boolean()) – None - ignoreFailure (
boolean()) – None
Return type: Promise <void>
- incs (
requestMeshInstancesByGroup
-
Instance.requestMeshInstancesByGroup(groupId, withMeshData, expandGroups) Arguments: - groupId (
GroupIds()) – None - withMeshData (
boolean()) – None - expandGroups (
boolean()) – None
Return type: Promise <void>
- groupId (
resetToEmpty
-
Instance.resetToEmpty(whitelistInstances, whitelistMeshes) Arguments: - whitelistInstances (
[InstanceKey]()) – None - whitelistMeshes (
[MeshKey]()) – None
Return type: Promise <void>
- whitelistInstances (
resumeDrawing
-
Instance.resumeDrawing(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
screenSelectByRay
-
Instance.screenSelectByRay(viewKey, elementMask, canvasX, canvasY, maxPixelTolerance, config) Arguments: - viewKey (
ViewKey()) – None - elementMask (
number()) – None - canvasX (
number()) – None - canvasY (
number()) – None - maxPixelTolerance (
number()) – None - config (
RaySelectionConfig()) – None
Return type: Promise <PickResult>
- viewKey (
setAmbientLightColor
-
Instance.setAmbientLightColor(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
Vector3()) – None
Return type: void
- viewKey (
setAmbientOcclusionBias
-
Instance.setAmbientOcclusionBias(viewKey, bias) Arguments: - viewKey (
ViewKey()) – None - bias (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionBlurInterval
-
Instance.setAmbientOcclusionBlurInterval(viewKey, interval) Arguments: - viewKey (
ViewKey()) – None - interval (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionBlurSamples
-
Instance.setAmbientOcclusionBlurSamples(viewKey, samples) Arguments: - viewKey (
ViewKey()) – None - samples (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionContrast
-
Instance.setAmbientOcclusionContrast(viewKey, contrast) Arguments: - viewKey (
ViewKey()) – None - contrast (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionEdgeDistance
-
Instance.setAmbientOcclusionEdgeDistance(viewKey, distance) Arguments: - viewKey (
ViewKey()) – None - distance (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionEnabled
-
Instance.setAmbientOcclusionEnabled(viewKey, enabled) Arguments: - viewKey (
ViewKey()) – None - enabled (
boolean()) – None
Return type: void
- viewKey (
setAmbientOcclusionIntensity
-
Instance.setAmbientOcclusionIntensity(viewKey, intensity) Arguments: - viewKey (
ViewKey()) – None - intensity (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionNoiseSize
-
Instance.setAmbientOcclusionNoiseSize(viewKey, size) Arguments: - viewKey (
ViewKey()) – None - size (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionOpacity
-
Instance.setAmbientOcclusionOpacity(viewKey, opacity) Arguments: - viewKey (
ViewKey()) – None - opacity (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionRadius
-
Instance.setAmbientOcclusionRadius(viewKey, radius) Arguments: - viewKey (
ViewKey()) – None - radius (
number()) – None
Return type: void
- viewKey (
setAmbientOcclusionSamples
-
Instance.setAmbientOcclusionSamples(viewKey, samples) Arguments: - viewKey (
ViewKey()) – None - samples (
number()) – None
Return type: void
- viewKey (
setAntiAliasingMode
-
Instance.setAntiAliasingMode(viewKey, antiAliasingMode) Arguments: - viewKey (
ViewKey()) – None - antiAliasingMode (
AntiAliasingMode()) – None
Return type: void
- viewKey (
setBackFacesVisible
-
Instance.setBackFacesVisible(viewKey, visible) Arguments: - viewKey (
ViewKey()) – None - visible (
boolean()) – None
Return type: void
- viewKey (
setBackgroundColor
-
Instance.setBackgroundColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setBackgroundGradient
-
Instance.setBackgroundGradient(viewKey, top, bottom) Arguments: - viewKey (
ViewKey()) – None - top (
Vector4()) – None - bottom (
Vector4()) – None
Return type: void
- viewKey (
setBloomBlurInterval
-
Instance.setBloomBlurInterval(viewKey, layer, value, unit) Arguments: - viewKey (
ViewKey()) – None - layer (
number()) – None - value (
number()) – None - unit (
BlurIntervalUnit()) – None
Return type: void
- viewKey (
setBloomBlurSamples
-
Instance.setBloomBlurSamples(viewKey, layer, value) Arguments: - viewKey (
ViewKey()) – None - layer (
number()) – None - value (
number()) – None
Return type: void
- viewKey (
setBloomEnabled
-
Instance.setBloomEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setBloomIntensity
-
Instance.setBloomIntensity(viewKey, layer, value) Arguments: - viewKey (
ViewKey()) – None - layer (
number()) – None - value (
number()) – None
Return type: void
- viewKey (
setBloomIntensityScale
-
Instance.setBloomIntensityScale(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setBloomLayerCount
-
Instance.setBloomLayerCount(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setBloomThreshold
-
Instance.setBloomThreshold(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setBloomThresholdRampWidth
-
Instance.setBloomThresholdRampWidth(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setBoundingDebugLevel
-
Instance.setBoundingDebugLevel(viewKey, level) Arguments: - viewKey (
ViewKey()) – None - level (
number()) – None
Return type: void
- viewKey (
setBoundingPreviewColor
-
Instance.setBoundingPreviewColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setBoundingPreviewEjected
-
Instance.setBoundingPreviewEjected(points, viewKey) Arguments: - points (
[Vector3]()) – None - viewKey (
ViewKey()) – None
Return type: void
- points (
setBoundingPreviewEjectedColor
-
Instance.setBoundingPreviewEjectedColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setBoundingPreviewTested
-
Instance.setBoundingPreviewTested(points, viewKey) Arguments: - points (
[Vector3]()) – None - viewKey (
ViewKey()) – None
Return type: void
- points (
setBoundingPreviewTestedColor
-
Instance.setBoundingPreviewTestedColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setBoundingPreviewUnderdraw
-
Instance.setBoundingPreviewUnderdraw(points, viewKey) Arguments: - points (
[Vector3]()) – None - viewKey (
ViewKey()) – None
Return type: void
- points (
setBoundingPreviewUnderdrawColor
-
Instance.setBoundingPreviewUnderdrawColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setCamera
setCappingIdleHookEnabled
-
Instance.setCappingIdleHookEnabled(enable) Arguments: - enable (
boolean()) – None
Return type: Promise <boolean>
- enable (
setClumpingEnabled
-
Instance.setClumpingEnabled(value) Arguments: - value (
boolean()) – None
Return type: void
- value (
setComparisonColors
-
Instance.setComparisonColors(viewKey, sameColor, only1Color, only2Color) Arguments: - viewKey (
ViewKey()) – None - sameColor (
Vector3()) – None - only1Color (
Vector3()) – None - only2Color (
Vector3()) – None
Return type: void
- viewKey (
setCurrentView
-
Instance.setCurrentView(viewKey, view) Arguments: - viewKey (
ViewKey()) – None - view (
ViewKey()) – None
Return type: void
- viewKey (
setDefaultDepthRange
-
Instance.setDefaultDepthRange(viewKey, min, max) Arguments: - viewKey (
ViewKey()) – None - min (
number()) – None - max (
number()) – None
Return type: void
- viewKey (
setDefaultGloss
-
Instance.setDefaultGloss(viewKey, gloss) Arguments: - viewKey (
ViewKey()) – None - gloss (
number()) – None
Return type: void
- viewKey (
setDefaultMirror
-
Instance.setDefaultMirror(viewKey, mirror) Arguments: - viewKey (
ViewKey()) – None - mirror (
number()) – None
Return type: void
- viewKey (
setDefaultSpecularMix
-
Instance.setDefaultSpecularMix(viewKey, mix) Arguments: - viewKey (
ViewKey()) – None - mix (
number()) – None
Return type: void
- viewKey (
setDefaultSphereMap
-
Instance.setDefaultSphereMap(viewKey, imageId) Arguments: - viewKey (
ViewKey()) – None - imageId (
ImageId()) – None
Return type: void
- viewKey (
setDisplayIncompleteFrames
-
Instance.setDisplayIncompleteFrames(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setDrawIdleDelay
-
Instance.setDrawIdleDelay(viewKey, delay) Arguments: - viewKey (
ViewKey()) – None - delay (
number()) – None
Return type: void
- viewKey (
setDrawMode
-
Instance.setDrawMode(viewKey, drawMode) Arguments: - viewKey (
ViewKey()) – None - drawMode (
DrawMode()) – None
Return type: void
- viewKey (
setDrawStrategy
-
Instance.setDrawStrategy(viewKey, strategy) Arguments: - viewKey (
ViewKey()) – None - strategy (
DrawStrategy()) – None
Return type: void
- viewKey (
setEventHandler
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
announce_model()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, masterModelKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - masterModelKey (
MasterModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
bad_data()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, data) Arguments: - eventName (
string()) – None - data (
BadDataData()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
bounding()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
camera_set()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, viewKey) Arguments: - eventName (
string()) – None - viewKey (
ViewKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
capping_idle()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, isIdle, cappedInstanceCount) Arguments: - eventName (
string()) – None - isIdle (
boolean()) – None - cappedInstanceCount (
number()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
client_message()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, data) Arguments: - eventName (
string()) – None - data (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
draw_complete()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, viewKey) Arguments: - eventName (
string()) – None - viewKey (
ViewKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
draw_idle()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, viewKey) Arguments: - eventName (
string()) – None - viewKey (
ViewKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
first_instance()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
inclusion()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, inclusionKey, modelKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - inclusionKey (
InclusionKey()) – None - modelKey (
ModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
meta_data()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, modelKey, dataKey, data) Arguments: - eventName (
string()) – None - modelKey (
ModelKey()) – None - dataKey (
DataKey()) – None - data (
Uint8Array()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
missing_model()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, modelPath) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - modelPath (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
network_receive_data()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, dataSize) Arguments: - eventName (
string()) – None - dataSize (
number()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
open_model_failed()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, data) Arguments: - eventName (
string()) – None - data (
OpenModelFailedData()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
post_draw()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, draw_index, stats, camera, visiblePoints) Arguments: - eventName (
string()) – None - draw_index (
ViewKey()) – None - stats (
FrameStats()) – None - camera (
Camera()) – None - visiblePoints (
[number]()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
post_draw_json()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, metadataJson) Arguments: - eventName (
string()) – None - metadataJson (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
priority_meta_data_sent()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, prototypeInstanceCount) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - prototypeInstanceCount (
number()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
remap_inclusion()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, effectiveModelKey, effectiveInclusionKey, originalInclusionKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - effectiveModelKey (
ModelKey()) – None - effectiveInclusionKey (
InclusionKey()) – None - originalInclusionKey (
InclusionKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
remap_model()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, effectiveModelKey, originalModelKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - effectiveModelKey (
ModelKey()) – None - originalModelKey (
ModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
session_started()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, primaryModelKey) Arguments: - eventName (
string()) – None - primaryModelKey (
ModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
socket_error()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
socket_open_failed()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
stream_active()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
stream_idle()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
webgl_context_lost()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.setEventHandler(eventName, callback) Arguments: - eventName (
websocket_connection_closed()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
setEyeDomeLightingBlurEdgeDistance
-
Instance.setEyeDomeLightingBlurEdgeDistance(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setEyeDomeLightingBlurInterval
-
Instance.setEyeDomeLightingBlurInterval(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setEyeDomeLightingBlurSamples
-
Instance.setEyeDomeLightingBlurSamples(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setEyeDomeLightingEnabled
-
Instance.setEyeDomeLightingEnabled(viewKey, enabled) Arguments: - viewKey (
ViewKey()) – None - enabled (
boolean()) – None
Return type: void
- viewKey (
setEyeDomeLightingOpacity
-
Instance.setEyeDomeLightingOpacity(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setEyeDomeLightingShadingEdgeDistance
-
Instance.setEyeDomeLightingShadingEdgeDistance(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setFaceWindingFlipped
-
Instance.setFaceWindingFlipped(viewKey, flipped) Arguments: - viewKey (
ViewKey()) – None - flipped (
boolean()) – None
Return type: void
- viewKey (
setFacesVisible
-
Instance.setFacesVisible(viewKey, visible) Arguments: - viewKey (
ViewKey()) – None - visible (
boolean()) – None
Return type: void
- viewKey (
setFixedDrawLimit
-
Instance.setFixedDrawLimit(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setFrontFacesVisible
-
Instance.setFrontFacesVisible(viewKey, visible) Arguments: - viewKey (
ViewKey()) – None - visible (
boolean()) – None
Return type: void
- viewKey (
setGoochBaseColorProminence
-
Instance.setGoochBaseColorProminence(viewKey, prominence) Arguments: - viewKey (
ViewKey()) – None - prominence (
number()) – None
Return type: void
- viewKey (
setGoochBlue
-
Instance.setGoochBlue(viewKey, blue) Arguments: - viewKey (
ViewKey()) – None - blue (
number()) – None
Return type: void
- viewKey (
setGoochLuminanceShiftStrength
-
Instance.setGoochLuminanceShiftStrength(viewKey, shiftStrength) Arguments: - viewKey (
ViewKey()) – None - shiftStrength (
number()) – None
Return type: void
- viewKey (
setGoochYellow
-
Instance.setGoochYellow(viewKey, yellow) Arguments: - viewKey (
ViewKey()) – None - yellow (
number()) – None
Return type: void
- viewKey (
setGroundPlane
-
Instance.setGroundPlane(viewKey, normal) Arguments: - viewKey (
ViewKey()) – None - normal (
Vector3()) – None
Return type: void
- viewKey (
setGroundPlaneWithPosition
-
Instance.setGroundPlaneWithPosition(viewKey, normal[, position]) Arguments: - viewKey (
ViewKey()) – None - normal (
Vector3()) – None - position (
Vector3()) – optional None
Return type: void
- viewKey (
setHardEdgeColor
-
Instance.setHardEdgeColor(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
Vector3()) – None
Return type: void
- viewKey (
setHardEdgeOpacity
-
Instance.setHardEdgeOpacity(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setHardEdgeThreshold
-
Instance.setHardEdgeThreshold(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setHardEdgeThresholdRampWidth
-
Instance.setHardEdgeThresholdRampWidth(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setHardEdgesEnabled
-
Instance.setHardEdgesEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setHighlightColorizeCompression
-
Instance.setHighlightColorizeCompression(viewKey, compressionLevel) Arguments: - viewKey (
ViewKey()) – None - compressionLevel (
number()) – None
Return type: void
- viewKey (
setHighlightMode
-
Instance.setHighlightMode(viewKey, highlightMode) Arguments: - viewKey (
ViewKey()) – None - highlightMode (
HighlightMode()) – None
Return type: void
- viewKey (
setHighlightedElementColor
-
Instance.setHighlightedElementColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setHighlightedElementFilter
-
Instance.setHighlightedElementFilter(viewKey, highlightedFilter) Arguments: - viewKey (
ViewKey()) – None - highlightedFilter (
HighlightFilter()) – None
Return type: void
- viewKey (
setHighlightedElementOutlineColor
-
Instance.setHighlightedElementOutlineColor(viewKey, highlightedOutlineColor) Arguments: - viewKey (
ViewKey()) – None - highlightedOutlineColor (
Vector4()) – None
Return type: void
- viewKey (
setHighlightedInstanceColor
-
Instance.setHighlightedInstanceColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setHighlightedInstanceFilter
-
Instance.setHighlightedInstanceFilter(viewKey, highlightedFilter) Arguments: - viewKey (
ViewKey()) – None - highlightedFilter (
HighlightFilter()) – None
Return type: void
- viewKey (
setHighlightedInstanceOutlineColor
-
Instance.setHighlightedInstanceOutlineColor(viewKey, highlightedOutlineColor) Arguments: - viewKey (
ViewKey()) – None - highlightedOutlineColor (
Vector4()) – None
Return type: void
- viewKey (
setImageBasedLightingEnabled
-
Instance.setImageBasedLightingEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setImageBasedLightingEnvironment
-
Instance.setImageBasedLightingEnvironment(viewKey, data) Arguments: - viewKey (
ViewKey()) – None - data (
Uint8Array()) – None
Return type: void
- viewKey (
setImageBasedLightingEnvironmentToDefault
-
Instance.setImageBasedLightingEnvironmentToDefault(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
setImageBasedLightingIntensity
-
Instance.setImageBasedLightingIntensity(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setImageBasedLightingMatrix
-
Instance.setImageBasedLightingMatrix(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
Matrix9()) – None
Return type: void
- viewKey (
setInstancingEnabled
-
Instance.setInstancingEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setInteractiveDrawLimitIncreaseEnabled
-
Instance.setInteractiveDrawLimitIncreaseEnabled(viewKey, enable) Arguments: - viewKey (
ViewKey()) – None - enable (
boolean()) – None
Return type: void
- viewKey (
setInteractiveDrawLimitIncreaseInterval
-
Instance.setInteractiveDrawLimitIncreaseInterval(viewKey, milliseconds) Arguments: - viewKey (
ViewKey()) – None - milliseconds (
number()) – None
Return type: void
- viewKey (
setLightingEnabled
-
Instance.setLightingEnabled(viewKey, enabled) Arguments: - viewKey (
ViewKey()) – None - enabled (
boolean()) – None
Return type: void
- viewKey (
setLineJitterEnabled
-
Instance.setLineJitterEnabled(viewKey, enabled) Arguments: - viewKey (
ViewKey()) – None - enabled (
boolean()) – None
Return type: void
- viewKey (
setLineJitterFrequency
-
Instance.setLineJitterFrequency(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setLineJitterInstanceCount
-
Instance.setLineJitterInstanceCount(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setLineJitterRadius
-
Instance.setLineJitterRadius(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setLinesVisible
-
Instance.setLinesVisible(viewKey, visible) Arguments: - viewKey (
ViewKey()) – None - visible (
boolean()) – None
Return type: void
- viewKey (
setMeshLevel
-
Instance.setMeshLevel(incs, level) Arguments: - incs (
InstanceIncs()) – None - level (
number()) – None
Return type: void
- incs (
setMetallicRoughnessMaterialOverride
-
Instance.setMetallicRoughnessMaterialOverride(defaultMetallicFactor, defaultRoughnessFactor) Arguments: - defaultMetallicFactor (
number()) – None - defaultRoughnessFactor (
number()) – None
Return type: void
- defaultMetallicFactor (
setMinDrawLimit
-
Instance.setMinDrawLimit(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setMinFrameRate
-
Instance.setMinFrameRate(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setMinIncrementalFrameRate
-
Instance.setMinIncrementalFrameRate(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setMinInteractiveFrameRate
-
Instance.setMinInteractiveFrameRate(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setPointShape
-
Instance.setPointShape(viewKey, shape) Arguments: - viewKey (
ViewKey()) – None - shape (
PointShape()) – None
Return type: void
- viewKey (
setPointSize
-
Instance.setPointSize(viewKey, size, unit) Arguments: - viewKey (
ViewKey()) – None - size (
number()) – None - unit (
PointSizeUnit()) – None
Return type: void
- viewKey (
setPointVisibilityTest
-
Instance.setPointVisibilityTest(points, viewKey) Arguments: - points (
[Vector3]()) – None - viewKey (
ViewKey()) – None
Return type: void
- points (
setPointsVisible
-
Instance.setPointsVisible(viewKey, visible) Arguments: - viewKey (
ViewKey()) – None - visible (
boolean()) – None
Return type: void
- viewKey (
setPostInputDelay
-
Instance.setPostInputDelay(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSilhouetteColor
-
Instance.setSilhouetteColor(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
Vector3()) – None
Return type: void
- viewKey (
setSilhouetteEnabled
-
Instance.setSilhouetteEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setSilhouetteOpacity
-
Instance.setSilhouetteOpacity(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSilhouetteThreshold
-
Instance.setSilhouetteThreshold(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSilhouetteThresholdRampWidth
-
Instance.setSilhouetteThresholdRampWidth(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSimpleReflectionAttenuation
-
Instance.setSimpleReflectionAttenuation(viewKey, nearDistance, farDistance, unit) Arguments: - viewKey (
ViewKey()) – None - nearDistance (
number()) – None - farDistance (
number()) – None - unit (
SimpleReflectionAttenuationUnit()) – None
Return type: void
- viewKey (
setSimpleReflectionBlurInterval
-
Instance.setSimpleReflectionBlurInterval(viewKey, value, unit) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None - unit (
BlurIntervalUnit()) – None
Return type: void
- viewKey (
setSimpleReflectionBlurSamples
-
Instance.setSimpleReflectionBlurSamples(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSimpleReflectionEnabled
-
Instance.setSimpleReflectionEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setSimpleReflectionFadeAngle
-
Instance.setSimpleReflectionFadeAngle(viewKey, degrees) Arguments: - viewKey (
ViewKey()) – None - degrees (
number()) – None
Return type: void
- viewKey (
setSimpleReflectionOpacity
-
Instance.setSimpleReflectionOpacity(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSimpleShadowBlurInterval
-
Instance.setSimpleShadowBlurInterval(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSimpleShadowBlurSamples
-
Instance.setSimpleShadowBlurSamples(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSimpleShadowColor
-
Instance.setSimpleShadowColor(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
Vector3()) – None
Return type: void
- viewKey (
setSimpleShadowEnabled
-
Instance.setSimpleShadowEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setSimpleShadowInteractiveUpdateEnabled
-
Instance.setSimpleShadowInteractiveUpdateEnabled(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
boolean()) – None
Return type: void
- viewKey (
setSimpleShadowOpacity
-
Instance.setSimpleShadowOpacity(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
number()) – None
Return type: void
- viewKey (
setSimpleShadowResolution
-
Instance.setSimpleShadowResolution(viewKey, pixels) Arguments: - viewKey (
ViewKey()) – None - pixels (
number()) – None
Return type: void
- viewKey (
setSsrQuality
-
Instance.setSsrQuality(opts) Arguments: - opts (
SsrQualityConfig()) – None
Return type: void
- opts (
setStreamCutoffScale
-
Instance.setStreamCutoffScale(value) Arguments: - value (
number()) – None
Return type: void
- value (
setToonBandCount
-
Instance.setToonBandCount(viewKey, bandCount) Arguments: - viewKey (
ViewKey()) – None - bandCount (
number()) – None
Return type: void
- viewKey (
setToonSpecularFactor
-
Instance.setToonSpecularFactor(viewKey, specularFactor) Arguments: - viewKey (
ViewKey()) – None - specularFactor (
number()) – None
Return type: void
- viewKey (
setTransparencyMode
-
Instance.setTransparencyMode(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
TransparencyMode()) – None
Return type: void
- viewKey (
setUnhighlightedColor
-
Instance.setUnhighlightedColor(viewKey, color) Arguments: - viewKey (
ViewKey()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setUnhighlightedFilter
-
Instance.setUnhighlightedFilter(viewKey, highlightedFilter) Arguments: - viewKey (
ViewKey()) – None - highlightedFilter (
HighlightFilter()) – None
Return type: void
- viewKey (
setVisibilityByAttachment
-
Instance.setVisibilityByAttachment(attachScope, setVisibility) Arguments: - attachScope (
AttachScope()) – None - setVisibility (
SetVisibility()) – None
Return type: void
- attachScope (
setXRayMaterial
-
Instance.setXRayMaterial(viewKey, group, element, color) Arguments: - viewKey (
ViewKey()) – None - group (
XRayGroup()) – None - element (
ElementType()) – None - color (
Vector4()) – None
Return type: void
- viewKey (
setXRayOpacity
-
Instance.setXRayOpacity(viewKey, element, value) Arguments: - viewKey (
ViewKey()) – None - element (
ElementType()) – None - value (
number()) – None
Return type: void
- viewKey (
setXRayTransparencyMode
-
Instance.setXRayTransparencyMode(viewKey, value) Arguments: - viewKey (
ViewKey()) – None - value (
TransparencyMode()) – None
Return type: void
- viewKey (
startComparison
-
Instance.startComparison(viewKey, instanceSet1, instanceSet2) Arguments: - viewKey (
ViewKey()) – None - instanceSet1 (
InstanceIncs()) – None - instanceSet2 (
InstanceIncs()) – None
Return type: void
- viewKey (
startExplode
-
Instance.startExplode(incs, center) Arguments: - incs (
InstanceIncs()) – None - center (
Vector3()) – None
Return type: void
- incs (
suspendDrawing
-
Instance.suspendDrawing(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
testPointVisibility
-
Instance.testPointVisibility(points, viewKey) Arguments: - points (
[Vector3]()) – None - viewKey (
ViewKey()) – None
Return type: Promise <[number]>
- points (
throttleLoad
-
Instance.throttleLoad(newPauseInterval, throttleDuration) Arguments: - newPauseInterval (
number()) – None - throttleDuration (
number()) – None
Return type: void
- newPauseInterval (
triangulatePolygon
-
Instance.triangulatePolygon(polygonPoints, normal) Arguments: - polygonPoints (
Float32Array | [number]()) – None - normal (
Vector3()) – None
Return type: [number]
- polygonPoints (
truncateMetaData
-
Instance.truncateMetaData(dataIds) Arguments: - dataIds (
DataIds()) – None
Return type: Promise <void>
- dataIds (
unsetCurrentView
-
Instance.unsetCurrentView(viewKey) Arguments: - viewKey (
ViewKey()) – None
Return type: void
- viewKey (
unsetEventHandler
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
announce_model()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, modelKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - modelKey (
ModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
bad_data()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, data) Arguments: - eventName (
string()) – None - data (
BadDataData()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
bounding()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
camera_set()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, viewKey) Arguments: - eventName (
string()) – None - viewKey (
ViewKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
capping_idle()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, isIdle, cappedInstanceCount) Arguments: - eventName (
string()) – None - isIdle (
boolean()) – None - cappedInstanceCount (
number()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
client_message()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, data) Arguments: - eventName (
string()) – None - data (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
draw_complete()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, viewKey) Arguments: - eventName (
string()) – None - viewKey (
ViewKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
draw_idle()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, viewKey) Arguments: - eventName (
string()) – None - viewKey (
ViewKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
inclusion()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, inclusionKey, modelKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - inclusionKey (
InclusionKey()) – None - modelKey (
ModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
meta_data()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, modelKey, dataKey, data) Arguments: - eventName (
string()) – None - modelKey (
ModelKey()) – None - dataKey (
DataKey()) – None - data (
Uint8Array()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
missing_model()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, modelPath) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - modelPath (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
network_receive_data()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, dataSize) Arguments: - eventName (
string()) – None - dataSize (
number()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
open_model_failed()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, data) Arguments: - eventName (
string()) – None - data (
OpenModelFailedData()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
post_draw()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, draw_index, stats, camera, visiblePoints) Arguments: - eventName (
string()) – None - draw_index (
ViewKey()) – None - stats (
FrameStats()) – None - camera (
Camera()) – None - visiblePoints (
[number]()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
post_draw_json()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, metadataJson) Arguments: - eventName (
string()) – None - metadataJson (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
priority_meta_data_sent()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, prototypeInstanceCount) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - prototypeInstanceCount (
number()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
remap_inclusion()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, effectiveModelKey, effectiveInclusionKey, originalInclusionKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - effectiveModelKey (
ModelKey()) – None - effectiveInclusionKey (
InclusionKey()) – None - originalInclusionKey (
InclusionKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
remap_model()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, attachScope, effectiveModelKey, originalModelKey) Arguments: - eventName (
string()) – None - attachScope (
AttachScope()) – None - effectiveModelKey (
ModelKey()) – None - originalModelKey (
ModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
session_started()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName, primaryModelKey) Arguments: - eventName (
string()) – None - primaryModelKey (
ModelKey()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
socket_error()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
socket_open_failed()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
stream_active()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
stream_idle()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
webgl_context_lost()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
-
Instance.unsetEventHandler(eventName, callback) Arguments: - eventName (
websocket_connection_closed()) – None - callback (
function()) – None
Return type: void
-
Instance.callback(eventName) Arguments: - eventName (
string()) – None
Return type: void
- eventName (
- eventName (
unsetXRayMaterial
-
Instance.unsetXRayMaterial(viewKey, group, element) Arguments: - viewKey (
ViewKey()) – None - group (
XRayGroup()) – None - element (
ElementType()) – None
Return type: Promise <void>
- viewKey (
updateLight
-
Instance.updateLight(viewKey, key, type, space, position, color) Arguments: - viewKey (
ViewKey()) – None - key (
LightKey()) – None - type (
LightType()) – None - space (
LightSpace()) – None - position (
Vector3()) – None - color (
Vector3()) – None
Return type: void
- viewKey (
worldSelectByRay
-
Instance.worldSelectByRay(viewKey, ray, config) Arguments: - viewKey (
ViewKey()) – None - ray (
IRay()) – None - config (
RaySelectionConfig()) – None
Return type: Promise <PickResult>
- viewKey (