MeshInstanceInterface

class Sc.MeshInstanceInterface()

Index

Methods

Methods

Sc.MeshInstanceInterface.clearAllElementHighlight()
clearAllElementHighlight(incs: InstanceIncs): void

Parameters

Returns: void

Sc.MeshInstanceInterface.clearAllElementVisible()
clearAllElementVisible(incs: InstanceIncs): void

Parameters

Returns: void

Sc.MeshInstanceInterface.clearAllElementXRay()
clearAllElementXRay(incs: InstanceIncs): void

Parameters

Returns: void

Sc.MeshInstanceInterface.clearElementColors()
clearElementColors(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

Sc.MeshInstanceInterface.clearElementHighlight()
clearElementHighlight(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

Sc.MeshInstanceInterface.clearElementVisible()
clearElementVisible(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

Sc.MeshInstanceInterface.clearElementXRay()
clearElementXRay(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

Sc.MeshInstanceInterface.computeMinimalBodyBodyDistance()
computeMinimalBodyBodyDistance(index: ViewKey, inc1: InstanceInc, inc2: InstanceInc): Promise

Parameters

index: ViewKey

inc1: InstanceInc

inc2: InstanceInc

Returns: Promise

Sc.MeshInstanceInterface.computeMinimalFaceFaceDistance()
computeMinimalFaceFaceDistance(index: ViewKey, inc1: InstanceInc, faceIndex1: number, inc2: InstanceInc, faceIndex2: number): Promise

Parameters

index: ViewKey

inc1: InstanceInc

faceIndex1: number

inc2: InstanceInc

faceIndex2: number

Returns: Promise

Sc.MeshInstanceInterface.computeMinimalFaceLineDistance()
computeMinimalFaceLineDistance(index: ViewKey, inc: InstanceInc, faceIndex: number, ray: IRay): Promise

Parameters

index: ViewKey

inc: InstanceInc

faceIndex: number

ray: IRay

Returns: Promise

Sc.MeshInstanceInterface.computeMinimalFaceRayDistance()
computeMinimalFaceRayDistance(index: ViewKey, inc: InstanceInc, faceIndex: number, ray: IRay): Promise

Parameters

index: ViewKey

inc: InstanceInc

faceIndex: number

ray: IRay

Returns: Promise

Sc.MeshInstanceInterface.create()
create(meshId: MeshId, matrixInc: MatrixInc, faceColor: Vector4, lineColor: Vector4, pointColor: Vector4, flags: number, overlayIndex: number, viewKey: ViewKey): Promise

Parameters

meshId: MeshId

matrixInc: MatrixInc

faceColor: Vector4

lineColor: Vector4

pointColor: Vector4

flags: number

overlayIndex: number

viewKey: ViewKey

Returns: Promise

Sc.MeshInstanceInterface.destroy()
destroy(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.discardAnonymousMatrix()
discardAnonymousMatrix(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getAlwaysDraw()
getAlwaysDraw(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getCappingMeshData()
getCappingMeshData(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getColor()
getColor(incs: InstanceIncs, elementType: ElementType, colorType: ColorType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

colorType: ColorType

Returns: Promise

Sc.MeshInstanceInterface.getCullingVector()
getCullingVector(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getDoNotCut()
getDoNotCut(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getDoNotExplode()
getDoNotExplode(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getDoNotLight()
getDoNotLight(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getDoNotOutlineHighlight()
getDoNotOutlineHighlight(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getDoNotSelect()
getDoNotSelect(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getDoNotUseVertexColors()
getDoNotUseVertexColors(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getDrawnWorldSpaceBounding()
getDrawnWorldSpaceBounding(viewKey: ViewKey): Promise

Parameters

viewKey: ViewKey

Returns: Promise

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

Parameters

incs: InstanceIncs

viewKey: ViewKey

Returns: Promise

Sc.MeshInstanceInterface.getEffectiveColor()
getEffectiveColor(incs: InstanceIncs, elementType: ElementType, colorType: ColorType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

colorType: ColorType

Returns: Promise

Sc.MeshInstanceInterface.getEffectiveElementColor()
getEffectiveElementColor(incs: InstanceIncs, viewKey: ViewKey, elementType: ElementType, index: number): Promise

Parameters

incs: InstanceIncs

viewKey: ViewKey

elementType: ElementType

index: number

Returns: Promise

Sc.MeshInstanceInterface.getEffectiveOpacity()
getEffectiveOpacity(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

Sc.MeshInstanceInterface.getElementColor()
getElementColor(incs: InstanceIncs, elementType: ElementType, index: number): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

index: number

Returns: Promise

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

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

Returns: Promise

Sc.MeshInstanceInterface.getElementVisible()
getElementVisible(incs: InstanceIncs, elementType: ElementType, elementIndex: number): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

Returns: Promise

Sc.MeshInstanceInterface.getElementXRay()
getElementXRay(incs: InstanceIncs, elementType: ElementType, elementIndex: number): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

Returns: Promise

Sc.MeshInstanceInterface.getExcludeBounding()
getExcludeBounding(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getFaceElementBounding()
getFaceElementBounding(elementIndices: number[], inc: InstanceInc): Promise

Parameters

elementIndices: number[]

inc: InstanceInc

Returns: Promise

Sc.MeshInstanceInterface.getFacesVisible()
getFacesVisible(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getHighlighted()
getHighlighted(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getLayerCount()
getLayerCount(): number

Returns: number

Sc.MeshInstanceInterface.getLineElementBounding()
getLineElementBounding(elementIndices: number[], inc: InstanceInc): Promise

Parameters

elementIndices: number[]

inc: InstanceInc

Returns: Promise

Sc.MeshInstanceInterface.getLinesVisible()
getLinesVisible(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getMaterial()
getMaterial(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getMatrix()
getMatrix(incs: InstanceIncs, layer: number): Promise

Parameters

incs: InstanceIncs

layer: number

Returns: Promise

Sc.MeshInstanceInterface.getMeshData()
getMeshData(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getMetallicRoughness()
getMetallicRoughness(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getObjectSpaceBounding()
getObjectSpaceBounding(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getOpacity()
getOpacity(incs: InstanceIncs, elementType: ElementType): (None | number)[]

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: (None | number)[]

Sc.MeshInstanceInterface.getOverrideSceneVisibility()
getOverrideSceneVisibility(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getPointElementBounding()
getPointElementBounding(elementIndices: number[], inc: InstanceInc): Promise

Parameters

elementIndices: number[]

inc: InstanceInc

Returns: Promise

Sc.MeshInstanceInterface.getPointsVisible()
getPointsVisible(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getScreenOriented()
getScreenOriented(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getScreenSpace()
getScreenSpace(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getScreenSpaceStretched()
getScreenSpaceStretched(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getSuppressCameraScale()
getSuppressCameraScale(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.getWorldSpaceBounding()
getWorldSpaceBounding(incs: InstanceIncs, ignoreInvisible: boolean, includeExcluded: boolean, tightBounding: boolean): Promise

Parameters

incs: InstanceIncs

ignoreInvisible: boolean

includeExcluded: boolean

tightBounding: boolean

Returns: Promise

Sc.MeshInstanceInterface.hasDepthRange()
hasDepthRange(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.hasTransparency()
hasTransparency(incs: InstanceIncs, elementType: ElementType): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: Promise

Sc.MeshInstanceInterface.linesToIncidentFaces()
linesToIncidentFaces(elementIndices: number[], inc: InstanceInc): Promise

Parameters

elementIndices: number[]

inc: InstanceInc

Returns: Promise

Sc.MeshInstanceInterface.matrixPreMultiply()
matrixPreMultiply(incs: InstanceIncs, matrix: Matrix16): Promise

Parameters

incs: InstanceIncs

matrix: Matrix16

Returns: Promise

Sc.MeshInstanceInterface.reifyAnonymousMatrix()
reifyAnonymousMatrix(incs: InstanceIncs): Promise

Parameters

Returns: Promise

Sc.MeshInstanceInterface.resetMaterial()
resetMaterial(incs: InstanceIncs, params: MaterialMask): void

Parameters

incs: InstanceIncs

params: MaterialMask

Returns: void

Sc.MeshInstanceInterface.setAlwaysDraw()
setAlwaysDraw(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setAmbientMix()
setAmbientMix(incs: InstanceIncs, elementType: ElementType, value: number): void

Parameters

incs: InstanceIncs

elementType: ElementType

value: number

Returns: void

Sc.MeshInstanceInterface.setAnonymousMatrices()
setAnonymousMatrices(incs: InstanceIncs, matrices: number[]): void

Parameters

incs: InstanceIncs

matrices: number[]

Returns: void

Sc.MeshInstanceInterface.setAnonymousMatrix()
setAnonymousMatrix(incs: InstanceIncs, matrix: Matrix16): void

Parameters

incs: InstanceIncs

matrix: Matrix16

Returns: void

Sc.MeshInstanceInterface.setColor()
setColor(incs: InstanceIncs, elementType: ElementType, colorType: ColorType, color: Vector3): void

Parameters

incs: InstanceIncs

elementType: ElementType

colorType: ColorType

color: Vector3

Returns: void

Sc.MeshInstanceInterface.setCullingVector()
setCullingVector(incs: InstanceIncs, space: CullingVectorSpace, vector: Vector3, toleranceDegrees: number): void

Parameters

incs: InstanceIncs

space: CullingVectorSpace

vector: Vector3

toleranceDegrees: number

Returns: void

Sc.MeshInstanceInterface.setDepthRange()
setDepthRange(incs: InstanceIncs, min: number, max: number): void

Parameters

incs: InstanceIncs

min: number

max: number

Returns: void

Sc.MeshInstanceInterface.setDoNotCut()
setDoNotCut(incs: InstanceIncs, doNotCut: boolean): void

Parameters

incs: InstanceIncs

doNotCut: boolean

Returns: void

Sc.MeshInstanceInterface.setDoNotExplode()
setDoNotExplode(incs: InstanceIncs, doNotExplode: boolean): void

Parameters

incs: InstanceIncs

doNotExplode: boolean

Returns: void

Sc.MeshInstanceInterface.setDoNotLight()
setDoNotLight(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setDoNotOutlineHighlight()
setDoNotOutlineHighlight(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setDoNotReset()
setDoNotReset(incs: InstanceIncs, doNotReset: boolean): void

Parameters

incs: InstanceIncs

doNotReset: boolean

Returns: void

Sc.MeshInstanceInterface.setDoNotSelect()
setDoNotSelect(incs: InstanceIncs, doNotSelect: boolean): void

Parameters

incs: InstanceIncs

doNotSelect: boolean

Returns: void

Sc.MeshInstanceInterface.setDoNotUseVertexColors()
setDoNotUseVertexColors(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setDoNotXRay()
setDoNotXRay(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setElementColor()
setElementColor(incs: InstanceIncs, elementType: ElementType, elementOffset: number, elementCount: number, color: Vector3): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementOffset: number

elementCount: number

color: Vector3

Returns: void

Sc.MeshInstanceInterface.setElementHighlighted()
setElementHighlighted(incs: InstanceIncs, elementType: ElementType, elementIndex: number, elementCount: number, value: boolean): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

elementCount: number

value: boolean

Returns: void

Sc.MeshInstanceInterface.setElementsVisibilityOverride()
setElementsVisibilityOverride(incs: InstanceIncs, pointsVisible: boolean, linesVisible: boolean, facesVisible: boolean): void

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

Parameters

incs: 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

Sc.MeshInstanceInterface.setElementVisible()
setElementVisible(incs: InstanceIncs, elementType: ElementType, elementIndex: number, elementCount: number, value: boolean): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

elementCount: number

value: boolean

Returns: void

Sc.MeshInstanceInterface.setElementXRay()
setElementXRay(incs: InstanceIncs, elementType: ElementType, elementIndex: number, elementCount: number, value: boolean): void

Parameters

incs: InstanceIncs

elementType: ElementType

elementIndex: number

elementCount: number

value: boolean

Returns: void

Sc.MeshInstanceInterface.setExcludeBounding()
setExcludeBounding(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setFacesVisible()
setFacesVisible(incs: InstanceIncs, visible: boolean): void

Parameters

incs: InstanceIncs

visible: boolean

Returns: void

Sc.MeshInstanceInterface.setHighlighted()
setHighlighted(incs: InstanceIncs, highlighted: boolean): void

Parameters

incs: InstanceIncs

highlighted: boolean

Returns: void

Sc.MeshInstanceInterface.setLinePattern()
setLinePattern(incs: InstanceIncs, pattern: (number[] | Uint8Array), patternLength: number, patternLengthUnit: LinePatternLengthUnit): void

Parameters

incs: InstanceIncs

pattern: (number[] | Uint8Array)

patternLength: number

patternLengthUnit: LinePatternLengthUnit

Returns: void

Sc.MeshInstanceInterface.setLinesVisible()
setLinesVisible(incs: InstanceIncs, visible: boolean): void

Parameters

incs: InstanceIncs

visible: boolean

Returns: void

Sc.MeshInstanceInterface.setMaterial()
setMaterial(incs: InstanceIncs, material: MaterialDescriptor): void

Parameters

Returns: void

Sc.MeshInstanceInterface.setMatrix()
setMatrix(incs: InstanceIncs, layer: number, matrixInc: MatrixInc): Promise

Parameters

incs: InstanceIncs

layer: number

matrixInc: MatrixInc

Returns: Promise

Sc.MeshInstanceInterface.setMeshLevel()
setMeshLevel(incs: InstanceIncs, meshLevel: number): void

Parameters

incs: InstanceIncs

meshLevel: number

Returns: void

Sc.MeshInstanceInterface.setMetallicRoughness()
setMetallicRoughness(incs: InstanceIncs, metallicFactor: number, roughnessFactor: number): void

Parameters

incs: InstanceIncs

metallicFactor: number

roughnessFactor: number

Returns: void

Sc.MeshInstanceInterface.setOpacity()
setOpacity(incs: InstanceIncs, elementType: ElementType, opacity: number): void

Parameters

incs: InstanceIncs

elementType: ElementType

opacity: number

Returns: void

Sc.MeshInstanceInterface.setOverlayId()
setOverlayId(incs: InstanceIncs, viewKey: ViewKey, index: number): void

Parameters

incs: InstanceIncs

viewKey: ViewKey

index: number

Returns: void

Sc.MeshInstanceInterface.setOverrideSceneVisibility()
setOverrideSceneVisibility(incs: InstanceIncs, overrideSceneVisibility: boolean): void

Parameters

incs: InstanceIncs

overrideSceneVisibility: boolean

Returns: void

Sc.MeshInstanceInterface.setPointsVisible()
setPointsVisible(incs: InstanceIncs, visible: boolean): void

Parameters

incs: InstanceIncs

visible: boolean

Returns: void

Sc.MeshInstanceInterface.setScreenOriented()
setScreenOriented(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setScreenSpace()
setScreenSpace(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setScreenSpaceStretched()
setScreenSpaceStretched(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.setSpecularIntensity()
setSpecularIntensity(incs: InstanceIncs, elementType: ElementType, value: number): void

Parameters

incs: InstanceIncs

elementType: ElementType

value: number

Returns: void

Sc.MeshInstanceInterface.setStreamCutoffScale()
setStreamCutoffScale(value: number): void

Parameters

value: number

Returns: void

Sc.MeshInstanceInterface.setSuppressCameraScale()
setSuppressCameraScale(incs: InstanceIncs, suppressCameraScale: boolean): void

Parameters

incs: InstanceIncs

suppressCameraScale: boolean

Returns: void

Sc.MeshInstanceInterface.setTexture()
setTexture(incs: InstanceIncs, elementType: ElementType, imageId: ImageId, matrix: Matrix16, tiling: TextureTiling, interpolation: TextureInterpolation, mipMapping: TextureMipMapping, parameterization: TextureParameterization, modifiers: TextureModifier): Promise

Parameters

incs: InstanceIncs

elementType: ElementType

imageId: ImageId

matrix: Matrix16

tiling: TextureTiling

interpolation: TextureInterpolation

mipMapping: TextureMipMapping

parameterization: TextureParameterization

modifiers: TextureModifier

Returns: Promise

Sc.MeshInstanceInterface.setVisible()
setVisible(incs: InstanceIncs, visible: boolean, onlyDemanded: boolean): void

Parameters

incs: InstanceIncs

visible: boolean

onlyDemanded: boolean

Returns: void

Sc.MeshInstanceInterface.setXRay()
setXRay(incs: InstanceIncs, value: boolean): void

Parameters

incs: InstanceIncs

value: boolean

Returns: void

Sc.MeshInstanceInterface.synchronizeVisibilities()
synchronizeVisibilities(incs: InstanceIncs, visible: boolean): void

Parameters

incs: InstanceIncs

visible: boolean

Returns: void

Sc.MeshInstanceInterface.unsetColor()
unsetColor(incs: InstanceIncs, elementType: ElementType, colorType: ColorType): void

Parameters

incs: InstanceIncs

elementType: ElementType

colorType: ColorType

Returns: void

Sc.MeshInstanceInterface.unsetCullingVector()
unsetCullingVector(incs: InstanceIncs): void

Parameters

Returns: void

Sc.MeshInstanceInterface.unsetDepthRange()
unsetDepthRange(incs: InstanceIncs): void

Parameters

Returns: void

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

Parameters

incs: InstanceIncs

elementType: ElementType

elementOffset: number

elementCount: number

Returns: void

Sc.MeshInstanceInterface.unsetElementsVisibilityOverride()
unsetElementsVisibilityOverride(incs: InstanceIncs): void

Unsets the visibility mask override for the given instances

Parameters

incs: InstanceIncs

Instances to apply the override to

Returns: void

Sc.MeshInstanceInterface.unsetLinePattern()
unsetLinePattern(incs: InstanceIncs): void

Parameters

Returns: void

Sc.MeshInstanceInterface.unsetMatrix()
unsetMatrix(incs: InstanceIncs, layer: number): Promise

Parameters

incs: InstanceIncs

layer: number

Returns: Promise

Sc.MeshInstanceInterface.unsetMetallicRoughness()
unsetMetallicRoughness(incs: InstanceIncs): void

Parameters

Returns: void

Sc.MeshInstanceInterface.unsetOpacity()
unsetOpacity(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

Sc.MeshInstanceInterface.unsetSpecularIntensity()
unsetSpecularIntensity(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void

Sc.MeshInstanceInterface.unsetTexture()
unsetTexture(incs: InstanceIncs, elementType: ElementType): void

Parameters

incs: InstanceIncs

elementType: ElementType

Returns: void