Model
-
class
Model()
Methods
activateCadConfiguration()activateCadView()activateDefaultCadConfiguration()activateDefaultCadView()addPropertyToNode()cadConfigurationsEnabled()clear()clearNodeFaceVisibility()clearNodeLineVisibility()clearNodePointVisibility()computeMinimumBodyBodyDistance()computeMinimumFaceFaceDistance()computeMinimumFaceLineDistance()computeMinimumFaceRayDistance()createAndAddRepresentationItem()createCadView()createImage()createMesh()createMeshInstance()createNode()createPart()createPmiInstance()deleteImages()deleteMeshInstances()deleteMeshes()deleteNode()getAbsoluteRootNode()getActiveCadConfiguration()getAssociatedModelKey()getBimIdConnectedElements()getBimIdFromNode()getBimIdRelatedElements()getBimIdRelatingElements()getBimIdsFromGenericId()getBimInfoFromBimId()getBranchVisibility()getCadConfigurations()getCadViewConfiguration()getCadViewMap()getCadViewPmis()getDataFromIds()getDefaultCadConfiguration()getDefaultCadView()getEdgeAttributes()getEdgeCount()getEdgeProperty()getFaceAttributes()getFaceCount()getFaceProperty()getFilterName()getFilters()getFiltersWithNode()getGenericIdFromBimId()getGenericTypeIdMap()getGenericTypes()getLayerIdsFromName()getLayerName()getLayers()getLooseBounding()getLowestAvailableNodeId()getMeshIds()getMetallicRoughness()getModelBounding()getModelFileNameFromNode()getModelFileTypeFromNode()getNodeCappingMeshData()getNodeChildren()getNodeColorMap()getNodeEffectiveFaceColor()getNodeEffectiveLineColor()getNodeEffectivePointColor()getNodeExchangeId()getNodeFaceColor()getNodeFaceHighlighted()getNodeGenericId()getNodeGenericType()getNodeIdFromBimId()getNodeIdFromScInstanceKey()getNodeIdOffset()getNodeIdsByGenericIds()getNodeLayerId()getNodeLineColor()getNodeLineHighlighted()getNodeMatrix()getNodeMeshData()getNodeName()getNodeNetMatrix()getNodeParent()getNodePointColor()getNodePointHighlighted()getNodeProperties()getNodeRealBounding()getNodeType()getNodeUnitMultiplier()getNodeUserData()getNodeUserDataIndices()getNodeVisibility()getNodesAmbientColor()getNodesBounding()getNodesByGenericType()getNodesCappingMeshData()getNodesCullingVectors()getNodesEffectiveAmbientColor()getNodesEffectiveEmissiveColor()getNodesEffectiveFaceColor()getNodesEffectiveLineColor()getNodesEffectiveOpacity()getNodesEffectivePointColor()getNodesEffectiveSpecularColor()getNodesFaceColor()getNodesFaceEmissiveColor()getNodesFaceSpecularColor()getNodesFromFiltersId()getNodesFromLayer()getNodesFromLayerName()getNodesFromLayers()getNodesHaveTransparency()getNodesHighlighted()getNodesInstancingSamePart()getNodesLineColor()getNodesMaterial()getNodesOpacity()getNodesPointColor()getOutOfHierarchy()getPmiColor()getPmiColorOverride()getPmiSubtype()getPmiTopologyReferences()getPmiType()getPmis()getPointAttributes()getRelationshipTypesFromBimId()getScInstanceKey()getUniqueLayerNames()getViewAxes()getVisibilityState()hasDepthRange()hasEffectiveGenericType()isAnnotationView()isCombineStateView()isDrawing()isFaceMeasurable()isLineMeasurable()isMeasurable()isNodeLoaded()isWithinExternalModel()loadMeasurementFromFile()loadMeasurementFromJson()loadMeasurementFromString()loadSubtreeFromModel()loadSubtreeFromScsBuffer()loadSubtreeFromScsFile()loadSubtreeFromScsXmlBuffer()loadSubtreeFromScsXmlFile()loadSubtreeFromXmlBuffer()loadSubtreeFromXmlFile()registerBimNodes()registerIfcNodes()replaceMesh()requestNodes()reset()resetModelHighlight()resetModelOpacity()resetNodeMatrixToInitial()resetNodesColor()resetNodesMaterial()resetNodesOpacity()resetNodesTransform()resetNodesVisibility()setBehaviorInitiallyHidden()setBodyNodesVisibility()setDepthRange()setEdgeProperty()setEnableAutomaticUnitScaling()setFaceProperty()setInstanceModifier()setMeshLevel()setMetallicRoughness()setNodeFaceColor()setNodeFaceHighlighted()setNodeFaceVisibility()setNodeLineColor()setNodeLineHighlighted()setNodeLineVisibility()setNodeMatrix()setNodePointColor()setNodePointHighlighted()setNodePointVisibility()setNodesAmbientColor()setNodesAmbientMix()setNodesColors()setNodesCullingVector()setNodesFaceColor()setNodesFaceEmissiveColor()setNodesFaceSpecularColor()setNodesFaceSpecularIntensity()setNodesHighlighted()setNodesLineColor()setNodesLinePattern()setNodesMaterial()setNodesOpacities()setNodesOpacity()setNodesPointColor()setNodesTexture()setNodesVisibilities()setNodesVisibility()setPart()setPhysicalProperties()setPmiColor()setPmiColorOverride()setViewAxes()switchToModel()triangulatePolygon()unsetDepthRange()unsetMetallicRoughness()unsetNodeFaceColor()unsetNodeLineColor()unsetNodePointColor()unsetNodesAmbientColor()unsetNodesCullingVectors()unsetNodesFaceColor()unsetNodesFaceEmissiveColor()unsetNodesFaceSpecularColor()unsetNodesFaceSpecularIntensity()unsetNodesLineColor()unsetNodesLinePattern()unsetNodesPointColor()unsetNodesTexture()viewAxesHaveBeenSet()
Methods
activateCadConfiguration
activateCadView
activateDefaultCadConfiguration
activateDefaultCadView
addPropertyToNode
clearNodeFaceVisibility
clearNodeLineVisibility
clearNodePointVisibility
computeMinimumBodyBodyDistance
-
Model.computeMinimumBodyBodyDistance(partId1, partId2) Arguments: Return type: Promise <
FaceFaceDistanceItem()>
computeMinimumFaceFaceDistance
-
Model.computeMinimumFaceFaceDistance(partId1, faceId1, partId2, faceId2) Arguments: Return type: Promise <
FaceFaceDistanceItem()>
computeMinimumFaceLineDistance
-
Model.computeMinimumFaceLineDistance(partId, faceId, ray) Arguments: Return type: Promise <
FaceFaceDistanceItem()>
computeMinimumFaceRayDistance
-
Model.computeMinimumFaceRayDistance(partId, faceId, ray) Arguments: Return type: Promise <
FaceFaceDistanceItem()>
createAndAddRepresentationItem
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: - primaryImage (
ImageOptions()) – - thumbnailImage (
ImageOptions()) – optional
Return type: Promise <ImageId>
- primaryImage (
createMesh
-
Model.createMesh(meshData[, config]) Arguments: - meshData (
MeshData()) – - config (
function()) – optional None
Return type: Promise <MeshId>
- meshData (
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>
- data (
createNode
-
Model.createNode(parentNodeId, nodeName[, nodeId[, localMatrix[, visibility[, measurementUnit]]]]) Arguments: Return type:
createPart
createPmiInstance
-
Model.createPmiInstance(data, pmiType, pmiSubType, refOnTopoItems[, parentNodeId]) Arguments: - data (
MeshInstanceData()) – - pmiType (
PmiType()) – - pmiSubType (PmiSubType) –
- refOnTopoItems ([
RefOnTopoItem()]) – - parentNodeId (NodeId | null) – optional
Return type: Promise <PmiId>
- data (
deleteImages
deleteMeshInstances
getAssociatedModelKey
getBimIdConnectedElements
-
Model.getBimIdConnectedElements(node, bimId, type) Arguments: - node (NodeId) –
- bimId (BimId) –
- type (RelationshipType) – None
Return type: function
getBimIdRelatingElements
-
Model.getBimIdRelatingElements(node, bimId, type) Arguments: - node (NodeId) –
- bimId (BimId) –
- type (RelationshipType) – None
Return type: [BimId]
getBimIdsFromGenericId
getBimInfoFromBimId
getCadConfigurations
-
Model.getCadConfigurations() Return type: IdStringMap()
getCadViewConfiguration
getDataFromIds
-
Model.getDataFromIds(ids) Arguments: - ids (
DataIds()) – None
Return type: Promise <[Uint8Array]>
- ids (
getEdgeAttributes
-
Model.getEdgeAttributes(nodeId, edgeIndex) Arguments: - nodeId (NodeId) –
- edgeIndex (
number()) –
Return type: Promise <
SubentityAttributes()| null>
getEdgeProperty
getFaceAttributes
-
Model.getFaceAttributes(nodeId, faceIndex) Arguments: - nodeId (NodeId) –
- faceIndex (
number()) –
Return type: Promise <
SubentityAttributes()| null>
getFaceProperty
getFilterName
-
Model.getFilterName(filterId) Arguments: - filterId (FilterId) – None
Return type: FilterName | null
getFilters
-
Model.getFilters() Return type: Map <FilterId, FilterName>
getFiltersWithNode
getGenericIdFromBimId
getGenericTypeIdMap
-
Model.getGenericTypeIdMap() Return type: Map <GenericType, Set <NodeId>>
getGenericTypes
-
Model.getGenericTypes() Return type: [GenericType]
getLayerIdsFromName
getLayerName
getMeshIds
getMetallicRoughness
-
Model.getMetallicRoughness(nodeIds) Arguments: - nodeIds ([NodeId]) –
Return type: Promise <[
MetallicRoughnessValue()]>
getModelBounding
-
Model.getModelBounding(ignoreInvisible, includeExcluded, tightBounding) Arguments: - ignoreInvisible (
boolean()) – None - includeExcluded (
boolean()) – None - tightBounding (
boolean()) – None
Return type: Promise <Box>
- ignoreInvisible (
getModelFileNameFromNode
getModelFileTypeFromNode
getNodeCappingMeshData
-
Model.getNodeCappingMeshData(nodeId) Arguments: - nodeId (NodeId) – None
Return type: Promise <
MeshDataCopy()| null>
getNodeChildren
getNodeColorMap
-
Model.getNodeColorMap(startNodeId, elementType) Arguments: - startNodeId (NodeId) –
- elementType (ElementType) –
Return type:
getNodeEffectiveFaceColor
getNodeEffectiveLineColor
getNodeEffectivePointColor
getNodeExchangeId
-
Model.getNodeExchangeId(nodeId) Arguments: - nodeId (NodeId) –
Return type: ExchangeId | null
getNodeFaceColor
getNodeFaceHighlighted
getNodeGenericId
getNodeGenericType
-
Model.getNodeGenericType(nodeId) Arguments: - nodeId (NodeId) – None
Return type: GenericType | null
getNodeIdFromBimId
getNodeIdFromScInstanceKey
getNodeIdsByGenericIds
getNodeLayerId
getNodeLineColor
getNodeLineHighlighted
getNodeMeshData
-
Model.getNodeMeshData(nodeId) Arguments: - nodeId (NodeId) –
Return type: Promise <
MeshDataCopy()>
getNodeNetMatrix
getNodeParent
getNodePointColor
getNodePointHighlighted
getNodeProperties
-
Model.getNodeProperties(nodeId, computeFromChildren) Arguments: - nodeId (NodeId) – None
- computeFromChildren (
boolean()) –
Return type: Promise <
StringStringMap()| null>
getNodeRealBounding
getNodeUnitMultiplier
getNodeUserData
-
Model.getNodeUserData(nodeId, index) Arguments: - nodeId (NodeId) –
- index (UserDataIndex) –
Return type: Uint8Array
getNodeUserDataIndices
getNodeVisibility
getNodesAmbientColor
getNodesBounding
-
Model.getNodesBounding(nodeIds[, config]) Arguments: - nodeIds ([NodeId]) –
- config (
GetNodesBoundingConfig()) – optional
Return type: Promise <Box>
getNodesByGenericType
-
Model.getNodesByGenericType(genericType) Arguments: - genericType (GenericType) –
Return type: Set <NodeId> | null
getNodesCappingMeshData
-
Model.getNodesCappingMeshData(nodeIds) Arguments: - nodeIds ([NodeId]) –
Return type: Promise <[
MeshDataCopy()]>
getNodesCullingVectors
-
Model.getNodesCullingVectors(nodeIds) Arguments: - nodeIds ([NodeId]) –
Return type: Promise <[
CullingVector()]>
getNodesEffectiveAmbientColor
getNodesEffectiveEmissiveColor
getNodesEffectiveFaceColor
getNodesEffectiveLineColor
getNodesEffectiveOpacity
-
Model.getNodesEffectiveOpacity(leafNodes, elementType) Arguments: - leafNodes ([NodeId]) – None
- elementType (ElementType) –
Return type: Promise <[number]>
getNodesEffectivePointColor
getNodesEffectiveSpecularColor
getNodesFaceColor
getNodesFaceEmissiveColor
getNodesFaceSpecularColor
getNodesFromFiltersId
-
Model.getNodesFromFiltersId(filtersId) Arguments: - filtersId ([FilterId]) –
Return type: FilteredNodes()| null
getNodesFromLayer
getNodesFromLayerName
getNodesFromLayers
getNodesHaveTransparency
getNodesHighlighted
getNodesInstancingSamePart
getNodesLineColor
getNodesMaterial
-
Model.getNodesMaterial(nodeIds) Arguments: - nodeIds ([NodeId]) –
Return type: Promise <[
IMaterial()]>
getNodesOpacity
getNodesPointColor
getOutOfHierarchy
getPmiTopologyReferences
-
Model.getPmiTopologyReferences(pmiNodeId) Arguments: - pmiNodeId (NodeId) –
Return type: [
RefOnTopoItem()] | null
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:
getScInstanceKey
getViewAxes
-
Model.getViewAxes() Return type: ViewAxes()
getVisibilityState
-
Model.getVisibilityState(startNodeId) Arguments: - startNodeId (NodeId) – None
Return type: Promise <
VisibilityState()>
hasDepthRange
hasEffectiveGenericType
-
Model.hasEffectiveGenericType(nodeId, genericType) Arguments: - nodeId (NodeId) –
- genericType (GenericType) –
Return type: boolean
isAnnotationView
isCombineStateView
isFaceMeasurable
isLineMeasurable
isWithinExternalModel
loadMeasurementFromFile
-
Model.loadMeasurementFromFile(filename) Arguments: - filename (
string()) –
Return type: Promise <void>
- filename (
loadMeasurementFromJson
-
Model.loadMeasurementFromJson(json) Arguments: - json (
any()) –
Return type: Promise <void>
- json (
loadMeasurementFromString
-
Model.loadMeasurementFromString(str) Arguments: - str (
string()) –
Return type: Promise <void>
- str (
loadSubtreeFromModel
-
Model.loadSubtreeFromModel(nodeId, modelName, config) Arguments: - nodeId (NodeId) –
- modelName (
ScModelName()) – - config (
LoadSubtreeConfig()) –
Return type: Promise <[NodeId]>
loadSubtreeFromScsBuffer
-
Model.loadSubtreeFromScsBuffer(nodeId, buffer, config) Arguments: - nodeId (NodeId) –
- buffer (
ScsBuffer()) – - config (
LoadSubtreeConfig()) –
Return type: Promise <[NodeId]>
loadSubtreeFromScsFile
-
Model.loadSubtreeFromScsFile(nodeId, scsFilename, config) Arguments: - nodeId (NodeId) –
- scsFilename (ScsUri) –
- config (
LoadSubtreeConfig()) –
Return type: Promise <[NodeId]>
loadSubtreeFromScsXmlBuffer
-
Model.loadSubtreeFromScsXmlBuffer(nodeId, xmlData, modelNameToScs, config) Arguments: - nodeId (NodeId) –
- xmlData (
string | Document()) – - modelNameToScs (ModelNameToScsFileFunc | null) –
- config (
LoadSubtreeConfig()) –
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: - nodeId (NodeId) –
- xmlFilename (XmlFilename) –
- modelNameToScs (ModelNameToScsFileFunc | null) –
- config (
LoadSubtreeConfig()) –
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: - nodeId (NodeId) –
- xmlData (
string | Document()) – - massageModelName (MassageModelNameFunc | null) –
- config (
LoadSubtreeConfig()) –
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: - nodeId (NodeId) –
- xmlFilename (XmlFilename) –
- massageModelName (MassageModelNameFunc | null) –
- config (
LoadSubtreeConfig()) –
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
- value (
registerIfcNodes
replaceMesh
-
Model.replaceMesh(id, data) Arguments: - id (MeshId) – None
- data (
MeshData()) –
Return type: Promise <void>
requestNodes
resetNodeMatrixToInitial
resetNodesMaterial
-
Model.resetNodesMaterial(nodeIds[, params]) Arguments: - nodeIds ([NodeId]) –
- params ([MaterialParam]) – optional
Return type: void
resetNodesOpacity
setBodyNodesVisibility
setDepthRange
setEdgeProperty
setEnableAutomaticUnitScaling
-
Model.setEnableAutomaticUnitScaling(enabled) Arguments: - enabled (
boolean()) –
Return type: void
- enabled (
setFaceProperty
setInstanceModifier
-
Model.setInstanceModifier(instanceModifier, nodeIds, value) Arguments: - instanceModifier (InstanceModifier) –
- nodeIds ([NodeId]) –
- value (
boolean()) –
Return type: Promise <void>
setMeshLevel
setMetallicRoughness
setNodeFaceColor
setNodeFaceHighlighted
setNodeFaceVisibility
setNodeLineColor
setNodeLineHighlighted
setNodeLineVisibility
setNodeMatrix
setNodePointColor
setNodePointHighlighted
setNodePointVisibility
setNodesAmbientColor
setNodesAmbientMix
setNodesColors
-
Model.setNodesColors(colorMap, alsoApplyToWireframe, alsoApplyToPoints) Arguments: - colorMap (Map <NodeId, Color> |
IdColorMap()) – None - alsoApplyToWireframe (
boolean()) – - alsoApplyToPoints (
boolean()) –
Return type: Promise <void>
- colorMap (Map <NodeId, Color> |
setNodesCullingVector
-
Model.setNodesCullingVector(nodeIds, space, vector, toleranceDegrees) Arguments: - nodeIds ([NodeId]) – None
- space (CullingVectorSpace) –
- vector (
Point3()) – - toleranceDegrees (Degrees) –
Return type: Promise <void>
setNodesFaceColor
setNodesFaceEmissiveColor
setNodesFaceSpecularColor
setNodesFaceSpecularIntensity
setNodesHighlighted
setNodesLineColor
setNodesLinePattern
-
Model.setNodesLinePattern(nodeIds, pattern, patternLength, patternLengthUnit) Arguments: - nodeIds ([NodeId]) –
- pattern (LinePattern) –
- patternLength (
number()) – - patternLengthUnit (LinePatternLengthUnit) –
Return type: void
setNodesMaterial
-
Model.setNodesMaterial(nodeIds, material) Arguments: - nodeIds ([NodeId]) –
- material (
IMaterial()) –
Return type: void
setNodesOpacities
-
Model.setNodesOpacities(params) Arguments: - params (Map <NodeId, number> |
IdNumberMap()) –
Return type: void
- params (Map <NodeId, number> |
setNodesOpacity
setNodesPointColor
setNodesTexture
-
Model.setNodesTexture(nodeIds, options) Arguments: - nodeIds ([NodeId]) –
- options (
TextureOptions()) –
Return type: Promise <void>
setNodesVisibilities
-
Model.setNodesVisibilities(mapping, initiallyHiddenStayHidden) Arguments: - mapping (Map <NodeId, boolean> |
IdBooleanMap()) – - initiallyHiddenStayHidden (
boolean | null()) –
Return type: Promise <void>
- mapping (Map <NodeId, boolean> |