Instance

class Sc.Instance()

Properties

• Image

• Matrix

• MeshData

• MeshDataBuilder

• MeshInstance

• Overlay

• allowHighDpi

• canvas

• containers

• wrappers

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

_loseWebGlContext

Instance._loseWebGlContext()

Return type

boolean

addCuttingSection

Instance.addCuttingSection(cuttingPlanes)

Arguments

• cuttingPlanes ([Vector4]()) – None

Return type

Promise <CuttingSectionKey>

addDrawContext

Instance.addDrawContext()

Return type

Promise <ViewKey>

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>

advanceExportToSvg

Instance.advanceExportToSvg()

Return type

Promise <[number]>

advanceVolumeSelection

Instance.advanceVolumeSelection(handle, batchCapacity)

Arguments

• handle (number()) – None

• batchCapacity (number()) – None

Return type

Promise <InstanceIncs>

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>

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>

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

beginConvexPolyhedronSelection

Instance.beginConvexPolyhedronSelection(volumePlaneCoeffs, heuristicOrigin, config, viewKey)

Arguments

• volumePlaneCoeffs ([Vector4]()) – None

• heuristicOrigin (Vector3()) – None

• config (VolumeSelectionConfig()) – None

• viewKey (ViewKey()) – None

Return type

Promise <number>

beginExportToSvg

Instance.beginExportToSvg(config)

Arguments

• config (SvgConfig()) – None

Return type

Promise <void>

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>

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>

beginSphereSelection

Instance.beginSphereSelection(viewKey, sphereCenter, sphereRadius, config)

Arguments

• viewKey (ViewKey()) – None

• sphereCenter (Vector3()) – None

• sphereRadius (number()) – None

• config (VolumeSelectionConfig()) – None

Return type

Promise <number>

clearLights

Instance.clearLights(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

createFloorplanMesh

Instance.createFloorplanMesh(incs)

Arguments

• incs (InstanceIncs()) – None

Return type

Promise <InstanceIncs>

cuttingSectionLimits

Instance.cuttingSectionLimits()

Return type

CuttingSectionLimits

debug_log

Instance.debug_log(message)

Arguments

• message (string()) – None

Return type

Promise <void>

debug_stateFailure

Instance.debug_stateFailure(stateFailureValue)

Arguments

• stateFailureValue (number()) – None

Return type

Promise <void>

debug_sync

Instance.debug_sync()

Return type

Promise <void>

demandMeshInstances

Instance.demandMeshInstances(incs)

Arguments

• incs (InstanceIncs()) – None

Return type

void

detachInclusions

Instance.detachInclusions(inclusionKeys)

Arguments

• inclusionKeys ([InclusionKey]()) – None

Return type

Promise <void>

disableCapping

Instance.disableCapping(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

disconnectNetwork

Instance.disconnectNetwork()

Return type

void

enableCapping

Instance.enableCapping(viewKey, lineColor, faceColor, quantizationGranularity)

Arguments

• viewKey (ViewKey()) – None

• lineColor (Vector4()) – None

• faceColor (Vector4()) – None

• quantizationGranularity (number()) – None

Return type

void

endComparison

Instance.endComparison(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

endVolumeSelection

Instance.endVolumeSelection(handle)

Arguments

• handle (number()) – None

Return type

void

explode

Instance.explode(distance)

Arguments

• distance (number()) – None

Return type

void

exportToSvg

Instance.exportToSvg(config)

Arguments

• config (SvgConfig()) – None

Return type

Promise <[number]>

feedScsBuffer

Instance.feedScsBuffer(attachScope, buffer)

Arguments

• attachScope (AttachScope()) – None

• buffer (null | Uint8Array()) – None

Return type

void

flushMetaDataCache

Instance.flushMetaDataCache()

Return type

void

getAmbientOcclusionEnabled

Instance.getAmbientOcclusionEnabled(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getAmbientOcclusionRadius

Instance.getAmbientOcclusionRadius(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getBackFacesVisible

Instance.getBackFacesVisible(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getBackgroundGradient

Instance.getBackgroundGradient(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <(Vector4, Vector4)>

getCamera

Instance.getCamera(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Camera

getCameraPromise

Instance.getCameraPromise(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <Camera>

getCappedInstances

Instance.getCappedInstances()

Return type

Promise <InstanceIncs>

getCuttingSections

Instance.getCuttingSections(sectionKeys)

Arguments

• sectionKeys ([CuttingSectionKey]()) – None

Return type

Promise <[Vector4]>

getDefaultDepthRange

Instance.getDefaultDepthRange(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <Range>

getElementCount

Instance.getElementCount()

Return type

Promise <number>

getEyeDomeLightingBlurEdgeDistance

Instance.getEyeDomeLightingBlurEdgeDistance(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getEyeDomeLightingBlurInterval

Instance.getEyeDomeLightingBlurInterval(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getEyeDomeLightingBlurSamples

Instance.getEyeDomeLightingBlurSamples(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getEyeDomeLightingEnabled

Instance.getEyeDomeLightingEnabled(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getEyeDomeLightingOpacity

Instance.getEyeDomeLightingOpacity(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getEyeDomeLightingShadingEdgeDistance

Instance.getEyeDomeLightingShadingEdgeDistance(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getFaceWindingFlipped

Instance.getFaceWindingFlipped(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getFacesVisible

Instance.getFacesVisible(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getFrontFacesVisible

Instance.getFrontFacesVisible(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getInteractiveDrawLimitIncreaseEnabled

Instance.getInteractiveDrawLimitIncreaseEnabled(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getLight

Instance.getLight(viewKey, key)

Arguments

• viewKey (ViewKey()) – None

• key (LightKey()) – None

Return type

Promise <Light>

getLightKeys

Instance.getLightKeys(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <[LightKey]>

getLinesVisible

Instance.getLinesVisible(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getLooseBounding

Instance.getLooseBounding()

Return type

Promise <IBox>

getMetaData

Instance.getMetaData(ids)

Arguments

• ids (DataIds()) – None

Return type

Promise <[Uint8Array]>

getMinFrameRate

Instance.getMinFrameRate(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getNetworkVersion

Instance.getNetworkVersion()

Return type

number

getPointShape

Instance.getPointShape(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <PointShape>

getPointSize

Instance.getPointSize(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <number>

getPointSizeUnit

Instance.getPointSizeUnit(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <PointSizeUnit>

getPointsVisible

Instance.getPointsVisible(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

Promise <boolean>

getStatistics

Instance.getStatistics()

Return type

Promise <Statistics>

getStreamVersion

Instance.getStreamVersion()

Return type

number

getStreamedBounding

Instance.getStreamedBounding()

Return type

Promise <IBox>

getTriangleCount

Instance.getTriangleCount()

Return type

Promise <number>

load

Instance.load(configuration)

Arguments

• configuration (LoadConfig()) – None

Return type

SessionType

markAllMeshInstancesInteresting

Instance.markAllMeshInstancesInteresting(interesting)

Arguments

• interesting (boolean()) – None

Return type

void

markCameraAsEmpty

Instance.markCameraAsEmpty(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

meshInstanceKeyInfo

Instance.meshInstanceKeyInfo(modelKeyOrAttachScope, byModel, keyCountOnly)

Arguments

• modelKeyOrAttachScope (ModelKey | AttachScope()) – None

• byModel (boolean()) – None

• keyCountOnly (boolean()) – None

Return type

Promise <(number) | [ModelKey | InstanceKey]>

metaDataKeyInfo

Instance.metaDataKeyInfo(modelKeyOrAttachScope, byModel, keyCountOnly)

Arguments

• modelKeyOrAttachScope (ModelKey | AttachScope()) – None

• byModel (boolean()) – None

• keyCountOnly (boolean()) – None

Return type

Promise <(number) | [ModelKey | DataKey]>

modelKeysFromInclusionKeys

Instance.modelKeysFromInclusionKeys(inclusionKeys)

Arguments

• inclusionKeys ([InclusionKey]()) – None

Return type

Promise <[ModelKey]>

onResize

Instance.onResize(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

pauseCapping

Instance.pauseCapping()

Return type

void

primaryModelKey

Instance.primaryModelKey()

Return type

Promise <ModelKey>

queueRedraw

Instance.queueRedraw(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

registerBimInstances

Instance.registerBimInstances(incs, bimType)

Arguments

• incs (InstanceIncs()) – None

• bimType (BimType()) – None

Return type

void

removeAllCuttingSections

Instance.removeAllCuttingSections()

Return type

void

removeCuttingSections

Instance.removeCuttingSections(sectionHandles)

Arguments

• sectionHandles ([CuttingSectionKey]()) – None

Return type

Promise <void>

removeDrawContext

Instance.removeDrawContext(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

removeLight

Instance.removeLight(viewKey, key)

Arguments

• viewKey (ViewKey()) – None

• key (LightKey()) – None

Return type

void

replaceCuttingSection

Instance.replaceCuttingSection(cuttingPlanes, key)

Arguments

• cuttingPlanes ([Vector4]()) – None

• key (CuttingSectionKey()) – None

Return type

Promise <void>

requestGroups

Instance.requestGroups(groupIds, obtainDependentGroups)

Arguments

• groupIds (GroupIds()) – None

• obtainDependentGroups (boolean()) – None

Return type

Promise <void>

requestImages

Instance.requestImages(imageIds, wantThumbnails)

Arguments

• imageIds (ImageIds()) – None

• wantThumbnails (boolean()) – None

Return type

Promise <void>

requestMeshInstances

Instance.requestMeshInstances(incs, withMeshData, ignoreFailure)

Arguments

• incs (InstanceIncs()) – None

• withMeshData (boolean()) – None

• ignoreFailure (boolean()) – None

Return type

Promise <void>

requestMeshInstancesByGroup

Instance.requestMeshInstancesByGroup(groupId, withMeshData, expandGroups)

Arguments

• groupId (GroupIds()) – None

• withMeshData (boolean()) – None

• expandGroups (boolean()) – None

Return type

Promise <void>

resetExplode

Instance.resetExplode()

Return type

void

resetToEmpty

Instance.resetToEmpty(whitelistInstances, whitelistMeshes)

Arguments

• whitelistInstances ([InstanceKey]()) – None

• whitelistMeshes ([MeshKey]()) – None

Return type

Promise <void>

resumeCapping

Instance.resumeCapping()

Return type

void

resumeDrawing

Instance.resumeDrawing(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

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>

serverSideRendering

Instance.serverSideRendering()

Return type

boolean

setAmbientLightColor

Instance.setAmbientLightColor(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (Vector3()) – None

Return type

void

setAmbientOcclusionBias

Instance.setAmbientOcclusionBias(viewKey, bias)

Arguments

• viewKey (ViewKey()) – None

• bias (number()) – None

Return type

void

setAmbientOcclusionBlurInterval

Instance.setAmbientOcclusionBlurInterval(viewKey, interval)

Arguments

• viewKey (ViewKey()) – None

• interval (number()) – None

Return type

void

setAmbientOcclusionBlurSamples

Instance.setAmbientOcclusionBlurSamples(viewKey, samples)

Arguments

• viewKey (ViewKey()) – None

• samples (number()) – None

Return type

void

setAmbientOcclusionContrast

Instance.setAmbientOcclusionContrast(viewKey, contrast)

Arguments

• viewKey (ViewKey()) – None

• contrast (number()) – None

Return type

void

setAmbientOcclusionEdgeDistance

Instance.setAmbientOcclusionEdgeDistance(viewKey, distance)

Arguments

• viewKey (ViewKey()) – None

• distance (number()) – None

Return type

void

setAmbientOcclusionEnabled

Instance.setAmbientOcclusionEnabled(viewKey, enabled)

Arguments

• viewKey (ViewKey()) – None

• enabled (boolean()) – None

Return type

void

setAmbientOcclusionIntensity

Instance.setAmbientOcclusionIntensity(viewKey, intensity)

Arguments

• viewKey (ViewKey()) – None

• intensity (number()) – None

Return type

void

setAmbientOcclusionNoiseSize

Instance.setAmbientOcclusionNoiseSize(viewKey, size)

Arguments

• viewKey (ViewKey()) – None

• size (number()) – None

Return type

void

setAmbientOcclusionOpacity

Instance.setAmbientOcclusionOpacity(viewKey, opacity)

Arguments

• viewKey (ViewKey()) – None

• opacity (number()) – None

Return type

void

setAmbientOcclusionRadius

Instance.setAmbientOcclusionRadius(viewKey, radius)

Arguments

• viewKey (ViewKey()) – None

• radius (number()) – None

Return type

void

setAmbientOcclusionSamples

Instance.setAmbientOcclusionSamples(viewKey, samples)

Arguments

• viewKey (ViewKey()) – None

• samples (number()) – None

Return type

void

setAntiAliasingMode

Instance.setAntiAliasingMode(viewKey, antiAliasingMode)

Arguments

• viewKey (ViewKey()) – None

• antiAliasingMode (AntiAliasingMode()) – None

Return type

void

setBackFacesVisible

Instance.setBackFacesVisible(viewKey, visible)

Arguments

• viewKey (ViewKey()) – None

• visible (boolean()) – None

Return type

void

setBackgroundColor

Instance.setBackgroundColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setBackgroundGradient

Instance.setBackgroundGradient(viewKey, top, bottom)

Arguments

• viewKey (ViewKey()) – None

• top (Vector4()) – None

• bottom (Vector4()) – None

Return type

void

setBloomBlurInterval

Instance.setBloomBlurInterval(viewKey, layer, value, unit)

Arguments

• viewKey (ViewKey()) – None

• layer (number()) – None

• value (number()) – None

• unit (BlurIntervalUnit()) – None

Return type

void

setBloomBlurSamples

Instance.setBloomBlurSamples(viewKey, layer, value)

Arguments

• viewKey (ViewKey()) – None

• layer (number()) – None

• value (number()) – None

Return type

void

setBloomEnabled

Instance.setBloomEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setBloomIntensity

Instance.setBloomIntensity(viewKey, layer, value)

Arguments

• viewKey (ViewKey()) – None

• layer (number()) – None

• value (number()) – None

Return type

void

setBloomIntensityScale

Instance.setBloomIntensityScale(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setBloomLayerCount

Instance.setBloomLayerCount(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setBloomThreshold

Instance.setBloomThreshold(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setBloomThresholdRampWidth

Instance.setBloomThresholdRampWidth(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setBoundingDebugLevel

Instance.setBoundingDebugLevel(viewKey, level)

Arguments

• viewKey (ViewKey()) – None

• level (number()) – None

Return type

void

setBoundingPreviewColor

Instance.setBoundingPreviewColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setBoundingPreviewEjected

Instance.setBoundingPreviewEjected(points, viewKey)

Arguments

• points ([Vector3]()) – None

• viewKey (ViewKey()) – None

Return type

void

setBoundingPreviewEjectedColor

Instance.setBoundingPreviewEjectedColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setBoundingPreviewTested

Instance.setBoundingPreviewTested(points, viewKey)

Arguments

• points ([Vector3]()) – None

• viewKey (ViewKey()) – None

Return type

void

setBoundingPreviewTestedColor

Instance.setBoundingPreviewTestedColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setBoundingPreviewUnderdraw

Instance.setBoundingPreviewUnderdraw(points, viewKey)

Arguments

• points ([Vector3]()) – None

• viewKey (ViewKey()) – None

Return type

void

setBoundingPreviewUnderdrawColor

Instance.setBoundingPreviewUnderdrawColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setCamera

Instance.setCamera(viewKey, camera)

Arguments

• viewKey (ViewKey()) – None

• camera (Camera()) – None

Return type

void

setCappingIdleHookEnabled

Instance.setCappingIdleHookEnabled(enable)

Arguments

• enable (boolean()) – None

Return type

Promise <boolean>

setClumpingEnabled

Instance.setClumpingEnabled(value)

Arguments

• value (boolean()) – None

Return type

void

setComparisonColors

Instance.setComparisonColors(viewKey, sameColor, only1Color, only2Color)

Arguments

• viewKey (ViewKey()) – None

• sameColor (Vector3()) – None

• only1Color (Vector3()) – None

• only2Color (Vector3()) – None

Return type

void

setCurrentView

Instance.setCurrentView(viewKey, view)

Arguments

• viewKey (ViewKey()) – None

• view (ViewKey()) – None

Return type

void

setDefaultDepthRange

Instance.setDefaultDepthRange(viewKey, min, max)

Arguments

• viewKey (ViewKey()) – None

• min (number()) – None

• max (number()) – None

Return type

void

setDefaultGloss

Instance.setDefaultGloss(viewKey, gloss)

Arguments

• viewKey (ViewKey()) – None

• gloss (number()) – None

Return type

void

setDefaultMirror

Instance.setDefaultMirror(viewKey, mirror)

Arguments

• viewKey (ViewKey()) – None

• mirror (number()) – None

Return type

void

setDefaultSpecularMix

Instance.setDefaultSpecularMix(viewKey, mix)

Arguments

• viewKey (ViewKey()) – None

• mix (number()) – None

Return type

void

setDefaultSphereMap

Instance.setDefaultSphereMap(viewKey, imageId)

Arguments

• viewKey (ViewKey()) – None

• imageId (ImageId()) – None

Return type

void

setDisplayIncompleteFrames

Instance.setDisplayIncompleteFrames(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setDrawIdleDelay

Instance.setDrawIdleDelay(viewKey, delay)

Arguments

• viewKey (ViewKey()) – None

• delay (number()) – None

Return type

void

setDrawMode

Instance.setDrawMode(viewKey, drawMode)

Arguments

• viewKey (ViewKey()) – None

• drawMode (DrawMode()) – None

Return type

void

setDrawStrategy

Instance.setDrawStrategy(viewKey, strategy)

Arguments

• viewKey (ViewKey()) – None

• strategy (DrawStrategy()) – None

Return type

void

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

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

Instance.setEventHandler(eventName, callback)

Arguments

• eventName (bounding()) – None

• callback (function()) – None

Return type

void

Instance.callback(eventName)

Arguments

• eventName (string()) – None

Return type

void

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

setEyeDomeLightingBlurEdgeDistance

Instance.setEyeDomeLightingBlurEdgeDistance(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setEyeDomeLightingBlurInterval

Instance.setEyeDomeLightingBlurInterval(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setEyeDomeLightingBlurSamples

Instance.setEyeDomeLightingBlurSamples(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setEyeDomeLightingEnabled

Instance.setEyeDomeLightingEnabled(viewKey, enabled)

Arguments

• viewKey (ViewKey()) – None

• enabled (boolean()) – None

Return type

void

setEyeDomeLightingOpacity

Instance.setEyeDomeLightingOpacity(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setEyeDomeLightingShadingEdgeDistance

Instance.setEyeDomeLightingShadingEdgeDistance(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setFaceWindingFlipped

Instance.setFaceWindingFlipped(viewKey, flipped)

Arguments

• viewKey (ViewKey()) – None

• flipped (boolean()) – None

Return type

void

setFacesVisible

Instance.setFacesVisible(viewKey, visible)

Arguments

• viewKey (ViewKey()) – None

• visible (boolean()) – None

Return type

void

setFixedDrawLimit

Instance.setFixedDrawLimit(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setFrontFacesVisible

Instance.setFrontFacesVisible(viewKey, visible)

Arguments

• viewKey (ViewKey()) – None

• visible (boolean()) – None

Return type

void

setGoochBaseColorProminence

Instance.setGoochBaseColorProminence(viewKey, prominence)

Arguments

• viewKey (ViewKey()) – None

• prominence (number()) – None

Return type

void

setGoochBlue

Instance.setGoochBlue(viewKey, blue)

Arguments

• viewKey (ViewKey()) – None

• blue (number()) – None

Return type

void

setGoochLuminanceShiftStrength

Instance.setGoochLuminanceShiftStrength(viewKey, shiftStrength)

Arguments

• viewKey (ViewKey()) – None

• shiftStrength (number()) – None

Return type

void

setGoochYellow

Instance.setGoochYellow(viewKey, yellow)

Arguments

• viewKey (ViewKey()) – None

• yellow (number()) – None

Return type

void

setGroundPlane

Instance.setGroundPlane(viewKey, normal)

Arguments

• viewKey (ViewKey()) – None

• normal (Vector3()) – None

Return type

void

setGroundPlaneWithPosition

Instance.setGroundPlaneWithPosition(viewKey, normal[, position])

Arguments

• viewKey (ViewKey()) – None

• normal (Vector3()) – None

• position (Vector3()) – optional None

Return type

void

setHardEdgeColor

Instance.setHardEdgeColor(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (Vector3()) – None

Return type

void

setHardEdgeOpacity

Instance.setHardEdgeOpacity(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setHardEdgeThreshold

Instance.setHardEdgeThreshold(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setHardEdgeThresholdRampWidth

Instance.setHardEdgeThresholdRampWidth(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setHardEdgesEnabled

Instance.setHardEdgesEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setHiddenLineHiddenLineColor

Instance.setHiddenLineHiddenLineColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHiddenLineHighlightedElementFillColor

Instance.setHiddenLineHighlightedElementFillColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHiddenLineHighlightedElementOutlineColor

Instance.setHiddenLineHighlightedElementOutlineColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHiddenLineHighlightedInstanceFillColor

Instance.setHiddenLineHighlightedInstanceFillColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHiddenLineHighlightedInstanceOutlineColor

Instance.setHiddenLineHighlightedInstanceOutlineColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHiddenLineVisibleLineColor

Instance.setHiddenLineVisibleLineColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHighlightColorizeCompression

Instance.setHighlightColorizeCompression(viewKey, compressionLevel)

Arguments

• viewKey (ViewKey()) – None

• compressionLevel (number()) – None

Return type

void

setHighlightMode

Instance.setHighlightMode(viewKey, highlightMode)

Arguments

• viewKey (ViewKey()) – None

• highlightMode (HighlightMode()) – None

Return type

void

setHighlightedElementColor

Instance.setHighlightedElementColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHighlightedElementFilter

Instance.setHighlightedElementFilter(viewKey, highlightedFilter)

Arguments

• viewKey (ViewKey()) – None

• highlightedFilter (HighlightFilter()) – None

Return type

void

setHighlightedElementOutlineColor

Instance.setHighlightedElementOutlineColor(viewKey, highlightedOutlineColor)

Arguments

• viewKey (ViewKey()) – None

• highlightedOutlineColor (Vector4()) – None

Return type

void

setHighlightedInstanceColor

Instance.setHighlightedInstanceColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setHighlightedInstanceFilter

Instance.setHighlightedInstanceFilter(viewKey, highlightedFilter)

Arguments

• viewKey (ViewKey()) – None

• highlightedFilter (HighlightFilter()) – None

Return type

void

setHighlightedInstanceOutlineColor

Instance.setHighlightedInstanceOutlineColor(viewKey, highlightedOutlineColor)

Arguments

• viewKey (ViewKey()) – None

• highlightedOutlineColor (Vector4()) – None

Return type

void

setImageBasedLightingEnabled

Instance.setImageBasedLightingEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setImageBasedLightingEnvironment

Instance.setImageBasedLightingEnvironment(viewKey, data)

Arguments

• viewKey (ViewKey()) – None

• data (Uint8Array()) – None

Return type

void

setImageBasedLightingEnvironmentToDefault

Instance.setImageBasedLightingEnvironmentToDefault(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

setImageBasedLightingIntensity

Instance.setImageBasedLightingIntensity(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setImageBasedLightingMatrix

Instance.setImageBasedLightingMatrix(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (Matrix9()) – None

Return type

void

setInstancingEnabled

Instance.setInstancingEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setInteractiveDrawLimitIncreaseEnabled

Instance.setInteractiveDrawLimitIncreaseEnabled(viewKey, enable)

Arguments

• viewKey (ViewKey()) – None

• enable (boolean()) – None

Return type

void

setInteractiveDrawLimitIncreaseInterval

Instance.setInteractiveDrawLimitIncreaseInterval(viewKey, milliseconds)

Arguments

• viewKey (ViewKey()) – None

• milliseconds (number()) – None

Return type

void

setLightingEnabled

Instance.setLightingEnabled(viewKey, enabled)

Arguments

• viewKey (ViewKey()) – None

• enabled (boolean()) – None

Return type

void

setLineJitterEnabled

Instance.setLineJitterEnabled(viewKey, enabled)

Arguments

• viewKey (ViewKey()) – None

• enabled (boolean()) – None

Return type

void

setLineJitterFrequency

Instance.setLineJitterFrequency(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setLineJitterInstanceCount

Instance.setLineJitterInstanceCount(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setLineJitterRadius

Instance.setLineJitterRadius(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setLinesVisible

Instance.setLinesVisible(viewKey, visible)

Arguments

• viewKey (ViewKey()) – None

• visible (boolean()) – None

Return type

void

setMeshLevel

Instance.setMeshLevel(incs, level)

Arguments

• incs (InstanceIncs()) – None

• level (number()) – None

Return type

void

setMetallicRoughnessMaterialOverride

Instance.setMetallicRoughnessMaterialOverride(defaultMetallicFactor, defaultRoughnessFactor)

Arguments

• defaultMetallicFactor (number()) – None

• defaultRoughnessFactor (number()) – None

Return type

void

setMinDrawLimit

Instance.setMinDrawLimit(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setMinFrameRate

Instance.setMinFrameRate(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setMinIncrementalFrameRate

Instance.setMinIncrementalFrameRate(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setMinInteractiveFrameRate

Instance.setMinInteractiveFrameRate(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setPointShape

Instance.setPointShape(viewKey, shape)

Arguments

• viewKey (ViewKey()) – None

• shape (PointShape()) – None

Return type

void

setPointSize

Instance.setPointSize(viewKey, size, unit)

Arguments

• viewKey (ViewKey()) – None

• size (number()) – None

• unit (PointSizeUnit()) – None

Return type

void

setPointVisibilityTest

Instance.setPointVisibilityTest(points, viewKey)

Arguments

• points ([Vector3]()) – None

• viewKey (ViewKey()) – None

Return type

void

setPointsVisible

Instance.setPointsVisible(viewKey, visible)

Arguments

• viewKey (ViewKey()) – None

• visible (boolean()) – None

Return type

void

setPostInputDelay

Instance.setPostInputDelay(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSilhouetteColor

Instance.setSilhouetteColor(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (Vector3()) – None

Return type

void

setSilhouetteEnabled

Instance.setSilhouetteEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setSilhouetteOpacity

Instance.setSilhouetteOpacity(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSilhouetteThreshold

Instance.setSilhouetteThreshold(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSilhouetteThresholdRampWidth

Instance.setSilhouetteThresholdRampWidth(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSimpleReflectionAttenuation

Instance.setSimpleReflectionAttenuation(viewKey, nearDistance, farDistance, unit)

Arguments

• viewKey (ViewKey()) – None

• nearDistance (number()) – None

• farDistance (number()) – None

• unit (SimpleReflectionAttenuationUnit()) – None

Return type

void

setSimpleReflectionBlurInterval

Instance.setSimpleReflectionBlurInterval(viewKey, value, unit)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

• unit (BlurIntervalUnit()) – None

Return type

void

setSimpleReflectionBlurSamples

Instance.setSimpleReflectionBlurSamples(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSimpleReflectionEnabled

Instance.setSimpleReflectionEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setSimpleReflectionFadeAngle

Instance.setSimpleReflectionFadeAngle(viewKey, degrees)

Arguments

• viewKey (ViewKey()) – None

• degrees (number()) – None

Return type

void

setSimpleReflectionOpacity

Instance.setSimpleReflectionOpacity(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSimpleShadowBlurInterval

Instance.setSimpleShadowBlurInterval(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSimpleShadowBlurSamples

Instance.setSimpleShadowBlurSamples(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSimpleShadowColor

Instance.setSimpleShadowColor(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (Vector3()) – None

Return type

void

setSimpleShadowEnabled

Instance.setSimpleShadowEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setSimpleShadowInteractiveUpdateEnabled

Instance.setSimpleShadowInteractiveUpdateEnabled(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (boolean()) – None

Return type

void

setSimpleShadowOpacity

Instance.setSimpleShadowOpacity(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (number()) – None

Return type

void

setSimpleShadowResolution

Instance.setSimpleShadowResolution(viewKey, pixels)

Arguments

• viewKey (ViewKey()) – None

• pixels (number()) – None

Return type

void

setSsrQuality

Instance.setSsrQuality(opts)

Arguments

• opts (SsrQualityConfig()) – None

Return type

void

setStreamCutoffScale

Instance.setStreamCutoffScale(value)

Arguments

• value (number()) – None

Return type

void

setStreamIdleMarker

Instance.setStreamIdleMarker()

Return type

Promise <void>

setToonBandCount

Instance.setToonBandCount(viewKey, bandCount)

Arguments

• viewKey (ViewKey()) – None

• bandCount (number()) – None

Return type

void

setToonSpecularFactor

Instance.setToonSpecularFactor(viewKey, specularFactor)

Arguments

• viewKey (ViewKey()) – None

• specularFactor (number()) – None

Return type

void

setTransparencyMode

Instance.setTransparencyMode(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (TransparencyMode()) – None

Return type

void

setUnhighlightedColor

Instance.setUnhighlightedColor(viewKey, color)

Arguments

• viewKey (ViewKey()) – None

• color (Vector4()) – None

Return type

void

setUnhighlightedFilter

Instance.setUnhighlightedFilter(viewKey, highlightedFilter)

Arguments

• viewKey (ViewKey()) – None

• highlightedFilter (HighlightFilter()) – None

Return type

void

setVisibilityByAttachment

Instance.setVisibilityByAttachment(attachScope, setVisibility)

Arguments

• attachScope (AttachScope()) – None

• setVisibility (SetVisibility()) – None

Return type

void

setXRayMaterial

Instance.setXRayMaterial(viewKey, group, element, color)

Arguments

• viewKey (ViewKey()) – None

• group (XRayGroup()) – None

• element (ElementType()) – None

• color (Vector4()) – None

Return type

void

setXRayOpacity

Instance.setXRayOpacity(viewKey, element, value)

Arguments

• viewKey (ViewKey()) – None

• element (ElementType()) – None

• value (number()) – None

Return type

void

setXRayTransparencyMode

Instance.setXRayTransparencyMode(viewKey, value)

Arguments

• viewKey (ViewKey()) – None

• value (TransparencyMode()) – None

Return type

void

shutDown

Instance.shutDown()

Return type

void

startComparison

Instance.startComparison(viewKey, instanceSet1, instanceSet2)

Arguments

• viewKey (ViewKey()) – None

• instanceSet1 (InstanceIncs()) – None

• instanceSet2 (InstanceIncs()) – None

Return type

void

startExplode

Instance.startExplode(incs, center)

Arguments

• incs (InstanceIncs()) – None

• center (Vector3()) – None

Return type

void

suspendDrawing

Instance.suspendDrawing(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

testPointVisibility

Instance.testPointVisibility(points, viewKey)

Arguments

• points ([Vector3]()) – None

• viewKey (ViewKey()) – None

Return type

Promise <[number]>

throttleLoad

Instance.throttleLoad(newPauseInterval, throttleDuration)

Arguments

• newPauseInterval (number()) – None

• throttleDuration (number()) – None

Return type

void

triangulatePolygon

Instance.triangulatePolygon(polygonPoints, normal)

Arguments

• polygonPoints (Float32Array | [number]()) – None

• normal (Vector3()) – None

Return type

[number]

truncateMetaData

Instance.truncateMetaData(dataIds)

Arguments

• dataIds (DataIds()) – None

Return type

Promise <void>

unsetAllColors

Instance.unsetAllColors()

Return type

void

unsetAllHighlighted

Instance.unsetAllHighlighted()

Return type

void

unsetAllOpacity

Instance.unsetAllOpacity()

Return type

void

unsetAllXRay

Instance.unsetAllXRay()

Return type

void

unsetCurrentView

Instance.unsetCurrentView(viewKey)

Arguments

• viewKey (ViewKey()) – None

Return type

void

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

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

Instance.unsetEventHandler(eventName, callback)

Arguments

• eventName (bounding()) – None

• callback (function()) – None

Return type

void

Instance.callback(eventName)

Arguments

• eventName (string()) – None

Return type

void

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

unsetXRayMaterial

Instance.unsetXRayMaterial(viewKey, group, element)

Arguments

• viewKey (ViewKey()) – None

• group (XRayGroup()) – None

• element (ElementType()) – None

Return type

Promise <void>

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

waitForImageDecoding

Instance.waitForImageDecoding()

Return type

Promise <void>

worldSelectByRay

Instance.worldSelectByRay(viewKey, ray, config)

Arguments

• viewKey (ViewKey()) – None

• ray (IRay()) – None

• config (RaySelectionConfig()) – None

Return type

Promise <PickResult>