MeshInstanceInterface
- class Sc.MeshInstanceInterface()
Methods
Methods
clearAllElementHighlight
- MeshInstanceInterface.clearAllElementHighlight(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
void
clearAllElementVisible
- MeshInstanceInterface.clearAllElementVisible(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
void
clearAllElementXRay
- MeshInstanceInterface.clearAllElementXRay(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
void
clearElementColors
- MeshInstanceInterface.clearElementColors(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
clearElementHighlight
- MeshInstanceInterface.clearElementHighlight(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
clearElementVisible
- MeshInstanceInterface.clearElementVisible(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
clearElementXRay
- MeshInstanceInterface.clearElementXRay(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
computeMinimalBodyBodyDistance
- MeshInstanceInterface.computeMinimalBodyBodyDistance(index, inc1, inc2)
- Arguments
index (
ViewKey()) – Noneinc1 (
InstanceInc()) – Noneinc2 (
InstanceInc()) – None
- Return type
Promise <FaceFaceDistanceObject>
computeMinimalFaceFaceDistance
- MeshInstanceInterface.computeMinimalFaceFaceDistance(index, inc1, faceIndex1, inc2, faceIndex2)
- Arguments
index (
ViewKey()) – Noneinc1 (
InstanceInc()) – NonefaceIndex1 (
number()) – Noneinc2 (
InstanceInc()) – NonefaceIndex2 (
number()) – None
- Return type
Promise <FaceFaceDistanceObject>
computeMinimalFaceLineDistance
computeMinimalFaceRayDistance
create
- MeshInstanceInterface.create(meshId, matrixInc, faceColor, lineColor, pointColor[, flags[, overlayIndex[, viewKey]]])
- Arguments
meshId (
MeshId()) – NonematrixInc (
MatrixInc()) – NonefaceColor (
Vector4()) – NonelineColor (
Vector4()) – NonepointColor (
Vector4()) – Noneflags (
number()) – optional NoneoverlayIndex (
number()) – optional NoneviewKey (
ViewKey()) – optional None
- Return type
Promise <InstanceInc>
destroy
- MeshInstanceInterface.destroy(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <void>
discardAnonymousMatrix
- MeshInstanceInterface.discardAnonymousMatrix(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <void>
getAlwaysDraw
- MeshInstanceInterface.getAlwaysDraw(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getCappingMeshData
- MeshInstanceInterface.getCappingMeshData(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <MeshIds>
getColor
- MeshInstanceInterface.getColor(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
Promise <[null | Vector3]>
getCullingVector
- MeshInstanceInterface.getCullingVector(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[CullingVector]>
getDoNotCut
- MeshInstanceInterface.getDoNotCut(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getDoNotExplode
- MeshInstanceInterface.getDoNotExplode(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getDoNotLight
- MeshInstanceInterface.getDoNotLight(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getDoNotOutlineHighlight
- MeshInstanceInterface.getDoNotOutlineHighlight(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getDoNotSelect
- MeshInstanceInterface.getDoNotSelect(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getDoNotUseVertexColors
- MeshInstanceInterface.getDoNotUseVertexColors(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getDrawnWorldSpaceBounding
- MeshInstanceInterface.getDrawnWorldSpaceBounding(viewKey)
- Arguments
viewKey (
ViewKey()) – None
- Return type
Promise <IBox>
- MeshInstanceInterface.getDrawnWorldSpaceBounding(incs, viewKey)
- Arguments
incs (
InstanceIncs()) – NoneviewKey (
ViewKey()) – None
- Return type
Promise <IBox>
getEffectiveColor
- MeshInstanceInterface.getEffectiveColor(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
Promise <[Vector3]>
getEffectiveElementColor
- MeshInstanceInterface.getEffectiveElementColor(incs, viewKey, elementType, index)
- Arguments
incs (
InstanceIncs()) – NoneviewKey (
ViewKey()) – NoneelementType (
ElementType()) – Noneindex (
number()) – None
- Return type
Promise <[Vector3]>
getEffectiveOpacity
- MeshInstanceInterface.getEffectiveOpacity(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
Promise <[number]>
getElementColor
- MeshInstanceInterface.getElementColor(incs, elementType, index)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Noneindex (
number()) – None
- Return type
Promise <[null | Vector3]>
getElementHighlighted
- MeshInstanceInterface.getElementHighlighted(incs, elementType, elementIndex)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementIndex (
number()) – None
- Return type
Promise <[boolean]>
getElementVisible
- MeshInstanceInterface.getElementVisible(incs, elementType, elementIndex)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementIndex (
number()) – None
- Return type
Promise <[boolean]>
getElementXRay
- MeshInstanceInterface.getElementXRay(incs, elementType, elementIndex)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementIndex (
number()) – None
- Return type
Promise <[boolean]>
getExcludeBounding
- MeshInstanceInterface.getExcludeBounding(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getFaceElementBounding
- MeshInstanceInterface.getFaceElementBounding(elementIndices, inc)
- Arguments
elementIndices (
[number]()) – Noneinc (
InstanceInc()) – None
- Return type
Promise <IBox>
getFacesVisible
- MeshInstanceInterface.getFacesVisible(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getHighlighted
- MeshInstanceInterface.getHighlighted(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getLayerCount
- MeshInstanceInterface.getLayerCount()
- Return type
number
getLineElementBounding
- MeshInstanceInterface.getLineElementBounding(elementIndices, inc)
- Arguments
elementIndices (
[number]()) – Noneinc (
InstanceInc()) – None
- Return type
Promise <IBox>
getLinesVisible
- MeshInstanceInterface.getLinesVisible(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getMatrix
- MeshInstanceInterface.getMatrix(incs, layer)
- Arguments
incs (
InstanceIncs()) – Nonelayer (
number()) – None
- Return type
Promise <MatrixIncs>
getMeshData
- MeshInstanceInterface.getMeshData(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <MeshIds>
getMetallicRoughness
- MeshInstanceInterface.getMetallicRoughness(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[number]>
getObjectSpaceBounding
- MeshInstanceInterface.getObjectSpaceBounding(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[IBox]>
getOpacity
- MeshInstanceInterface.getOpacity(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
[null | number]
getOverrideSceneVisibility
- MeshInstanceInterface.getOverrideSceneVisibility(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getPointElementBounding
- MeshInstanceInterface.getPointElementBounding(elementIndices, inc)
- Arguments
elementIndices (
[number]()) – Noneinc (
InstanceInc()) – None
- Return type
Promise <IBox>
getPointsVisible
- MeshInstanceInterface.getPointsVisible(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getScreenOriented
- MeshInstanceInterface.getScreenOriented(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getScreenSpace
- MeshInstanceInterface.getScreenSpace(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getScreenSpaceStretched
- MeshInstanceInterface.getScreenSpaceStretched(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getSuppressCameraScale
- MeshInstanceInterface.getSuppressCameraScale(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
getWorldSpaceBounding
- MeshInstanceInterface.getWorldSpaceBounding(incs, ignoreInvisible, includeExcluded, tightBounding)
- Arguments
incs (
InstanceIncs()) – NoneignoreInvisible (
boolean()) – NoneincludeExcluded (
boolean()) – NonetightBounding (
boolean()) – None
- Return type
Promise <IBox>
hasDepthRange
- MeshInstanceInterface.hasDepthRange(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <[boolean]>
hasTransparency
- MeshInstanceInterface.hasTransparency(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
Promise <[boolean]>
linesToIncidentFaces
- MeshInstanceInterface.linesToIncidentFaces(elementIndices, inc)
- Arguments
elementIndices (
[number]()) – Noneinc (
InstanceInc()) – None
- Return type
Promise <[number]>
matrixPreMultiply
- MeshInstanceInterface.matrixPreMultiply(incs, matrix)
- Arguments
incs (
InstanceIncs()) – Nonematrix (
Matrix16()) – None
- Return type
Promise <void>
reifyAnonymousMatrix
- MeshInstanceInterface.reifyAnonymousMatrix(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
Promise <MatrixIncs>
setAlwaysDraw
- MeshInstanceInterface.setAlwaysDraw(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setAmbientColor
- MeshInstanceInterface.setAmbientColor(incs, elementType, color)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Nonecolor (
Vector3()) – None
- Return type
void
setAmbientMix
- MeshInstanceInterface.setAmbientMix(incs, elementType, value)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Nonevalue (
number()) – None
- Return type
void
setAnonymousMatrices
- MeshInstanceInterface.setAnonymousMatrices(incs, matrices)
- Arguments
incs (
InstanceIncs()) – Nonematrices (
[number]()) – None
- Return type
void
setAnonymousMatrix
- MeshInstanceInterface.setAnonymousMatrix(incs, matrix)
- Arguments
incs (
InstanceIncs()) – Nonematrix (
Matrix16()) – None
- Return type
void
setColor
- MeshInstanceInterface.setColor(incs, elementType, color)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Nonecolor (
Vector3()) – None
- Return type
void
setCullingVector
- MeshInstanceInterface.setCullingVector(incs, space, vector, toleranceDegrees)
- Arguments
incs (
InstanceIncs()) – Nonespace (
CullingVectorSpace()) – Nonevector (
Vector3()) – NonetoleranceDegrees (
number()) – None
- Return type
void
setDepthRange
- MeshInstanceInterface.setDepthRange(incs, min, max)
- Arguments
incs (
InstanceIncs()) – Nonemin (
number()) – Nonemax (
number()) – None
- Return type
void
setDoNotCut
- MeshInstanceInterface.setDoNotCut(incs, doNotCut)
- Arguments
incs (
InstanceIncs()) – NonedoNotCut (
boolean()) – None
- Return type
void
setDoNotExplode
- MeshInstanceInterface.setDoNotExplode(incs, doNotExplode)
- Arguments
incs (
InstanceIncs()) – NonedoNotExplode (
boolean()) – None
- Return type
void
setDoNotLight
- MeshInstanceInterface.setDoNotLight(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setDoNotOutlineHighlight
- MeshInstanceInterface.setDoNotOutlineHighlight(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setDoNotReset
- MeshInstanceInterface.setDoNotReset(incs, doNotReset)
- Arguments
incs (
InstanceIncs()) – NonedoNotReset (
boolean()) – None
- Return type
void
setDoNotSelect
- MeshInstanceInterface.setDoNotSelect(incs, doNotSelect)
- Arguments
incs (
InstanceIncs()) – NonedoNotSelect (
boolean()) – None
- Return type
void
setDoNotUseVertexColors
- MeshInstanceInterface.setDoNotUseVertexColors(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setDoNotXRay
- MeshInstanceInterface.setDoNotXRay(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setElementColor
- MeshInstanceInterface.setElementColor(incs, elementType, elementOffset, elementCount, color)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementOffset (
number()) – NoneelementCount (
number()) – Nonecolor (
Vector3()) – None
- Return type
void
setElementHighlighted
- MeshInstanceInterface.setElementHighlighted(incs, elementType, elementIndex, elementCount, value)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementIndex (
number()) – NoneelementCount (
number()) – Nonevalue (
boolean()) – None
- Return type
void
setElementVisible
- MeshInstanceInterface.setElementVisible(incs, elementType, elementIndex, elementCount, value)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementIndex (
number()) – NoneelementCount (
number()) – Nonevalue (
boolean()) – None
- Return type
void
setElementXRay
- MeshInstanceInterface.setElementXRay(incs, elementType, elementIndex, elementCount, value)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementIndex (
number()) – NoneelementCount (
number()) – Nonevalue (
boolean()) – None
- Return type
void
setEmissiveColor
- MeshInstanceInterface.setEmissiveColor(incs, elementType, color)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Nonecolor (
Vector3()) – None
- Return type
void
setExcludeBounding
- MeshInstanceInterface.setExcludeBounding(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setFacesVisible
- MeshInstanceInterface.setFacesVisible(incs, visible)
- Arguments
incs (
InstanceIncs()) – Nonevisible (
boolean()) – None
- Return type
void
setHighlighted
- MeshInstanceInterface.setHighlighted(incs, highlighted)
- Arguments
incs (
InstanceIncs()) – Nonehighlighted (
boolean()) – None
- Return type
void
setLinePattern
- MeshInstanceInterface.setLinePattern(incs, pattern, patternLength, patternLengthUnit)
- Arguments
incs (
InstanceIncs()) – Nonepattern (
[number] | Uint8Array()) – NonepatternLength (
number()) – NonepatternLengthUnit (
LinePatternLengthUnit()) – None
- Return type
void
setLinesVisible
- MeshInstanceInterface.setLinesVisible(incs, visible)
- Arguments
incs (
InstanceIncs()) – Nonevisible (
boolean()) – None
- Return type
void
setMatrix
- MeshInstanceInterface.setMatrix(incs, layer, matrixInc)
- Arguments
incs (
InstanceIncs()) – Nonelayer (
number()) – NonematrixInc (
MatrixInc()) – None
- Return type
Promise <void>
setMeshLevel
- MeshInstanceInterface.setMeshLevel(incs, meshLevel)
- Arguments
incs (
InstanceIncs()) – NonemeshLevel (
number()) – None
- Return type
void
setMetallicRoughness
- MeshInstanceInterface.setMetallicRoughness(incs, metallicFactor, roughnessFactor)
- Arguments
incs (
InstanceIncs()) – NonemetallicFactor (
number()) – NoneroughnessFactor (
number()) – None
- Return type
void
setOpacity
- MeshInstanceInterface.setOpacity(incs, elementType, opacity)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Noneopacity (
number()) – None
- Return type
void
setOverlayId
- MeshInstanceInterface.setOverlayId(incs, viewKey, index)
- Arguments
incs (
InstanceIncs()) – NoneviewKey (
ViewKey()) – Noneindex (
number()) – None
- Return type
void
setOverrideSceneVisibility
- MeshInstanceInterface.setOverrideSceneVisibility(incs, overrideSceneVisibility)
- Arguments
incs (
InstanceIncs()) – NoneoverrideSceneVisibility (
boolean()) – None
- Return type
void
setPointsVisible
- MeshInstanceInterface.setPointsVisible(incs, visible)
- Arguments
incs (
InstanceIncs()) – Nonevisible (
boolean()) – None
- Return type
void
setScreenOriented
- MeshInstanceInterface.setScreenOriented(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setScreenSpace
- MeshInstanceInterface.setScreenSpace(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setScreenSpaceStretched
- MeshInstanceInterface.setScreenSpaceStretched(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
setSpecularColor
- MeshInstanceInterface.setSpecularColor(incs, elementType, color)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Nonecolor (
Vector3()) – None
- Return type
void
setSpecularIntensity
- MeshInstanceInterface.setSpecularIntensity(incs, elementType, value)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – Nonevalue (
number()) – None
- Return type
void
setStreamCutoffScale
- MeshInstanceInterface.setStreamCutoffScale(value)
- Arguments
value (
number()) – None
- Return type
void
setSuppressCameraScale
- MeshInstanceInterface.setSuppressCameraScale(incs, suppressCameraScale)
- Arguments
incs (
InstanceIncs()) – NonesuppressCameraScale (
boolean()) – None
- Return type
void
setTexture
- MeshInstanceInterface.setTexture(incs, elementType, imageId, matrix, tiling, interpolation, mipMapping, parameterization, modifiers)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneimageId (
ImageId()) – Nonematrix (
Matrix16()) – Nonetiling (
TextureTiling()) – Noneinterpolation (
TextureInterpolation()) – NonemipMapping (
TextureMipMapping()) – Noneparameterization (
TextureParameterization()) – Nonemodifiers (
TextureModifier()) – None
- Return type
Promise <void>
setVisible
- MeshInstanceInterface.setVisible(incs, visible, onlyDemanded)
- Arguments
incs (
InstanceIncs()) – Nonevisible (
boolean()) – NoneonlyDemanded (
boolean()) – None
- Return type
void
setXRay
- MeshInstanceInterface.setXRay(incs, value)
- Arguments
incs (
InstanceIncs()) – Nonevalue (
boolean()) – None
- Return type
void
synchronizeVisibilities
- MeshInstanceInterface.synchronizeVisibilities(incs, visible)
- Arguments
incs (
InstanceIncs()) – Nonevisible (
boolean()) – None
- Return type
void
unsetColor
- MeshInstanceInterface.unsetColor(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
unsetCullingVector
- MeshInstanceInterface.unsetCullingVector(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
void
unsetDepthRange
- MeshInstanceInterface.unsetDepthRange(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
void
unsetElementColor
- MeshInstanceInterface.unsetElementColor(incs, elementType, elementOffset, elementCount)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – NoneelementOffset (
number()) – NoneelementCount (
number()) – None
- Return type
void
unsetEmissiveColor
- MeshInstanceInterface.unsetEmissiveColor(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
unsetLinePattern
- MeshInstanceInterface.unsetLinePattern(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
void
unsetMatrix
- MeshInstanceInterface.unsetMatrix(incs, layer)
- Arguments
incs (
InstanceIncs()) – Nonelayer (
number()) – None
- Return type
Promise <void>
unsetMetallicRoughness
- MeshInstanceInterface.unsetMetallicRoughness(incs)
- Arguments
incs (
InstanceIncs()) – None
- Return type
void
unsetOpacity
- MeshInstanceInterface.unsetOpacity(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
unsetSpecularColor
- MeshInstanceInterface.unsetSpecularColor(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
unsetSpecularIntensity
- MeshInstanceInterface.unsetSpecularIntensity(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void
unsetTexture
- MeshInstanceInterface.unsetTexture(incs, elementType)
- Arguments
incs (
InstanceIncs()) – NoneelementType (
ElementType()) – None
- Return type
void