ScEngine

class ScEngine()

Constructors

constructor()

Methods

_getScPlaneArray()
_toTextureInterpolation()
_toTextureMipMapping()
_toTextureModifier()
_toTextureParameterization()
_toTextureTiling()
addCuttingSection()
addLight()
addNodesToOverlay()
addPointLight()
addView()
advanceExportToSvg()
advanceIncrementalSelection()
attachModel()
attachScsBuffer()
attachScsModelByKey()
beginConvexPolyhedronSelection()
beginExportToSvg()
beginRayDrillSelection()
beginRequestBatch()
beginScreenAreaSelection()
beginSphereSelection()
clearElementVisibility()
clearHighlight()
clearLights()
compositePickFromScreen()
computeMinimumBodyBodyDistance()
computeMinimumFaceLineDistance()
computeMinimumFaceRayDistance()
computeMininimumFaceFaceDistance()
createFloorplanMesh()
createIdentityMatrix()
createImage()
createMatrix()
createMesh()
createMeshInstance()
debug_log()
debug_stateFailure()
debug_sync()
delayCapping()
destroyImages()
destroyLocalInstances()
destroyMeshes()
destroyOverlay()
detachInclusions()
disconnectNetwork()
enableCappingIdleCallback()
enableHiddenLineRendering()
endComparison()
endIncrementalSelection()
endRequestBatch()
exportToSvg()
feedScsBuffer()
flushMetaDataCache()
getAllowHighDpi()
getBounding()
getCamera()
getCameraPromise()
getCanvasSize()
getCappedInstances()
getCappingGeometryVisibility()
getClientDimensions()
getCullingVector()
getCuttingSectionLimits()
getDataFromIds()
getDrawnPartsBounding()
getEffectiveElementColor()
getEffectivePartColor()
getEffectivePartOpacity()
getElementColor()
getElementHighlighted()
getEyeDomeLightingBlurEdgeDistance()
getEyeDomeLightingBlurInterval()
getEyeDomeLightingBlurSamples()
getEyeDomeLightingEnabled()
getEyeDomeLightingOpacity()
getEyeDomeLightingShadingEdgeDistance()
getFullCameraMatrix()
getInstancesCappingMeshData()
getInstancesMeshData()
getInteractiveDrawLimitIncreaseEnabled()
getLight()
getLightKeys()
getLooseBounding()
getMaxOverlayIndex()
getMeshData()
getMetallicRoughness()
getMinimumFramerate()
getModelBounding()
getNetworkModelName()
getPartAmbientColor()
getPartColor()
getPartEffectiveAmbientColor()
getPartEffectiveEmissiveColor()
getPartEffectiveSpecularColor()
getPartEmissiveColor()
getPartHasTransparency()
getPartHighlighted()
getPartMaterial()
getPartOpacity()
getPartSpecularColor()
getPartsBounding()
getPickTolerance()
getPointShape()
getPointSize()
getPrimaryModelKey()
getProjectionMatrix()
getRendererType()
getScsInfo()
getSessionType()
getStatistics()
getStreamCutoffScale()
getVersionString()
getViewMatrix()
hasDepthRange()
highlightElements()
highlightParts()
instanceKeyInfo()
isInit()
loadEmpty()
loadFinished()
logMessage()
loseWebGlContext()
markCameraAsEmpty()
metaDataKeyInfo()
modelKeysFromInclusionKeys()
pauseAllRendering()
pauseRendering()
pickAllFromRay()
pickAllFromScreen()
pickFromRay()
pickFromScreen()
redraw()
registerBimInstances()
removeAllCuttingSections()
removeCuttingSection()
removeLight()
removeView()
replaceMesh()
requestMeshInstances()
resetCachedStatistics()
resetColors()
resetOpacity()
resetPartMaterial()
resetToEmpty()
resize()
resumeAllRendering()
resumeRendering()
safeGetMetaData()
safeGetMetaDatas()
safeLoadMetaDatas()
setAllowHighDpi()
setAmbientLightColor()
setAmbientOcclusionEnabled()
setAmbientOcclusionRadius()
setAntiAliasingMode()
setBackFacesVisible()
setBackgroundGradient()
setBloomEnabled()
setBloomIntensityScale()
setBloomLayers()
setBloomThreshold()
setBloomThresholdRampWidth()
setBoundingDebugLevel()
setBoundingPreviewEjected()
setBoundingPreviewEjectedColor()
setBoundingPreviewTested()
setBoundingPreviewTestedColor()
setBoundingPreviewUnderDraw()
setBoundingPreviewUnderDrawColor()
setCamera()
setCappingDelay()
setCappingFaceColor()
setCappingGeometryVisibility()
setCappingLineColor()
setCullingVector()
setDefaultDepthRange()
setDepthRange()
setDisplayIncompleteFrames()
setDrawMode()
setDrawStrategy()
setElementColor()
setElementHighlightColor()
setElementVisibility()
setExplodeMagnitude()
setEyeDomeLightingBlurEdgeDistance()
setEyeDomeLightingBlurInterval()
setEyeDomeLightingBlurSamples()
setEyeDomeLightingEnabled()
setEyeDomeLightingOpacity()
setEyeDomeLightingShadingEdgeDistance()
setFaceVisibility()
setGoochBaseColorProminence()
setGoochBlue()
setGoochLuminanceShiftStrength()
setGoochYellow()
setGroundPlane()
setHardEdgeColor()
setHardEdgeOpacity()
setHardEdgeThreshold()
setHardEdgeThresholdRampWidth()
setHardEdgesEnabled()
setHighlightColorizeCompression()
setImageBasedLightingEnabled()
setImageBasedLightingEnvironment()
setImageBasedLightingEnvironmentToDefault()
setImageBasedLightingIntensity()
setImageBasedLightingMatrix()
setInstanceModifier()
setInstancesMatrix()
setInteractiveDrawDelay()
setInteractiveDrawLimitIncreaseEnabled()
setLightingEnabled()
setLineJitterEnabled()
setLineJitterFrequency()
setLineJitterInstanceCount()
setLineJitterRadius()
setLinePattern()
setLineVisibility()
setMatrices()
setMeshLevel()
setMetallicRoughness()
setMetallicRoughnessMaterialOverride()
setMinimumFramerate()
setNodeHighlightColor()
setOverlayCamera()
setOverlayViewport()
setOverlayVisibility()
setPartAmbientColor()
setPartAmbientMix()
setPartColor()
setPartEmissiveColor()
setPartMaterial()
setPartOpacity()
setPartSpecularColor()
setPartSpecularIntensity()
setPartVisibility()
setPickTolerance()
setPointShape()
setPointSize()
setPointVisibilityTest()
setProjection()
setRemoteEndpoint()
setServerRenderQuality()
setSilhouetteColor()
setSilhouetteEnabled()
setSilhouetteOpacity()
setSilhouetteThreshold()
setSilhouetteThresholdRampWidth()
setSimpleReflectionAttenuation()
setSimpleReflectionBlurInterval()
setSimpleReflectionBlurSamples()
setSimpleReflectionEnabled()
setSimpleReflectionFadeAngle()
setSimpleReflectionOpacity()
setSimpleShadowBlurInterval()
setSimpleShadowBlurSamples()
setSimpleShadowColor()
setSimpleShadowEnabled()
setSimpleShadowInteractiveUpdateEnabled()
setSimpleShadowOpacity()
setSimpleShadowResolution()
setStreamCutoffScale()
setStreamIdleMarker()
setTexture()
setTimeout()
setToonShadingBandCount()
setToonShadingSpecularFactor()
setTransparencyMode()
setVisibilityByAttachment()
setXRayColor()
setXRayOpacity()
setXRayTransparencyMode()
shutdown()
sleep()
start()
startComparison()
startExplode()
stopExplode()
synchronizeVisibilities()
testPointVisibility()
throttleLoad()
triangulatePolygon()
unsetCullingVector()
unsetDepthRange()
unsetElementColor()
unsetLinePattern()
unsetMetallicRoughness()
unsetPartAmbientColor()
unsetPartColor()
unsetPartEmissiveColor()
unsetPartOpacity()
unsetPartSpecularColor()
unsetPartSpecularIntensity()
unsetTexture()
unsetXRayColor()
updateCamera()
updateCuttingSection()
updateLight()
waitForImageDecoding()

Constructors

ScEngine.constructor(callbackManager, options)

Arguments:	callbackManager (`ICallbackManager()`) – None options (`WebViewerConfig()`) – None
Return type:	`ScEngine()`

Methods

_getScPlaneArray

ScEngine._getScPlaneArray(cuttingSection)

Arguments:	cuttingSection (`ICuttingSection()`) – None
Return type:	[Vector4]

_toTextureInterpolation

ScEngine._toTextureInterpolation(value)

Arguments:	value (`boolean \| undefined()`) – None
Return type:	ScTextureInterpolation

_toTextureMipMapping

ScEngine._toTextureMipMapping(value)

Arguments:	value (`boolean \| undefined()`) – None
Return type:	ScTextureMipMapping

_toTextureModifier

ScEngine._toTextureModifier(value)

Arguments:	value (`number \| undefined()`) – None
Return type:	ScTextureModifier

_toTextureParameterization

ScEngine._toTextureParameterization(value)

Arguments:	value (TextureParameterization \| undefined) – None
Return type:	ScTextureParameterization

_toTextureTiling

ScEngine._toTextureTiling(value)

Arguments:	value (TextureTiling \| undefined) – None
Return type:	ScTextureTiling

addCuttingSection

ScEngine.addCuttingSection(cuttingSection)

Arguments:	cuttingSection (`ICuttingSection()`) – None
Return type:	Promise <void>

addLight

ScEngine.addLight(view_key, light)

Arguments:	view_key (`ViewKey()`) – None light (`Light()`) – None
Return type:	Promise <LightKey>

addNodesToOverlay

ScEngine.addNodesToOverlay(incs, viewKey, index)

Arguments:	incs (`InstanceIncs()`) – None viewKey (`ViewKey()`) – None index (`OverlayIndex()`) – None
Return type:	void

addPointLight

ScEngine.addPointLight(view_key, light)

Arguments:	view_key (`ViewKey()`) – None light (`PointLight()`) – None
Return type:	Promise <LightKey>

addView

ScEngine.addView(canvasContainer)

Arguments:	canvasContainer (`HTMLDivElement()`) – None
Return type:	Promise <ViewKey>

advanceExportToSvg

ScEngine.advanceExportToSvg()

Return type:	Promise <string \| undefined>

advanceIncrementalSelection

ScEngine.advanceIncrementalSelection(handle)

Arguments:	handle (`IncrementalSelectionId()`) – None
Return type:	Promise <[`SelectionItem()`] \| null>

attachModel

ScEngine.attachModel(attachScope, modelName, inclusionMatrix, attachMeasurementUnit, attachInvisibly)

Arguments:	attachScope (`AttachScope()`) – None modelName (`ScModelName()`) – None inclusionMatrix (`Matrix12()`) – None attachMeasurementUnit (`number()`) – None attachInvisibly (`boolean()`) – None
Return type:	Promise <void>

attachScsBuffer

ScEngine.attachScsBuffer(attachScope, buffer, inclusionMatrix, attachMeasurementUnit, attachInvisibly, resolveOnFullyLoaded, cancelUnitMatrix, autoUnitScale)

Arguments:	attachScope (`AttachScope()`) – None buffer (`ScsBuffer()`) – None inclusionMatrix (`Matrix12()`) – None attachMeasurementUnit (`number()`) – None attachInvisibly (`boolean()`) – None resolveOnFullyLoaded (`boolean()`) – None cancelUnitMatrix (`boolean()`) – None autoUnitScale (`boolean()`) – None
Return type:	Promise <void>

attachScsModelByKey

ScEngine.attachScsModelByKey(attachScope, modelKey, inclusionMatrix, attachMeasurementUnit, attachInvisibly)

Arguments:	attachScope (`AttachScope()`) – None modelKey (`ModelKey()`) – None inclusionMatrix (`Matrix12()`) – None attachMeasurementUnit (`number()`) – None attachInvisibly (`boolean()`) – None
Return type:	InclusionKey

beginConvexPolyhedronSelection

ScEngine.beginConvexPolyhedronSelection(volumePlanes, heuristicOrigin, config)

Arguments:	volumePlanes ([Plane]) – None heuristicOrigin (`Point3()`) – None config (`IncrementalPickConfig()`) – None
Return type:	Promise <`IncrementalSelectionId()`>

beginExportToSvg

ScEngine.beginExportToSvg(config)

Arguments:	config (`SvgConfig()`) – None
Return type:	Promise <void>

beginRayDrillSelection

ScEngine.beginRayDrillSelection(viewKey, rayCssOrigin, rayCssBoxRadius, config)

Arguments:	viewKey (`ViewKey()`) – None rayCssOrigin (`Point2()`) – None rayCssBoxRadius (`number()`) – None config (`IncrementalPickConfig()`) – None
Return type:	Promise <`IncrementalSelectionId()`>

beginRequestBatch

ScEngine.beginRequestBatch(type)

Arguments:	type (RequestBatchType) – None
Return type:	void

beginScreenAreaSelection

ScEngine.beginScreenAreaSelection(viewKey, areaCssMin, areaCssMax, config)

Arguments:	viewKey (`ViewKey()`) – None areaCssMin (`Point2()`) – None areaCssMax (`Point2()`) – None config (`IncrementalPickConfig()`) – None
Return type:	Promise <`IncrementalSelectionId()`>

beginSphereSelection

ScEngine.beginSphereSelection(sphereCenter, sphereRadius, config)

Arguments:	sphereCenter (Vector3) – None sphereRadius (`number()`) – None config (`IncrementalPickConfig()`) – None
Return type:	Promise <`IncrementalSelectionId()`>

clearElementVisibility

ScEngine.clearElementVisibility(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	void

clearHighlight

ScEngine.clearHighlight()

Return type:	void

clearLights

ScEngine.clearLights(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	void

compositePickFromScreen

ScEngine.compositePickFromScreen(viewKey, point, config, isDrawing)

Arguments:	viewKey (`ViewKey()`) – None point (`Point2()`) – None config (`PickConfig()`) – None isDrawing (`boolean()`) – None
Return type:	Promise <`CompositeSelectionItem()`>

computeMinimumBodyBodyDistance

ScEngine.computeMinimumBodyBodyDistance(inc1, inc2)

Arguments:	inc1 (`InstanceInc()`) – None inc2 (`InstanceInc()`) – None
Return type:	Promise <`FaceFaceDistanceItem()`>

computeMinimumFaceLineDistance

ScEngine.computeMinimumFaceLineDistance(inc, faceId, ray)

Arguments:	inc (`InstanceInc()`) – None faceId (`number()`) – None ray (`Ray()`) – None
Return type:	Promise <`FaceFaceDistanceItem()`>

computeMinimumFaceRayDistance

ScEngine.computeMinimumFaceRayDistance(inc, faceId, ray)

Arguments:	inc (`InstanceInc()`) – None faceId (`number()`) – None ray (`Ray()`) – None
Return type:	Promise <`FaceFaceDistanceItem()`>

computeMininimumFaceFaceDistance

ScEngine.computeMininimumFaceFaceDistance(inc1, face1, inc2, face2)

Arguments:	inc1 (`InstanceInc()`) – None face1 (`number()`) – None inc2 (`InstanceInc()`) – None face2 (`number()`) – None
Return type:	Promise <`FaceFaceDistanceItem()`>

createFloorplanMesh

ScEngine.createFloorplanMesh(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <InstanceIncs>

createIdentityMatrix

ScEngine.createIdentityMatrix()

Return type:	Promise <MatrixInc>

createImage

ScEngine.createImage(primaryImage[, thumbnailImage])

Arguments:	primaryImage (`ImageOptions()`) – None thumbnailImage (`ImageOptions()`) – optional None
Return type:	Promise <ImageId>

createMatrix

ScEngine.createMatrix(elements)

Arguments:	elements (`Matrix16()`) – None
Return type:	Promise <MatrixInc>

createMesh

ScEngine.createMesh(meshData)

Arguments:	meshData (`MeshData()`) – None
Return type:	Promise <MeshId>

createMeshInstance

ScEngine.createMeshInstance(meshInstanceData)

Arguments:	meshInstanceData (`MeshInstanceData()`) – None
Return type:	Promise <InstanceInc>

debug_log

ScEngine.debug_log(message)

Arguments:	message (`string()`) – None
Return type:	Promise <void>

debug_stateFailure

ScEngine.debug_stateFailure(value)

Arguments:	value (`StateFailure()`) – None
Return type:	Promise <void>

debug_sync

ScEngine.debug_sync()

Return type:	Promise <void>

delayCapping

ScEngine.delayCapping()

Return type:	void

destroyImages

ScEngine.destroyImages(imageIds)

Arguments:	imageIds (`ImageIds()`) – None
Return type:	Promise <void>

destroyLocalInstances

ScEngine.destroyLocalInstances(instanceIncs)

Arguments:	instanceIncs (`InstanceIncs()`) – None
Return type:	Promise <void>

destroyMeshes

ScEngine.destroyMeshes(meshIds)

Arguments:	meshIds (`MeshIds()`) – None
Return type:	Promise <void>

destroyOverlay

ScEngine.destroyOverlay(index, viewKey)

Arguments:	index (`OverlayIndex()`) – None viewKey (`ViewKey()`) – None
Return type:	void

detachInclusions

ScEngine.detachInclusions(inclusionKeys)

Arguments:	inclusionKeys (`[InclusionKey]()`) – None
Return type:	Promise <void>

disconnectNetwork

ScEngine.disconnectNetwork()

Return type:	void

enableCappingIdleCallback

ScEngine.enableCappingIdleCallback(enable)

Arguments:	enable (`boolean()`) – None
Return type:	Promise <boolean>

enableHiddenLineRendering

ScEngine.enableHiddenLineRendering(view_key, settings)

Arguments:	view_key (`ViewKey()`) – None settings (`HiddenLineSettings()`) – None
Return type:	void

endComparison

ScEngine.endComparison(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	void

endIncrementalSelection

ScEngine.endIncrementalSelection(handle)

Arguments:	handle (`IncrementalSelectionId()`) – None
Return type:	void

endRequestBatch

ScEngine.endRequestBatch(type)

Arguments:	type (RequestBatchType) – None
Return type:	void

exportToSvg

ScEngine.exportToSvg(config)

Arguments:	config (`SvgConfig()`) – None
Return type:	Promise <string>

feedScsBuffer

ScEngine.feedScsBuffer(attachScope, buffer)

Arguments:	attachScope (`AttachScope()`) – None buffer (`ScsBuffer \| null()`) – None
Return type:	void

flushMetaDataCache

ScEngine.flushMetaDataCache()

Return type:	void

getAllowHighDpi

ScEngine.getAllowHighDpi()

Return type:	boolean

getBounding

ScEngine.getBounding(incs, ignoreInvisible, includeExcluded, tightBounding)

Arguments:	incs (`InstanceIncs()`) – None ignoreInvisible (`boolean()`) – None includeExcluded (`boolean()`) – None tightBounding (`boolean()`) – None
Return type:	Promise <Box>

getCamera

ScEngine.getCamera(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	`Camera()`

getCameraPromise

ScEngine.getCameraPromise(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	Promise <`Camera()`>

getCanvasSize

ScEngine.getCanvasSize(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	Point2

getCappedInstances

ScEngine.getCappedInstances()

Return type:	Promise <InstanceIncs>

getCappingGeometryVisibility

ScEngine.getCappingGeometryVisibility()

Return type:	boolean

getClientDimensions

ScEngine.getClientDimensions(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	(number, number)

getCullingVector

ScEngine.getCullingVector(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <[`CullingVector()`]>

getCuttingSectionLimits

ScEngine.getCuttingSectionLimits()

Return type:	`CuttingSectionLimits()`

getDataFromIds

ScEngine.getDataFromIds(ids)

Arguments:	ids (`DataIds()`) – None
Return type:	Promise <[Uint8Array]>

getDrawnPartsBounding

ScEngine.getDrawnPartsBounding(incs, viewKey)

Arguments:	incs (`InstanceIncs()`) – None viewKey (`ViewKey()`) – None
Return type:	Promise <Box>

getEffectiveElementColor

ScEngine.getEffectiveElementColor(incs, elementType, elementOffset, viewKey)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None elementOffset (`number()`) – None viewKey (`ViewKey()`) – None
Return type:	Promise <[Color]>

getEffectivePartColor

ScEngine.getEffectivePartColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[Color]>

getEffectivePartOpacity

ScEngine.getEffectivePartOpacity(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[number]>

getElementColor

ScEngine.getElementColor(inc, elementType, elementOffset)

Arguments:	inc (`InstanceInc()`) – None elementType (ElementType) – None elementOffset (`number()`) – None
Return type:	Promise <(Color \| null)>

ScEngine.getElementColor(incs, elementType, elementOffset)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None elementOffset (`number()`) – None
Return type:	Promise <[any]>

getElementHighlighted

ScEngine.getElementHighlighted(incs, elementType, elementIndex)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None elementIndex (`number()`) – None
Return type:	Promise <[boolean]>

getEyeDomeLightingBlurEdgeDistance

ScEngine.getEyeDomeLightingBlurEdgeDistance(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <number>

getEyeDomeLightingBlurInterval

ScEngine.getEyeDomeLightingBlurInterval(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <number>

getEyeDomeLightingBlurSamples

ScEngine.getEyeDomeLightingBlurSamples(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <number>

getEyeDomeLightingEnabled

ScEngine.getEyeDomeLightingEnabled(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <boolean>

getEyeDomeLightingOpacity

ScEngine.getEyeDomeLightingOpacity(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <number>

getEyeDomeLightingShadingEdgeDistance

ScEngine.getEyeDomeLightingShadingEdgeDistance(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <number>

getFullCameraMatrix

ScEngine.getFullCameraMatrix(camera, viewKey)

Arguments:	camera (`Camera()`) – None viewKey (`ViewKey()`) – None
Return type:	Matrix

getInstancesCappingMeshData

ScEngine.getInstancesCappingMeshData(inc)

Arguments:	inc (`InstanceInc()`) – None
Return type:	Promise <MeshId>

ScEngine.getInstancesCappingMeshData(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <MeshIds>

getInstancesMeshData

ScEngine.getInstancesMeshData(inc)

Arguments:	inc (`InstanceInc()`) – None
Return type:	Promise <MeshId>

ScEngine.getInstancesMeshData(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <MeshIds>

getInteractiveDrawLimitIncreaseEnabled

ScEngine.getInteractiveDrawLimitIncreaseEnabled(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	Promise <boolean>

getLight

ScEngine.getLight(view_key, key)

Arguments:	view_key (`ViewKey()`) – None key (LightKey) – None
Return type:	Promise <`Light()` \| undefined>

getLightKeys

ScEngine.getLightKeys(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <[LightKey]>

getLooseBounding

ScEngine.getLooseBounding()

Return type:	Promise <Box>

getMaxOverlayIndex

ScEngine.getMaxOverlayIndex()

Return type:	OverlayIndex

getMeshData

ScEngine.getMeshData(id)

Arguments:	id (MeshId) – None
Return type:	Promise <`MeshDataCopy()`>

getMetallicRoughness

ScEngine.getMetallicRoughness(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <[`MetallicRoughnessValue()`]>

getMinimumFramerate

ScEngine.getMinimumFramerate(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	Promise <number>

getModelBounding

ScEngine.getModelBounding(ignoreInvisible, includeExcluded, tightBounding)

Arguments:	ignoreInvisible (`boolean()`) – None includeExcluded (`boolean()`) – None tightBounding (`boolean()`) – None
Return type:	Promise <Box>

getNetworkModelName

ScEngine.getNetworkModelName()

Return type:	ScModelName

getPartAmbientColor

ScEngine.getPartAmbientColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[any]>

getPartColor

ScEngine.getPartColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[any]>

getPartEffectiveAmbientColor

ScEngine.getPartEffectiveAmbientColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[Color]>

getPartEffectiveEmissiveColor

ScEngine.getPartEffectiveEmissiveColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[Color]>

getPartEffectiveSpecularColor

ScEngine.getPartEffectiveSpecularColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[Color]>

getPartEmissiveColor

ScEngine.getPartEmissiveColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[any]>

getPartHasTransparency

ScEngine.getPartHasTransparency(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <[boolean]>

getPartHighlighted

ScEngine.getPartHighlighted(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <[boolean]>

getPartMaterial

ScEngine.getPartMaterial(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <[`IMaterial()`]>

getPartOpacity

ScEngine.getPartOpacity(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	[number]

getPartSpecularColor

ScEngine.getPartSpecularColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	Promise <[any]>

getPartsBounding

ScEngine.getPartsBounding(incs, ignoreInvisible, tightBounding)

Arguments:	incs (`InstanceIncs()`) – None ignoreInvisible (`boolean()`) – None tightBounding (`boolean()`) – None
Return type:	Promise <Box>

getPickTolerance

ScEngine.getPickTolerance()

Return type:	number

getPointShape

ScEngine.getPointShape(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <PointShape>

getPointSize

ScEngine.getPointSize(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	Promise <(number, PointSizeUnit)>

getPrimaryModelKey

ScEngine.getPrimaryModelKey()

Return type:	Promise <ModelKey>

getProjectionMatrix

ScEngine.getProjectionMatrix(camera, viewKey)

Arguments:	camera (`Camera()`) – None viewKey (`ViewKey()`) – None
Return type:	Matrix

getRendererType

ScEngine.getRendererType()

Return type:	RendererType

getScsInfo

ScEngine.getScsInfo()

Return type:	ScsUri \| ScsBuffer \| null

getSessionType

ScEngine.getSessionType()

Return type:	SessionType

getStatistics

ScEngine.getStatistics(forceUpdate)

Arguments:	forceUpdate (`boolean()`) – None
Return type:	Promise <`StatisticMap()`>

getStreamCutoffScale

ScEngine.getStreamCutoffScale()

Return type:	number

getVersionString

ScEngine.getVersionString()

Return type:	string

getViewMatrix

ScEngine.getViewMatrix(camera)

Arguments:	camera (`Camera()`) – None
Return type:	Matrix

hasDepthRange

ScEngine.hasDepthRange(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	Promise <[boolean]>

highlightElements

ScEngine.highlightElements(incs, elementType, elementIndex, elementCount, value)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None elementIndex (`number()`) – None elementCount (`number()`) – None value (`boolean()`) – None
Return type:	void

highlightParts

ScEngine.highlightParts(incs, highlighted)

Arguments:	incs (`InstanceIncs()`) – None highlighted (`boolean()`) – None
Return type:	void

instanceKeyInfo

ScEngine.instanceKeyInfo(modelKey, by, ret)

Arguments:	modelKey (`ModelKey()`) – None by (Model) – None ret (AllKeys) – None
Return type:	Promise <[InstanceKey]>

ScEngine.instanceKeyInfo(attachScope, by, ret)

Arguments:	attachScope (`AttachScope()`) – None by (Attachment) – None ret (AllKeys) – None
Return type:	Promise <Map <ModelKey, [InstanceKey]>>

ScEngine.instanceKeyInfo(modelKey, by, ret)

Arguments:	modelKey (`ModelKey()`) – None by (Model) – None ret (KeyCountOnly) – None
Return type:	Promise <(number)>

ScEngine.instanceKeyInfo(attachScope, by, ret)

Arguments:	attachScope (`AttachScope()`) – None by (Attachment) – None ret (KeyCountOnly) – None
Return type:	Promise <(number)>

isInit

ScEngine.isInit()

Return type:	boolean

loadEmpty

ScEngine.loadEmpty()

Return type:	Promise <void>

loadFinished

ScEngine.loadFinished()

Return type:	boolean

logMessage

ScEngine.logMessage(message)

Arguments:	message (`string()`) – None
Return type:	void

loseWebGlContext

ScEngine.loseWebGlContext()

Return type:	boolean

markCameraAsEmpty

ScEngine.markCameraAsEmpty(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	void

metaDataKeyInfo

ScEngine.metaDataKeyInfo(modelKey, byModel, keyCountOnly)

Arguments:	modelKey (`ModelKey()`) – None byModel (`true()`) – None keyCountOnly (`false()`) – None
Return type:	Promise <[DataKey]>

ScEngine.metaDataKeyInfo(attachScope, byModel, keyCountOnly)

Arguments:	attachScope (`AttachScope()`) – None byModel (`false()`) – None keyCountOnly (`false()`) – None
Return type:	Promise <Map <ModelKey, [DataKey]>>

ScEngine.metaDataKeyInfo(modelKey, byModel, keyCountOnly)

Arguments:	modelKey (`ModelKey()`) – None byModel (`true()`) – None keyCountOnly (`true()`) – None
Return type:	Promise <(number)>

ScEngine.metaDataKeyInfo(attachScope, byModel, keyCountOnly)

Arguments:	attachScope (`AttachScope()`) – None byModel (`false()`) – None keyCountOnly (`true()`) – None
Return type:	Promise <(number)>

modelKeysFromInclusionKeys

ScEngine.modelKeysFromInclusionKeys(inclusionKeys)

Arguments:	inclusionKeys (`[InclusionKey]()`) – None
Return type:	Promise <[ModelKey]>

pauseAllRendering

ScEngine.pauseAllRendering([callback])

Arguments:	callback (`function()`) – optional None
Return type:	void

ScEngine.callback()

Return type:	void

pauseRendering

ScEngine.pauseRendering(viewKey[, callback])

Arguments:	viewKey (`ViewKey()`) – None callback (`function()`) – optional None
Return type:	void

ScEngine.callback()

Return type:	void

pickAllFromRay

ScEngine.pickAllFromRay(ray, config)

Arguments:	ray (`Ray()`) – None config (`PickConfig()`) – None
Return type:	Promise <[`NodeEntitySelectionItem()`]>

pickAllFromScreen

ScEngine.pickAllFromScreen(viewKey, point, config, isDrawing)

Arguments:	viewKey (`ViewKey()`) – None point (`Point2()`) – None config (`PickConfig()`) – None isDrawing (`boolean()`) – None
Return type:	Promise <[`NodeEntitySelectionItem()`]>

pickFromRay

ScEngine.pickFromRay(ray, config)

Arguments:	ray (`Ray()`) – None config (`PickConfig()`) – None
Return type:	Promise <`NodeEntitySelectionItem()` \| null>

pickFromScreen

ScEngine.pickFromScreen(viewKey, point, config, isDrawing)

Arguments:	viewKey (`ViewKey()`) – None point (`Point2()`) – None config (`PickConfig()`) – None isDrawing (`boolean()`) – None
Return type:	Promise <`NodeEntitySelectionItem()` \| null>

redraw

ScEngine.redraw(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	void

registerBimInstances

ScEngine.registerBimInstances(incs, bimType)

Arguments:	incs (`InstanceIncs()`) – None bimType (`BimType()`) – None
Return type:	void

removeAllCuttingSections

ScEngine.removeAllCuttingSections()

Return type:	void

removeCuttingSection

ScEngine.removeCuttingSection(cuttingSection)

Arguments:	cuttingSection (`ICuttingSection()`) – None
Return type:	Promise <void>

removeLight

ScEngine.removeLight(view_key, key)

Arguments:	view_key (`ViewKey()`) – None key (LightKey) – None
Return type:	void

removeView

ScEngine.removeView(index)

Arguments:	index (`ViewKey()`) – None
Return type:	void

replaceMesh

ScEngine.replaceMesh(id, data)

Arguments:	id (MeshId) – None data (`MeshData()`) – None
Return type:	Promise <void>

requestMeshInstances

ScEngine.requestMeshInstances(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	void

resetCachedStatistics

ScEngine.resetCachedStatistics()

Return type:	void

resetColors

ScEngine.resetColors()

Return type:	void

resetOpacity

ScEngine.resetOpacity()

Return type:	void

resetPartMaterial

ScEngine.resetPartMaterial(nodeIds[, params])

Arguments:	nodeIds (`InstanceIncs()`) – None params ([MaterialParam]) – optional None
Return type:	void

resetToEmpty

ScEngine.resetToEmpty(whitelistInstances, whitelistMeshes)

Arguments:	whitelistInstances (`[InstanceKey]()`) – None whitelistMeshes ([MeshKey]) – None
Return type:	Promise <void>

resize

ScEngine.resize([viewKey])

Arguments:	viewKey (`ViewKey()`) – optional None
Return type:	void

resumeAllRendering

ScEngine.resumeAllRendering()

Return type:	void

resumeRendering

ScEngine.resumeRendering(viewKey)

Arguments:	viewKey (`ViewKey()`) – None
Return type:	void

safeGetMetaData

ScEngine.safeGetMetaData(modelKey, dataKey)

Arguments:	modelKey (`ModelKey()`) – None dataKey (`DataKey()`) – None
Return type:	Promise <Uint8Array \| null>

safeGetMetaDatas

ScEngine.safeGetMetaDatas(modelKey, dataKey)

Arguments:	modelKey (`ModelKey()`) – None dataKey (`(DataKey)()`) – None
Return type:	Promise <(Uint8Array) \| null>

ScEngine.safeGetMetaDatas(modelKey, dataKeys)

Arguments:	modelKey (`ModelKey()`) – None dataKeys (`[DataKey]()`) – None
Return type:	Promise <[Uint8Array] \| null>

safeLoadMetaDatas

ScEngine.safeLoadMetaDatas(ids)

Arguments:	ids (`DataIds()`) – None
Return type:	Promise <void>

setAllowHighDpi

ScEngine.setAllowHighDpi(allow)

Arguments:	allow (`boolean()`) – None
Return type:	void

setAmbientLightColor

ScEngine.setAmbientLightColor(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (Color) – None
Return type:	void

setAmbientOcclusionEnabled

ScEngine.setAmbientOcclusionEnabled(view_key, enabled)

Arguments:	view_key (`ViewKey()`) – None enabled (`boolean()`) – None
Return type:	void

setAmbientOcclusionRadius

ScEngine.setAmbientOcclusionRadius(view_key, radius)

Arguments:	view_key (`ViewKey()`) – None radius (`number()`) – None
Return type:	void

setAntiAliasingMode

ScEngine.setAntiAliasingMode(view_key, antiAliasingMode)

Arguments:	view_key (`ViewKey()`) – None antiAliasingMode (AntiAliasingMode) – None
Return type:	void

setBackFacesVisible

ScEngine.setBackFacesVisible(view_key, visible)

Arguments:	view_key (`ViewKey()`) – None visible (`boolean()`) – None
Return type:	void

setBackgroundGradient

ScEngine.setBackgroundGradient(view_key, top, bottom)

Arguments:	view_key (`ViewKey()`) – None top (Color \| null) – None bottom (Color \| null) – None
Return type:	void

setBloomEnabled

ScEngine.setBloomEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setBloomIntensityScale

ScEngine.setBloomIntensityScale(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setBloomLayers

ScEngine.setBloomLayers(view_key, layers)

Arguments:	view_key (`ViewKey()`) – None layers ([`BloomLayerInfo()`]) – None
Return type:	void

setBloomThreshold

ScEngine.setBloomThreshold(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setBloomThresholdRampWidth

ScEngine.setBloomThresholdRampWidth(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setBoundingDebugLevel

ScEngine.setBoundingDebugLevel(level, viewKey)

Arguments:	level (`number()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setBoundingPreviewEjected

ScEngine.setBoundingPreviewEjected(boxes, viewKey)

Arguments:	boxes (`[Box]()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setBoundingPreviewEjectedColor

ScEngine.setBoundingPreviewEjectedColor(color, viewKey)

Arguments:	color (Color) – None viewKey (`ViewKey()`) – None
Return type:	void

setBoundingPreviewTested

ScEngine.setBoundingPreviewTested(boxes, viewKey)

Arguments:	boxes (`[Box]()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setBoundingPreviewTestedColor

ScEngine.setBoundingPreviewTestedColor(color, viewKey)

Arguments:	color (Color) – None viewKey (`ViewKey()`) – None
Return type:	void

setBoundingPreviewUnderDraw

ScEngine.setBoundingPreviewUnderDraw(boxes, viewKey)

Arguments:	boxes (`[Box]()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setBoundingPreviewUnderDrawColor

ScEngine.setBoundingPreviewUnderDrawColor(color, viewKey)

Arguments:	color (Color) – None viewKey (`ViewKey()`) – None
Return type:	void

setCamera

ScEngine.setCamera(viewKey, camera)

Arguments:	viewKey (`ViewKey()`) – None camera (`Camera()`) – None
Return type:	void

setCappingDelay

ScEngine.setCappingDelay(delayInMilliseconds)

Arguments:	delayInMilliseconds (`number()`) – None
Return type:	void

setCappingFaceColor

ScEngine.setCappingFaceColor(color)

Arguments:	color (Color \| null) – None
Return type:	void

setCappingGeometryVisibility

ScEngine.setCappingGeometryVisibility(view_key, cappingGeometryVisibility)

Arguments:	view_key (`ViewKey()`) – None cappingGeometryVisibility (`boolean()`) – None
Return type:	void

setCappingLineColor

ScEngine.setCappingLineColor(color)

Arguments:	color (Color \| null) – None
Return type:	void

setCullingVector

ScEngine.setCullingVector(incs, space, vector, toleranceDegrees)

Arguments:	incs (`InstanceIncs()`) – None space (CullingVectorSpace) – None vector (`Point3()`) – None toleranceDegrees (`number()`) – None
Return type:	void

setDefaultDepthRange

ScEngine.setDefaultDepthRange(view_key, min, max)

Arguments:	view_key (`ViewKey()`) – None min (`number()`) – None max (`number()`) – None
Return type:	void

setDepthRange

ScEngine.setDepthRange(incs, min, max)

Arguments:	incs (`InstanceIncs()`) – None min (`number()`) – None max (`number()`) – None
Return type:	void

setDisplayIncompleteFrames

ScEngine.setDisplayIncompleteFrames(value, viewKey)

Arguments:	value (`boolean()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setDrawMode

ScEngine.setDrawMode(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`ScDrawMode()`) – None
Return type:	void

setDrawStrategy

ScEngine.setDrawStrategy(viewKey, strategy)

Arguments:	viewKey (`ViewKey()`) – None strategy (DrawStrategy) – None
Return type:	void

setElementColor

ScEngine.setElementColor(incs, elementType, elementOffset, elementCount, color)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None elementOffset (`number()`) – None elementCount (`number()`) – None color (Color) – None
Return type:	void

setElementHighlightColor

ScEngine.setElementHighlightColor(viewKey, fillColor, outlineColor)

Arguments:	viewKey (`ViewKey()`) – None fillColor (Color \| null) – None outlineColor (Color \| null) – None
Return type:	void

setElementVisibility

ScEngine.setElementVisibility(incs, elementType, elementOffset, elementCount, visible)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None elementOffset (`number()`) – None elementCount (`number()`) – None visible (`boolean()`) – None
Return type:	void

setExplodeMagnitude

ScEngine.setExplodeMagnitude(magnitude)

Arguments:	magnitude (`number()`) – None
Return type:	void

setEyeDomeLightingBlurEdgeDistance

ScEngine.setEyeDomeLightingBlurEdgeDistance(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setEyeDomeLightingBlurInterval

ScEngine.setEyeDomeLightingBlurInterval(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setEyeDomeLightingBlurSamples

ScEngine.setEyeDomeLightingBlurSamples(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setEyeDomeLightingEnabled

ScEngine.setEyeDomeLightingEnabled(view_key, enabled)

Arguments:	view_key (`ViewKey()`) – None enabled (`boolean()`) – None
Return type:	void

setEyeDomeLightingOpacity

ScEngine.setEyeDomeLightingOpacity(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setEyeDomeLightingShadingEdgeDistance

ScEngine.setEyeDomeLightingShadingEdgeDistance(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setFaceVisibility

ScEngine.setFaceVisibility(view_key, faceVisibility)

Arguments:	view_key (`ViewKey()`) – None faceVisibility (`boolean()`) – None
Return type:	void

setGoochBaseColorProminence

ScEngine.setGoochBaseColorProminence(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setGoochBlue

ScEngine.setGoochBlue(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setGoochLuminanceShiftStrength

ScEngine.setGoochLuminanceShiftStrength(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setGoochYellow

ScEngine.setGoochYellow(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setGroundPlane

ScEngine.setGroundPlane(view_key, normal[, position])

Arguments:	view_key (`ViewKey()`) – None normal (`Point3()`) – None position (`Point3()`) – optional None
Return type:	void

setHardEdgeColor

ScEngine.setHardEdgeColor(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (Color) – None
Return type:	void

setHardEdgeOpacity

ScEngine.setHardEdgeOpacity(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setHardEdgeThreshold

ScEngine.setHardEdgeThreshold(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setHardEdgeThresholdRampWidth

ScEngine.setHardEdgeThresholdRampWidth(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setHardEdgesEnabled

ScEngine.setHardEdgesEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setHighlightColorizeCompression

ScEngine.setHighlightColorizeCompression(viewKey, compressionLevel)

Arguments:	viewKey (`ViewKey()`) – None compressionLevel (`number()`) – None
Return type:	void

setImageBasedLightingEnabled

ScEngine.setImageBasedLightingEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setImageBasedLightingEnvironment

ScEngine.setImageBasedLightingEnvironment(view_key, data)

Arguments:	view_key (`ViewKey()`) – None data (`Uint8Array()`) – None
Return type:	void

setImageBasedLightingEnvironmentToDefault

ScEngine.setImageBasedLightingEnvironmentToDefault(view_key)

Arguments:	view_key (`ViewKey()`) – None
Return type:	void

setImageBasedLightingIntensity

ScEngine.setImageBasedLightingIntensity(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setImageBasedLightingMatrix

ScEngine.setImageBasedLightingMatrix(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`Matrix()`) – None
Return type:	void

setInstanceModifier

ScEngine.setInstanceModifier(instanceModifier, incs, modifierValue)

Arguments:	instanceModifier (InstanceModifier) – None incs (`InstanceIncs()`) – None modifierValue (`boolean()`) – None
Return type:	void

setInstancesMatrix

ScEngine.setInstancesMatrix(incs, matrix)

Arguments:	incs (`InstanceIncs()`) – None matrix (`Matrix()`) – None
Return type:	void

setInteractiveDrawDelay

ScEngine.setInteractiveDrawDelay(value, viewKey)

Arguments:	value (`number()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setInteractiveDrawLimitIncreaseEnabled

ScEngine.setInteractiveDrawLimitIncreaseEnabled(enable, viewKey)

Arguments:	enable (`boolean()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setLightingEnabled

ScEngine.setLightingEnabled(view_key, enabled)

Arguments:	view_key (`ViewKey()`) – None enabled (`boolean()`) – None
Return type:	void

setLineJitterEnabled

ScEngine.setLineJitterEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setLineJitterFrequency

ScEngine.setLineJitterFrequency(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setLineJitterInstanceCount

ScEngine.setLineJitterInstanceCount(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setLineJitterRadius

ScEngine.setLineJitterRadius(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setLinePattern

ScEngine.setLinePattern(incs, pattern, patternLength, patternLengthUnit)

Arguments:	incs (`InstanceIncs()`) – None pattern (LinePattern) – None patternLength (`number()`) – None patternLengthUnit (LinePatternLengthUnit) – None
Return type:	void

setLineVisibility

ScEngine.setLineVisibility(view_key, lineVisibility)

Arguments:	view_key (`ViewKey()`) – None lineVisibility (`boolean()`) – None
Return type:	void

setMatrices

ScEngine.setMatrices(incs, matrices)

Arguments:	incs (`InstanceIncs()`) – None matrices (`[Matrix]()`) – None
Return type:	void

setMeshLevel

ScEngine.setMeshLevel(incs, meshLevel)

Arguments:	incs (`InstanceIncs()`) – None meshLevel (`number()`) – None
Return type:	void

setMetallicRoughness

ScEngine.setMetallicRoughness(incs, metallicFactor, roughnessFactor)

Arguments:	incs (`InstanceIncs()`) – None metallicFactor (`number()`) – None roughnessFactor (`number()`) – None
Return type:	void

setMetallicRoughnessMaterialOverride

ScEngine.setMetallicRoughnessMaterialOverride(defaultMetallicFactor, defaultRoughnessFactor)

Arguments:	defaultMetallicFactor (`number()`) – None defaultRoughnessFactor (`number()`) – None
Return type:	void

setMinimumFramerate

ScEngine.setMinimumFramerate(viewKey, value)

Arguments:	viewKey (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setNodeHighlightColor

ScEngine.setNodeHighlightColor(viewKey, fillColor, outlineColor)

Arguments:	viewKey (`ViewKey()`) – None fillColor (Color \| null) – None outlineColor (Color \| null) – None
Return type:	void

setOverlayCamera

ScEngine.setOverlayCamera(index, camera, viewKey)

Arguments:	index (`OverlayIndex()`) – None camera (`Camera()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setOverlayViewport

ScEngine.setOverlayViewport(index, anchor, x, xUnit, y, yUnit, width, widthUnit, height, heightUnit, viewKey)

Arguments:	index (`OverlayIndex()`) – None anchor (OverlayAnchor) – None x (`number()`) – None xUnit (OverlayUnit) – None y (`number()`) – None yUnit (OverlayUnit) – None width (`number()`) – None widthUnit (OverlayUnit) – None height (`number()`) – None heightUnit (OverlayUnit) – None viewKey (`ViewKey()`) – None
Return type:	void

setOverlayVisibility

ScEngine.setOverlayVisibility(index, visibility, viewKey)

Arguments:	index (`OverlayIndex()`) – None visibility (`boolean()`) – None viewKey (`ViewKey()`) – None
Return type:	void

setPartAmbientColor

ScEngine.setPartAmbientColor(incs, elementType, color)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None color (Color) – None
Return type:	void

setPartAmbientMix

ScEngine.setPartAmbientMix(incs, elementType, value)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None value (`number()`) – None
Return type:	void

setPartColor

ScEngine.setPartColor(incs, elementType, color)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None color (Color) – None
Return type:	void

setPartEmissiveColor

ScEngine.setPartEmissiveColor(incs, elementType, color)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None color (Color) – None
Return type:	void

setPartMaterial

ScEngine.setPartMaterial(incs, material)

Arguments:	incs (`InstanceIncs()`) – None material (`IMaterial()`) – None
Return type:	void

setPartOpacity

ScEngine.setPartOpacity(incs, opacity)

Arguments:	incs (`InstanceIncs()`) – None opacity (`number()`) – None
Return type:	void

setPartSpecularColor

ScEngine.setPartSpecularColor(incs, elementType, color)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None color (Color) – None
Return type:	void

setPartSpecularIntensity

ScEngine.setPartSpecularIntensity(incs, elementType, value)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None value (`number()`) – None
Return type:	void

setPartVisibility

ScEngine.setPartVisibility(incs, visible, onlyDemanded)

Arguments:	incs (`InstanceIncs()`) – None visible (`boolean()`) – None onlyDemanded (`boolean()`) – None
Return type:	void

setPickTolerance

ScEngine.setPickTolerance(tolerance)

Arguments:	tolerance (`number()`) – None
Return type:	void

setPointShape

ScEngine.setPointShape(view_key, shape)

Arguments:	view_key (`ViewKey()`) – None shape (PointShape) – None
Return type:	void

setPointSize

ScEngine.setPointSize(view_key, size, unit)

Arguments:	view_key (`ViewKey()`) – None size (`number()`) – None unit (PointSizeUnit) – None
Return type:	void

setPointVisibilityTest

ScEngine.setPointVisibilityTest(view_key, points)

Arguments:	view_key (`ViewKey()`) – None points (`[Point3]()`) – None
Return type:	void

setProjection

ScEngine.setProjection(viewKey, projection)

Arguments:	viewKey (`ViewKey()`) – None projection (Projection) – None
Return type:	void

setRemoteEndpoint

ScEngine.setRemoteEndpoint(uri, modelName)

Arguments:	uri (`string()`) – None modelName (`ScModelName()`) – None
Return type:	void

setServerRenderQuality

ScEngine.setServerRenderQuality(jpegQualityLow, jpegQualityHigh, scaleLow, scaleHigh)

Arguments:	jpegQualityLow (`number()`) – None jpegQualityHigh (`number()`) – None scaleLow (`number()`) – None scaleHigh (`number()`) – None
Return type:	void

setSilhouetteColor

ScEngine.setSilhouetteColor(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (Color) – None
Return type:	void

setSilhouetteEnabled

ScEngine.setSilhouetteEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setSilhouetteOpacity

ScEngine.setSilhouetteOpacity(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSilhouetteThreshold

ScEngine.setSilhouetteThreshold(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSilhouetteThresholdRampWidth

ScEngine.setSilhouetteThresholdRampWidth(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSimpleReflectionAttenuation

ScEngine.setSimpleReflectionAttenuation(view_key, nearDistance, farDistance, unit)

Arguments:	view_key (`ViewKey()`) – None nearDistance (`number()`) – None farDistance (`number()`) – None unit (`any()`) – None
Return type:	void

setSimpleReflectionBlurInterval

ScEngine.setSimpleReflectionBlurInterval(view_key, value, unit)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None unit (BlurIntervalUnit) – None
Return type:	void

setSimpleReflectionBlurSamples

ScEngine.setSimpleReflectionBlurSamples(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSimpleReflectionEnabled

ScEngine.setSimpleReflectionEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setSimpleReflectionFadeAngle

ScEngine.setSimpleReflectionFadeAngle(view_key, degrees)

Arguments:	view_key (`ViewKey()`) – None degrees (`number()`) – None
Return type:	void

setSimpleReflectionOpacity

ScEngine.setSimpleReflectionOpacity(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSimpleShadowBlurInterval

ScEngine.setSimpleShadowBlurInterval(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSimpleShadowBlurSamples

ScEngine.setSimpleShadowBlurSamples(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSimpleShadowColor

ScEngine.setSimpleShadowColor(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (Color) – None
Return type:	void

setSimpleShadowEnabled

ScEngine.setSimpleShadowEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setSimpleShadowInteractiveUpdateEnabled

ScEngine.setSimpleShadowInteractiveUpdateEnabled(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`boolean()`) – None
Return type:	void

setSimpleShadowOpacity

ScEngine.setSimpleShadowOpacity(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None
Return type:	void

setSimpleShadowResolution

ScEngine.setSimpleShadowResolution(view_key, pixels)

Arguments:	view_key (`ViewKey()`) – None pixels (`number()`) – None
Return type:	void

setStreamCutoffScale

ScEngine.setStreamCutoffScale(value)

Arguments:	value (`number()`) – None
Return type:	void

setStreamIdleMarker

ScEngine.setStreamIdleMarker()

Return type:	Promise <void>

setTexture

ScEngine.setTexture(instanceIncs, options)

Arguments:	instanceIncs (`InstanceIncs()`) – None options (`TextureOptions()`) – None
Return type:	Promise <void>

setTimeout

ScEngine.setTimeout(handler, timeout)

Arguments:	handler (`function()`) – None timeout (`number()`) – None
Return type:	ReturnType <setTimeout>

ScEngine.handler()

Return type:	void

setToonShadingBandCount

ScEngine.setToonShadingBandCount(view_key, bandCount)

Arguments:	view_key (`ViewKey()`) – None bandCount (`number()`) – None
Return type:	void

setToonShadingSpecularFactor

ScEngine.setToonShadingSpecularFactor(view_key, specularFactor)

Arguments:	view_key (`ViewKey()`) – None specularFactor (`number()`) – None
Return type:	void

setTransparencyMode

ScEngine.setTransparencyMode(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (TransparencyMode) – None
Return type:	void

setVisibilityByAttachment

ScEngine.setVisibilityByAttachment(attachScope, setVisibility)

Arguments:	attachScope (`AttachScope()`) – None setVisibility (`SetVisibility()`) – None
Return type:	void

setXRayColor

ScEngine.setXRayColor(view_key, group, element, color)

Arguments:	view_key (`ViewKey()`) – None group (XRayGroup) – None element (ElementType) – None color (Color) – None
Return type:	void

setXRayOpacity

ScEngine.setXRayOpacity(view_key, value[, element])

Arguments:	view_key (`ViewKey()`) – None value (`number()`) – None element (ElementType) – optional None
Return type:	void

setXRayTransparencyMode

ScEngine.setXRayTransparencyMode(view_key, value)

Arguments:	view_key (`ViewKey()`) – None value (XRayTransparencyMode) – None
Return type:	void

shutdown

ScEngine.shutdown()

Return type:	void

sleep

ScEngine.sleep(duration)

Arguments:	duration (`Milliseconds()`) – None
Return type:	Promise <void>

start

ScEngine.start(canvasContainer, options)

Arguments:	canvasContainer (`HTMLDivElement()`) – None options (`InitOptions()`) – None
Return type:	boolean

startComparison

ScEngine.startComparison(view_key, instanceSet1, instanceSet2[, config])

Arguments:	view_key (`ViewKey()`) – None instanceSet1 (`InstanceIncs()`) – None instanceSet2 (`InstanceIncs()`) – None config (`ComparisonConfig()`) – optional None
Return type:	void

startExplode

ScEngine.startExplode(incs, vector)

Arguments:	incs (`InstanceIncs()`) – None vector (`Point3()`) – None
Return type:	void

stopExplode

ScEngine.stopExplode()

Return type:	void

synchronizeVisibilities

ScEngine.synchronizeVisibilities(incs, visible)

Arguments:	incs (`InstanceIncs()`) – None visible (`boolean()`) – None
Return type:	void

testPointVisibility

ScEngine.testPointVisibility(view_key, points)

Arguments:	view_key (`ViewKey()`) – None points (`[Point3]()`) – None
Return type:	Promise <[number]>

throttleLoad

ScEngine.throttleLoad(newPauseInterval, throttleDuration)

Arguments:	newPauseInterval (`Milliseconds()`) – None throttleDuration (`Milliseconds()`) – None
Return type:	void

triangulatePolygon

ScEngine.triangulatePolygon(polygonPoints, normal)

Arguments:	polygonPoints (`Float32Array \| [number]()`) – None normal (Vector3) – None
Return type:	Float32Array

unsetCullingVector

ScEngine.unsetCullingVector(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	void

unsetDepthRange

ScEngine.unsetDepthRange(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	void

unsetElementColor

ScEngine.unsetElementColor(incs, elementType, elementOffset, elementCount)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None elementOffset (`number()`) – None elementCount (`number()`) – None
Return type:	void

unsetLinePattern

ScEngine.unsetLinePattern(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	void

unsetMetallicRoughness

ScEngine.unsetMetallicRoughness(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	void

unsetPartAmbientColor

ScEngine.unsetPartAmbientColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	void

unsetPartColor

ScEngine.unsetPartColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	void

unsetPartEmissiveColor

ScEngine.unsetPartEmissiveColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	void

unsetPartOpacity

ScEngine.unsetPartOpacity(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	void

unsetPartSpecularColor

ScEngine.unsetPartSpecularColor(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	void

unsetPartSpecularIntensity

ScEngine.unsetPartSpecularIntensity(incs, elementType)

Arguments:	incs (`InstanceIncs()`) – None elementType (ElementType) – None
Return type:	void

unsetTexture

ScEngine.unsetTexture(incs)

Arguments:	incs (`InstanceIncs()`) – None
Return type:	void

unsetXRayColor

ScEngine.unsetXRayColor(view_key, group, element)

Arguments:	view_key (`ViewKey()`) – None group (XRayGroup) – None element (ElementType) – None
Return type:	Promise <void>

updateCamera

ScEngine.updateCamera(viewKey, camera)

Arguments:	viewKey (`ViewKey()`) – None camera (`Camera()`) – None
Return type:	`Camera()`

updateCuttingSection

ScEngine.updateCuttingSection(cuttingSection)

Arguments:	cuttingSection (`ICuttingSection()`) – None
Return type:	Promise <void>

updateLight

ScEngine.updateLight(view_key, key, light)

Arguments:	view_key (`ViewKey()`) – None key (LightKey) – None light (`Light()`) – None
Return type:	void

waitForImageDecoding

ScEngine.waitForImageDecoding()

Return type:	Promise <void>