IScEngine

class core.IScEngine()

Methods

Methods

_getScPlaneArray

IScEngine._getScPlaneArray(cuttingSection)
Arguments:
Return type:

[Vector4]

_toTextureInterpolation

IScEngine._toTextureInterpolation(value)
Arguments:
  • value (undefined | boolean()) – None
Return type:

TextureInterpolation

_toTextureMipMapping

IScEngine._toTextureMipMapping(value)
Arguments:
  • value (undefined | boolean()) – None
Return type:

TextureMipMapping

_toTextureModifier

IScEngine._toTextureModifier(value)
Arguments:
  • value (undefined | number()) – None
Return type:

TextureModifier

_toTextureParameterization

IScEngine._toTextureParameterization(value)
Arguments:
  • value (undefined | TextureParameterization()) – None
Return type:

TextureParameterization

_toTextureTiling

IScEngine._toTextureTiling(value)
Arguments:
  • value (undefined | TextureTiling()) – None
Return type:

TextureTiling

addCuttingSection

IScEngine.addCuttingSection(cuttingSection)
Arguments:
Return type:

Promise <void>

addLight

IScEngine.addLight(view_key, light)
Arguments:
  • view_key (ViewKey()) – None
  • light (Light()) – None
Return type:

Promise <number>

addNodesToOverlay

IScEngine.addNodesToOverlay(incs, viewKey, index)
Arguments:
  • incs (InstanceIncs()) – None
  • viewKey (ViewKey()) – None
  • index (number()) – None
Return type:

void

addPointLight

IScEngine.addPointLight(view_key, light)
Arguments:
  • view_key (ViewKey()) – None
  • light (PointLight()) – None
Return type:

Promise <number>

addView

IScEngine.addView(canvasContainer)
Arguments:
  • canvasContainer (HTMLDivElement()) – None
Return type:

Promise <ViewKey>

advanceExportToSvg

IScEngine.advanceExportToSvg()
Return type:Promise <undefined | string>

advanceIncrementalSelection

IScEngine.advanceIncrementalSelection(handle)
Arguments:
  • handle (IncrementalSelectionId()) – None
Return type:

Promise <null | [SelectionItem]>

attachModel

IScEngine.attachModel(attachScope, modelName, inclusionMatrix, parentMeasurementUnit, markAllInstancesInvisible)
Arguments:
  • attachScope (AttachScope()) – None
  • modelName (string()) – None
  • inclusionMatrix (Matrix12()) – None
  • parentMeasurementUnit (number()) – None
  • markAllInstancesInvisible (boolean()) – None
Return type:

Promise <void>

attachScsBuffer

IScEngine.attachScsBuffer(attachScope, buffer, inclusionMatrix, parentMeasurementUnit, markAllInstancesInvisible, resolveOnFullyLoaded, cancelUnitMatrix)
Arguments:
  • attachScope (AttachScope()) – None
  • buffer (null | Uint8Array()) – None
  • inclusionMatrix (Matrix12()) – None
  • parentMeasurementUnit (number()) – None
  • markAllInstancesInvisible (boolean()) – None
  • resolveOnFullyLoaded (boolean()) – None
  • cancelUnitMatrix (boolean()) – None
Return type:

Promise <void>

attachScsModelByKey

IScEngine.attachScsModelByKey(attachScope, modelKey, inclusionMatrix, parentMeasurementUnit, markAllInstancesInvisible)
Arguments:
  • attachScope (AttachScope()) – None
  • modelKey (ModelKey()) – None
  • inclusionMatrix (Matrix12()) – None
  • parentMeasurementUnit (number()) – None
  • markAllInstancesInvisible (boolean()) – None
Return type:

InclusionKey

beginConvexPolyhedronSelection

IScEngine.beginConvexPolyhedronSelection(volumePlanes, heuristicOrigin, config)
Arguments:
Return type:

Promise <IncrementalSelectionId>

beginExportToSvg

IScEngine.beginExportToSvg(config)
Arguments:
Return type:

Promise <void>

beginRayDrillSelection

IScEngine.beginRayDrillSelection(viewKey, rayCssOrigin, rayCssBoxRadius, config)
Arguments:
Return type:

Promise <IncrementalSelectionId>

beginRequestBatch

IScEngine.beginRequestBatch(type)
Arguments:
  • type (RequestBatchType()) – None
Return type:

void

beginScreenAreaSelection

IScEngine.beginScreenAreaSelection(viewKey, areaCssMin, areaCssMax, config)
Arguments:
Return type:

Promise <IncrementalSelectionId>

beginSphereSelection

IScEngine.beginSphereSelection(sphereCenter, sphereRadius, config)
Arguments:
Return type:

Promise <IncrementalSelectionId>

clearElementVisibility

IScEngine.clearElementVisibility(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

void

clearHighlight

IScEngine.clearHighlight()
Return type:void

clearLights

IScEngine.clearLights(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

void

compositePickFromScreen

IScEngine.compositePickFromScreen(viewKey, point, config, isDrawing)
Arguments:
  • viewKey (ViewKey()) – None
  • point (Point2()) – None
  • config (PickConfig()) – None
  • isDrawing (boolean()) – None
Return type:

Promise <CompositeSelectionItem>

computeMinimumBodyBodyDistance

IScEngine.computeMinimumBodyBodyDistance(inc1, inc2)
Arguments:
  • inc1 (InstanceInc()) – None
  • inc2 (InstanceInc()) – None
Return type:

Promise <FaceFaceDistanceItem>

computeMinimumFaceLineDistance

IScEngine.computeMinimumFaceLineDistance(inc, faceId, ray)
Arguments:
  • inc (InstanceInc()) – None
  • faceId (number()) – None
  • ray (Ray()) – None
Return type:

Promise <FaceFaceDistanceItem>

computeMinimumFaceRayDistance

IScEngine.computeMinimumFaceRayDistance(inc, faceId, ray)
Arguments:
  • inc (InstanceInc()) – None
  • faceId (number()) – None
  • ray (Ray()) – None
Return type:

Promise <FaceFaceDistanceItem>

computeMininimumFaceFaceDistance

IScEngine.computeMininimumFaceFaceDistance(inc1, face1, inc2, face2)
Arguments:
  • inc1 (InstanceInc()) – None
  • face1 (number()) – None
  • inc2 (InstanceInc()) – None
  • face2 (number()) – None
Return type:

Promise <FaceFaceDistanceItem>

createFloorplanMesh

IScEngine.createFloorplanMesh(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <InstanceIncs>

createIdentityMatrix

IScEngine.createIdentityMatrix()
Return type:Promise <MatrixInc>

createImage

IScEngine.createImage(primaryImage[, thumbnailImage])
Arguments:
Return type:

Promise <ImageId>

createMatrix

IScEngine.createMatrix(elements)
Arguments:
  • elements (Matrix16()) – None
Return type:

Promise <MatrixInc>

createMesh

IScEngine.createMesh(meshData)
Arguments:
Return type:

Promise <MeshId>

createMeshInstance

IScEngine.createMeshInstance(meshInstanceData)
Arguments:
Return type:

Promise <InstanceInc>

debug_log

IScEngine.debug_log(message)
Arguments:
  • message (string()) – None
Return type:

Promise <void>

debug_stateFailure

IScEngine.debug_stateFailure(value)
Arguments:
  • value (StateFailure()) – None
Return type:

Promise <void>

debug_sync

IScEngine.debug_sync()
Return type:Promise <void>

delayCapping

IScEngine.delayCapping()
Return type:void

destroyImages

IScEngine.destroyImages(imageIds)
Arguments:
  • imageIds (ImageIds()) – None
Return type:

Promise <void>

destroyLocalInstances

IScEngine.destroyLocalInstances(instanceIncs)
Arguments:
  • instanceIncs (InstanceIncs()) – None
Return type:

Promise <void>

destroyMeshes

IScEngine.destroyMeshes(meshIds)
Arguments:
  • meshIds (MeshIds()) – None
Return type:

Promise <void>

destroyOverlay

IScEngine.destroyOverlay(index, viewKey)
Arguments:
  • index (number()) – None
  • viewKey (ViewKey()) – None
Return type:

void

detachInclusions

IScEngine.detachInclusions(inclusionKeys)
Arguments:
  • inclusionKeys ([InclusionKey]()) – None
Return type:

Promise <void>

disconnectNetwork

IScEngine.disconnectNetwork()
Return type:void

enableCappingIdleCallback

IScEngine.enableCappingIdleCallback(enable)
Arguments:
  • enable (boolean()) – None
Return type:

Promise <boolean>

enableHiddenLineRendering

IScEngine.enableHiddenLineRendering(view_key, settings)
Arguments:
  • view_key (ViewKey()) – None
  • settings (HiddenLineSettings()) – None
Return type:

void

endComparison

IScEngine.endComparison(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

void

endIncrementalSelection

IScEngine.endIncrementalSelection(handle)
Arguments:
  • handle (IncrementalSelectionId()) – None
Return type:

void

endRequestBatch

IScEngine.endRequestBatch(type)
Arguments:
  • type (RequestBatchType()) – None
Return type:

void

exportToSvg

IScEngine.exportToSvg(config)
Arguments:
Return type:

Promise <string>

feedScsBuffer

IScEngine.feedScsBuffer(attachScope, buffer)
Arguments:
  • attachScope (AttachScope()) – None
  • buffer (null | Uint8Array()) – None
Return type:

void

flushMetaDataCache

IScEngine.flushMetaDataCache()
Return type:void

getAllowHighDpi

IScEngine.getAllowHighDpi()
Return type:boolean

getBounding

IScEngine.getBounding(incs, ignoreInvisible, includeExcluded, tightBounding)
Arguments:
  • incs (InstanceIncs()) – None
  • ignoreInvisible (boolean()) – None
  • includeExcluded (boolean()) – None
  • tightBounding (boolean()) – None
Return type:

Promise <Box>

getCamera

IScEngine.getCamera(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

Camera

getCameraPromise

IScEngine.getCameraPromise(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

Promise <Camera>

getCanvasSize

IScEngine.getCanvasSize(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

Point2

getCappedInstances

IScEngine.getCappedInstances()
Return type:Promise <InstanceIncs>

getCappingGeometryVisibility

IScEngine.getCappingGeometryVisibility()
Return type:boolean

getClientDimensions

IScEngine.getClientDimensions(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

(number, number)

getCullingVector

IScEngine.getCullingVector(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <[null | CullingVector]>

getCuttingSectionLimits

IScEngine.getCuttingSectionLimits()
Return type:CuttingSectionLimits

getDataFromIds

IScEngine.getDataFromIds(ids)
Arguments:
  • ids (DataIds()) – None
Return type:

Promise <[Uint8Array]>

getDrawnPartsBounding

IScEngine.getDrawnPartsBounding(incs, viewKey)
Arguments:
  • incs (InstanceIncs()) – None
  • viewKey (ViewKey()) – None
Return type:

Promise <Box>

getEffectiveElementColor

IScEngine.getEffectiveElementColor(incs, elementType, elementOffset, viewKey)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • elementOffset (number()) – None
  • viewKey (ViewKey()) – None
Return type:

Promise <[Color]>

getEffectivePartColor

IScEngine.getEffectivePartColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[Color]>

getEffectivePartOpacity

IScEngine.getEffectivePartOpacity(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[number]>

getElementColor

IScEngine.getElementColor(incs, elementType, elementOffset)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • elementOffset (number()) – None
Return type:

Promise <[null | Color]>

getElementHighlighted

IScEngine.getElementHighlighted(incs, elementType, elementIndex)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • elementIndex (number()) – None
Return type:

Promise <[boolean]>

getEyeDomeLightingBlurEdgeDistance

IScEngine.getEyeDomeLightingBlurEdgeDistance(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <number>

getEyeDomeLightingBlurInterval

IScEngine.getEyeDomeLightingBlurInterval(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <number>

getEyeDomeLightingBlurSamples

IScEngine.getEyeDomeLightingBlurSamples(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <number>

getEyeDomeLightingEnabled

IScEngine.getEyeDomeLightingEnabled(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <boolean>

getEyeDomeLightingOpacity

IScEngine.getEyeDomeLightingOpacity(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <number>

getEyeDomeLightingShadingEdgeDistance

IScEngine.getEyeDomeLightingShadingEdgeDistance(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <number>

getFullCameraMatrix

IScEngine.getFullCameraMatrix(camera, viewKey)
Arguments:
  • camera (Camera()) – None
  • viewKey (ViewKey()) – None
Return type:

Matrix

getInstancesCappingMeshData

IScEngine.getInstancesCappingMeshData(inc)
Arguments:
  • inc (InstanceInc()) – None
Return type:

Promise <MeshId>
IScEngine.getInstancesCappingMeshData(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <MeshIds>

getInstancesMeshData

IScEngine.getInstancesMeshData(inc)
Arguments:
  • inc (InstanceInc()) – None
Return type:

Promise <MeshId>
IScEngine.getInstancesMeshData(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <MeshIds>

getInteractiveDrawLimitIncreaseEnabled

IScEngine.getInteractiveDrawLimitIncreaseEnabled(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

Promise <boolean>

getLight

IScEngine.getLight(view_key, key)
Arguments:
  • view_key (ViewKey()) – None
  • key (number()) – None
Return type:

Promise <undefined | Light>

getLightKeys

IScEngine.getLightKeys(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <[number]>

getLooseBounding

IScEngine.getLooseBounding()
Return type:Promise <Box>

getMaxOverlayIndex

IScEngine.getMaxOverlayIndex()
Return type:number

getMeshData

IScEngine.getMeshData(id)
Arguments:
  • id (MeshId()) – None
Return type:

Promise <MeshDataCopy>

getMetallicRoughness

IScEngine.getMetallicRoughness(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <[null | MetallicRoughnessValue]>

getMinimumFramerate

IScEngine.getMinimumFramerate(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

Promise <number>

getModelBounding

IScEngine.getModelBounding(ignoreInvisible, includeExcluded, tightBounding)
Arguments:
  • ignoreInvisible (boolean()) – None
  • includeExcluded (boolean()) – None
  • tightBounding (boolean()) – None
Return type:

Promise <Box>

getNetworkModelName

IScEngine.getNetworkModelName()
Return type:string

getPartAmbientColor

IScEngine.getPartAmbientColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[null | Color]>

getPartColor

IScEngine.getPartColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[null | Color]>

getPartEffectiveAmbientColor

IScEngine.getPartEffectiveAmbientColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[Color]>

getPartEffectiveEmissiveColor

IScEngine.getPartEffectiveEmissiveColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[Color]>

getPartEffectiveSpecularColor

IScEngine.getPartEffectiveSpecularColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[Color]>

getPartEmissiveColor

IScEngine.getPartEmissiveColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[null | Color]>

getPartHasTransparency

IScEngine.getPartHasTransparency(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <[boolean]>

getPartHighlighted

IScEngine.getPartHighlighted(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <[boolean]>

getPartOpacity

IScEngine.getPartOpacity(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

[null | number]

getPartsBounding

IScEngine.getPartsBounding(incs, ignoreInvisible, tightBounding)
Arguments:
  • incs (InstanceIncs()) – None
  • ignoreInvisible (boolean()) – None
  • tightBounding (boolean()) – None
Return type:

Promise <Box>

getPartSpecularColor

IScEngine.getPartSpecularColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[null | Color]>

getPickTolerance

IScEngine.getPickTolerance()
Return type:number

getPointShape

IScEngine.getPointShape(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <PointShape>

getPointSize

IScEngine.getPointSize(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

Promise <(number, PointSizeUnit)>

getPrimaryModelKey

IScEngine.getPrimaryModelKey()
Return type:Promise <ModelKey>

getProjectionMatrix

IScEngine.getProjectionMatrix(camera, viewKey)
Arguments:
  • camera (Camera()) – None
  • viewKey (ViewKey()) – None
Return type:

Matrix

getRendererType

IScEngine.getRendererType()
Return type:RendererType

getScsInfo

IScEngine.getScsInfo()
Return type:null | string | Uint8Array

getSessionType

IScEngine.getSessionType()
Return type:SessionType

getStatistics

IScEngine.getStatistics([forceUpdate])
Arguments:
  • forceUpdate (boolean()) – optional None
Return type:

Promise <StatisticMap>

getStreamCutoffScale

IScEngine.getStreamCutoffScale()
Return type:number

getVersionString

IScEngine.getVersionString()
Return type:string

getViewMatrix

IScEngine.getViewMatrix(camera)
Arguments:
Return type:

Matrix

hasDepthRange

IScEngine.hasDepthRange(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

Promise <[boolean]>

highlightElements

IScEngine.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

IScEngine.highlightParts(incs, highlighted)
Arguments:
  • incs (InstanceIncs()) – None
  • highlighted (boolean()) – None
Return type:

void

instanceKeyInfo

IScEngine.instanceKeyInfo(attachScope, by, ret)
Arguments:
  • attachScope (AttachScope()) – None
  • by (Attachment()) – None
  • ret (AllKeys()) – None
Return type:

Promise <Map <ModelKey, [InstanceKey]>>
IScEngine.instanceKeyInfo(attachScope, by, ret)
Arguments:
  • attachScope (AttachScope()) – None
  • by (Attachment()) – None
  • ret (KeyCountOnly()) – None
Return type:

Promise <(number)>

isInit

IScEngine.isInit()
Return type:boolean

loadEmpty

IScEngine.loadEmpty()
Return type:Promise <void>

loadFinished

IScEngine.loadFinished()
Return type:boolean

logMessage

IScEngine.logMessage(message)
Arguments:
  • message (string()) – None
Return type:

void

loseWebGlContext

IScEngine.loseWebGlContext()
Return type:boolean

markCameraAsEmpty

IScEngine.markCameraAsEmpty(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

void

metaDataKeyInfo

IScEngine.metaDataKeyInfo(modelKeyOrAttachScope, byModel, keyCountOnly)
Arguments:
  • modelKeyOrAttachScope (ModelKey | AttachScope()) – None
  • byModel (boolean()) – None
  • keyCountOnly (boolean()) – None
Return type:

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

modelKeysFromInclusionKeys

IScEngine.modelKeysFromInclusionKeys(inclusionKeys)
Arguments:
  • inclusionKeys ([InclusionKey]()) – None
Return type:

Promise <[ModelKey]>

pauseAllRendering

IScEngine.pauseAllRendering([callback])
Arguments:
  • callback (function()) – optional None
Return type:

void
IScEngine.callback()
Return type:void

pauseRendering

IScEngine.pauseRendering(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

void

pickAllFromRay

IScEngine.pickAllFromRay(ray, config)
Arguments:
Return type:

Promise <[NodeEntitySelectionItem]>

pickAllFromScreen

IScEngine.pickAllFromScreen(viewKey, point, config, isDrawing)
Arguments:
  • viewKey (ViewKey()) – None
  • point (Point2()) – None
  • config (PickConfig()) – None
  • isDrawing (boolean()) – None
Return type:

Promise <[NodeEntitySelectionItem]>

pickFromRay

IScEngine.pickFromRay(ray, config)
Arguments:
Return type:

Promise <null | NodeEntitySelectionItem>

pickFromScreen

IScEngine.pickFromScreen(viewKey, point, config, isDrawing)
Arguments:
  • viewKey (ViewKey()) – None
  • point (Point2()) – None
  • config (PickConfig()) – None
  • isDrawing (boolean()) – None
Return type:

Promise <null | NodeEntitySelectionItem>

redraw

IScEngine.redraw(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

void

registerBimInstances

IScEngine.registerBimInstances(incs, bimType)
Arguments:
  • incs (InstanceIncs()) – None
  • bimType (BimType()) – None
Return type:

void

removeAllCuttingSections

IScEngine.removeAllCuttingSections()
Return type:void

removeCuttingSection

IScEngine.removeCuttingSection(cuttingSection)
Arguments:
Return type:

Promise <void>

removeLight

IScEngine.removeLight(view_key, key)
Arguments:
  • view_key (ViewKey()) – None
  • key (number()) – None
Return type:

void

removeView

IScEngine.removeView(index)
Arguments:
  • index (ViewKey()) – None
Return type:

void

replaceMesh

IScEngine.replaceMesh(id, data)
Arguments:
  • id (MeshId()) – None
  • data (MeshData()) – None
Return type:

Promise <void>

requestMeshInstances

IScEngine.requestMeshInstances(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

void

resetCachedStatistics

IScEngine.resetCachedStatistics()
Return type:void

resetColors

IScEngine.resetColors()
Return type:void

resetOpacity

IScEngine.resetOpacity()
Return type:void

resetToEmpty

IScEngine.resetToEmpty(whitelistInstances, whitelistMeshes)
Arguments:
  • whitelistInstances ([InstanceKey]()) – None
  • whitelistMeshes ([MeshKey]()) – None
Return type:

Promise <void>

resize

IScEngine.resize([viewKey])
Arguments:
  • viewKey (ViewKey()) – optional None
Return type:

void

resumeAllRendering

IScEngine.resumeAllRendering()
Return type:void

resumeRendering

IScEngine.resumeRendering(viewKey)
Arguments:
  • viewKey (ViewKey()) – None
Return type:

void

safeGetMetaData

IScEngine.safeGetMetaData(modelKey, dataKey)
Arguments:
  • modelKey (ModelKey()) – None
  • dataKey (DataKey()) – None
Return type:

Promise <null | Uint8Array>

safeGetMetaDatas

IScEngine.safeGetMetaDatas(modelKey, dataKeys)
Arguments:
  • modelKey (ModelKey()) – None
  • dataKeys ([DataKey]()) – None
Return type:

Promise <null | [Uint8Array]>

safeLoadMetaDatas

IScEngine.safeLoadMetaDatas(ids)
Arguments:
  • ids (DataIds()) – None
Return type:

Promise <void>

setAllowHighDpi

IScEngine.setAllowHighDpi(allow)
Arguments:
  • allow (boolean()) – None
Return type:

void

setAmbientLightColor

IScEngine.setAmbientLightColor(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (Color()) – None
Return type:

void

setAmbientOcclusionEnabled

IScEngine.setAmbientOcclusionEnabled(view_key, enabled)
Arguments:
  • view_key (ViewKey()) – None
  • enabled (boolean()) – None
Return type:

void

setAmbientOcclusionRadius

IScEngine.setAmbientOcclusionRadius(view_key, radius)
Arguments:
  • view_key (ViewKey()) – None
  • radius (number()) – None
Return type:

void

setAntiAliasingMode

IScEngine.setAntiAliasingMode(view_key, antiAliasingMode)
Arguments:
  • view_key (ViewKey()) – None
  • antiAliasingMode (AntiAliasingMode()) – None
Return type:

void

setBackFacesVisible

IScEngine.setBackFacesVisible(view_key, visible)
Arguments:
  • view_key (ViewKey()) – None
  • visible (boolean()) – None
Return type:

void

setBackgroundGradient

IScEngine.setBackgroundGradient(view_key, top, bottom)
Arguments:
  • view_key (ViewKey()) – None
  • top (null | Color()) – None
  • bottom (null | Color()) – None
Return type:

void

setBloomEnabled

IScEngine.setBloomEnabled(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – None
Return type:

void

setBloomIntensityScale

IScEngine.setBloomIntensityScale(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setBloomLayers

IScEngine.setBloomLayers(view_key, layers)
Arguments:
  • view_key (ViewKey()) – None
  • layers ([BloomLayerInfo]()) – None
Return type:

void

setBloomThreshold

IScEngine.setBloomThreshold(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setBloomThresholdRampWidth

IScEngine.setBloomThresholdRampWidth(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setCamera

IScEngine.setCamera(viewKey, camera)
Arguments:
  • viewKey (ViewKey()) – None
  • camera (Camera()) – None
Return type:

void

setCappingDelay

IScEngine.setCappingDelay(delayInMilliseconds)
Arguments:
  • delayInMilliseconds (number()) – None
Return type:

void

setCappingFaceColor

IScEngine.setCappingFaceColor(color)
Arguments:
  • color (null | Color()) – None
Return type:

void

setCappingGeometryVisibility

IScEngine.setCappingGeometryVisibility(view_key, cappingGeometryVisibility)
Arguments:
  • view_key (ViewKey()) – None
  • cappingGeometryVisibility (boolean()) – None
Return type:

void

setCappingLineColor

IScEngine.setCappingLineColor(color)
Arguments:
  • color (null | Color()) – None
Return type:

void

setCullingVector

IScEngine.setCullingVector(incs, space, vector, toleranceDegrees)
Arguments:
  • incs (InstanceIncs()) – None
  • space (CullingVectorSpace()) – None
  • vector (Point3()) – None
  • toleranceDegrees (number()) – None
Return type:

void

setDefaultDepthRange

IScEngine.setDefaultDepthRange(view_key, min, max)
Arguments:
  • view_key (ViewKey()) – None
  • min (number()) – None
  • max (number()) – None
Return type:

void

setDepthRange

IScEngine.setDepthRange(incs, min, max)
Arguments:
  • incs (InstanceIncs()) – None
  • min (number()) – None
  • max (number()) – None
Return type:

void

setDisplayIncompleteFrames

IScEngine.setDisplayIncompleteFrames(value, viewKey)
Arguments:
  • value (boolean()) – None
  • viewKey (ViewKey()) – None
Return type:

void

setDrawMode

IScEngine.setDrawMode(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (DrawMode()) – None
Return type:

void

setDrawStrategy

IScEngine.setDrawStrategy(viewKey, strategy)
Arguments:
  • viewKey (ViewKey()) – None
  • strategy (DrawStrategy()) – None
Return type:

void

setElementColor

IScEngine.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

IScEngine.setElementHighlightColor(viewKey, fillColor, outlineColor)
Arguments:
  • viewKey (ViewKey()) – None
  • fillColor (null | Color()) – None
  • outlineColor (null | Color()) – None
Return type:

void

setElementVisibility

IScEngine.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

IScEngine.setExplodeMagnitude(magnitude)
Arguments:
  • magnitude (number()) – None
Return type:

void

setEyeDomeLightingBlurEdgeDistance

IScEngine.setEyeDomeLightingBlurEdgeDistance(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setEyeDomeLightingBlurInterval

IScEngine.setEyeDomeLightingBlurInterval(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setEyeDomeLightingBlurSamples

IScEngine.setEyeDomeLightingBlurSamples(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setEyeDomeLightingEnabled

IScEngine.setEyeDomeLightingEnabled(view_key, enabled)
Arguments:
  • view_key (ViewKey()) – None
  • enabled (boolean()) – None
Return type:

void

setEyeDomeLightingOpacity

IScEngine.setEyeDomeLightingOpacity(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setEyeDomeLightingShadingEdgeDistance

IScEngine.setEyeDomeLightingShadingEdgeDistance(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setFaceVisibility

IScEngine.setFaceVisibility(view_key, faceVisibility)
Arguments:
  • view_key (ViewKey()) – None
  • faceVisibility (boolean()) – None
Return type:

void

setGoochBaseColorProminence

IScEngine.setGoochBaseColorProminence(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setGoochBlue

IScEngine.setGoochBlue(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setGoochLuminanceShiftStrength

IScEngine.setGoochLuminanceShiftStrength(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setGoochYellow

IScEngine.setGoochYellow(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setGroundPlane

IScEngine.setGroundPlane(view_key, normal[, position])
Arguments:
  • view_key (ViewKey()) – None
  • normal (Point3()) – None
  • position (Point3()) – optional None
Return type:

void

setHardEdgeColor

IScEngine.setHardEdgeColor(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (Color()) – None
Return type:

void

setHardEdgeOpacity

IScEngine.setHardEdgeOpacity(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setHardEdgesEnabled

IScEngine.setHardEdgesEnabled(view_key[, value])
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – optional None
Return type:

void

setHardEdgeThreshold

IScEngine.setHardEdgeThreshold(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setHardEdgeThresholdRampWidth

IScEngine.setHardEdgeThresholdRampWidth(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setHighlightColorizeCompression

IScEngine.setHighlightColorizeCompression(viewKey, compressionLevel)
Arguments:
  • viewKey (ViewKey()) – None
  • compressionLevel (number()) – None
Return type:

void

setImageBasedLightingEnabled

IScEngine.setImageBasedLightingEnabled(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – None
Return type:

void

setImageBasedLightingEnvironment

IScEngine.setImageBasedLightingEnvironment(view_key, data)
Arguments:
  • view_key (ViewKey()) – None
  • data (Uint8Array()) – None
Return type:

void

setImageBasedLightingEnvironmentToDefault

IScEngine.setImageBasedLightingEnvironmentToDefault(view_key)
Arguments:
  • view_key (ViewKey()) – None
Return type:

void

setImageBasedLightingIntensity

IScEngine.setImageBasedLightingIntensity(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setImageBasedLightingMatrix

IScEngine.setImageBasedLightingMatrix(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (Matrix()) – None
Return type:

void

setInstanceModifier

IScEngine.setInstanceModifier(instanceModifier, incs, modifierValue)
Arguments:
  • instanceModifier (InstanceModifier()) – None
  • incs (InstanceIncs()) – None
  • modifierValue (boolean()) – None
Return type:

void

setInstancesMatrix

IScEngine.setInstancesMatrix(incs, matrix)
Arguments:
  • incs (InstanceIncs()) – None
  • matrix (Matrix()) – None
Return type:

void

setInteractiveDrawDelay

IScEngine.setInteractiveDrawDelay(value, viewKey)
Arguments:
  • value (number()) – None
  • viewKey (ViewKey()) – None
Return type:

void

setInteractiveDrawLimitIncreaseEnabled

IScEngine.setInteractiveDrawLimitIncreaseEnabled(enable, viewKey)
Arguments:
  • enable (boolean()) – None
  • viewKey (ViewKey()) – None
Return type:

void

setLightingEnabled

IScEngine.setLightingEnabled(view_key, enabled)
Arguments:
  • view_key (ViewKey()) – None
  • enabled (boolean()) – None
Return type:

void

setLineJitterEnabled

IScEngine.setLineJitterEnabled(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – None
Return type:

void

setLineJitterFrequency

IScEngine.setLineJitterFrequency(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setLineJitterInstanceCount

IScEngine.setLineJitterInstanceCount(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setLineJitterRadius

IScEngine.setLineJitterRadius(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setLinePattern

IScEngine.setLinePattern(incs, pattern, patternLength, patternLengthUnit)
Arguments:
  • incs (InstanceIncs()) – None
  • pattern (LinePattern()) – None
  • patternLength (number()) – None
  • patternLengthUnit (LinePatternLengthUnit()) – None
Return type:

void

setLineVisibility

IScEngine.setLineVisibility(view_key, lineVisibility)
Arguments:
  • view_key (ViewKey()) – None
  • lineVisibility (boolean()) – None
Return type:

void

setMatrices

IScEngine.setMatrices(incs, matrices)
Arguments:
  • incs (InstanceIncs()) – None
  • matrices ([Matrix]()) – None
Return type:

void

setMeshLevel

IScEngine.setMeshLevel(incs, meshLevel)
Arguments:
  • incs (InstanceIncs()) – None
  • meshLevel (number()) – None
Return type:

void

setMetallicRoughness

IScEngine.setMetallicRoughness(incs, metallicFactor, roughnessFactor)
Arguments:
  • incs (InstanceIncs()) – None
  • metallicFactor (number()) – None
  • roughnessFactor (number()) – None
Return type:

void

setMetallicRoughnessMaterialOverride

IScEngine.setMetallicRoughnessMaterialOverride(defaultMetallicFactor, defaultRoughnessFactor)
Arguments:
  • defaultMetallicFactor (number()) – None
  • defaultRoughnessFactor (number()) – None
Return type:

void

setMinimumFramerate

IScEngine.setMinimumFramerate(viewKey, value)
Arguments:
  • viewKey (ViewKey()) – None
  • value (number()) – None
Return type:

void

setNodeHighlightColor

IScEngine.setNodeHighlightColor(viewKey, fillColor, outlineColor)
Arguments:
  • viewKey (ViewKey()) – None
  • fillColor (null | Color()) – None
  • outlineColor (null | Color()) – None
Return type:

void

setOverlayCamera

IScEngine.setOverlayCamera(index, camera, viewKey)
Arguments:
  • index (number()) – None
  • camera (Camera()) – None
  • viewKey (ViewKey()) – None
Return type:

void

setOverlayViewport

IScEngine.setOverlayViewport(index, anchor, x, xUnit, y, yUnit, width, widthUnit, height, heightUnit, viewKey)
Arguments:
  • index (number()) – 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

IScEngine.setOverlayVisibility(index, visibility, viewKey)
Arguments:
  • index (number()) – None
  • visibility (boolean()) – None
  • viewKey (ViewKey()) – None
Return type:

void

setPartAmbientColor

IScEngine.setPartAmbientColor(incs, elementType, color)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • color (Color()) – None
Return type:

void

setPartAmbientMix

IScEngine.setPartAmbientMix(incs, elementType, value)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • value (number()) – None
Return type:

void

setPartColor

IScEngine.setPartColor(incs, elementType, color)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • color (Color()) – None
Return type:

void

setPartEmissiveColor

IScEngine.setPartEmissiveColor(incs, elementType, color)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • color (Color()) – None
Return type:

void

setPartOpacity

IScEngine.setPartOpacity(incs, opacity)
Arguments:
  • incs (InstanceIncs()) – None
  • opacity (number()) – None
Return type:

void

setPartSpecularColor

IScEngine.setPartSpecularColor(incs, elementType, color)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • color (Color()) – None
Return type:

void

setPartSpecularIntensity

IScEngine.setPartSpecularIntensity(incs, elementType, value)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • value (number()) – None
Return type:

void

setPartVisibility

IScEngine.setPartVisibility(incs, visible, onlyDemanded)
Arguments:
  • incs (InstanceIncs()) – None
  • visible (boolean()) – None
  • onlyDemanded (boolean()) – None
Return type:

void

setPickTolerance

IScEngine.setPickTolerance(tolerance)
Arguments:
  • tolerance (number()) – None
Return type:

void

setPointShape

IScEngine.setPointShape(view_key, shape)
Arguments:
  • view_key (ViewKey()) – None
  • shape (PointShape()) – None
Return type:

void

setPointSize

IScEngine.setPointSize(view_key, size, unit)
Arguments:
  • view_key (ViewKey()) – None
  • size (number()) – None
  • unit (PointSizeUnit()) – None
Return type:

void

setPointVisibilityTest

IScEngine.setPointVisibilityTest(view_key, points)
Arguments:
  • view_key (ViewKey()) – None
  • points ([Point3]()) – None
Return type:

void

setProjection

IScEngine.setProjection(viewKey, projection)
Arguments:
  • viewKey (ViewKey()) – None
  • projection (Projection()) – None
Return type:

void

setRemoteEndpoint

IScEngine.setRemoteEndpoint(uri, modelName)
Arguments:
  • uri (string()) – None
  • modelName (string()) – None
Return type:

void

setServerRenderQuality

IScEngine.setServerRenderQuality(jpegQualityLow, jpegQualityHigh, scaleLow, scaleHigh)
Arguments:
  • jpegQualityLow (number()) – None
  • jpegQualityHigh (number()) – None
  • scaleLow (number()) – None
  • scaleHigh (number()) – None
Return type:

void

setSilhouetteColor

IScEngine.setSilhouetteColor(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (Color()) – None
Return type:

void

setSilhouetteEnabled

IScEngine.setSilhouetteEnabled(view_key[, value])
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – optional None
Return type:

void

setSilhouetteOpacity

IScEngine.setSilhouetteOpacity(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSilhouetteThreshold

IScEngine.setSilhouetteThreshold(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSilhouetteThresholdRampWidth

IScEngine.setSilhouetteThresholdRampWidth(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSimpleReflectionAttenuation

IScEngine.setSimpleReflectionAttenuation(view_key, nearDistance, farDistance[, unit])
Arguments:
  • view_key (ViewKey()) – None
  • nearDistance (number()) – None
  • farDistance (number()) – None
  • unit (SimpleReflectionAttenuationUnit()) – optional None
Return type:

void

setSimpleReflectionBlurInterval

IScEngine.setSimpleReflectionBlurInterval(view_key, value, unit)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
  • unit (BlurIntervalUnit()) – None
Return type:

void

setSimpleReflectionBlurSamples

IScEngine.setSimpleReflectionBlurSamples(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSimpleReflectionEnabled

IScEngine.setSimpleReflectionEnabled(view_key[, value])
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – optional None
Return type:

void

setSimpleReflectionFadeAngle

IScEngine.setSimpleReflectionFadeAngle(view_key, degrees)
Arguments:
  • view_key (ViewKey()) – None
  • degrees (number()) – None
Return type:

void

setSimpleReflectionOpacity

IScEngine.setSimpleReflectionOpacity(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSimpleShadowBlurInterval

IScEngine.setSimpleShadowBlurInterval(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSimpleShadowBlurSamples

IScEngine.setSimpleShadowBlurSamples(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSimpleShadowColor

IScEngine.setSimpleShadowColor(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (Color()) – None
Return type:

void

setSimpleShadowEnabled

IScEngine.setSimpleShadowEnabled(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – None
Return type:

void

setSimpleShadowInteractiveUpdateEnabled

IScEngine.setSimpleShadowInteractiveUpdateEnabled(view_key[, value])
Arguments:
  • view_key (ViewKey()) – None
  • value (boolean()) – optional None
Return type:

void

setSimpleShadowOpacity

IScEngine.setSimpleShadowOpacity(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
Return type:

void

setSimpleShadowResolution

IScEngine.setSimpleShadowResolution(view_key, pixels)
Arguments:
  • view_key (ViewKey()) – None
  • pixels (number()) – None
Return type:

void

setStreamCutoffScale

IScEngine.setStreamCutoffScale(value)
Arguments:
  • value (number()) – None
Return type:

void

setStreamIdleMarker

IScEngine.setStreamIdleMarker()
Return type:Promise <void>

setTexture

IScEngine.setTexture(instanceIncs, options)
Arguments:
Return type:

Promise <void>

setTimeout

IScEngine.setTimeout(handler, timeout)
Arguments:
  • handler (function()) – None
  • timeout (number()) – None
Return type:

Timeout
IScEngine.handler()
Return type:void

setToonShadingBandCount

IScEngine.setToonShadingBandCount(view_key, bandCount)
Arguments:
  • view_key (ViewKey()) – None
  • bandCount (number()) – None
Return type:

void

setToonShadingSpecularFactor

IScEngine.setToonShadingSpecularFactor(view_key, specularFactor)
Arguments:
  • view_key (ViewKey()) – None
  • specularFactor (number()) – None
Return type:

void

setTransparencyMode

IScEngine.setTransparencyMode(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (TransparencyMode()) – None
Return type:

void

setVisibilityByAttachment

IScEngine.setVisibilityByAttachment(attachScope, setVisibility)
Arguments:
  • attachScope (AttachScope()) – None
  • setVisibility (SetVisibility()) – None
Return type:

void

setXRayColor

IScEngine.setXRayColor(view_key, group, element, color)
Arguments:
  • view_key (ViewKey()) – None
  • group (XRayGroup()) – None
  • element (ElementType()) – None
  • color (Color()) – None
Return type:

void

setXRayOpacity

IScEngine.setXRayOpacity(view_key, value[, element])
Arguments:
  • view_key (ViewKey()) – None
  • value (number()) – None
  • element (ElementType()) – optional None
Return type:

void

setXRayTransparencyMode

IScEngine.setXRayTransparencyMode(view_key, value)
Arguments:
  • view_key (ViewKey()) – None
  • value (TransparencyMode()) – None
Return type:

void

shutdown

IScEngine.shutdown()
Return type:void

sleep

IScEngine.sleep(duration)
Arguments:
  • duration (number()) – None
Return type:

Promise <void>

start

IScEngine.start(canvasContainer, options)
Arguments:
  • canvasContainer (HTMLDivElement()) – None
  • options (InitOptions()) – None
Return type:

boolean

startComparison

IScEngine.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

IScEngine.startExplode(incs, vector)
Arguments:
  • incs (InstanceIncs()) – None
  • vector (Point3()) – None
Return type:

void

stopExplode

IScEngine.stopExplode()
Return type:void

synchronizeVisibilities

IScEngine.synchronizeVisibilities(incs, visible)
Arguments:
  • incs (InstanceIncs()) – None
  • visible (boolean()) – None
Return type:

void

testPointVisibility

IScEngine.testPointVisibility(view_key, points)
Arguments:
  • view_key (ViewKey()) – None
  • points ([Point3]()) – None
Return type:

Promise <[number]>

throttleLoad

IScEngine.throttleLoad(newPauseInterval, throttleDuration)
Arguments:
  • newPauseInterval (number()) – None
  • throttleDuration (number()) – None
Return type:

void

triangulatePolygon

IScEngine.triangulatePolygon(polygonPoints, normal)
Arguments:
  • polygonPoints (Float32Array | [number]()) – None
  • normal (Vector3()) – None
Return type:

Float32Array

unsetCullingVector

IScEngine.unsetCullingVector(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

void

unsetDepthRange

IScEngine.unsetDepthRange(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

void

unsetElementColor

IScEngine.unsetElementColor(incs, elementType, elementOffset, elementCount)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
  • elementOffset (number()) – None
  • elementCount (number()) – None
Return type:

void

unsetLinePattern

IScEngine.unsetLinePattern(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

void

unsetMetallicRoughness

IScEngine.unsetMetallicRoughness(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

void

unsetPartAmbientColor

IScEngine.unsetPartAmbientColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

void

unsetPartColor

IScEngine.unsetPartColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

void

unsetPartEmissiveColor

IScEngine.unsetPartEmissiveColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

void

unsetPartOpacity

IScEngine.unsetPartOpacity(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

void

unsetPartSpecularColor

IScEngine.unsetPartSpecularColor(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

void

unsetPartSpecularIntensity

IScEngine.unsetPartSpecularIntensity(incs, elementType)
Arguments:
  • incs (InstanceIncs()) – None
  • elementType (ElementType()) – None
Return type:

void

unsetTexture

IScEngine.unsetTexture(incs)
Arguments:
  • incs (InstanceIncs()) – None
Return type:

void

unsetXRayColor

IScEngine.unsetXRayColor(view_key, group, element)
Arguments:
  • view_key (ViewKey()) – None
  • group (XRayGroup()) – None
  • element (ElementType()) – None
Return type:

Promise <void>

updateCamera

IScEngine.updateCamera(viewKey, camera)
Arguments:
  • viewKey (ViewKey()) – None
  • camera (Camera()) – None
Return type:

Camera

updateCuttingSection

IScEngine.updateCuttingSection(cuttingSection)
Arguments:
Return type:

Promise <void>

updateLight

IScEngine.updateLight(view_key, key, light)
Arguments:
  • view_key (ViewKey()) – None
  • key (number()) – None
  • light (Light()) – None
Return type:

void

waitForImageDecoding

IScEngine.waitForImageDecoding()
Return type:Promise <void>