IScEngine

class IScEngine()

Index

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
• getPartsBounding
• getPartSpecularColor
• 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
• setCamera
• setCappingDelay
• setCappingFaceColor
• setCappingGeometryVisibility
• setCappingLineColor
• setCullingVector
• setDefaultDepthRange
• setDepthRange
• setDisplayIncompleteFrames
• setDrawMode
• setDrawStrategy
• setElementColor
• setElementHighlightColor
• setElementsVisibilityOverride
• setElementVisibility
• setExplodeMagnitude
• setEyeDomeLightingBlurEdgeDistance
• setEyeDomeLightingBlurInterval
• setEyeDomeLightingBlurSamples
• setEyeDomeLightingEnabled
• setEyeDomeLightingOpacity
• setEyeDomeLightingShadingEdgeDistance
• setFaceVisibility
• setGoochBaseColorProminence
• setGoochBlue
• setGoochLuminanceShiftStrength
• setGoochYellow
• setGroundPlane
• setHardEdgeColor
• setHardEdgeOpacity
• setHardEdgesEnabled
• setHardEdgeThreshold
• setHardEdgeThresholdRampWidth
• 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
• unsetElementsVisibilityOverride
• unsetLinePattern
• unsetMetallicRoughness
• unsetPartAmbientColor
• unsetPartColor
• unsetPartEmissiveColor
• unsetPartOpacity
• unsetPartSpecularColor
• unsetPartSpecularIntensity
• unsetTexture
• unsetXRayColor
• updateCamera
• updateCuttingSection
• updateLight
• waitForImageDecoding

Methods

IScEngine._getScPlaneArray()

_getScPlaneArray(cuttingSection: ICuttingSection): Vector4[]

Parameters

cuttingSection: ICuttingSection

Returns: Vector4[]

IScEngine._toTextureInterpolation()

_toTextureInterpolation(value: (undefined | boolean)): TextureInterpolation

Parameters

value: (undefined | boolean)

Returns: TextureInterpolation

IScEngine._toTextureMipMapping()

_toTextureMipMapping(value: (undefined | boolean)): TextureMipMapping

Parameters

value: (undefined | boolean)

Returns: TextureMipMapping

IScEngine._toTextureModifier()

_toTextureModifier(value: (undefined | number)): TextureModifier

Parameters

value: (undefined | number)

Returns: TextureModifier

IScEngine._toTextureParameterization()

_toTextureParameterization(value: (undefined | TextureParameterization)): TextureParameterization

Parameters

value: (undefined | TextureParameterization)

Returns: TextureParameterization

IScEngine._toTextureTiling()

_toTextureTiling(value: (undefined | TextureTiling)): TextureTiling

Parameters

value: (undefined | TextureTiling)

Returns: TextureTiling

IScEngine.addCuttingSection()

addCuttingSection(cuttingSection: ICuttingSection): Promise

Parameters

cuttingSection: ICuttingSection

Returns: Promise

IScEngine.addLight()

addLight(view_key: ViewKey, light: Light): Promise

Parameters

view_key: ViewKey

light: Light

Returns: Promise

IScEngine.addNodesToOverlay()

addNodesToOverlay(incs: InstanceIncs, viewKey: ViewKey, index: number): void

Parameters

incs: InstanceIncs

viewKey: ViewKey

index: number

Returns: void

IScEngine.addPointLight()

addPointLight(view_key: ViewKey, light: PointLight): Promise

Parameters

view_key: ViewKey

light: PointLight

Returns: Promise

IScEngine.addView()

addView(canvasContainer: HTMLDivElement): Promise

Parameters

canvasContainer: HTMLDivElement

Returns: Promise

IScEngine.advanceExportToSvg()

advanceExportToSvg(): Promise

Returns: Promise

IScEngine.advanceIncrementalSelection()

advanceIncrementalSelection(handle: IncrementalSelectionId): Promise

Parameters

handle: IncrementalSelectionId

Returns: Promise

IScEngine.attachModel()

attachModel(attachScope: AttachScope, modelName: string, inclusionMatrix: Matrix12, parentMeasurementUnit: number, markAllInstancesInvisible: boolean): Promise

Parameters

attachScope: AttachScope

modelName: string

inclusionMatrix: Matrix12

parentMeasurementUnit: number

markAllInstancesInvisible: boolean

Returns: Promise

IScEngine.attachScsBuffer()

attachScsBuffer(attachScope: AttachScope, buffer: (None | ScsBuffer), inclusionMatrix: Matrix12, parentMeasurementUnit: number, markAllInstancesInvisible: boolean, resolveOnFullyLoaded: boolean, cancelUnitMatrix: boolean, autoUnitScale: boolean): Promise

Parameters

attachScope: AttachScope

buffer: (None | ScsBuffer)

inclusionMatrix: Matrix12

parentMeasurementUnit: number

markAllInstancesInvisible: boolean

resolveOnFullyLoaded: boolean

cancelUnitMatrix: boolean

autoUnitScale: boolean

Returns: Promise

IScEngine.attachScsModelByKey()

attachScsModelByKey(attachScope: AttachScope, modelKey: ModelKey, inclusionMatrix: Matrix12, parentMeasurementUnit: number, markAllInstancesInvisible: boolean): InclusionKey

Parameters

attachScope: AttachScope

modelKey: ModelKey

inclusionMatrix: Matrix12

parentMeasurementUnit: number

markAllInstancesInvisible: boolean

Returns: InclusionKey

IScEngine.beginConvexPolyhedronSelection()

beginConvexPolyhedronSelection(volumePlanes: Plane[], heuristicOrigin: Point3, config: IncrementalPickConfig): Promise

Parameters

volumePlanes: Plane[]

heuristicOrigin: Point3

config: IncrementalPickConfig

Returns: Promise

IScEngine.beginExportToSvg()

beginExportToSvg(config: SvgConfig): Promise

Parameters

config: SvgConfig

Returns: Promise

IScEngine.beginRayDrillSelection()

beginRayDrillSelection(viewKey: ViewKey, rayCssOrigin: Point2, rayCssBoxRadius: number, config: IncrementalPickConfig): Promise

Parameters

viewKey: ViewKey

rayCssOrigin: Point2

rayCssBoxRadius: number

config: IncrementalPickConfig

Returns: Promise

IScEngine.beginRequestBatch()

beginRequestBatch(type: RequestBatchType): void

Parameters

type: RequestBatchType

Returns: void

IScEngine.beginScreenAreaSelection()

beginScreenAreaSelection(viewKey: ViewKey, areaCssMin: Point2, areaCssMax: Point2, config: IncrementalPickConfig): Promise

Parameters

viewKey: ViewKey

areaCssMin: Point2

areaCssMax: Point2

config: IncrementalPickConfig

Returns: Promise

IScEngine.beginSphereSelection()

beginSphereSelection(sphereCenter: Vector3, sphereRadius: number, config: IncrementalPickConfig): Promise

Parameters

sphereCenter: Vector3

sphereRadius: number

config: IncrementalPickConfig

Returns: Promise

IScEngine.clearElementVisibility()

clearElementVisibility(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

IScEngine.clearHighlight()

clearHighlight(): void

Returns: void

IScEngine.clearLights()

clearLights(view_key: ViewKey): void

Parameters

view_key: ViewKey

Returns: void

IScEngine.compositePickFromScreen()

compositePickFromScreen(viewKey: ViewKey, point: Point2, config: PickConfig, isDrawing: boolean): Promise

Parameters

viewKey: ViewKey

point: Point2

config: PickConfig

isDrawing: boolean

Returns: Promise

IScEngine.computeMinimumBodyBodyDistance()

computeMinimumBodyBodyDistance(inc1: InstanceInc, inc2: InstanceInc): Promise

Parameters

inc1: InstanceInc

inc2: InstanceInc

Returns: Promise

IScEngine.computeMinimumFaceLineDistance()

computeMinimumFaceLineDistance(inc: InstanceInc, faceId: number, ray: Ray): Promise

Parameters

inc: InstanceInc

faceId: number

ray: Ray

Returns: Promise

IScEngine.computeMinimumFaceRayDistance()

computeMinimumFaceRayDistance(inc: InstanceInc, faceId: number, ray: Ray): Promise

Parameters

inc: InstanceInc

faceId: number

ray: Ray

Returns: Promise

IScEngine.computeMininimumFaceFaceDistance()

computeMininimumFaceFaceDistance(inc1: InstanceInc, face1: number, inc2: InstanceInc, face2: number): Promise

Parameters

inc1: InstanceInc

face1: number

inc2: InstanceInc

face2: number

Returns: Promise

IScEngine.createFloorplanMesh()

createFloorplanMesh(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.createIdentityMatrix()

createIdentityMatrix(): Promise

Returns: Promise

IScEngine.createImage()

createImage(primaryImage: ImageOptions, thumbnailImage: ImageOptions): Promise

Parameters

primaryImage: ImageOptions

thumbnailImage: ImageOptions

Returns: Promise

IScEngine.createMatrix()

createMatrix(elements: Matrix16): Promise

Parameters

elements: Matrix16

Returns: Promise

IScEngine.createMesh()

createMesh(meshData: MeshData): Promise

Parameters

meshData: MeshData

Returns: Promise

IScEngine.createMeshInstance()

createMeshInstance(meshInstanceData: MeshInstanceData): Promise

Parameters

meshInstanceData: MeshInstanceData

Returns: Promise

IScEngine.debug_log()

debug_log(message: string): Promise

Parameters

message: string

Returns: Promise

IScEngine.debug_stateFailure()

debug_stateFailure(value: StateFailure): Promise

Parameters

value: StateFailure

Returns: Promise

IScEngine.debug_sync()

debug_sync(): Promise

Returns: Promise

IScEngine.delayCapping()

delayCapping(): void

Returns: void

IScEngine.destroyImages()

destroyImages(imageIds: ImageIds): Promise

Parameters

imageIds: ImageIds

Returns: Promise

IScEngine.destroyLocalInstances()

destroyLocalInstances(instanceIncs: InstanceIncs): Promise

Parameters

instanceIncs: InstanceIncs

Returns: Promise

IScEngine.destroyMeshes()

destroyMeshes(meshIds: MeshIds): Promise

Parameters

meshIds: MeshIds

Returns: Promise

IScEngine.destroyOverlay()

destroyOverlay(index: number, viewKey: ViewKey): void

Parameters

index: number

viewKey: ViewKey

Returns: void

IScEngine.detachInclusions()

detachInclusions(inclusionKeys: InclusionKey[]): Promise

Parameters

inclusionKeys: InclusionKey[]

Returns: Promise

IScEngine.disconnectNetwork()

disconnectNetwork(): void

Returns: void

IScEngine.enableCappingIdleCallback()

enableCappingIdleCallback(enable: boolean): Promise

Parameters

enable: boolean

Returns: Promise

IScEngine.enableHiddenLineRendering()

enableHiddenLineRendering(view_key: ViewKey, settings: HiddenLineSettings): void

Parameters

view_key: ViewKey

settings: HiddenLineSettings

Returns: void

IScEngine.endComparison()

endComparison(view_key: ViewKey): void

Parameters

view_key: ViewKey

Returns: void

IScEngine.endIncrementalSelection()

endIncrementalSelection(handle: IncrementalSelectionId): void

Parameters

handle: IncrementalSelectionId

Returns: void

IScEngine.endRequestBatch()

endRequestBatch(type: RequestBatchType): void

Parameters

type: RequestBatchType

Returns: void

IScEngine.exportToSvg()

exportToSvg(config: SvgConfig): Promise

Parameters

config: SvgConfig

Returns: Promise

IScEngine.feedScsBuffer()

feedScsBuffer(attachScope: AttachScope, buffer: (None | ScsBuffer)): void

Parameters

attachScope: AttachScope

buffer: (None | ScsBuffer)

Returns: void

IScEngine.flushMetaDataCache()

flushMetaDataCache(): void

Returns: void

IScEngine.getAllowHighDpi()

getAllowHighDpi(): boolean

Returns: boolean

IScEngine.getBounding()

getBounding(incs: InstanceIncs, ignoreInvisible: boolean, includeExcluded: boolean, tightBounding: boolean): Promise

Parameters

incs: InstanceIncs

ignoreInvisible: boolean

includeExcluded: boolean

tightBounding: boolean

Returns: Promise

IScEngine.getCamera()

getCamera(viewKey: ViewKey): Camera

Parameters

viewKey: ViewKey

Returns: Camera

IScEngine.getCameraPromise()

getCameraPromise(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

IScEngine.getCanvasSize()

getCanvasSize(viewKey: ViewKey): Point2

Parameters

viewKey: ViewKey

Returns: Point2

IScEngine.getCappedInstances()

getCappedInstances(): Promise

Returns: Promise

IScEngine.getCappingGeometryVisibility()

getCappingGeometryVisibility(): boolean

Returns: boolean

IScEngine.getClientDimensions()

getClientDimensions(viewKey: ViewKey): [number, number]

Parameters

viewKey: ViewKey

Returns: [number, number]

IScEngine.getCullingVector()

getCullingVector(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.getCuttingSectionLimits()

getCuttingSectionLimits(): CuttingSectionLimits

Returns: CuttingSectionLimits

IScEngine.getDataFromIds()

getDataFromIds(ids: DataIds): Promise

Parameters

ids: DataIds

Returns: Promise

IScEngine.getDrawnPartsBounding()

getDrawnPartsBounding(incs: InstanceIncs, viewKey: ViewKey): Promise

Parameters

incs: InstanceIncs

viewKey: ViewKey

Returns: Promise

IScEngine.getEffectiveElementColor()

getEffectiveElementColor(incs: InstanceIncs, elementType: ElementType, elementOffset: number, viewKey: ViewKey): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

elementOffset: number

viewKey: ViewKey

Returns: Promise

IScEngine.getEffectivePartColor()

getEffectivePartColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getEffectivePartOpacity()

getEffectivePartOpacity(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getElementColor()

getElementColor(incs: InstanceIncs, elementType: ElementType, elementOffset: number): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

elementOffset: number

Returns: Promise

IScEngine.getElementHighlighted()

getElementHighlighted(incs: InstanceIncs, elementType: ElementType, elementIndex: number): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

Returns: Promise

IScEngine.getEyeDomeLightingBlurEdgeDistance()

getEyeDomeLightingBlurEdgeDistance(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getEyeDomeLightingBlurInterval()

getEyeDomeLightingBlurInterval(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getEyeDomeLightingBlurSamples()

getEyeDomeLightingBlurSamples(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getEyeDomeLightingEnabled()

getEyeDomeLightingEnabled(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getEyeDomeLightingOpacity()

getEyeDomeLightingOpacity(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getEyeDomeLightingShadingEdgeDistance()

getEyeDomeLightingShadingEdgeDistance(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getFullCameraMatrix()

getFullCameraMatrix(camera: Camera, viewKey: ViewKey): Matrix

Parameters

camera: Camera

viewKey: ViewKey

Returns: Matrix

IScEngine.getInstancesCappingMeshData()

getInstancesCappingMeshData(inc: InstanceInc): Promise

Parameters

inc: InstanceInc

Returns: Promise

getInstancesCappingMeshData(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.getInstancesMeshData()

getInstancesMeshData(inc: InstanceInc): Promise

Parameters

inc: InstanceInc

Returns: Promise

getInstancesMeshData(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.getInteractiveDrawLimitIncreaseEnabled()

getInteractiveDrawLimitIncreaseEnabled(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

IScEngine.getLight()

getLight(view_key: ViewKey, key: number): Promise

Parameters

view_key: ViewKey

key: number

Returns: Promise

IScEngine.getLightKeys()

getLightKeys(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getLooseBounding()

getLooseBounding(): Promise

Returns: Promise

IScEngine.getMaxOverlayIndex()

getMaxOverlayIndex(): number

Returns: number

IScEngine.getMeshData()

getMeshData(id: MeshId): Promise

Parameters

id: MeshId

Returns: Promise

IScEngine.getMetallicRoughness()

getMetallicRoughness(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.getMinimumFramerate()

getMinimumFramerate(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

IScEngine.getModelBounding()

getModelBounding(ignoreInvisible: boolean, includeExcluded: boolean, tightBounding: boolean): Promise

Parameters

ignoreInvisible: boolean

includeExcluded: boolean

tightBounding: boolean

Returns: Promise

IScEngine.getNetworkModelName()

getNetworkModelName(): string

Returns: string

IScEngine.getPartAmbientColor()

getPartAmbientColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getPartColor()

getPartColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getPartEffectiveAmbientColor()

getPartEffectiveAmbientColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getPartEffectiveEmissiveColor()

getPartEffectiveEmissiveColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getPartEffectiveSpecularColor()

getPartEffectiveSpecularColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getPartEmissiveColor()

getPartEmissiveColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getPartHasTransparency()

getPartHasTransparency(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.getPartHighlighted()

getPartHighlighted(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.getPartMaterial()

getPartMaterial(nodeIds: InstanceIncs): Promise

Parameters

nodeIds: InstanceIncs

Returns: Promise

IScEngine.getPartOpacity()

getPartOpacity(incs: InstanceIncs): (None | number)[]

Parameters

incs: InstanceIncs

Returns: (None | number)[]

IScEngine.getPartsBounding()

getPartsBounding(incs: InstanceIncs, ignoreInvisible: boolean, tightBounding: boolean): Promise

Parameters

incs: InstanceIncs

ignoreInvisible: boolean

tightBounding: boolean

Returns: Promise

IScEngine.getPartSpecularColor()

getPartSpecularColor(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

IScEngine.getPickTolerance()

getPickTolerance(): number

Returns: number

IScEngine.getPointShape()

getPointShape(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getPointSize()

getPointSize(view_key: ViewKey): Promise

Parameters

view_key: ViewKey

Returns: Promise

IScEngine.getPrimaryModelKey()

getPrimaryModelKey(): Promise

Returns: Promise

IScEngine.getProjectionMatrix()

getProjectionMatrix(camera: Camera, viewKey: ViewKey): Matrix

Parameters

camera: Camera

viewKey: ViewKey

Returns: Matrix

IScEngine.getRendererType()

getRendererType(): RendererType

Returns: RendererType

IScEngine.getScsInfo()

getScsInfo(): (None | string | ScsBuffer)

Returns: (None | string | ScsBuffer)

IScEngine.getSessionType()

getSessionType(): SessionType

Returns: SessionType

IScEngine.getStatistics()

getStatistics(forceUpdate: boolean): Promise

Parameters

forceUpdate: boolean

Returns: Promise

IScEngine.getStreamCutoffScale()

getStreamCutoffScale(): number

Returns: number

IScEngine.getVersionString()

getVersionString(): string

Returns: string

IScEngine.getViewMatrix()

getViewMatrix(camera: Camera): Matrix

Parameters

camera: Camera

Returns: Matrix

IScEngine.hasDepthRange()

hasDepthRange(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

IScEngine.highlightElements()

highlightElements(incs: InstanceIncs, elementType: ElementType, elementIndex: number, elementCount: number, value: boolean): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

elementCount: number

value: boolean

Returns: void

IScEngine.highlightParts()

highlightParts(incs: InstanceIncs, highlighted: boolean): void

Parameters

incs: InstanceIncs

highlighted: boolean

Returns: void

IScEngine.instanceKeyInfo()

instanceKeyInfo(attachScope: AttachScope, by: Attachment, ret: AllKeys): Promise

Parameters

attachScope: AttachScope

by: Attachment

ret: AllKeys

Returns: Promise

instanceKeyInfo(attachScope: AttachScope, by: Attachment, ret: KeyCountOnly): Promise

Parameters

attachScope: AttachScope

by: Attachment

ret: KeyCountOnly

Returns: Promise

IScEngine.isInit()

isInit(): boolean

Returns: boolean

IScEngine.loadEmpty()

loadEmpty(): Promise

Returns: Promise

IScEngine.loadFinished()

loadFinished(): boolean

Returns: boolean

IScEngine.logMessage()

logMessage(message: string): void

Parameters

message: string

Returns: void

IScEngine.loseWebGlContext()

loseWebGlContext(): boolean

Returns: boolean

IScEngine.markCameraAsEmpty()

markCameraAsEmpty(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

IScEngine.metaDataKeyInfo()

metaDataKeyInfo(modelKeyOrAttachScope: (ModelKey | AttachScope), byModel: boolean, keyCountOnly: boolean): Promise

Parameters

modelKeyOrAttachScope: (ModelKey | AttachScope)

byModel: boolean

keyCountOnly: boolean

Returns: Promise

IScEngine.modelKeysFromInclusionKeys()

modelKeysFromInclusionKeys(inclusionKeys: InclusionKey[]): Promise

Parameters

inclusionKeys: InclusionKey[]

Returns: Promise

IScEngine.pauseAllRendering()

pauseAllRendering(callback: () => void): void

Parameters

callback: () => void

Returns: void

IScEngine.pauseRendering()

pauseRendering(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

IScEngine.pickAllFromRay()

pickAllFromRay(ray: Ray, config: PickConfig): Promise

Parameters

ray: Ray

config: PickConfig

Returns: Promise

IScEngine.pickAllFromScreen()

pickAllFromScreen(viewKey: ViewKey, point: Point2, config: PickConfig, isDrawing: boolean): Promise

Parameters

viewKey: ViewKey

point: Point2

config: PickConfig

isDrawing: boolean

Returns: Promise

IScEngine.pickFromRay()

pickFromRay(ray: Ray, config: PickConfig): Promise

Parameters

ray: Ray

config: PickConfig

Returns: Promise

IScEngine.pickFromScreen()

pickFromScreen(viewKey: ViewKey, point: Point2, config: PickConfig, isDrawing: boolean): Promise

Parameters

viewKey: ViewKey

point: Point2

config: PickConfig

isDrawing: boolean

Returns: Promise

IScEngine.redraw()

redraw(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

IScEngine.registerBimInstances()

registerBimInstances(incs: InstanceIncs, bimType: BimType): void

Parameters

incs: InstanceIncs

bimType: BimType

Returns: void

IScEngine.removeAllCuttingSections()

removeAllCuttingSections(): void

Returns: void

IScEngine.removeCuttingSection()

removeCuttingSection(cuttingSection: ICuttingSection): Promise

Parameters

cuttingSection: ICuttingSection

Returns: Promise

IScEngine.removeLight()

removeLight(view_key: ViewKey, key: number): void

Parameters

view_key: ViewKey

key: number

Returns: void

IScEngine.removeView()

removeView(index: ViewKey): void

Parameters

index: ViewKey

Returns: void

IScEngine.replaceMesh()

replaceMesh(id: MeshId, data: MeshData): Promise

Parameters

id: MeshId

data: MeshData

Returns: Promise

IScEngine.requestMeshInstances()

requestMeshInstances(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

IScEngine.resetCachedStatistics()

resetCachedStatistics(): void

Returns: void

IScEngine.resetColors()

resetColors(): void

Returns: void

IScEngine.resetOpacity()

resetOpacity(): void

Returns: void

IScEngine.resetPartMaterial()

resetPartMaterial(nodeIds: InstanceIncs, params: keyof IMaterial[]): void

Parameters

nodeIds: InstanceIncs

params: keyof IMaterial[]

Returns: void

IScEngine.resetToEmpty()

resetToEmpty(whitelistInstances: InstanceKey[], whitelistMeshes: MeshKey[]): Promise

Parameters

whitelistInstances: InstanceKey[]

whitelistMeshes: MeshKey[]

Returns: Promise

IScEngine.resize()

resize(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

IScEngine.resumeAllRendering()

resumeAllRendering(): void

Returns: void

IScEngine.resumeRendering()

resumeRendering(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

IScEngine.safeGetMetaData()

safeGetMetaData(modelKey: ModelKey, dataKey: DataKey): Promise

Parameters

modelKey: ModelKey

dataKey: DataKey

Returns: Promise

IScEngine.safeGetMetaDatas()

safeGetMetaDatas(modelKey: ModelKey, dataKeys: DataKey[]): Promise

Parameters

modelKey: ModelKey

dataKeys: DataKey[]

Returns: Promise

IScEngine.safeLoadMetaDatas()

safeLoadMetaDatas(ids: DataIds): Promise

Parameters

ids: DataIds

Returns: Promise

IScEngine.setAllowHighDpi()

setAllowHighDpi(allow: boolean): void

Parameters

allow: boolean

Returns: void

IScEngine.setAmbientLightColor()

setAmbientLightColor(view_key: ViewKey, value: Color): void

Parameters

view_key: ViewKey

value: Color

Returns: void

IScEngine.setAmbientOcclusionEnabled()

setAmbientOcclusionEnabled(view_key: ViewKey, enabled: boolean): void

Parameters

view_key: ViewKey

enabled: boolean

Returns: void

IScEngine.setAmbientOcclusionRadius()

setAmbientOcclusionRadius(view_key: ViewKey, radius: number): void

Parameters

view_key: ViewKey

radius: number

Returns: void

IScEngine.setAntiAliasingMode()

setAntiAliasingMode(view_key: ViewKey, antiAliasingMode: AntiAliasingMode): void

Parameters

view_key: ViewKey

antiAliasingMode: AntiAliasingMode

Returns: void

IScEngine.setBackFacesVisible()

setBackFacesVisible(view_key: ViewKey, visible: boolean): void

Parameters

view_key: ViewKey

visible: boolean

Returns: void

IScEngine.setBackgroundGradient()

setBackgroundGradient(view_key: ViewKey, top: (None | Color), bottom: (None | Color)): void

Parameters

view_key: ViewKey

top: (None | Color)

bottom: (None | Color)

Returns: void

IScEngine.setBloomEnabled()

setBloomEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setBloomIntensityScale()

setBloomIntensityScale(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setBloomLayers()

setBloomLayers(view_key: ViewKey, layers: BloomLayerInfo[]): void

Parameters

view_key: ViewKey

layers: BloomLayerInfo[]

Returns: void

IScEngine.setBloomThreshold()

setBloomThreshold(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setBloomThresholdRampWidth()

setBloomThresholdRampWidth(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setCamera()

setCamera(viewKey: ViewKey, camera: Camera): void

Parameters

viewKey: ViewKey

camera: Camera

Returns: void

IScEngine.setCappingDelay()

setCappingDelay(delayInMilliseconds: number): void

Parameters

delayInMilliseconds: number

Returns: void

IScEngine.setCappingFaceColor()

setCappingFaceColor(color: (None | Color)): void

Parameters

color: (None | Color)

Returns: void

IScEngine.setCappingGeometryVisibility()

setCappingGeometryVisibility(view_key: ViewKey, cappingGeometryVisibility: boolean): void

Parameters

view_key: ViewKey

cappingGeometryVisibility: boolean

Returns: void

IScEngine.setCappingLineColor()

setCappingLineColor(color: (None | Color)): void

Parameters

color: (None | Color)

Returns: void

IScEngine.setCullingVector()

setCullingVector(incs: InstanceIncs, space: CullingVectorSpace, vector: Point3, toleranceDegrees: number): void

Parameters

incs: InstanceIncs

space: CullingVectorSpace

vector: Point3

toleranceDegrees: number

Returns: void

IScEngine.setDefaultDepthRange()

setDefaultDepthRange(view_key: ViewKey, min: number, max: number): void

Parameters

view_key: ViewKey

min: number

max: number

Returns: void

IScEngine.setDepthRange()

setDepthRange(incs: InstanceIncs, min: number, max: number): void

Parameters

incs: InstanceIncs

min: number

max: number

Returns: void

IScEngine.setDisplayIncompleteFrames()

setDisplayIncompleteFrames(value: boolean, viewKey: ViewKey): void

Parameters

value: boolean

viewKey: ViewKey

Returns: void

IScEngine.setDrawMode()

setDrawMode(view_key: ViewKey, value: DrawMode): void

Parameters

view_key: ViewKey

value: DrawMode

Returns: void

IScEngine.setDrawStrategy()

setDrawStrategy(viewKey: ViewKey, strategy: DrawStrategy): void

Parameters

viewKey: ViewKey

strategy: DrawStrategy

Returns: void

IScEngine.setElementColor()

setElementColor(incs: InstanceIncs, elementType: ElementType, elementOffset: number, elementCount: number, color: Color): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementOffset: number

elementCount: number

color: Color

Returns: void

IScEngine.setElementHighlightColor()

setElementHighlightColor(viewKey: ViewKey, fillColor: (None | Color), outlineColor: (None | Color)): void

Parameters

viewKey: ViewKey

fillColor: (None | Color)

outlineColor: (None | Color)

Returns: void

IScEngine.setElementsVisibilityOverride()

setElementsVisibilityOverride(instances: InstanceIncs, pointsVisible: boolean, linesVisible: boolean, facesVisible: boolean): void

Sets the visibility mask override for the given instances Will be applied for all views

Parameters

instances: InstanceIncs

Instances to apply the override to

pointsVisible: boolean

if points should be visible in the mask

linesVisible: boolean

if lines should be visible in the mask

facesVisible: boolean

if faces should be visible in the mask

Returns: void

IScEngine.setElementVisibility()

setElementVisibility(incs: InstanceIncs, elementType: ElementType, elementOffset: number, elementCount: number, visible: boolean): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementOffset: number

elementCount: number

visible: boolean

Returns: void

IScEngine.setExplodeMagnitude()

setExplodeMagnitude(magnitude: number): void

Parameters

magnitude: number

Returns: void

IScEngine.setEyeDomeLightingBlurEdgeDistance()

setEyeDomeLightingBlurEdgeDistance(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setEyeDomeLightingBlurInterval()

setEyeDomeLightingBlurInterval(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setEyeDomeLightingBlurSamples()

setEyeDomeLightingBlurSamples(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setEyeDomeLightingEnabled()

setEyeDomeLightingEnabled(view_key: ViewKey, enabled: boolean): void

Parameters

view_key: ViewKey

enabled: boolean

Returns: void

IScEngine.setEyeDomeLightingOpacity()

setEyeDomeLightingOpacity(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setEyeDomeLightingShadingEdgeDistance()

setEyeDomeLightingShadingEdgeDistance(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setFaceVisibility()

setFaceVisibility(view_key: ViewKey, faceVisibility: boolean): void

Parameters

view_key: ViewKey

faceVisibility: boolean

Returns: void

IScEngine.setGoochBaseColorProminence()

setGoochBaseColorProminence(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setGoochBlue()

setGoochBlue(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setGoochLuminanceShiftStrength()

setGoochLuminanceShiftStrength(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setGoochYellow()

setGoochYellow(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setGroundPlane()

setGroundPlane(view_key: ViewKey, normal: Point3, position: Point3): void

Parameters

view_key: ViewKey

normal: Point3

position: Point3

Returns: void

IScEngine.setHardEdgeColor()

setHardEdgeColor(view_key: ViewKey, value: Color): void

Parameters

view_key: ViewKey

value: Color

Returns: void

IScEngine.setHardEdgeOpacity()

setHardEdgeOpacity(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setHardEdgesEnabled()

setHardEdgesEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setHardEdgeThreshold()

setHardEdgeThreshold(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setHardEdgeThresholdRampWidth()

setHardEdgeThresholdRampWidth(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setHighlightColorizeCompression()

setHighlightColorizeCompression(viewKey: ViewKey, compressionLevel: number): void

Parameters

viewKey: ViewKey

compressionLevel: number

Returns: void

IScEngine.setImageBasedLightingEnabled()

setImageBasedLightingEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setImageBasedLightingEnvironment()

setImageBasedLightingEnvironment(view_key: ViewKey, data: Uint8Array): void

Parameters

view_key: ViewKey

data: Uint8Array

Returns: void

IScEngine.setImageBasedLightingEnvironmentToDefault()

setImageBasedLightingEnvironmentToDefault(view_key: ViewKey): void

Parameters

view_key: ViewKey

Returns: void

IScEngine.setImageBasedLightingIntensity()

setImageBasedLightingIntensity(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setImageBasedLightingMatrix()

setImageBasedLightingMatrix(view_key: ViewKey, value: Matrix): void

Parameters

view_key: ViewKey

value: Matrix

Returns: void

IScEngine.setInstanceModifier()

setInstanceModifier(instanceModifier: InstanceModifier, incs: InstanceIncs, modifierValue: boolean): void

Parameters

instanceModifier: InstanceModifier

incs: InstanceIncs

modifierValue: boolean

Returns: void

IScEngine.setInstancesMatrix()

setInstancesMatrix(incs: InstanceIncs, matrix: Matrix): void

Parameters

incs: InstanceIncs

matrix: Matrix

Returns: void

IScEngine.setInteractiveDrawDelay()

setInteractiveDrawDelay(value: number, viewKey: ViewKey): void

Parameters

value: number

viewKey: ViewKey

Returns: void

IScEngine.setInteractiveDrawLimitIncreaseEnabled()

setInteractiveDrawLimitIncreaseEnabled(enable: boolean, viewKey: ViewKey): void

Parameters

enable: boolean

viewKey: ViewKey

Returns: void

IScEngine.setLightingEnabled()

setLightingEnabled(view_key: ViewKey, enabled: boolean): void

Parameters

view_key: ViewKey

enabled: boolean

Returns: void

IScEngine.setLineJitterEnabled()

setLineJitterEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setLineJitterFrequency()

setLineJitterFrequency(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setLineJitterInstanceCount()

setLineJitterInstanceCount(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setLineJitterRadius()

setLineJitterRadius(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setLinePattern()

setLinePattern(incs: InstanceIncs, pattern: LinePattern, patternLength: number, patternLengthUnit: LinePatternLengthUnit): void

Parameters

incs: InstanceIncs

pattern: LinePattern

patternLength: number

patternLengthUnit: LinePatternLengthUnit

Returns: void

IScEngine.setLineVisibility()

setLineVisibility(view_key: ViewKey, lineVisibility: boolean): void

Parameters

view_key: ViewKey

lineVisibility: boolean

Returns: void

IScEngine.setMatrices()

setMatrices(incs: InstanceIncs, matrices: Matrix[]): void

Parameters

incs: InstanceIncs

matrices: Matrix[]

Returns: void

IScEngine.setMeshLevel()

setMeshLevel(incs: InstanceIncs, meshLevel: number): void

Parameters

incs: InstanceIncs

meshLevel: number

Returns: void

IScEngine.setMetallicRoughness()

setMetallicRoughness(incs: InstanceIncs, metallicFactor: number, roughnessFactor: number): void

Parameters

incs: InstanceIncs

metallicFactor: number

roughnessFactor: number

Returns: void

IScEngine.setMetallicRoughnessMaterialOverride()

setMetallicRoughnessMaterialOverride(defaultMetallicFactor: number, defaultRoughnessFactor: number): void

Parameters

defaultMetallicFactor: number

defaultRoughnessFactor: number

Returns: void

IScEngine.setMinimumFramerate()

setMinimumFramerate(viewKey: ViewKey, value: number): void

Parameters

viewKey: ViewKey

value: number

Returns: void

IScEngine.setNodeHighlightColor()

setNodeHighlightColor(viewKey: ViewKey, fillColor: (None | Color), outlineColor: (None | Color)): void

Parameters

viewKey: ViewKey

fillColor: (None | Color)

outlineColor: (None | Color)

Returns: void

IScEngine.setOverlayCamera()

setOverlayCamera(index: number, camera: Camera, viewKey: ViewKey): void

Parameters

index: number

camera: Camera

viewKey: ViewKey

Returns: void

IScEngine.setOverlayViewport()

setOverlayViewport(index: number, anchor: OverlayAnchor, x: number, xUnit: OverlayUnit, y: number, yUnit: OverlayUnit, width: number, widthUnit: OverlayUnit, height: number, heightUnit: OverlayUnit, viewKey: ViewKey): void

Parameters

index: number

anchor: OverlayAnchor

x: number

xUnit: OverlayUnit

y: number

yUnit: OverlayUnit

width: number

widthUnit: OverlayUnit

height: number

heightUnit: OverlayUnit

viewKey: ViewKey

Returns: void

IScEngine.setOverlayVisibility()

setOverlayVisibility(index: number, visibility: boolean, viewKey: ViewKey): void

Parameters

index: number

visibility: boolean

viewKey: ViewKey

Returns: void

IScEngine.setPartAmbientColor()

setPartAmbientColor(incs: InstanceIncs, elementType: ElementType, color: Color): void

Parameters

incs: InstanceIncs

elementType: ElementType

color: Color

Returns: void

IScEngine.setPartAmbientMix()

setPartAmbientMix(incs: InstanceIncs, elementType: ElementType, value: number): void

Parameters

incs: InstanceIncs

elementType: ElementType

value: number

Returns: void

IScEngine.setPartColor()

setPartColor(incs: InstanceIncs, elementType: ElementType, color: Color): void

Parameters

incs: InstanceIncs

elementType: ElementType

color: Color

Returns: void

IScEngine.setPartEmissiveColor()

setPartEmissiveColor(incs: InstanceIncs, elementType: ElementType, color: Color): void

Parameters

incs: InstanceIncs

elementType: ElementType

color: Color

Returns: void

IScEngine.setPartMaterial()

setPartMaterial(incs: InstanceIncs, material: IMaterial): void

Parameters

incs: InstanceIncs

material: IMaterial

Returns: void

IScEngine.setPartOpacity()

setPartOpacity(incs: InstanceIncs, opacity: number): void

Parameters

incs: InstanceIncs

opacity: number

Returns: void

IScEngine.setPartSpecularColor()

setPartSpecularColor(incs: InstanceIncs, elementType: ElementType, color: Color): void

Parameters

incs: InstanceIncs

elementType: ElementType

color: Color

Returns: void

IScEngine.setPartSpecularIntensity()

setPartSpecularIntensity(incs: InstanceIncs, elementType: ElementType, value: number): void

Parameters

incs: InstanceIncs

elementType: ElementType

value: number

Returns: void

IScEngine.setPartVisibility()

setPartVisibility(incs: InstanceIncs, visible: boolean, onlyDemanded: boolean): void

Parameters

incs: InstanceIncs

visible: boolean

onlyDemanded: boolean

Returns: void

IScEngine.setPickTolerance()

setPickTolerance(tolerance: number): void

Parameters

tolerance: number

Returns: void

IScEngine.setPointShape()

setPointShape(view_key: ViewKey, shape: PointShape): void

Parameters

view_key: ViewKey

shape: PointShape

Returns: void

IScEngine.setPointSize()

setPointSize(view_key: ViewKey, size: number, unit: PointSizeUnit): void

Parameters

view_key: ViewKey

size: number

unit: PointSizeUnit

Returns: void

IScEngine.setPointVisibilityTest()

setPointVisibilityTest(view_key: ViewKey, points: Point3[]): void

Parameters

view_key: ViewKey

points: Point3[]

Returns: void

IScEngine.setProjection()

setProjection(viewKey: ViewKey, projection: Projection): void

Parameters

viewKey: ViewKey

projection: Projection

Returns: void

IScEngine.setRemoteEndpoint()

setRemoteEndpoint(uri: string, modelName: string): void

Parameters

uri: string

modelName: string

Returns: void

IScEngine.setServerRenderQuality()

setServerRenderQuality(jpegQualityLow: number, jpegQualityHigh: number, scaleLow: number, scaleHigh: number): void

Parameters

jpegQualityLow: number

jpegQualityHigh: number

scaleLow: number

scaleHigh: number

Returns: void

IScEngine.setSilhouetteColor()

setSilhouetteColor(view_key: ViewKey, value: Color): void

Parameters

view_key: ViewKey

value: Color

Returns: void

IScEngine.setSilhouetteEnabled()

setSilhouetteEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setSilhouetteOpacity()

setSilhouetteOpacity(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSilhouetteThreshold()

setSilhouetteThreshold(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSilhouetteThresholdRampWidth()

setSilhouetteThresholdRampWidth(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSimpleReflectionAttenuation()

setSimpleReflectionAttenuation(view_key: ViewKey, nearDistance: number, farDistance: number, unit: SimpleReflectionAttenuationUnit): void

Parameters

view_key: ViewKey

nearDistance: number

farDistance: number

unit: SimpleReflectionAttenuationUnit

Returns: void

IScEngine.setSimpleReflectionBlurInterval()

setSimpleReflectionBlurInterval(view_key: ViewKey, value: number, unit: BlurIntervalUnit): void

Parameters

view_key: ViewKey

value: number

unit: BlurIntervalUnit

Returns: void

IScEngine.setSimpleReflectionBlurSamples()

setSimpleReflectionBlurSamples(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSimpleReflectionEnabled()

setSimpleReflectionEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setSimpleReflectionFadeAngle()

setSimpleReflectionFadeAngle(view_key: ViewKey, degrees: number): void

Parameters

view_key: ViewKey

degrees: number

Returns: void

IScEngine.setSimpleReflectionOpacity()

setSimpleReflectionOpacity(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSimpleShadowBlurInterval()

setSimpleShadowBlurInterval(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSimpleShadowBlurSamples()

setSimpleShadowBlurSamples(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSimpleShadowColor()

setSimpleShadowColor(view_key: ViewKey, value: Color): void

Parameters

view_key: ViewKey

value: Color

Returns: void

IScEngine.setSimpleShadowEnabled()

setSimpleShadowEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setSimpleShadowInteractiveUpdateEnabled()

setSimpleShadowInteractiveUpdateEnabled(view_key: ViewKey, value: boolean): void

Parameters

view_key: ViewKey

value: boolean

Returns: void

IScEngine.setSimpleShadowOpacity()

setSimpleShadowOpacity(view_key: ViewKey, value: number): void

Parameters

view_key: ViewKey

value: number

Returns: void

IScEngine.setSimpleShadowResolution()

setSimpleShadowResolution(view_key: ViewKey, pixels: number): void

Parameters

view_key: ViewKey

pixels: number

Returns: void

IScEngine.setStreamCutoffScale()

setStreamCutoffScale(value: number): void

Parameters

value: number

Returns: void

IScEngine.setStreamIdleMarker()

setStreamIdleMarker(): Promise

Returns: Promise

IScEngine.setTexture()

setTexture(instanceIncs: InstanceIncs, options: TextureOptions): Promise

Parameters

instanceIncs: InstanceIncs

options: TextureOptions

Returns: Promise

IScEngine.setTimeout()

setTimeout(handler: () => void, timeout: number): Timeout

Parameters

handler: () => void

timeout: number

Returns: Timeout

IScEngine.setToonShadingBandCount()

setToonShadingBandCount(view_key: ViewKey, bandCount: number): void

Parameters

view_key: ViewKey

bandCount: number

Returns: void

IScEngine.setToonShadingSpecularFactor()

setToonShadingSpecularFactor(view_key: ViewKey, specularFactor: number): void

Parameters

view_key: ViewKey

specularFactor: number

Returns: void

IScEngine.setTransparencyMode()

setTransparencyMode(view_key: ViewKey, value: TransparencyMode): void

Parameters

view_key: ViewKey

value: TransparencyMode

Returns: void

IScEngine.setVisibilityByAttachment()

setVisibilityByAttachment(attachScope: AttachScope, setVisibility: SetVisibility): void

Parameters

attachScope: AttachScope

setVisibility: SetVisibility

Returns: void

IScEngine.setXRayColor()

setXRayColor(view_key: ViewKey, group: XRayGroup, element: ElementType, color: Color): void

Parameters

view_key: ViewKey

group: XRayGroup

element: ElementType

color: Color

Returns: void

IScEngine.setXRayOpacity()

setXRayOpacity(view_key: ViewKey, value: number, element: ElementType): void

Parameters

view_key: ViewKey

value: number

element: ElementType

Returns: void

IScEngine.setXRayTransparencyMode()

setXRayTransparencyMode(view_key: ViewKey, value: TransparencyMode): void

Parameters

view_key: ViewKey

value: TransparencyMode

Returns: void

IScEngine.shutdown()

shutdown(): void

Returns: void

IScEngine.sleep()

sleep(duration: number): Promise

Parameters

duration: number

Returns: Promise

IScEngine.start()

start(canvasContainer: HTMLDivElement, options: InitOptions): boolean

Parameters

canvasContainer: HTMLDivElement

options: InitOptions

Returns: boolean

IScEngine.startComparison()

startComparison(view_key: ViewKey, instanceSet1: InstanceIncs, instanceSet2: InstanceIncs, config: ComparisonConfig): void

Parameters

view_key: ViewKey

instanceSet1: InstanceIncs

instanceSet2: InstanceIncs

config: ComparisonConfig

Returns: void

IScEngine.startExplode()

startExplode(incs: InstanceIncs, vector: Point3): void

Parameters

incs: InstanceIncs

vector: Point3

Returns: void

IScEngine.stopExplode()

stopExplode(): void

Returns: void

IScEngine.synchronizeVisibilities()

synchronizeVisibilities(incs: InstanceIncs, visible: boolean): void

Parameters

incs: InstanceIncs

visible: boolean

Returns: void

IScEngine.testPointVisibility()

testPointVisibility(view_key: ViewKey, points: Point3[]): Promise

Parameters

view_key: ViewKey

points: Point3[]

Returns: Promise

IScEngine.throttleLoad()

throttleLoad(newPauseInterval: number, throttleDuration: number): void

Parameters

newPauseInterval: number

throttleDuration: number

Returns: void

IScEngine.triangulatePolygon()

triangulatePolygon(polygonPoints: (number[] | Float32Array), normal: Vector3): Float32Array

Parameters

polygonPoints: (number[] | Float32Array)

normal: Vector3

Returns: Float32Array

IScEngine.unsetCullingVector()

unsetCullingVector(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

IScEngine.unsetDepthRange()

unsetDepthRange(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

IScEngine.unsetElementColor()

unsetElementColor(incs: InstanceIncs, elementType: ElementType, elementOffset: number, elementCount: number): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementOffset: number

elementCount: number

Returns: void

IScEngine.unsetElementsVisibilityOverride()

unsetElementsVisibilityOverride(instances: InstanceIncs): void

Unsets the visibility mask override for the given instances

Parameters

instances: InstanceIncs

Instances to apply the override to

Returns: void

IScEngine.unsetLinePattern()

unsetLinePattern(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

IScEngine.unsetMetallicRoughness()

unsetMetallicRoughness(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

IScEngine.unsetPartAmbientColor()

unsetPartAmbientColor(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

IScEngine.unsetPartColor()

unsetPartColor(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

IScEngine.unsetPartEmissiveColor()

unsetPartEmissiveColor(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

IScEngine.unsetPartOpacity()

unsetPartOpacity(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

IScEngine.unsetPartSpecularColor()

unsetPartSpecularColor(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

IScEngine.unsetPartSpecularIntensity()

unsetPartSpecularIntensity(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

IScEngine.unsetTexture()

unsetTexture(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

IScEngine.unsetXRayColor()

unsetXRayColor(view_key: ViewKey, group: XRayGroup, element: ElementType): Promise

Parameters

view_key: ViewKey

group: XRayGroup

element: ElementType

Returns: Promise

IScEngine.updateCamera()

updateCamera(viewKey: ViewKey, camera: Camera): Camera

Parameters

viewKey: ViewKey

camera: Camera

Returns: Camera

IScEngine.updateCuttingSection()

updateCuttingSection(cuttingSection: ICuttingSection): Promise

Parameters

cuttingSection: ICuttingSection

Returns: Promise

IScEngine.updateLight()

updateLight(view_key: ViewKey, key: number, light: Light): void

Parameters

view_key: ViewKey

key: number

light: Light

Returns: void

IScEngine.waitForImageDecoding()

waitForImageDecoding(): Promise

Returns: Promise