Instance

class Sc.Instance()

Index

Properties

• allowHighDpi
• canvas
• containers
• Image
• Matrix
• MeshData
• MeshDataBuilder
• MeshInstance
• Overlay
• wrappers

Methods

• _loseWebGlContext
• addCuttingSection
• addDrawContext
• addLight
• advanceExportToSvg
• advanceVolumeSelection
• attachModels
• attachScsBuffer
• attachScsModelByKey
• beginConvexPolyhedronSelection
• beginExportToSvg
• beginRayDrillSelection
• beginScreenAreaSelection
• beginSphereSelection
• clearLights
• createFloorplanMesh
• cuttingSectionLimits
• debug_log
• debug_stateFailure
• debug_sync
• demandMeshInstances
• detachInclusions
• disableCapping
• disconnectNetwork
• enableCapping
• endComparison
• endVolumeSelection
• explode
• exportToSvg
• feedScsBuffer
• flushMetaDataCache
• getAmbientOcclusionEnabled
• getAmbientOcclusionRadius
• getBackFacesVisible
• getBackgroundGradient
• getCamera
• getCameraPromise
• getCappedInstances
• getCuttingSections
• getDefaultDepthRange
• getElementCount
• getEyeDomeLightingBlurEdgeDistance
• getEyeDomeLightingBlurInterval
• getEyeDomeLightingBlurSamples
• getEyeDomeLightingEnabled
• getEyeDomeLightingOpacity
• getEyeDomeLightingShadingEdgeDistance
• getFacesVisible
• getFaceWindingFlipped
• getFrontFacesVisible
• getInteractiveDrawLimitIncreaseEnabled
• getLight
• getLightKeys
• getLinesVisible
• getLooseBounding
• getMetaData
• getMinFrameRate
• getNetworkVersion
• getPointShape
• getPointSize
• getPointSizeUnit
• getPointsVisible
• getStatistics
• getStreamedBounding
• getStreamVersion
• getTriangleCount
• load
• markAllMeshInstancesInteresting
• markCameraAsEmpty
• meshInstanceKeyInfo
• metaDataKeyInfo
• modelKeysFromInclusionKeys
• onResize
• pauseCapping
• primaryModelKey
• queueRedraw
• registerBimInstances
• removeAllCuttingSections
• removeCuttingSections
• removeDrawContext
• removeLight
• replaceCuttingSection
• requestGroups
• requestImages
• requestMeshInstances
• requestMeshInstancesByGroup
• resetExplode
• resetToEmpty
• resumeCapping
• resumeDrawing
• screenSelectByRay
• serverSideRendering
• setAmbientLightColor
• setAmbientOcclusionBias
• setAmbientOcclusionBlurInterval
• setAmbientOcclusionBlurSamples
• setAmbientOcclusionContrast
• setAmbientOcclusionEdgeDistance
• setAmbientOcclusionEnabled
• setAmbientOcclusionIntensity
• setAmbientOcclusionNoiseSize
• setAmbientOcclusionOpacity
• setAmbientOcclusionRadius
• setAmbientOcclusionSamples
• setAntiAliasingMode
• setBackFacesVisible
• setBackgroundColor
• setBackgroundGradient
• setBloomBlurInterval
• setBloomBlurSamples
• setBloomEnabled
• setBloomIntensity
• setBloomIntensityScale
• setBloomLayerCount
• setBloomThreshold
• setBloomThresholdRampWidth
• setBoundingDebugLevel
• setBoundingPreviewColor
• setBoundingPreviewEjected
• setBoundingPreviewEjectedColor
• setBoundingPreviewTested
• setBoundingPreviewTestedColor
• setBoundingPreviewUnderdraw
• setBoundingPreviewUnderdrawColor
• setCamera
• setCappingIdleHookEnabled
• setClumpingEnabled
• setComparisonColors
• setCurrentView
• setDefaultDepthRange
• setDefaultGloss
• setDefaultMirror
• setDefaultSpecularMix
• setDefaultSphereMap
• setDisplayIncompleteFrames
• setDrawIdleDelay
• setDrawMode
• setDrawStrategy
• setEventHandler
• setEyeDomeLightingBlurEdgeDistance
• setEyeDomeLightingBlurInterval
• setEyeDomeLightingBlurSamples
• setEyeDomeLightingEnabled
• setEyeDomeLightingOpacity
• setEyeDomeLightingShadingEdgeDistance
• setFacesVisible
• setFaceWindingFlipped
• setFixedDrawLimit
• setFrontFacesVisible
• setGoochBaseColorProminence
• setGoochBlue
• setGoochLuminanceShiftStrength
• setGoochYellow
• setGroundPlane
• setGroundPlaneWithPosition
• setHardEdgeColor
• setHardEdgeOpacity
• setHardEdgesEnabled
• setHardEdgeThreshold
• setHardEdgeThresholdRampWidth
• setHiddenLineHiddenLineColor
• setHiddenLineHighlightedElementFillColor
• setHiddenLineHighlightedElementOutlineColor
• setHiddenLineHighlightedInstanceFillColor
• setHiddenLineHighlightedInstanceOutlineColor
• setHiddenLineVisibleLineColor
• setHighlightColorizeCompression
• setHighlightedElementColor
• setHighlightedElementFilter
• setHighlightedElementOutlineColor
• setHighlightedInstanceColor
• setHighlightedInstanceFilter
• setHighlightedInstanceOutlineColor
• setHighlightMode
• setImageBasedLightingEnabled
• setImageBasedLightingEnvironment
• setImageBasedLightingEnvironmentToDefault
• setImageBasedLightingIntensity
• setImageBasedLightingMatrix
• setInstancingEnabled
• setInteractiveDrawLimitIncreaseEnabled
• setInteractiveDrawLimitIncreaseInterval
• setLightDecay
• setLightingEnabled
• setLightPower
• setLineJitterEnabled
• setLineJitterFrequency
• setLineJitterInstanceCount
• setLineJitterRadius
• setLinesVisible
• setMeshLevel
• setMetallicRoughnessMaterialOverride
• setMinDrawLimit
• setMinFrameRate
• setMinIncrementalFrameRate
• setMinInteractiveFrameRate
• setPointShape
• setPointSize
• setPointsVisible
• setPointVisibilityTest
• setPostInputDelay
• setSilhouetteColor
• setSilhouetteEnabled
• setSilhouetteOpacity
• setSilhouetteThreshold
• setSilhouetteThresholdRampWidth
• setSimpleReflectionAttenuation
• setSimpleReflectionBlurInterval
• setSimpleReflectionBlurSamples
• setSimpleReflectionEnabled
• setSimpleReflectionFadeAngle
• setSimpleReflectionOpacity
• setSimpleShadowBlurInterval
• setSimpleShadowBlurSamples
• setSimpleShadowColor
• setSimpleShadowEnabled
• setSimpleShadowInteractiveUpdateEnabled
• setSimpleShadowOpacity
• setSimpleShadowResolution
• setSsrQuality
• setStreamCutoffScale
• setStreamIdleMarker
• setToonBandCount
• setToonSpecularFactor
• setTransparencyMode
• setUnhighlightedColor
• setUnhighlightedFilter
• setVisibilityByAttachment
• setXRayMaterial
• setXRayOpacity
• setXRayTransparencyMode
• shutDown
• startComparison
• startExplode
• suspendDrawing
• testPointVisibility
• throttleLoad
• triangulatePolygon
• truncateMetaData
• unsetAllColors
• unsetAllHighlighted
• unsetAllOpacity
• unsetAllXRay
• unsetCurrentView
• unsetEventHandler
• unsetXRayMaterial
• updateLight
• waitForImageDecoding
• worldSelectByRay

Properties

Sc.Instance.allowHighDpi

allowHighDpi: boolean

Sc.Instance.canvas

canvas: (OffscreenCanvas | HTMLCanvasElement)

Sc.Instance.containers

containers: Map

Sc.Instance.Image

Image: ImageInterface

Sc.Instance.Matrix

Matrix: MatrixInterface

Sc.Instance.MeshData

MeshData: MeshDataInterface

Sc.Instance.MeshDataBuilder

MeshDataBuilder: MeshDataBuilder(): MeshDataBuilder

Sc.Instance.MeshInstance

MeshInstance: MeshInstanceInterface

Sc.Instance.Overlay

Overlay: OverlayInterface

Sc.Instance.wrappers

wrappers: Map

Methods

Sc.Instance._loseWebGlContext()

_loseWebGlContext(): boolean

Returns: boolean

Sc.Instance.addCuttingSection()

addCuttingSection(cuttingPlanes: Vector4[]): Promise

Parameters

cuttingPlanes: Vector4[]

Returns: Promise

Sc.Instance.addDrawContext()

addDrawContext(): Promise

Returns: Promise

Sc.Instance.addLight()

addLight(viewKey: ViewKey, type: LightType, space: LightSpace, position: Vector3, color: Vector3): Promise

Parameters

viewKey: ViewKey

type: LightType

space: LightSpace

position: Vector3

color: Vector3

Returns: Promise

Sc.Instance.advanceExportToSvg()

advanceExportToSvg(): Promise

Returns: Promise

Sc.Instance.advanceVolumeSelection()

advanceVolumeSelection(handle: number, batchCapacity: number): Promise

Parameters

handle: number

batchCapacity: number

Returns: Promise

Sc.Instance.attachModels()

attachModels(attachScope: AttachScope, modelNameWithTransform: [string, Matrix12][], attachMeasurementUnit: number, attachInvisibly: boolean): Promise

Parameters

attachScope: AttachScope

modelNameWithTransform: [string, Matrix12][]

attachMeasurementUnit: number

attachInvisibly: boolean

Returns: Promise

Sc.Instance.attachScsBuffer()

attachScsBuffer(attachScope: AttachScope, buffer: ScsBuffer, inclusionMatrix: Matrix12, attachMeasurementUnit: number, attachInvisibly: boolean, resolveOnFullyLoaded: boolean, cancelUnitMatrix: boolean, autoUnitScale: boolean): Promise

Parameters

attachScope: AttachScope

buffer: ScsBuffer

inclusionMatrix: Matrix12

attachMeasurementUnit: number

attachInvisibly: boolean

resolveOnFullyLoaded: boolean

cancelUnitMatrix: boolean

autoUnitScale: boolean

Returns: Promise

Sc.Instance.attachScsModelByKey()

attachScsModelByKey(attachScope: AttachScope, matrix: Matrix12, modelKey: ModelKey, attachMeasurementUnit: number, attachInvisibly: boolean): InclusionKey

Parameters

attachScope: AttachScope

matrix: Matrix12

modelKey: ModelKey

attachMeasurementUnit: number

attachInvisibly: boolean

Returns: InclusionKey

Sc.Instance.beginConvexPolyhedronSelection()

beginConvexPolyhedronSelection(volumePlaneCoeffs: Vector4[], heuristicOrigin: Vector3, config: VolumeSelectionConfig, viewKey: ViewKey): Promise

Parameters

volumePlaneCoeffs: Vector4[]

heuristicOrigin: Vector3

config: VolumeSelectionConfig

viewKey: ViewKey

Returns: Promise

Sc.Instance.beginExportToSvg()

beginExportToSvg(config: SvgConfig): Promise

Parameters

config: SvgConfig

Returns: Promise

Sc.Instance.beginRayDrillSelection()

beginRayDrillSelection(viewKey: ViewKey, rayCssOriginX: number, rayCssOriginY: number, rayCssBoxRadius: number, config: VolumeSelectionConfig): Promise

Parameters

viewKey: ViewKey

rayCssOriginX: number

rayCssOriginY: number

rayCssBoxRadius: number

config: VolumeSelectionConfig

Returns: Promise

Sc.Instance.beginScreenAreaSelection()

beginScreenAreaSelection(viewKey: ViewKey, areaCssMinX: number, areaCssMinY: number, areaCssMaxX: number, areaCssMaxY: number, config: VolumeSelectionConfig): Promise

Parameters

viewKey: ViewKey

areaCssMinX: number

areaCssMinY: number

areaCssMaxX: number

areaCssMaxY: number

config: VolumeSelectionConfig

Returns: Promise

Sc.Instance.beginSphereSelection()

beginSphereSelection(viewKey: ViewKey, sphereCenter: Vector3, sphereRadius: number, config: VolumeSelectionConfig): Promise

Parameters

viewKey: ViewKey

sphereCenter: Vector3

sphereRadius: number

config: VolumeSelectionConfig

Returns: Promise

Sc.Instance.clearLights()

clearLights(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.createFloorplanMesh()

createFloorplanMesh(incs: InstanceIncs): Promise

Parameters

incs: InstanceIncs

Returns: Promise

Sc.Instance.cuttingSectionLimits()

cuttingSectionLimits(): CuttingSectionLimits

Returns: CuttingSectionLimits

Sc.Instance.debug_log()

debug_log(message: string): Promise

Parameters

message: string

Returns: Promise

Sc.Instance.debug_stateFailure()

debug_stateFailure(stateFailureValue: number): Promise

Parameters

stateFailureValue: number

Returns: Promise

Sc.Instance.debug_sync()

debug_sync(): Promise

Returns: Promise

Sc.Instance.demandMeshInstances()

demandMeshInstances(incs: InstanceIncs): void

Parameters

incs: InstanceIncs

Returns: void

Sc.Instance.detachInclusions()

detachInclusions(inclusionKeys: InclusionKey[]): Promise

Parameters

inclusionKeys: InclusionKey[]

Returns: Promise

Sc.Instance.disableCapping()

disableCapping(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.disconnectNetwork()

disconnectNetwork(): void

Returns: void

Sc.Instance.enableCapping()

enableCapping(viewKey: ViewKey, lineColor: Vector4, faceColor: Vector4, quantizationGranularity: number): void

Parameters

viewKey: ViewKey

lineColor: Vector4

faceColor: Vector4

quantizationGranularity: number

Returns: void

Sc.Instance.endComparison()

endComparison(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.endVolumeSelection()

endVolumeSelection(handle: number): void

Parameters

handle: number

Returns: void

Sc.Instance.explode()

explode(distance: number): void

Parameters

distance: number

Returns: void

Sc.Instance.exportToSvg()

exportToSvg(config: SvgConfig): Promise

Parameters

config: SvgConfig

Returns: Promise

Sc.Instance.feedScsBuffer()

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

Parameters

attachScope: AttachScope

buffer: (None | ScsBuffer)

Returns: void

Sc.Instance.flushMetaDataCache()

flushMetaDataCache(): void

Returns: void

Sc.Instance.getAmbientOcclusionEnabled()

getAmbientOcclusionEnabled(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getAmbientOcclusionRadius()

getAmbientOcclusionRadius(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getBackFacesVisible()

getBackFacesVisible(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getBackgroundGradient()

getBackgroundGradient(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getCamera()

getCamera(viewKey: ViewKey): Camera

Parameters

viewKey: ViewKey

Returns: Camera

Sc.Instance.getCameraPromise()

getCameraPromise(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getCappedInstances()

getCappedInstances(): Promise

Returns: Promise

Sc.Instance.getCuttingSections()

getCuttingSections(sectionKeys: CuttingSectionKey[]): Promise

Parameters

sectionKeys: CuttingSectionKey[]

Returns: Promise

Sc.Instance.getDefaultDepthRange()

getDefaultDepthRange(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getElementCount()

getElementCount(): Promise

Returns: Promise

Sc.Instance.getEyeDomeLightingBlurEdgeDistance()

getEyeDomeLightingBlurEdgeDistance(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getEyeDomeLightingBlurInterval()

getEyeDomeLightingBlurInterval(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getEyeDomeLightingBlurSamples()

getEyeDomeLightingBlurSamples(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getEyeDomeLightingEnabled()

getEyeDomeLightingEnabled(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getEyeDomeLightingOpacity()

getEyeDomeLightingOpacity(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getEyeDomeLightingShadingEdgeDistance()

getEyeDomeLightingShadingEdgeDistance(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getFacesVisible()

getFacesVisible(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getFaceWindingFlipped()

getFaceWindingFlipped(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getFrontFacesVisible()

getFrontFacesVisible(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getInteractiveDrawLimitIncreaseEnabled()

getInteractiveDrawLimitIncreaseEnabled(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getLight()

getLight(viewKey: ViewKey, key: LightKey): Promise

Parameters

viewKey: ViewKey

key: LightKey

Returns: Promise

Sc.Instance.getLightKeys()

getLightKeys(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getLinesVisible()

getLinesVisible(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getLooseBounding()

getLooseBounding(): Promise

Returns: Promise

Sc.Instance.getMetaData()

getMetaData(ids: DataIds): Promise

Parameters

ids: DataIds

Returns: Promise

Sc.Instance.getMinFrameRate()

getMinFrameRate(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getNetworkVersion()

getNetworkVersion(): number

Returns: number

Sc.Instance.getPointShape()

getPointShape(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getPointSize()

getPointSize(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getPointSizeUnit()

getPointSizeUnit(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getPointsVisible()

getPointsVisible(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

Sc.Instance.getStatistics()

getStatistics(): Promise

Returns: Promise

Sc.Instance.getStreamedBounding()

getStreamedBounding(): Promise

Returns: Promise

Sc.Instance.getStreamVersion()

getStreamVersion(): number

Returns: number

Sc.Instance.getTriangleCount()

getTriangleCount(): Promise

Returns: Promise

Sc.Instance.load()

load(configuration: LoadConfig): SessionType

Parameters

configuration: LoadConfig

Returns: SessionType

Sc.Instance.markAllMeshInstancesInteresting()

markAllMeshInstancesInteresting(interesting: boolean): void

Parameters

interesting: boolean

Returns: void

Sc.Instance.markCameraAsEmpty()

markCameraAsEmpty(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.meshInstanceKeyInfo()

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

Parameters

modelKeyOrAttachScope: (ModelKey | AttachScope)

byModel: boolean

keyCountOnly: boolean

Returns: Promise

Sc.Instance.metaDataKeyInfo()

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

Parameters

modelKeyOrAttachScope: (ModelKey | AttachScope)

byModel: boolean

keyCountOnly: boolean

Returns: Promise

Sc.Instance.modelKeysFromInclusionKeys()

modelKeysFromInclusionKeys(inclusionKeys: InclusionKey[]): Promise

Parameters

inclusionKeys: InclusionKey[]

Returns: Promise

Sc.Instance.onResize()

onResize(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.pauseCapping()

pauseCapping(): void

Returns: void

Sc.Instance.primaryModelKey()

primaryModelKey(): Promise

Returns: Promise

Sc.Instance.queueRedraw()

queueRedraw(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.registerBimInstances()

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

Parameters

incs: InstanceIncs

bimType: BimType

Returns: void

Sc.Instance.removeAllCuttingSections()

removeAllCuttingSections(): void

Returns: void

Sc.Instance.removeCuttingSections()

removeCuttingSections(sectionHandles: CuttingSectionKey[]): Promise

Parameters

sectionHandles: CuttingSectionKey[]

Returns: Promise

Sc.Instance.removeDrawContext()

removeDrawContext(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.removeLight()

removeLight(viewKey: ViewKey, key: LightKey): void

Parameters

viewKey: ViewKey

key: LightKey

Returns: void

Sc.Instance.replaceCuttingSection()

replaceCuttingSection(cuttingPlanes: Vector4[], key: CuttingSectionKey): Promise

Parameters

cuttingPlanes: Vector4[]

key: CuttingSectionKey

Returns: Promise

Sc.Instance.requestGroups()

requestGroups(groupIds: GroupIds, obtainDependentGroups: boolean): Promise

Parameters

groupIds: GroupIds

obtainDependentGroups: boolean

Returns: Promise

Sc.Instance.requestImages()

requestImages(imageIds: ImageIds, wantThumbnails: boolean): Promise

Parameters

imageIds: ImageIds

wantThumbnails: boolean

Returns: Promise

Sc.Instance.requestMeshInstances()

requestMeshInstances(incs: InstanceIncs, withMeshData: boolean, ignoreFailure: boolean): Promise

Parameters

incs: InstanceIncs

withMeshData: boolean

ignoreFailure: boolean

Returns: Promise

Sc.Instance.requestMeshInstancesByGroup()

requestMeshInstancesByGroup(groupId: GroupIds, withMeshData: boolean, expandGroups: boolean): Promise

Parameters

groupId: GroupIds

withMeshData: boolean

expandGroups: boolean

Returns: Promise

Sc.Instance.resetExplode()

resetExplode(): void

Returns: void

Sc.Instance.resetToEmpty()

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

Parameters

whitelistInstances: InstanceKey[]

whitelistMeshes: MeshKey[]

Returns: Promise

Sc.Instance.resumeCapping()

resumeCapping(): void

Returns: void

Sc.Instance.resumeDrawing()

resumeDrawing(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.screenSelectByRay()

screenSelectByRay(viewKey: ViewKey, elementMask: number, canvasX: number, canvasY: number, maxPixelTolerance: number, config: RaySelectionConfig): Promise

Parameters

viewKey: ViewKey

elementMask: number

canvasX: number

canvasY: number

maxPixelTolerance: number

config: RaySelectionConfig

Returns: Promise

Sc.Instance.serverSideRendering()

serverSideRendering(): boolean

Returns: boolean

Sc.Instance.setAmbientLightColor()

setAmbientLightColor(viewKey: ViewKey, value: Vector3): void

Parameters

viewKey: ViewKey

value: Vector3

Returns: void

Sc.Instance.setAmbientOcclusionBias()

setAmbientOcclusionBias(viewKey: ViewKey, bias: number): void

Parameters

viewKey: ViewKey

bias: number

Returns: void

Sc.Instance.setAmbientOcclusionBlurInterval()

setAmbientOcclusionBlurInterval(viewKey: ViewKey, interval: number): void

Parameters

viewKey: ViewKey

interval: number

Returns: void

Sc.Instance.setAmbientOcclusionBlurSamples()

setAmbientOcclusionBlurSamples(viewKey: ViewKey, samples: number): void

Parameters

viewKey: ViewKey

samples: number

Returns: void

Sc.Instance.setAmbientOcclusionContrast()

setAmbientOcclusionContrast(viewKey: ViewKey, contrast: number): void

Parameters

viewKey: ViewKey

contrast: number

Returns: void

Sc.Instance.setAmbientOcclusionEdgeDistance()

setAmbientOcclusionEdgeDistance(viewKey: ViewKey, distance: number): void

Parameters

viewKey: ViewKey

distance: number

Returns: void

Sc.Instance.setAmbientOcclusionEnabled()

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

Parameters

viewKey: ViewKey

enabled: boolean

Returns: void

Sc.Instance.setAmbientOcclusionIntensity()

setAmbientOcclusionIntensity(viewKey: ViewKey, intensity: number): void

Parameters

viewKey: ViewKey

intensity: number

Returns: void

Sc.Instance.setAmbientOcclusionNoiseSize()

setAmbientOcclusionNoiseSize(viewKey: ViewKey, size: number): void

Parameters

viewKey: ViewKey

size: number

Returns: void

Sc.Instance.setAmbientOcclusionOpacity()

setAmbientOcclusionOpacity(viewKey: ViewKey, opacity: number): void

Parameters

viewKey: ViewKey

opacity: number

Returns: void

Sc.Instance.setAmbientOcclusionRadius()

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

Parameters

viewKey: ViewKey

radius: number

Returns: void

Sc.Instance.setAmbientOcclusionSamples()

setAmbientOcclusionSamples(viewKey: ViewKey, samples: number): void

Parameters

viewKey: ViewKey

samples: number

Returns: void

Sc.Instance.setAntiAliasingMode()

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

Parameters

viewKey: ViewKey

antiAliasingMode: AntiAliasingMode

Returns: void

Sc.Instance.setBackFacesVisible()

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

Parameters

viewKey: ViewKey

visible: boolean

Returns: void

Sc.Instance.setBackgroundColor()

setBackgroundColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setBackgroundGradient()

setBackgroundGradient(viewKey: ViewKey, top: Vector4, bottom: Vector4): void

Parameters

viewKey: ViewKey

top: Vector4

bottom: Vector4

Returns: void

Sc.Instance.setBloomBlurInterval()

setBloomBlurInterval(viewKey: ViewKey, layer: number, value: number, unit: BlurIntervalUnit): void

Parameters

viewKey: ViewKey

layer: number

value: number

unit: BlurIntervalUnit

Returns: void

Sc.Instance.setBloomBlurSamples()

setBloomBlurSamples(viewKey: ViewKey, layer: number, value: number): void

Parameters

viewKey: ViewKey

layer: number

value: number

Returns: void

Sc.Instance.setBloomEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setBloomIntensity()

setBloomIntensity(viewKey: ViewKey, layer: number, value: number): void

Parameters

viewKey: ViewKey

layer: number

value: number

Returns: void

Sc.Instance.setBloomIntensityScale()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setBloomLayerCount()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setBloomThreshold()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setBloomThresholdRampWidth()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setBoundingDebugLevel()

setBoundingDebugLevel(viewKey: ViewKey, level: number): void

Parameters

viewKey: ViewKey

level: number

Returns: void

Sc.Instance.setBoundingPreviewColor()

setBoundingPreviewColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setBoundingPreviewEjected()

setBoundingPreviewEjected(points: Vector3[], viewKey: ViewKey): void

Parameters

points: Vector3[]

viewKey: ViewKey

Returns: void

Sc.Instance.setBoundingPreviewEjectedColor()

setBoundingPreviewEjectedColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setBoundingPreviewTested()

setBoundingPreviewTested(points: Vector3[], viewKey: ViewKey): void

Parameters

points: Vector3[]

viewKey: ViewKey

Returns: void

Sc.Instance.setBoundingPreviewTestedColor()

setBoundingPreviewTestedColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setBoundingPreviewUnderdraw()

setBoundingPreviewUnderdraw(points: Vector3[], viewKey: ViewKey): void

Parameters

points: Vector3[]

viewKey: ViewKey

Returns: void

Sc.Instance.setBoundingPreviewUnderdrawColor()

setBoundingPreviewUnderdrawColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setCamera()

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

Parameters

viewKey: ViewKey

camera: Camera

Returns: void

Sc.Instance.setCappingIdleHookEnabled()

setCappingIdleHookEnabled(enable: boolean): Promise

Parameters

enable: boolean

Returns: Promise

Sc.Instance.setClumpingEnabled()

setClumpingEnabled(value: boolean): void

Parameters

value: boolean

Returns: void

Sc.Instance.setComparisonColors()

setComparisonColors(viewKey: ViewKey, sameColor: Vector3, only1Color: Vector3, only2Color: Vector3): void

Parameters

viewKey: ViewKey

sameColor: Vector3

only1Color: Vector3

only2Color: Vector3

Returns: void

Sc.Instance.setCurrentView()

setCurrentView(viewKey: ViewKey, view: ViewKey): void

Parameters

viewKey: ViewKey

view: ViewKey

Returns: void

Sc.Instance.setDefaultDepthRange()

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

Parameters

viewKey: ViewKey

min: number

max: number

Returns: void

Sc.Instance.setDefaultGloss()

setDefaultGloss(viewKey: ViewKey, gloss: number): void

Parameters

viewKey: ViewKey

gloss: number

Returns: void

Sc.Instance.setDefaultMirror()

setDefaultMirror(viewKey: ViewKey, mirror: number): void

Parameters

viewKey: ViewKey

mirror: number

Returns: void

Sc.Instance.setDefaultSpecularMix()

setDefaultSpecularMix(viewKey: ViewKey, mix: number): void

Parameters

viewKey: ViewKey

mix: number

Returns: void

Sc.Instance.setDefaultSphereMap()

setDefaultSphereMap(viewKey: ViewKey, imageId: ImageId): void

Parameters

viewKey: ViewKey

imageId: ImageId

Returns: void

Sc.Instance.setDisplayIncompleteFrames()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setDrawIdleDelay()

setDrawIdleDelay(viewKey: ViewKey, delay: number): void

Parameters

viewKey: ViewKey

delay: number

Returns: void

Sc.Instance.setDrawMode()

setDrawMode(viewKey: ViewKey, drawMode: DrawMode): void

Parameters

viewKey: ViewKey

drawMode: DrawMode

Returns: void

Sc.Instance.setDrawStrategy()

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

Parameters

viewKey: ViewKey

strategy: DrawStrategy

Returns: void

Sc.Instance.setEventHandler()

setEventHandler(eventName: “announce_model”, callback: (eventName: string, attachScope: AttachScope, masterModelKey: MasterModelKey) => void): void

Parameters

eventName: “announce_model”

callback: (eventName: string, attachScope: AttachScope, masterModelKey: MasterModelKey) => void

Returns: void

setEventHandler(eventName: “bad_data”, callback: (eventName: string, data: BadDataData) => void): void

Parameters

eventName: “bad_data”

callback: (eventName: string, data: BadDataData) => void

Returns: void

setEventHandler(eventName: “bounding”, callback: (eventName: string) => void): void

Parameters

eventName: “bounding”

callback: (eventName: string) => void

Returns: void

setEventHandler(eventName: “camera_set”, callback: (eventName: string, viewKey: ViewKey) => void): void

Parameters

eventName: “camera_set”

callback: (eventName: string, viewKey: ViewKey) => void

Returns: void

setEventHandler(eventName: “capping_idle”, callback: (eventName: string, isIdle: boolean, cappedInstanceCount: number) => void): void

Parameters

eventName: “capping_idle”

callback: (eventName: string, isIdle: boolean, cappedInstanceCount: number) => void

Returns: void

setEventHandler(eventName: “client_message”, callback: (eventName: string, data: string) => void): void

Parameters

eventName: “client_message”

callback: (eventName: string, data: string) => void

Returns: void

setEventHandler(eventName: “draw_complete”, callback: (eventName: string, viewKey: ViewKey) => void): void

Parameters

eventName: “draw_complete”

callback: (eventName: string, viewKey: ViewKey) => void

Returns: void

setEventHandler(eventName: “draw_idle”, callback: (eventName: string, viewKey: ViewKey) => void): void

Parameters

eventName: “draw_idle”

callback: (eventName: string, viewKey: ViewKey) => void

Returns: void

setEventHandler(eventName: “first_instance”, callback: (eventName: string) => void): void

Parameters

eventName: “first_instance”

callback: (eventName: string) => void

Returns: void

setEventHandler(eventName: “inclusion”, callback: (eventName: string, attachScope: AttachScope, inclusionKey: InclusionKey, modelKey: ModelKey) => void): void

Parameters

eventName: “inclusion”

callback: (eventName: string, attachScope: AttachScope, inclusionKey: InclusionKey, modelKey: ModelKey) => void

Returns: void

setEventHandler(eventName: “meta_data”, callback: (eventName: string, modelKey: ModelKey, dataKey: DataKey, data: Uint8Array) => void): void

Parameters

eventName: “meta_data”

callback: (eventName: string, modelKey: ModelKey, dataKey: DataKey, data: Uint8Array) => void

Returns: void

setEventHandler(eventName: “missing_model”, callback: (eventName: string, attachScope: AttachScope, modelPath: string) => void): void

Parameters

eventName: “missing_model”

callback: (eventName: string, attachScope: AttachScope, modelPath: string) => void

Returns: void

setEventHandler(eventName: “network_receive_data”, callback: (eventName: string, dataSize: number) => void): void

Parameters

eventName: “network_receive_data”

callback: (eventName: string, dataSize: number) => void

Returns: void

setEventHandler(eventName: “open_model_failed”, callback: (eventName: string, data: OpenModelFailedData) => void): void

Parameters

eventName: “open_model_failed”

callback: (eventName: string, data: OpenModelFailedData) => void

Returns: void

setEventHandler(eventName: “post_draw”, callback: (eventName: string, draw_index: ViewKey, stats: FrameStats, camera: Camera, visiblePoints: number[]) => void): void

Parameters

eventName: “post_draw”

callback: (eventName: string, draw_index: ViewKey, stats: FrameStats, camera: Camera, visiblePoints: number[]) => void

Returns: void

setEventHandler(eventName: “post_draw_json”, callback: (eventName: string, metadataJson: string) => void): void

Parameters

eventName: “post_draw_json”

callback: (eventName: string, metadataJson: string) => void

Returns: void

setEventHandler(eventName: “priority_meta_data_sent”, callback: (eventName: string, attachScope: AttachScope, prototypeInstanceCount: number) => void): void

Parameters

eventName: “priority_meta_data_sent”

callback: (eventName: string, attachScope: AttachScope, prototypeInstanceCount: number) => void

Returns: void

setEventHandler(eventName: “remap_inclusion”, callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, effectiveInclusionKey: InclusionKey, originalInclusionKey: InclusionKey) => void): void

Parameters

eventName: “remap_inclusion”

callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, effectiveInclusionKey: InclusionKey, originalInclusionKey: InclusionKey) => void

Returns: void

setEventHandler(eventName: “remap_model”, callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, originalModelKey: ModelKey) => void): void

Parameters

eventName: “remap_model”

callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, originalModelKey: ModelKey) => void

Returns: void

setEventHandler(eventName: “session_started”, callback: (eventName: string, primaryModelKey: ModelKey) => void): void

Parameters

eventName: “session_started”

callback: (eventName: string, primaryModelKey: ModelKey) => void

Returns: void

setEventHandler(eventName: “socket_error”, callback: (eventName: string) => void): void

Parameters

eventName: “socket_error”

callback: (eventName: string) => void

Returns: void

setEventHandler(eventName: “socket_open_failed”, callback: (eventName: string) => void): void

Parameters

eventName: “socket_open_failed”

callback: (eventName: string) => void

Returns: void

setEventHandler(eventName: “stream_active”, callback: (eventName: string) => void): void

Parameters

eventName: “stream_active”

callback: (eventName: string) => void

Returns: void

setEventHandler(eventName: “stream_idle”, callback: (eventName: string) => void): void

Parameters

eventName: “stream_idle”

callback: (eventName: string) => void

Returns: void

setEventHandler(eventName: “webgl_context_lost”, callback: (eventName: string) => void): void

Parameters

eventName: “webgl_context_lost”

callback: (eventName: string) => void

Returns: void

setEventHandler(eventName: “websocket_connection_closed”, callback: (eventName: string) => void): void

Parameters

eventName: “websocket_connection_closed”

callback: (eventName: string) => void

Returns: void

Sc.Instance.setEyeDomeLightingBlurEdgeDistance()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setEyeDomeLightingBlurInterval()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setEyeDomeLightingBlurSamples()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setEyeDomeLightingEnabled()

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

Parameters

viewKey: ViewKey

enabled: boolean

Returns: void

Sc.Instance.setEyeDomeLightingOpacity()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setEyeDomeLightingShadingEdgeDistance()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setFacesVisible()

setFacesVisible(viewKey: ViewKey, visible: boolean): void

Parameters

viewKey: ViewKey

visible: boolean

Returns: void

Sc.Instance.setFaceWindingFlipped()

setFaceWindingFlipped(viewKey: ViewKey, flipped: boolean): void

Parameters

viewKey: ViewKey

flipped: boolean

Returns: void

Sc.Instance.setFixedDrawLimit()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setFrontFacesVisible()

setFrontFacesVisible(viewKey: ViewKey, visible: boolean): void

Parameters

viewKey: ViewKey

visible: boolean

Returns: void

Sc.Instance.setGoochBaseColorProminence()

setGoochBaseColorProminence(viewKey: ViewKey, prominence: number): void

Parameters

viewKey: ViewKey

prominence: number

Returns: void

Sc.Instance.setGoochBlue()

setGoochBlue(viewKey: ViewKey, blue: number): void

Parameters

viewKey: ViewKey

blue: number

Returns: void

Sc.Instance.setGoochLuminanceShiftStrength()

setGoochLuminanceShiftStrength(viewKey: ViewKey, shiftStrength: number): void

Parameters

viewKey: ViewKey

shiftStrength: number

Returns: void

Sc.Instance.setGoochYellow()

setGoochYellow(viewKey: ViewKey, yellow: number): void

Parameters

viewKey: ViewKey

yellow: number

Returns: void

Sc.Instance.setGroundPlane()

setGroundPlane(viewKey: ViewKey, normal: Vector3): void

Parameters

viewKey: ViewKey

normal: Vector3

Returns: void

Sc.Instance.setGroundPlaneWithPosition()

setGroundPlaneWithPosition(viewKey: ViewKey, normal: Vector3, position: Vector3): void

Parameters

viewKey: ViewKey

normal: Vector3

position: Vector3

Returns: void

Sc.Instance.setHardEdgeColor()

setHardEdgeColor(viewKey: ViewKey, value: Vector3): void

Parameters

viewKey: ViewKey

value: Vector3

Returns: void

Sc.Instance.setHardEdgeOpacity()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setHardEdgesEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setHardEdgeThreshold()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setHardEdgeThresholdRampWidth()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setHiddenLineHiddenLineColor()

setHiddenLineHiddenLineColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHiddenLineHighlightedElementFillColor()

setHiddenLineHighlightedElementFillColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHiddenLineHighlightedElementOutlineColor()

setHiddenLineHighlightedElementOutlineColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHiddenLineHighlightedInstanceFillColor()

setHiddenLineHighlightedInstanceFillColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHiddenLineHighlightedInstanceOutlineColor()

setHiddenLineHighlightedInstanceOutlineColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHiddenLineVisibleLineColor()

setHiddenLineVisibleLineColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHighlightColorizeCompression()

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

Parameters

viewKey: ViewKey

compressionLevel: number

Returns: void

Sc.Instance.setHighlightedElementColor()

setHighlightedElementColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHighlightedElementFilter()

setHighlightedElementFilter(viewKey: ViewKey, highlightedFilter: HighlightFilter): void

Parameters

viewKey: ViewKey

highlightedFilter: HighlightFilter

Returns: void

Sc.Instance.setHighlightedElementOutlineColor()

setHighlightedElementOutlineColor(viewKey: ViewKey, highlightedOutlineColor: Vector4): void

Parameters

viewKey: ViewKey

highlightedOutlineColor: Vector4

Returns: void

Sc.Instance.setHighlightedInstanceColor()

setHighlightedInstanceColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setHighlightedInstanceFilter()

setHighlightedInstanceFilter(viewKey: ViewKey, highlightedFilter: HighlightFilter): void

Parameters

viewKey: ViewKey

highlightedFilter: HighlightFilter

Returns: void

Sc.Instance.setHighlightedInstanceOutlineColor()

setHighlightedInstanceOutlineColor(viewKey: ViewKey, highlightedOutlineColor: Vector4): void

Parameters

viewKey: ViewKey

highlightedOutlineColor: Vector4

Returns: void

Sc.Instance.setHighlightMode()

setHighlightMode(viewKey: ViewKey, highlightMode: HighlightMode): void

Parameters

viewKey: ViewKey

highlightMode: HighlightMode

Returns: void

Sc.Instance.setImageBasedLightingEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setImageBasedLightingEnvironment()

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

Parameters

viewKey: ViewKey

data: Uint8Array

Returns: void

Sc.Instance.setImageBasedLightingEnvironmentToDefault()

setImageBasedLightingEnvironmentToDefault(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.setImageBasedLightingIntensity()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setImageBasedLightingMatrix()

setImageBasedLightingMatrix(viewKey: ViewKey, value: Matrix9): void

Parameters

viewKey: ViewKey

value: Matrix9

Returns: void

Sc.Instance.setInstancingEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setInteractiveDrawLimitIncreaseEnabled()

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

Parameters

viewKey: ViewKey

enable: boolean

Returns: void

Sc.Instance.setInteractiveDrawLimitIncreaseInterval()

setInteractiveDrawLimitIncreaseInterval(viewKey: ViewKey, milliseconds: number): void

Parameters

viewKey: ViewKey

milliseconds: number

Returns: void

Sc.Instance.setLightDecay()

setLightDecay(viewKey: ViewKey, key: LightKey, decay: number): void

Parameters

viewKey: ViewKey

key: LightKey

decay: number

Returns: void

Sc.Instance.setLightingEnabled()

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

Parameters

viewKey: ViewKey

enabled: boolean

Returns: void

Sc.Instance.setLightPower()

setLightPower(viewKey: ViewKey, key: LightKey, power: number): void

Parameters

viewKey: ViewKey

key: LightKey

power: number

Returns: void

Sc.Instance.setLineJitterEnabled()

setLineJitterEnabled(viewKey: ViewKey, enabled: boolean): void

Parameters

viewKey: ViewKey

enabled: boolean

Returns: void

Sc.Instance.setLineJitterFrequency()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setLineJitterInstanceCount()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setLineJitterRadius()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setLinesVisible()

setLinesVisible(viewKey: ViewKey, visible: boolean): void

Parameters

viewKey: ViewKey

visible: boolean

Returns: void

Sc.Instance.setMeshLevel()

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

Parameters

incs: InstanceIncs

level: number

Returns: void

Sc.Instance.setMetallicRoughnessMaterialOverride()

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

Parameters

defaultMetallicFactor: number

defaultRoughnessFactor: number

Returns: void

Sc.Instance.setMinDrawLimit()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setMinFrameRate()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setMinIncrementalFrameRate()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setMinInteractiveFrameRate()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setPointShape()

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

Parameters

viewKey: ViewKey

shape: PointShape

Returns: void

Sc.Instance.setPointSize()

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

Parameters

viewKey: ViewKey

size: number

unit: PointSizeUnit

Returns: void

Sc.Instance.setPointsVisible()

setPointsVisible(viewKey: ViewKey, visible: boolean): void

Parameters

viewKey: ViewKey

visible: boolean

Returns: void

Sc.Instance.setPointVisibilityTest()

setPointVisibilityTest(points: Vector3[], viewKey: ViewKey): void

Parameters

points: Vector3[]

viewKey: ViewKey

Returns: void

Sc.Instance.setPostInputDelay()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSilhouetteColor()

setSilhouetteColor(viewKey: ViewKey, value: Vector3): void

Parameters

viewKey: ViewKey

value: Vector3

Returns: void

Sc.Instance.setSilhouetteEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setSilhouetteOpacity()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSilhouetteThreshold()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSilhouetteThresholdRampWidth()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSimpleReflectionAttenuation()

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

Parameters

viewKey: ViewKey

nearDistance: number

farDistance: number

unit: SimpleReflectionAttenuationUnit

Returns: void

Sc.Instance.setSimpleReflectionBlurInterval()

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

Parameters

viewKey: ViewKey

value: number

unit: BlurIntervalUnit

Returns: void

Sc.Instance.setSimpleReflectionBlurSamples()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSimpleReflectionEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setSimpleReflectionFadeAngle()

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

Parameters

viewKey: ViewKey

degrees: number

Returns: void

Sc.Instance.setSimpleReflectionOpacity()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSimpleShadowBlurInterval()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSimpleShadowBlurSamples()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSimpleShadowColor()

setSimpleShadowColor(viewKey: ViewKey, value: Vector3): void

Parameters

viewKey: ViewKey

value: Vector3

Returns: void

Sc.Instance.setSimpleShadowEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setSimpleShadowInteractiveUpdateEnabled()

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

Parameters

viewKey: ViewKey

value: boolean

Returns: void

Sc.Instance.setSimpleShadowOpacity()

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

Parameters

viewKey: ViewKey

value: number

Returns: void

Sc.Instance.setSimpleShadowResolution()

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

Parameters

viewKey: ViewKey

pixels: number

Returns: void

Sc.Instance.setSsrQuality()

setSsrQuality(opts: SsrQualityConfig): void

Parameters

opts: SsrQualityConfig

Returns: void

Sc.Instance.setStreamCutoffScale()

setStreamCutoffScale(value: number): void

Parameters

value: number

Returns: void

Sc.Instance.setStreamIdleMarker()

setStreamIdleMarker(): Promise

Returns: Promise

Sc.Instance.setToonBandCount()

setToonBandCount(viewKey: ViewKey, bandCount: number): void

Parameters

viewKey: ViewKey

bandCount: number

Returns: void

Sc.Instance.setToonSpecularFactor()

setToonSpecularFactor(viewKey: ViewKey, specularFactor: number): void

Parameters

viewKey: ViewKey

specularFactor: number

Returns: void

Sc.Instance.setTransparencyMode()

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

Parameters

viewKey: ViewKey

value: TransparencyMode

Returns: void

Sc.Instance.setUnhighlightedColor()

setUnhighlightedColor(viewKey: ViewKey, color: Vector4): void

Parameters

viewKey: ViewKey

color: Vector4

Returns: void

Sc.Instance.setUnhighlightedFilter()

setUnhighlightedFilter(viewKey: ViewKey, highlightedFilter: HighlightFilter): void

Parameters

viewKey: ViewKey

highlightedFilter: HighlightFilter

Returns: void

Sc.Instance.setVisibilityByAttachment()

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

Parameters

attachScope: AttachScope

setVisibility: SetVisibility

Returns: void

Sc.Instance.setXRayMaterial()

setXRayMaterial(viewKey: ViewKey, group: XRayGroup, element: ElementType, color: Vector4): void

Parameters

viewKey: ViewKey

group: XRayGroup

element: ElementType

color: Vector4

Returns: void

Sc.Instance.setXRayOpacity()

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

Parameters

viewKey: ViewKey

element: ElementType

value: number

Returns: void

Sc.Instance.setXRayTransparencyMode()

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

Parameters

viewKey: ViewKey

value: TransparencyMode

Returns: void

Sc.Instance.shutDown()

shutDown(): void

Returns: void

Sc.Instance.startComparison()

startComparison(viewKey: ViewKey, instanceSet1: InstanceIncs, instanceSet2: InstanceIncs): void

Parameters

viewKey: ViewKey

instanceSet1: InstanceIncs

instanceSet2: InstanceIncs

Returns: void

Sc.Instance.startExplode()

startExplode(incs: InstanceIncs, center: Vector3): void

Parameters

incs: InstanceIncs

center: Vector3

Returns: void

Sc.Instance.suspendDrawing()

suspendDrawing(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.testPointVisibility()

testPointVisibility(points: Vector3[], viewKey: ViewKey): Promise

Parameters

points: Vector3[]

viewKey: ViewKey

Returns: Promise

Sc.Instance.throttleLoad()

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

Parameters

newPauseInterval: number

throttleDuration: number

Returns: void

Sc.Instance.triangulatePolygon()

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

Parameters

polygonPoints: (number[] | Float32Array)

normal: Vector3

Returns: number[]

Sc.Instance.truncateMetaData()

truncateMetaData(dataIds: DataIds): Promise

Parameters

dataIds: DataIds

Returns: Promise

Sc.Instance.unsetAllColors()

unsetAllColors(): void

Returns: void

Sc.Instance.unsetAllHighlighted()

unsetAllHighlighted(): void

Returns: void

Sc.Instance.unsetAllOpacity()

unsetAllOpacity(): void

Returns: void

Sc.Instance.unsetAllXRay()

unsetAllXRay(): void

Returns: void

Sc.Instance.unsetCurrentView()

unsetCurrentView(viewKey: ViewKey): void

Parameters

viewKey: ViewKey

Returns: void

Sc.Instance.unsetEventHandler()

unsetEventHandler(eventName: “announce_model”, callback: (eventName: string, attachScope: AttachScope, modelKey: ModelKey) => void): void

Parameters

eventName: “announce_model”

callback: (eventName: string, attachScope: AttachScope, modelKey: ModelKey) => void

Returns: void

unsetEventHandler(eventName: “bad_data”, callback: (eventName: string, data: BadDataData) => void): void

Parameters

eventName: “bad_data”

callback: (eventName: string, data: BadDataData) => void

Returns: void

unsetEventHandler(eventName: “bounding”, callback: (eventName: string) => void): void

Parameters

eventName: “bounding”

callback: (eventName: string) => void

Returns: void

unsetEventHandler(eventName: “camera_set”, callback: (eventName: string, viewKey: ViewKey) => void): void

Parameters

eventName: “camera_set”

callback: (eventName: string, viewKey: ViewKey) => void

Returns: void

unsetEventHandler(eventName: “capping_idle”, callback: (eventName: string, isIdle: boolean, cappedInstanceCount: number) => void): void

Parameters

eventName: “capping_idle”

callback: (eventName: string, isIdle: boolean, cappedInstanceCount: number) => void

Returns: void

unsetEventHandler(eventName: “client_message”, callback: (eventName: string, data: string) => void): void

Parameters

eventName: “client_message”

callback: (eventName: string, data: string) => void

Returns: void

unsetEventHandler(eventName: “draw_complete”, callback: (eventName: string, viewKey: ViewKey) => void): void

Parameters

eventName: “draw_complete”

callback: (eventName: string, viewKey: ViewKey) => void

Returns: void

unsetEventHandler(eventName: “draw_idle”, callback: (eventName: string, viewKey: ViewKey) => void): void

Parameters

eventName: “draw_idle”

callback: (eventName: string, viewKey: ViewKey) => void

Returns: void

unsetEventHandler(eventName: “inclusion”, callback: (eventName: string, attachScope: AttachScope, inclusionKey: InclusionKey, modelKey: ModelKey) => void): void

Parameters

eventName: “inclusion”

callback: (eventName: string, attachScope: AttachScope, inclusionKey: InclusionKey, modelKey: ModelKey) => void

Returns: void

unsetEventHandler(eventName: “meta_data”, callback: (eventName: string, modelKey: ModelKey, dataKey: DataKey, data: Uint8Array) => void): void

Parameters

eventName: “meta_data”

callback: (eventName: string, modelKey: ModelKey, dataKey: DataKey, data: Uint8Array) => void

Returns: void

unsetEventHandler(eventName: “missing_model”, callback: (eventName: string, attachScope: AttachScope, modelPath: string) => void): void

Parameters

eventName: “missing_model”

callback: (eventName: string, attachScope: AttachScope, modelPath: string) => void

Returns: void

unsetEventHandler(eventName: “network_receive_data”, callback: (eventName: string, dataSize: number) => void): void

Parameters

eventName: “network_receive_data”

callback: (eventName: string, dataSize: number) => void

Returns: void

unsetEventHandler(eventName: “open_model_failed”, callback: (eventName: string, data: OpenModelFailedData) => void): void

Parameters

eventName: “open_model_failed”

callback: (eventName: string, data: OpenModelFailedData) => void

Returns: void

unsetEventHandler(eventName: “post_draw”, callback: (eventName: string, draw_index: ViewKey, stats: FrameStats, camera: Camera, visiblePoints: number[]) => void): void

Parameters

eventName: “post_draw”

callback: (eventName: string, draw_index: ViewKey, stats: FrameStats, camera: Camera, visiblePoints: number[]) => void

Returns: void

unsetEventHandler(eventName: “post_draw_json”, callback: (eventName: string, metadataJson: string) => void): void

Parameters

eventName: “post_draw_json”

callback: (eventName: string, metadataJson: string) => void

Returns: void

unsetEventHandler(eventName: “priority_meta_data_sent”, callback: (eventName: string, attachScope: AttachScope, prototypeInstanceCount: number) => void): void

Parameters

eventName: “priority_meta_data_sent”

callback: (eventName: string, attachScope: AttachScope, prototypeInstanceCount: number) => void

Returns: void

unsetEventHandler(eventName: “remap_inclusion”, callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, effectiveInclusionKey: InclusionKey, originalInclusionKey: InclusionKey) => void): void

Parameters

eventName: “remap_inclusion”

callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, effectiveInclusionKey: InclusionKey, originalInclusionKey: InclusionKey) => void

Returns: void

unsetEventHandler(eventName: “remap_model”, callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, originalModelKey: ModelKey) => void): void

Parameters

eventName: “remap_model”

callback: (eventName: string, attachScope: AttachScope, effectiveModelKey: ModelKey, originalModelKey: ModelKey) => void

Returns: void

unsetEventHandler(eventName: “session_started”, callback: (eventName: string, primaryModelKey: ModelKey) => void): void

Parameters

eventName: “session_started”

callback: (eventName: string, primaryModelKey: ModelKey) => void

Returns: void

unsetEventHandler(eventName: “socket_error”, callback: (eventName: string) => void): void

Parameters

eventName: “socket_error”

callback: (eventName: string) => void

Returns: void

unsetEventHandler(eventName: “socket_open_failed”, callback: (eventName: string) => void): void

Parameters

eventName: “socket_open_failed”

callback: (eventName: string) => void

Returns: void

unsetEventHandler(eventName: “stream_active”, callback: (eventName: string) => void): void

Parameters

eventName: “stream_active”

callback: (eventName: string) => void

Returns: void

unsetEventHandler(eventName: “stream_idle”, callback: (eventName: string) => void): void

Parameters

eventName: “stream_idle”

callback: (eventName: string) => void

Returns: void

unsetEventHandler(eventName: “webgl_context_lost”, callback: (eventName: string) => void): void

Parameters

eventName: “webgl_context_lost”

callback: (eventName: string) => void

Returns: void

unsetEventHandler(eventName: “websocket_connection_closed”, callback: (eventName: string) => void): void

Parameters

eventName: “websocket_connection_closed”

callback: (eventName: string) => void

Returns: void

Sc.Instance.unsetXRayMaterial()

unsetXRayMaterial(viewKey: ViewKey, group: XRayGroup, element: ElementType): Promise

Parameters

viewKey: ViewKey

group: XRayGroup

element: ElementType

Returns: Promise

Sc.Instance.updateLight()

updateLight(viewKey: ViewKey, key: LightKey, type: LightType, space: LightSpace, position: Vector3, color: Vector3): void

Parameters

viewKey: ViewKey

key: LightKey

type: LightType

space: LightSpace

position: Vector3

color: Vector3

Returns: void

Sc.Instance.waitForImageDecoding()

waitForImageDecoding(): Promise

Returns: Promise

Sc.Instance.worldSelectByRay()

worldSelectByRay(viewKey: ViewKey, ray: IRay, config: RaySelectionConfig): Promise

Parameters

viewKey: ViewKey

ray: IRay

config: RaySelectionConfig

Returns: Promise