Model

class Model()

Methods


Methods

activateCadConfiguration

Model.activateCadConfiguration(nodeId, view)
Arguments:
Return type:

Promise <void>

activateCadView

Model.activateCadView(nodeId, duration, massageCamera, view)
Arguments:
  • nodeId (NodeId) – None
  • duration (number()) –
  • massageCamera (boolean()) –
  • view (IView()) –
Return type:

Promise <void>

activateDefaultCadConfiguration

Model.activateDefaultCadConfiguration(fitNodes, view)
Arguments:
  • fitNodes (boolean()) –
  • view (IView()) –
Return type:

Promise <void>

activateDefaultCadView

Model.activateDefaultCadView(duration, massageCamera, view)
Arguments:
  • duration (number()) –
  • massageCamera (boolean()) –
  • view (IView()) –
Return type:

Promise <void>

addPropertyToNode

Model.addPropertyToNode(nodeId, propertyName, propertyValue, propertyUnit)
Arguments:
  • nodeId (NodeId) –
  • propertyName (string()) – None
  • propertyValue (string()) – None
  • propertyUnit ([UnitElement]()) – None
Return type:

boolean

cadConfigurationsEnabled

Model.cadConfigurationsEnabled()
Return type:Promise <boolean>

clear

Model.clear()
Return type:Promise <void>

clearNodeFaceVisibility

Model.clearNodeFaceVisibility(partId)
Arguments:
Return type:

void

clearNodeLineVisibility

Model.clearNodeLineVisibility(partId)
Arguments:
Return type:

void

clearNodePointVisibility

Model.clearNodePointVisibility(partId)
Arguments:
Return type:

void

computeMinimumBodyBodyDistance

Model.computeMinimumBodyBodyDistance(partId1, partId2)
Arguments:
Return type:

Promise <FaceFaceDistanceItem()>

computeMinimumFaceFaceDistance

Model.computeMinimumFaceFaceDistance(partId1, faceId1, partId2, faceId2)
Arguments:
  • partId1 (PartId) –
  • faceId1 (number()) –
  • partId2 (PartId) –
  • faceId2 (number()) –
Return type:

Promise <FaceFaceDistanceItem()>

computeMinimumFaceLineDistance

Model.computeMinimumFaceLineDistance(partId, faceId, ray)
Arguments:
  • partId (PartId) – None
  • faceId (number()) –
  • ray (Ray()) –
Return type:

Promise <FaceFaceDistanceItem()>

computeMinimumFaceRayDistance

Model.computeMinimumFaceRayDistance(partId, faceId, ray)
Arguments:
  • partId (PartId) – None
  • faceId (number()) –
  • ray (Ray()) –
Return type:

Promise <FaceFaceDistanceItem()>

createAndAddRepresentationItem

Model.createAndAddRepresentationItem(partNodeId[, repItemId])
Arguments:
  • partNodeId (PartId | undefined | null) –
  • repItemId (NodeId | null) – optional
Return type:

NodeId | null

createCadView

Model.createCadView(nodeId, viewName, camera[, pmiIds[, nodesToShow[, nodesToHide[, nodeIdsAndLocalTransforms[, cuttingPlane[, meshInstanceData]]]]]])
Arguments:
  • nodeId (NodeId) – None
  • viewName (string()) –
  • camera (Camera()) –
  • pmiIds ([PmiId] | null) – optional
  • nodesToShow ([NodeId] | null) – optional
  • nodesToHide ([NodeId] | null) – optional
  • nodeIdsAndLocalTransforms ([(NodeId, Matrix)] | null) – optional
  • cuttingPlane (Plane | null) – optional
  • meshInstanceData (MeshInstanceData() | null) – optional
Return type:

CadViewId | null

createImage

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

Promise <ImageId>

createMesh

Model.createMesh(meshData[, config])
Arguments:
  • meshData (MeshData()) –
  • config (function()) – optional None
Return type:

Promise <MeshId>

createMeshInstance

Model.createMeshInstance(data[, parentNodeId[, preventFromResetting[, isOutOfHierarchy]]])
Arguments:
  • data (MeshInstanceData()) –
  • parentNodeId (NodeId | null) – optional
  • preventFromResetting (boolean | null()) – optional
  • isOutOfHierarchy (boolean | null()) – optional
Return type:

Promise <NodeId>

createNode

Model.createNode(parentNodeId, nodeName[, nodeId[, localMatrix[, visibility[, measurementUnit]]]])
Arguments:
  • parentNodeId (NodeId | undefined | null) –
  • nodeName (string()) – None
  • nodeId (NodeId | null) – optional None
  • localMatrix (Matrix | null()) – optional
  • visibility (boolean | null()) – optional
  • measurementUnit (number | null()) – optional None
Return type:

NodeId

createPart

Model.createPart([nodeId])
Arguments:
  • nodeId (NodeId | null) – optional None
Return type:

PartId

createPmiInstance

Model.createPmiInstance(data, pmiType, pmiSubType, refOnTopoItems[, parentNodeId])
Arguments:
Return type:

Promise <PmiId>

deleteImages

Model.deleteImages(imageIds)
Arguments:
Return type:

Promise <void>

deleteMeshInstances

Model.deleteMeshInstances(nodeIds)
Arguments:
Return type:

Promise <void>

deleteMeshes

Model.deleteMeshes(ids)
Arguments:
Return type:

Promise <void>

deleteNode

Model.deleteNode(nodeId)
Arguments:
Return type:

Promise <void>

getAbsoluteRootNode

Model.getAbsoluteRootNode()
Return type:NodeId

getActiveCadConfiguration

Model.getActiveCadConfiguration()
Return type:NodeId | null

getAssociatedModelKey

Model.getAssociatedModelKey(nodeId)
Arguments:
Return type:

Promise <ModelKey | null>

getBimIdConnectedElements

Model.getBimIdConnectedElements(node, bimId, type)
Arguments:
Return type:

function

getBimIdFromNode

Model.getBimIdFromNode(node)
Arguments:
Return type:

BimId | null

getBimIdRelatedElements

Model.getBimIdRelatedElements(node, bimId, type)
Arguments:
Return type:

[BimId]

getBimIdRelatingElements

Model.getBimIdRelatingElements(node, bimId, type)
Arguments:
Return type:

[BimId]

getBimIdsFromGenericId

Model.getBimIdsFromGenericId(ifcGuid)
Arguments:
Return type:

[BimId]

getBimInfoFromBimId

Model.getBimInfoFromBimId(node, bimId)
Arguments:
Return type:

function

getBranchVisibility

Model.getBranchVisibility(nodeId)
Arguments:
Return type:

BranchVisibility

getCadConfigurations

Model.getCadConfigurations()
Return type:IdStringMap()

getCadViewConfiguration

Model.getCadViewConfiguration(cadViewNodeId)
Arguments:
  • cadViewNodeId (NodeId) – None
Return type:

NodeId | null

getCadViewMap

Model.getCadViewMap()
Return type:Map <NodeId, string>

getCadViewPmis

Model.getCadViewPmis(nodeId)
Arguments:
Return type:

[PmiId]

getDataFromIds

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

Promise <[Uint8Array]>

getDefaultCadConfiguration

Model.getDefaultCadConfiguration()
Return type:NodeId | null

getDefaultCadView

Model.getDefaultCadView()
Return type:NodeId | null

getEdgeAttributes

Model.getEdgeAttributes(nodeId, edgeIndex)
Arguments:
  • nodeId (NodeId) –
  • edgeIndex (number()) –
Return type:

Promise <SubentityAttributes() | null>

getEdgeCount

Model.getEdgeCount(nodeId)
Arguments:
Return type:

Promise <number>

getEdgeProperty

Model.getEdgeProperty(nodeId, edgeId)
Arguments:
  • nodeId (NodeId) –
  • edgeId (number()) – None
Return type:

Promise <Edge | null>

getFaceAttributes

Model.getFaceAttributes(nodeId, faceIndex)
Arguments:
  • nodeId (NodeId) –
  • faceIndex (number()) –
Return type:

Promise <SubentityAttributes() | null>

getFaceCount

Model.getFaceCount(nodeId)
Arguments:
Return type:

Promise <number>

getFaceProperty

Model.getFaceProperty(nodeId, faceId)
Arguments:
  • nodeId (NodeId) –
  • faceId (number()) – None
Return type:

Promise <Face | null>

getFilterName

Model.getFilterName(filterId)
Arguments:
Return type:

FilterName | null

getFilters

Model.getFilters()
Return type:Map <FilterId, FilterName>

getFiltersWithNode

Model.getFiltersWithNode(nodeIdSearched)
Arguments:
  • nodeIdSearched (NodeId) – None
Return type:

[FilterId]

getGenericIdFromBimId

Model.getGenericIdFromBimId(node, bimId)
Arguments:
Return type:

GenericId | null

getGenericTypeIdMap

Model.getGenericTypeIdMap()
Return type:Map <GenericType, Set <NodeId>>

getGenericTypes

Model.getGenericTypes()
Return type:[GenericType]

getLayerIdsFromName

Model.getLayerIdsFromName(name)
Arguments:
Return type:

[LayerId] | null

getLayerName

Model.getLayerName(layerId)
Arguments:
Return type:

LayerName | null

getLayers

Model.getLayers()
Return type:Map <LayerId, LayerName>

getLooseBounding

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

getLowestAvailableNodeId

Model.getLowestAvailableNodeId()
Return type:NodeId

getMeshIds

Model.getMeshIds(nodeIds)
Arguments:
Return type:

Promise <[MeshId]>

getMetallicRoughness

Model.getMetallicRoughness(nodeIds)
Arguments:
Return type:

Promise <[MetallicRoughnessValue()]>

getModelBounding

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

Promise <Box>

getModelFileNameFromNode

Model.getModelFileNameFromNode(nodeId)
Arguments:
Return type:

string | null

getModelFileTypeFromNode

Model.getModelFileTypeFromNode(nodeId)
Arguments:
Return type:

FileType | null

getNodeCappingMeshData

Model.getNodeCappingMeshData(nodeId)
Arguments:
Return type:

Promise <MeshDataCopy() | null>

getNodeChildren

Model.getNodeChildren(nodeId[, includeOutOfHierarchy])
Arguments:
  • nodeId (NodeId) – None
  • includeOutOfHierarchy (boolean()) – optional
Return type:

[NodeId]

getNodeColorMap

Model.getNodeColorMap(startNodeId, elementType)
Arguments:
Return type:

Promise <Map <NodeId, Color>>

getNodeEffectiveFaceColor

Model.getNodeEffectiveFaceColor(partId, faceIndex[, view])
Arguments:
  • partId (PartId) – None
  • faceIndex (number()) –
  • view (IView()) – optional
Return type:

Promise <Color | null>

getNodeEffectiveLineColor

Model.getNodeEffectiveLineColor(partId, lineIndex[, view])
Arguments:
  • partId (PartId) – None
  • lineIndex (number()) –
  • view (IView()) – optional
Return type:

Promise <Color | null>

getNodeEffectivePointColor

Model.getNodeEffectivePointColor(partId, pointIndex[, view])
Arguments:
  • partId (PartId) – None
  • pointIndex (number()) –
  • view (IView()) – optional
Return type:

Promise <Color | null>

getNodeExchangeId

Model.getNodeExchangeId(nodeId)
Arguments:
Return type:

ExchangeId | null

getNodeFaceColor

Model.getNodeFaceColor(partId, faceIndex)
Arguments:
  • partId (PartId) – None
  • faceIndex (number()) –
Return type:

Promise <Color | null>

getNodeFaceHighlighted

Model.getNodeFaceHighlighted(nodeId, faceIndex)
Arguments:
  • nodeId (NodeId) –
  • faceIndex (number()) –
Return type:

Promise <boolean>

getNodeGenericId

Model.getNodeGenericId(nodeId)
Arguments:
Return type:

GenericId | null

getNodeGenericType

Model.getNodeGenericType(nodeId)
Arguments:
Return type:

GenericType | null

getNodeIdFromBimId

Model.getNodeIdFromBimId(node, bimID)
Arguments:
Return type:

NodeId | null

getNodeIdFromScInstanceKey

Model.getNodeIdFromScInstanceKey(inclusionKey, instanceKey)
Arguments:
  • inclusionKey (InclusionKey()) – None
  • instanceKey (InstanceKey()) – None
Return type:

NodeId | null

getNodeIdOffset

Model.getNodeIdOffset(nodeId)
Arguments:
Return type:

NodeIdOffset

getNodeIdsByGenericIds

Model.getNodeIdsByGenericIds(genericIds)
Arguments:
Return type:

[NodeId]

getNodeLayerId

Model.getNodeLayerId(nodeId)
Arguments:
Return type:

LayerId | null

getNodeLineColor

Model.getNodeLineColor(partId, lineIndex)
Arguments:
  • partId (PartId) – None
  • lineIndex (number()) –
Return type:

Promise <Color | null>

getNodeLineHighlighted

Model.getNodeLineHighlighted(nodeId, lineIndex)
Arguments:
  • nodeId (NodeId) –
  • lineIndex (number()) –
Return type:

Promise <boolean>

getNodeMatrix

Model.getNodeMatrix(nodeId)
Arguments:
Return type:

Matrix

getNodeMeshData

Model.getNodeMeshData(nodeId)
Arguments:
Return type:

Promise <MeshDataCopy()>

getNodeName

Model.getNodeName(nodeId)
Arguments:
Return type:

string | null

getNodeNetMatrix

Model.getNodeNetMatrix(nodeId)
Arguments:
Return type:

Matrix

getNodeParent

Model.getNodeParent(nodeId)
Arguments:
Return type:

NodeId | null

getNodePointColor

Model.getNodePointColor(partId, pointIndex)
Arguments:
  • partId (PartId) – None
  • pointIndex (number()) –
Return type:

Promise <Color | null>

getNodePointHighlighted

Model.getNodePointHighlighted(nodeId, pointIndex)
Arguments:
  • nodeId (NodeId) –
  • pointIndex (number()) –
Return type:

Promise <boolean>

getNodeProperties

Model.getNodeProperties(nodeId, computeFromChildren)
Arguments:
  • nodeId (NodeId) – None
  • computeFromChildren (boolean()) –
Return type:

Promise <StringStringMap() | null>

getNodeRealBounding

Model.getNodeRealBounding(nodeId[, view])
Arguments:
Return type:

Promise <Box>

getNodeType

Model.getNodeType(nodeId)
Arguments:
Return type:

NodeType

getNodeUnitMultiplier

Model.getNodeUnitMultiplier(nodeId)
Arguments:
Return type:

number

getNodeUserData

Model.getNodeUserData(nodeId, index)
Arguments:
Return type:

Uint8Array

getNodeUserDataIndices

Model.getNodeUserDataIndices(nodeId)
Arguments:
Return type:

[UserDataIndex]

getNodeVisibility

Model.getNodeVisibility(nodeId)
Arguments:
Return type:

boolean

getNodesAmbientColor

Model.getNodesAmbientColor(nodeIds)
Arguments:
Return type:

Promise <[any]>

getNodesBounding

Model.getNodesBounding(nodeIds[, config])
Arguments:
Return type:

Promise <Box>

getNodesByGenericType

Model.getNodesByGenericType(genericType)
Arguments:
Return type:

Set <NodeId> | null

getNodesCappingMeshData

Model.getNodesCappingMeshData(nodeIds)
Arguments:
Return type:

Promise <[MeshDataCopy()]>

getNodesCullingVectors

Model.getNodesCullingVectors(nodeIds)
Arguments:
Return type:

Promise <[CullingVector()]>

getNodesEffectiveAmbientColor

Model.getNodesEffectiveAmbientColor(nodeIds)
Arguments:
Return type:

Promise <[Color]>

getNodesEffectiveEmissiveColor

Model.getNodesEffectiveEmissiveColor(nodeIds)
Arguments:
Return type:

Promise <[Color]>

getNodesEffectiveFaceColor

Model.getNodesEffectiveFaceColor(nodeIds)
Arguments:
Return type:

Promise <[Color]>

getNodesEffectiveLineColor

Model.getNodesEffectiveLineColor(nodeIds)
Arguments:
Return type:

Promise <[Color]>

getNodesEffectiveOpacity

Model.getNodesEffectiveOpacity(leafNodes, elementType)
Arguments:
Return type:

Promise <[number]>

getNodesEffectivePointColor

Model.getNodesEffectivePointColor(nodeIds)
Arguments:
Return type:

Promise <[Color]>

getNodesEffectiveSpecularColor

Model.getNodesEffectiveSpecularColor(nodeIds)
Arguments:
Return type:

Promise <[Color]>

getNodesFaceColor

Model.getNodesFaceColor(nodeIds)
Arguments:
Return type:

Promise <[any]>

getNodesFaceEmissiveColor

Model.getNodesFaceEmissiveColor(nodeIds)
Arguments:
Return type:

Promise <[any]>

getNodesFaceSpecularColor

Model.getNodesFaceSpecularColor(nodeIds)
Arguments:
Return type:

Promise <[any]>

getNodesFromFiltersId

Model.getNodesFromFiltersId(filtersId)
Arguments:
Return type:

FilteredNodes() | null

getNodesFromLayer

Model.getNodesFromLayer(layerId[, onlyTreeNodes])
Arguments:
  • layerId (LayerId) –
  • onlyTreeNodes (boolean()) – optional
Return type:

[NodeId] | null

getNodesFromLayerName

Model.getNodesFromLayerName(layerName[, onlyTreeNodes])
Arguments:
  • layerName (LayerName) – None
  • onlyTreeNodes (boolean()) – optional
Return type:

[NodeId] | null

getNodesFromLayers

Model.getNodesFromLayers(layersId[, onlyTreeNodes])
Arguments:
  • layersId ([LayerId]) –
  • onlyTreeNodes (boolean()) – optional
Return type:

[NodeId] | null

getNodesHaveTransparency

Model.getNodesHaveTransparency(nodeIds)
Arguments:
Return type:

Promise <[boolean]>

getNodesHighlighted

Model.getNodesHighlighted(partIds)
Arguments:
Return type:

Promise <[boolean]>

getNodesInstancingSamePart

Model.getNodesInstancingSamePart(nodeId)
Arguments:
Return type:

Promise <[NodeId] | null>

getNodesLineColor

Model.getNodesLineColor(nodeIds)
Arguments:
Return type:

Promise <[any]>

getNodesMaterial

Model.getNodesMaterial(nodeIds)
Arguments:
Return type:

Promise <[IMaterial()]>

getNodesOpacity

Model.getNodesOpacity(leafNodes)
Arguments:
  • leafNodes ([NodeId]) – None
Return type:

Promise <[number]>

getNodesPointColor

Model.getNodesPointColor(nodeIds)
Arguments:
Return type:

Promise <[any]>

getOutOfHierarchy

Model.getOutOfHierarchy(nodeId)
Arguments:
Return type:

boolean

getPmiColor

Model.getPmiColor()
Return type:Color

getPmiColorOverride

Model.getPmiColorOverride()
Return type:boolean

getPmiSubtype

Model.getPmiSubtype(pmiId)
Arguments:
Return type:

PmiSubType

getPmiTopologyReferences

Model.getPmiTopologyReferences(pmiNodeId)
Arguments:
Return type:

[RefOnTopoItem()] | null

getPmiType

Model.getPmiType(pmiId)
Arguments:
Return type:

PmiType

getPmis

Model.getPmis()
Return type:IdStringMap()

getPointAttributes

Model.getPointAttributes(nodeId, pointIndex)
Arguments:
  • nodeId (NodeId) –
  • pointIndex (number()) –
Return type:

Promise <SubentityAttributes() | null>

getRelationshipTypesFromBimId

Model.getRelationshipTypesFromBimId(node, bimId)
Arguments:
Return type:

[RelationshipType]

getScInstanceKey

Model.getScInstanceKey(nodeId)
Arguments:
Return type:

InstanceInc | null

getUniqueLayerNames

Model.getUniqueLayerNames()
Return type:[LayerName]

getViewAxes

Model.getViewAxes()
Return type:ViewAxes()

getVisibilityState

Model.getVisibilityState(startNodeId)
Arguments:
  • startNodeId (NodeId) – None
Return type:

Promise <VisibilityState()>

hasDepthRange

Model.hasDepthRange(nodeIds)
Arguments:
Return type:

Promise <[boolean]>

hasEffectiveGenericType

Model.hasEffectiveGenericType(nodeId, genericType)
Arguments:
Return type:

boolean

isAnnotationView

Model.isAnnotationView(cadViewNodeId)
Arguments:
Return type:

boolean

isCombineStateView

Model.isCombineStateView(cadViewNodeId)
Arguments:
Return type:

boolean

isDrawing

Model.isDrawing()
Return type:boolean

isFaceMeasurable

Model.isFaceMeasurable(bodyId, faceIndex)
Arguments:
  • bodyId (NodeId) – None
  • faceIndex (number()) – None
Return type:

Promise <boolean>

isLineMeasurable

Model.isLineMeasurable(bodyId, lineIndex)
Arguments:
  • bodyId (NodeId) –
  • lineIndex (number()) –
Return type:

Promise <boolean>

isMeasurable

Model.isMeasurable()
Return type:boolean

isNodeLoaded

Model.isNodeLoaded(nodeId)
Arguments:
Return type:

boolean

isWithinExternalModel

Model.isWithinExternalModel(nodeId)
Arguments:
Return type:

boolean

loadMeasurementFromFile

Model.loadMeasurementFromFile(filename)
Arguments:
  • filename (string()) –
Return type:

Promise <void>

loadMeasurementFromJson

Model.loadMeasurementFromJson(json)
Arguments:
  • json (any()) –
Return type:

Promise <void>

loadMeasurementFromString

Model.loadMeasurementFromString(str)
Arguments:
  • str (string()) –
Return type:

Promise <void>

loadSubtreeFromModel

Model.loadSubtreeFromModel(nodeId, modelName, config)
Arguments:
Return type:

Promise <[NodeId]>

Model.loadSubtreeFromModel(nodeId, modelName[, additionalMatrix])
Arguments:
  • nodeId (NodeId) –
  • modelName (ScModelName()) –
  • additionalMatrix (Matrix | null()) – optional
Return type:

Promise <[NodeId]>

loadSubtreeFromScsBuffer

Model.loadSubtreeFromScsBuffer(nodeId, buffer, config)
Arguments:
Return type:

Promise <[NodeId]>

Model.loadSubtreeFromScsBuffer(nodeId, buffer[, additionalMatrix])
Arguments:
  • nodeId (NodeId) –
  • buffer (ScsBuffer()) –
  • additionalMatrix (Matrix | null()) – optional
Return type:

Promise <[NodeId]>

loadSubtreeFromScsFile

Model.loadSubtreeFromScsFile(nodeId, scsFilename, config)
Arguments:
Return type:

Promise <[NodeId]>

Model.loadSubtreeFromScsFile(nodeId, scsFilename[, additionalMatrix])
Arguments:
  • nodeId (NodeId) –
  • scsFilename (ScsUri) –
  • additionalMatrix (Matrix | null()) – optional
Return type:

Promise <[NodeId]>

loadSubtreeFromScsXmlBuffer

Model.loadSubtreeFromScsXmlBuffer(nodeId, xmlData, modelNameToScs, config)
Arguments:
Return type:

Promise <[NodeId]>

Model.loadSubtreeFromScsXmlBuffer(nodeId, xmlData[, modelNameToScs[, additionalMatrix[, allowMissingExternalModels]]])
Arguments:
  • nodeId (NodeId) –
  • xmlData (string | Document()) –
  • modelNameToScs (ModelNameToScsFileFunc | null) – optional
  • additionalMatrix (Matrix | null()) – optional
  • allowMissingExternalModels (boolean()) – optional
Return type:

Promise <[NodeId]>

loadSubtreeFromScsXmlFile

Model.loadSubtreeFromScsXmlFile(nodeId, xmlFilename, modelNameToScs, config)
Arguments:
Return type:

Promise <[NodeId]>

Model.loadSubtreeFromScsXmlFile(nodeId, xmlFilename[, modelNameToScs[, additionalMatrix[, allowMissingExternalModels]]])
Arguments:
  • nodeId (NodeId) –
  • xmlFilename (XmlFilename) –
  • modelNameToScs (ModelNameToScsFileFunc | null) – optional
  • additionalMatrix (Matrix | null()) – optional
  • allowMissingExternalModels (boolean()) – optional
Return type:

Promise <[NodeId]>

loadSubtreeFromXmlBuffer

Model.loadSubtreeFromXmlBuffer(nodeId, xmlData, massageModelName, config)
Arguments:
Return type:

Promise <[NodeId]>

Model.loadSubtreeFromXmlBuffer(nodeId, xmlData[, massageModelName[, additionalMatrix[, allowMissingExternalModels]]])
Arguments:
  • nodeId (NodeId) –
  • xmlData (string | Document()) –
  • massageModelName (MassageModelNameFunc | null) – optional
  • additionalMatrix (Matrix | null()) – optional
  • allowMissingExternalModels (boolean()) – optional
Return type:

Promise <[NodeId]>

loadSubtreeFromXmlFile

Model.loadSubtreeFromXmlFile(nodeId, xmlFilename, massageModelName, config)
Arguments:
Return type:

Promise <[NodeId]>

Model.loadSubtreeFromXmlFile(nodeId, xmlFilename[, massageModelName[, additionalMatrix[, allowMissingExternalModels]]])
Arguments:
  • nodeId (NodeId) –
  • xmlFilename (XmlFilename) –
  • massageModelName (MassageModelNameFunc | null) – optional
  • additionalMatrix (Matrix | null()) – optional
  • allowMissingExternalModels (boolean()) – optional
Return type:

Promise <[NodeId]>

registerBimNodes

Model.registerBimNodes(startNodeId, attributeToMask, legacy_useAttributeTitle)
Arguments:
  • startNodeId (NodeId) –
  • attributeToMask (function()) –
  • legacy_useAttributeTitle (string | boolean | null()) – None
Return type:

Promise <void>

Model.attributeToMask(value)
Arguments:
  • value (string()) – None
Return type:

BimMask

registerIfcNodes

Model.registerIfcNodes(startNodeId, legacy_useAttributeTitle)
Arguments:
  • startNodeId (NodeId) –
  • legacy_useAttributeTitle (string | boolean | null()) – None
Return type:

Promise <void>

replaceMesh

Model.replaceMesh(id, data)
Arguments:
Return type:

Promise <void>

requestNodes

Model.requestNodes(nodeIds)
Arguments:
Return type:

Promise <void>

reset

Model.reset()
Return type:Promise <void>

resetModelHighlight

Model.resetModelHighlight()
Return type:Promise <void>

resetModelOpacity

Model.resetModelOpacity()
Return type:void

resetNodeMatrixToInitial

Model.resetNodeMatrixToInitial(nodeId)
Arguments:
Return type:

Promise <void>

resetNodesColor

Model.resetNodesColor()
Return type:Promise <void>

resetNodesMaterial

Model.resetNodesMaterial(nodeIds[, params])
Arguments:
Return type:

void

resetNodesOpacity

Model.resetNodesOpacity(nodeIds)
Arguments:
Return type:

void

resetNodesTransform

Model.resetNodesTransform()
Return type:Promise <void>

resetNodesVisibility

Model.resetNodesVisibility()
Return type:Promise <void>

setBehaviorInitiallyHidden

Model.setBehaviorInitiallyHidden(enabled)
Arguments:
  • enabled (boolean()) –
Return type:

void

setBodyNodesVisibility

Model.setBodyNodesVisibility(startNodeId, visibility)
Arguments:
  • startNodeId (NodeId) –
  • visibility (boolean()) –
Return type:

Promise <void>

Model.setBodyNodesVisibility(startNodeId, visibilityFormatter)
Arguments:
  • startNodeId (NodeId) –
  • visibilityFormatter (function()) –
Return type:

Promise <void>

Model.visibilityFormatter(node)
Arguments:
Return type:

boolean | undefined

setDepthRange

Model.setDepthRange(nodeIds, min, max)
Arguments:
  • nodeIds ([NodeId]) –
  • min (number()) –
  • max (number()) –
Return type:

Promise <void>

setEdgeProperty

Model.setEdgeProperty(nodeId, edgeId, prop)
Arguments:
  • nodeId (NodeId) – None
  • edgeId (number()) – None
  • prop (Base) –
Return type:

void

setEnableAutomaticUnitScaling

Model.setEnableAutomaticUnitScaling(enabled)
Arguments:
  • enabled (boolean()) –
Return type:

void

setFaceProperty

Model.setFaceProperty(nodeId, faceId, prop)
Arguments:
  • nodeId (NodeId) – None
  • faceId (number()) – None
  • prop (Base) –
Return type:

void

setInstanceModifier

Model.setInstanceModifier(instanceModifier, nodeIds, value)
Arguments:
Return type:

Promise <void>

setMeshLevel

Model.setMeshLevel(nodeIds, meshLevel)
Arguments:
  • nodeIds ([NodeId]) –
  • meshLevel (number()) –
Return type:

Promise <void>

setMetallicRoughness

Model.setMetallicRoughness(nodeIds, metallicFactor, roughnessFactor)
Arguments:
  • nodeIds ([NodeId]) –
  • metallicFactor (number()) –
  • roughnessFactor (number()) –
Return type:

void

setNodeFaceColor

Model.setNodeFaceColor(partId, faceId, color)
Arguments:
  • partId (PartId) – None
  • faceId (number()) –
  • color (Color) –
Return type:

Promise <void>

setNodeFaceHighlighted

Model.setNodeFaceHighlighted(nodeId, faceId, highlighted)
Arguments:
  • nodeId (NodeId) –
  • faceId (number()) –
  • highlighted (boolean()) –
Return type:

Promise <void>

setNodeFaceVisibility

Model.setNodeFaceVisibility(partId, faceId, visibility)
Arguments:
  • partId (PartId) –
  • faceId (number()) –
  • visibility (boolean()) –
Return type:

void

setNodeLineColor

Model.setNodeLineColor(partId, lineId, color)
Arguments:
  • partId (PartId) – None
  • lineId (number()) –
  • color (Color) –
Return type:

Promise <void>

setNodeLineHighlighted

Model.setNodeLineHighlighted(partId, lineId, highlighted)
Arguments:
  • partId (PartId) – None
  • lineId (number()) –
  • highlighted (boolean()) –
Return type:

Promise <void>

setNodeLineVisibility

Model.setNodeLineVisibility(partId, lineId, visibility)
Arguments:
  • partId (PartId) –
  • lineId (number()) –
  • visibility (boolean()) –
Return type:

void

setNodeMatrix

Model.setNodeMatrix(nodeId, matrix, setAsInitial)
Arguments:
  • nodeId (NodeId) – None
  • matrix (Matrix()) – None
  • setAsInitial (boolean()) –
Return type:

Promise <void>

setNodePointColor

Model.setNodePointColor(partId, pointId, color)
Arguments:
  • partId (PartId) –
  • pointId (number()) –
  • color (Color) –
Return type:

void

setNodePointHighlighted

Model.setNodePointHighlighted(partId, pointId, highlighted)
Arguments:
  • partId (NodeId) – None
  • pointId (number()) –
  • highlighted (boolean()) –
Return type:

Promise <void>

setNodePointVisibility

Model.setNodePointVisibility(partId, pointId, visibility)
Arguments:
  • partId (PartId) –
  • pointId (number()) –
  • visibility (boolean()) –
Return type:

void

setNodesAmbientColor

Model.setNodesAmbientColor(nodeIds, color)
Arguments:
Return type:

void

setNodesAmbientMix

Model.setNodesAmbientMix(nodeIds, value)
Arguments:
  • nodeIds ([NodeId]) –
  • value (number()) –
Return type:

void

setNodesColors

Model.setNodesColors(colorMap, alsoApplyToWireframe, alsoApplyToPoints)
Arguments:
  • colorMap (Map <NodeId, Color> | IdColorMap()) – None
  • alsoApplyToWireframe (boolean()) –
  • alsoApplyToPoints (boolean()) –
Return type:

Promise <void>

setNodesCullingVector

Model.setNodesCullingVector(nodeIds, space, vector, toleranceDegrees)
Arguments:
Return type:

Promise <void>

setNodesFaceColor

Model.setNodesFaceColor(nodeIds, color)
Arguments:
Return type:

Promise <void>

setNodesFaceEmissiveColor

Model.setNodesFaceEmissiveColor(nodeIds, color)
Arguments:
Return type:

void

setNodesFaceSpecularColor

Model.setNodesFaceSpecularColor(nodeIds, color)
Arguments:
Return type:

void

setNodesFaceSpecularIntensity

Model.setNodesFaceSpecularIntensity(nodeIds, value)
Arguments:
  • nodeIds ([NodeId]) –
  • value (number()) –
Return type:

void

setNodesHighlighted

Model.setNodesHighlighted(partIds, highlighted)
Arguments:
  • partIds ([PartId]) – None
  • highlighted (boolean()) –
Return type:

Promise <void>

setNodesLineColor

Model.setNodesLineColor(nodeIds, color)
Arguments:
Return type:

Promise <void>

setNodesLinePattern

Model.setNodesLinePattern(nodeIds, pattern, patternLength, patternLengthUnit)
Arguments:
Return type:

void

setNodesMaterial

Model.setNodesMaterial(nodeIds, material)
Arguments:
Return type:

void

setNodesOpacities

Model.setNodesOpacities(params)
Arguments:
Return type:

void

setNodesOpacity

Model.setNodesOpacity(nodeIds, opacity)
Arguments:
  • nodeIds ([NodeId]) –
  • opacity (number()) –
Return type:

void

setNodesPointColor

Model.setNodesPointColor(nodeIds, color)
Arguments:
Return type:

void

setNodesTexture

Model.setNodesTexture(nodeIds, options)
Arguments:
Return type:

Promise <void>

setNodesVisibilities

Model.setNodesVisibilities(mapping, initiallyHiddenStayHidden)
Arguments:
  • mapping (Map <NodeId, boolean> | IdBooleanMap()) –
  • initiallyHiddenStayHidden (boolean | null()) –
Return type:

Promise <void>

setNodesVisibility

Model.setNodesVisibility(nodeIds, visibility, initiallyHiddenStayHidden)
Arguments:
  • nodeIds ([NodeId]) –
  • visibility (boolean()) –
  • initiallyHiddenStayHidden (boolean | null()) –
Return type:

Promise <void>

setPart

Model.setPart(assemblyNodeId, partNodeId)
Arguments:
  • assemblyNodeId (NodeId | undefined | null) – None
  • partNodeId (PartId | undefined | null) – None
Return type:

boolean

setPhysicalProperties

Model.setPhysicalProperties(nodeId, gravityCenter, surfaceArea, volume)
Arguments:
  • nodeId (NodeId) –
  • gravityCenter (Point3()) –
  • surfaceArea (number()) –
  • volume (number()) –
Return type:

boolean

setPmiColor

Model.setPmiColor(color)
Arguments:
Return type:

void

setPmiColorOverride

Model.setPmiColorOverride(enableOverride[, rootId])
Arguments:
  • enableOverride (boolean()) – None
  • rootId (NodeId) – optional None
Return type:

Promise <void>

setViewAxes

Model.setViewAxes(frontVector, upVector)
Arguments:
Return type:

void

switchToModel

Model.switchToModel(newModelFilename)
Arguments:
  • newModelFilename (ScModelName()) –
Return type:

Promise <[NodeId]>

triangulatePolygon

Model.triangulatePolygon(polygonPoints, normal)
Arguments:
  • polygonPoints (Float32Array | [number]()) –
  • normal (Point3()) –
Return type:

Float32Array

unsetDepthRange

Model.unsetDepthRange(nodeIds)
Arguments:
Return type:

void

unsetMetallicRoughness

Model.unsetMetallicRoughness(nodeIds)
Arguments:
Return type:

void

unsetNodeFaceColor

Model.unsetNodeFaceColor(partId, faceId)
Arguments:
  • partId (PartId) – None
  • faceId (number()) –
Return type:

Promise <void>

unsetNodeLineColor

Model.unsetNodeLineColor(partId, lineId)
Arguments:
  • partId (PartId) – None
  • lineId (number()) –
Return type:

Promise <void>

unsetNodePointColor

Model.unsetNodePointColor(partId, pointId)
Arguments:
  • partId (PartId) –
  • pointId (number()) –
Return type:

void

unsetNodesAmbientColor

Model.unsetNodesAmbientColor(nodeIds)
Arguments:
Return type:

void

unsetNodesCullingVectors

Model.unsetNodesCullingVectors(nodeIds)
Arguments:
Return type:

Promise <void>

unsetNodesFaceColor

Model.unsetNodesFaceColor(nodeIds)
Arguments:
Return type:

Promise <void>

unsetNodesFaceEmissiveColor

Model.unsetNodesFaceEmissiveColor(nodeIds)
Arguments:
Return type:

void

unsetNodesFaceSpecularColor

Model.unsetNodesFaceSpecularColor(nodeIds)
Arguments:
Return type:

void

unsetNodesFaceSpecularIntensity

Model.unsetNodesFaceSpecularIntensity(nodeIds)
Arguments:
Return type:

void

unsetNodesLineColor

Model.unsetNodesLineColor(nodeIds)
Arguments:
Return type:

Promise <void>

unsetNodesLinePattern

Model.unsetNodesLinePattern(nodeIds)
Arguments:
Return type:

void

unsetNodesPointColor

Model.unsetNodesPointColor(nodeIds)
Arguments:
Return type:

void

unsetNodesTexture

Model.unsetNodesTexture(nodeIds)
Arguments:
Return type:

void

viewAxesHaveBeenSet

Model.viewAxesHaveBeenSet()
Return type:boolean