IModelStructure

class core.IModelStructure()

Methods

Methods

_disableCadConfigurations

IModelStructure._disableCadConfigurations()
Return type:Promise <void>

$mapBimRelationshipTypes

IModelStructure.$mapBimRelationshipTypes(nodeId, relationships)
Arguments:
  • nodeId (string()) – None
  • relationships ([Relationship]()) – None
Return type:

[RelationshipInfo]

activateCadConfiguration

IModelStructure.activateCadConfiguration(view, cadConfigId, fitNodes)
Arguments:
  • view (IView()) – None
  • cadConfigId (number()) – None
  • fitNodes (boolean()) – None
Return type:

Promise <void>

activateCadView

IModelStructure.activateCadView(view, cadViewId, duration, massageCamera)
Arguments:
  • view (IView()) – None
  • cadViewId (number()) – None
  • duration (number()) – None
  • massageCamera (boolean()) – None
Return type:

Promise <void>

activateDefaultCadConfiguration

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

Promise <void>

activateDefaultCadView

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

Promise <void>

addProperty

IModelStructure.addProperty(nodeId, propertyName, propertyValue, propertyUnit)
Arguments:
  • nodeId (number()) – None
  • propertyName (string()) – None
  • propertyValue (string()) – None
  • propertyUnit ([UnitElement]()) – None
Return type:

boolean

allowNodeDeletion

IModelStructure.allowNodeDeletion(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

void

applyFilters

IModelStructure.applyFilters(filterIds)
Arguments:
  • filterIds ([FilterId]()) – None
Return type:

void

cadConfigurationsEnabled

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

clear

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

createAndAddRepItem

IModelStructure.createAndAddRepItem(partId, repItemId)
Arguments:
  • partId (number()) – None
  • repItemId (null | number()) – None
Return type:

null | number

createCadView

IModelStructure.createCadView(parentId, viewName, camera, pmiIds, nodesToShow, nodesToHide, nodesIdAndLocalTransforms, cuttingPlane, meshInstanceData)
Arguments:
  • parentId (number()) – None
  • viewName (string()) – None
  • camera (Camera()) – None
  • pmiIds (null | [number]()) – None
  • nodesToShow ([number]()) – None
  • nodesToHide ([number]()) – None
  • nodesIdAndLocalTransforms ([(number, Matrix)]()) – None
  • cuttingPlane (null | Plane()) – None
  • meshInstanceData (null | MeshInstanceData()) – None
Return type:

null | number

createMeshInstance

IModelStructure.createMeshInstance(inclusionKey, instanceKey, name, parentId, preventFromResetting, isOutOfHierarchy, implicitBody)
Arguments:
  • inclusionKey (InclusionKey()) – None
  • instanceKey (InstanceKey()) – None
  • name (null | string()) – None
  • parentId (null | number()) – None
  • preventFromResetting (boolean()) – None
  • isOutOfHierarchy (boolean()) – None
  • implicitBody (boolean()) – None
Return type:

number

createNode

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

number

createPart

IModelStructure.createPart(nodeId)
Arguments:
  • nodeId (null | number()) – None
Return type:

number

createPmiInstance

IModelStructure.createPmiInstance(inclusionKey, instanceKey, pmiType, pmiSubType, topoRefs, name, parentId)
Arguments:
  • inclusionKey (InclusionKey()) – None
  • instanceKey (InstanceKey()) – None
  • pmiType (PmiType()) – None
  • pmiSubType (PmiSubType()) – None
  • topoRefs ([ReferenceOnTopology]()) – None
  • name (null | string()) – None
  • parentId (null | number()) – None
Return type:

number

deleteNode

IModelStructure.deleteNode(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Promise <void>

firstAssemblyDataHeader

IModelStructure.firstAssemblyDataHeader()
Return type:null | AssemblyDataHeader

gatherInclusionKeysFromNodeIds

IModelStructure.gatherInclusionKeysFromNodeIds(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

[InclusionKey]

gatherInstanceIncsFromNodeIds

IModelStructure.gatherInstanceIncsFromNodeIds(nodeIds, allowedTypes, restriction)
Arguments:
  • nodeIds ([number]()) – None
  • allowedTypes (BodyTypeBits()) – None
  • restriction (WalkRestriction()) – None
Return type:

InstanceIncs

getAbsoluteRootNodeId

IModelStructure.getAbsoluteRootNodeId()
Return type:number

getActiveCadConfiguration

IModelStructure.getActiveCadConfiguration()
Return type:null | number

getAllRelationships

IModelStructure.getAllRelationships(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

[Relationship]

getAssociatedModelKey

IModelStructure.getAssociatedModelKey(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | ModelKey

getAttributes

IModelStructure.getAttributes(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Promise <[Attribute]>

getBimIdFromNode

IModelStructure.getBimIdFromNode(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | string

getBimIdRelationshipTypes

IModelStructure.getBimIdRelationshipTypes(contextNodeId, nodeId)
Arguments:
  • contextNodeId (number()) – None
  • nodeId (string()) – None
Return type:

[RelationshipInfo]

getBounding

IModelStructure.getBounding(nodeIds, allowedTypes, ignoreInvisible, tightBounding)
Arguments:
  • nodeIds ([number]()) – None
  • allowedTypes (BodyTypeBits()) – None
  • ignoreInvisible (boolean()) – None
  • tightBounding (boolean()) – None
Return type:

Promise <Box>

getBranchVisibility

IModelStructure.getBranchVisibility(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

BranchVisibility

getCadConfigurations

IModelStructure.getCadConfigurations()
Return type:IdStringMap

getCadViewConfiguration

IModelStructure.getCadViewConfiguration(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | number

getCadViewMap

IModelStructure.getCadViewMap()
Return type:Map <number, string>

getCadViewPmis

IModelStructure.getCadViewPmis(cadViewId)
Arguments:
  • cadViewId (number()) – None
Return type:

[number]

getChildIds

IModelStructure.getChildIds(nodeId, includeOutOfHierarchy)
Arguments:
  • nodeId (number()) – None
  • includeOutOfHierarchy (boolean()) – None
Return type:

[number]

getDefaultCadConfiguration

IModelStructure.getDefaultCadConfiguration()
Return type:null | number

getDefaultCadView

IModelStructure.getDefaultCadView()
Return type:null | number

getEdgeAttributes

IModelStructure.getEdgeAttributes(nodeId, edgeId)
Arguments:
  • nodeId (number()) – None
  • edgeId (number()) – None
Return type:

Promise <null | SubentityAttributes>

getEdgeCount

IModelStructure.getEdgeCount(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Promise <number>

getEdgeProperty

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

Promise <null | Edge>

getFaceAttributes

IModelStructure.getFaceAttributes(nodeId, faceId)
Arguments:
  • nodeId (number()) – None
  • faceId (number()) – None
Return type:

Promise <null | SubentityAttributes>

getFaceCount

IModelStructure.getFaceCount(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Promise <number>

getFaceProperty

IModelStructure.getFaceProperty(prcId, faceId)
Arguments:
  • prcId (number()) – None
  • faceId (number()) – None
Return type:

Promise <null | Face>

getFilterName

IModelStructure.getFilterName(filterId)
Arguments:
  • filterId (FilterId()) – None
Return type:

null | string

getFilters

IModelStructure.getFilters()
Return type:Map <FilterId, string>

getFiltersFromView

IModelStructure.getFiltersFromView(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

[FilterId]

getFiltersWithNode

IModelStructure.getFiltersWithNode(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

[FilterId]

getGenericTypeIdMap

IModelStructure.getGenericTypeIdMap()
Return type:Map <string, Set <number>>

getGenericTypes

IModelStructure.getGenericTypes()
Return type:[string]

getIdOffset

IModelStructure.getIdOffset(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

number

getInfoOfBimId

IModelStructure.getInfoOfBimId(nodeID, bimId)
Arguments:
  • nodeID (number()) – None
  • bimId (string()) – None
Return type:

function

getInstanceIncs

IModelStructure.getInstanceIncs(nodeId, allowedTypes)
Arguments:
  • nodeId (number()) – None
  • allowedTypes (BodyTypeBits()) – None
Return type:

InstanceIncs

getLayerIdsFromName

IModelStructure.getLayerIdsFromName(name)
Arguments:
  • name (string()) – None
Return type:

null | [LayerId]

getLayerName

IModelStructure.getLayerName(layerId)
Arguments:
  • layerId (LayerId()) – None
Return type:

null | string

getLayers

IModelStructure.getLayers()
Return type:Map <LayerId, string>

getLowestAvailableNodeId

IModelStructure.getLowestAvailableNodeId()
Return type:number

getMatrix

IModelStructure.getMatrix(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Matrix

getModelFileNameFromNode

IModelStructure.getModelFileNameFromNode(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | string

getModelFileTypeFromNode

IModelStructure.getModelFileTypeFromNode(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | FileType

getName

IModelStructure.getName(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | string

getNetMatrix

IModelStructure.getNetMatrix(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Matrix16

getNodeExchangeId

IModelStructure.getNodeExchangeId(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | string

getNodeFromInstanceInc

IModelStructure.getNodeFromInstanceInc(markNodeLoadedIfCreated, inclusionKey, instanceKey, isOutOfHierarchy)
Arguments:
  • markNodeLoadedIfCreated (boolean()) – None
  • inclusionKey (InclusionKey()) – None
  • instanceKey (InstanceKey()) – None
  • isOutOfHierarchy (boolean()) – None
Return type:

number

getNodeGenericId

IModelStructure.getNodeGenericId(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | string

getNodeGenericType

IModelStructure.getNodeGenericType(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | string

getNodeLayerId

IModelStructure.getNodeLayerId(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | LayerId

getNodeOrRepItem

IModelStructure.getNodeOrRepItem(node)
Arguments:
  • node (AnyNode()) – None
Return type:

Promise <null | ProductOccurrence | Pmi | CadView | PartDefinition | RepresentationItem>

getNodesByGenericId

IModelStructure.getNodesByGenericId(genericId)
Arguments:
  • genericId (string()) – None
Return type:

null | Set <number>

getNodesByGenericType

IModelStructure.getNodesByGenericType(genericType)
Arguments:
  • genericType (string()) – None
Return type:

null | Set <number>

getNodesFromFilterIds

IModelStructure.getNodesFromFilterIds(filterIds)
Arguments:
  • filterIds ([FilterId]()) – None
Return type:

null | FilteredNodes

getParentId

IModelStructure.getParentId(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | number

getPartReferrers

IModelStructure.getPartReferrers(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Promise <null | [number]>

getPmis

IModelStructure.getPmis()
Return type:IdStringMap

getPmiSubType

IModelStructure.getPmiSubType(pmiId)
Arguments:
  • pmiId (number()) – None
Return type:

PmiSubType

getPmiTopologyReferences

IModelStructure.getPmiTopologyReferences(pmiNodeId)
Arguments:
  • pmiNodeId (number()) – None
Return type:

null | [PmiTopologyReference]

getPmiType

IModelStructure.getPmiType(pmiId)
Arguments:
  • pmiId (number()) – None
Return type:

PmiType

getPointAttributes

IModelStructure.getPointAttributes(nodeId, pointId)
Arguments:
  • nodeId (number()) – None
  • pointId (number()) – None
Return type:

Promise <null | SubentityAttributes>

getProperties

IModelStructure.getProperties(nodeId, computeFromChildren)
Arguments:
  • nodeId (number()) – None
  • computeFromChildren (boolean()) – None
Return type:

Promise <null | StringStringMap>

getRelationsByTypeFromNode

IModelStructure.getRelationsByTypeFromNode(contextNodeId, nodeId)
Arguments:
  • contextNodeId (number()) – None
  • nodeId (string()) – None
Return type:

null | Map <RelationshipType, BimRelationship>

getRuntimeNodeFromBimId

IModelStructure.getRuntimeNodeFromBimId(contextNodeId, bimId)
Arguments:
  • contextNodeId (number()) – None
  • bimId (string()) – None
Return type:

null | number

getRuntimeNodesFromLayer

IModelStructure.getRuntimeNodesFromLayer(layerId[, onlyTreeNodes])
Arguments:
  • layerId (LayerId()) – None
  • onlyTreeNodes (boolean()) – optional None
Return type:

null | [number]

getRuntimeNodesFromLayerName

IModelStructure.getRuntimeNodesFromLayerName(layerName[, onlyTreeNodes])
Arguments:
  • layerName (string()) – None
  • onlyTreeNodes (boolean()) – optional None
Return type:

null | [number]

getRuntimeNodesFromLayers

IModelStructure.getRuntimeNodesFromLayers(layersId[, onlyTreeNodes])
Arguments:
  • layersId ([LayerId]()) – None
  • onlyTreeNodes (boolean()) – optional None
Return type:

null | [number]

getType

IModelStructure.getType(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

NodeType

getUniqueLayerNames

IModelStructure.getUniqueLayerNames()
Return type:[string]

getUnit

IModelStructure.getUnit(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

number

getUserData

IModelStructure.getUserData(nodeId, index)
Arguments:
  • nodeId (number()) – None
  • index (UserDataIndex()) – None
Return type:

Uint8Array

getUserDataIndices

IModelStructure.getUserDataIndices(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

[UserDataIndex]

hasEffectiveGenericType

IModelStructure.hasEffectiveGenericType(nodeId, genericType)
Arguments:
  • nodeId (number()) – None
  • genericType (string()) – None
Return type:

boolean

hasRelationships

IModelStructure.hasRelationships(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

boolean

init

IModelStructure.init(view, maxConcurrentAttachments)
Arguments:
  • view (IView()) – None
  • maxConcurrentAttachments (null | number()) – None
Return type:

Promise <void>

isACadDrawing

IModelStructure.isACadDrawing()
Return type:boolean

isAnnotationView

IModelStructure.isAnnotationView(cadViewNodeId)
Arguments:
  • cadViewNodeId (number()) – None
Return type:

boolean

isCombineStateView

IModelStructure.isCombineStateView(cadViewNodeId)
Arguments:
  • cadViewNodeId (number()) – None
Return type:

boolean

isFaceMeasurable

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

Promise <boolean>

isIdValid

IModelStructure.isIdValid(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

boolean

isLineMeasurable

IModelStructure.isLineMeasurable(bodyId, lineIndex)
Arguments:
  • bodyId (number()) – None
  • lineIndex (number()) – None
Return type:

Promise <boolean>

isMeasurable

IModelStructure.isMeasurable()
Return type:boolean

isNodeLoaded

IModelStructure.isNodeLoaded(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

boolean

isOutOfHierarchy

IModelStructure.isOutOfHierarchy(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

boolean

isReady

IModelStructure.isReady()
Return type:boolean

isVisible

IModelStructure.isVisible(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

boolean

isWithinExternalModel

IModelStructure.isWithinExternalModel(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

boolean

loadMeasurementFromFile

IModelStructure.loadMeasurementFromFile(zipFilename)
Arguments:
  • zipFilename (string()) – None
Return type:

Promise <void>

loadMeasurementFromJson

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

Promise <void>

loadMeasurementFromString

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

Promise <void>

loadSubtreeFromAssemblyData

IModelStructure.loadSubtreeFromAssemblyData(nodeId, modelInc, assemblyData, config)
Arguments:
  • nodeId (number()) – None
  • modelInc (ModelInc()) – None
  • assemblyData (AssemblyData()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsBuffer

IModelStructure.loadSubtreeFromScsBuffer(nodeId, scsBuffer, config)
Arguments:
  • nodeId (number()) – None
  • scsBuffer (Uint8Array()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsFile

IModelStructure.loadSubtreeFromScsFile(nodeId, scsFilename, config)
Arguments:
  • nodeId (number()) – None
  • scsFilename (string()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsXmlDoc

IModelStructure.loadSubtreeFromScsXmlDoc(nodeId, xmlData, modelNameToScs, config)
Arguments:
  • nodeId (number()) – None
  • xmlData (string | Document()) – None
  • modelNameToScs (ModelNameToScsFileFunc()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsXmlFile

IModelStructure.loadSubtreeFromScsXmlFile(nodeId, xmlFilename, modelNameToScs, config)
Arguments:
  • nodeId (number()) – None
  • xmlFilename (string()) – None
  • modelNameToScs (ModelNameToScsFileFunc()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

loadSubtreeFromStream

IModelStructure.loadSubtreeFromStream(nodeId, modelName, config)
Arguments:
  • nodeId (number()) – None
  • modelName (string()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

loadSubtreeFromXmlDoc

IModelStructure.loadSubtreeFromXmlDoc(nodeId, xml, massageModelName, config)
Arguments:
  • nodeId (number()) – None
  • xml (string | Document()) – None
  • massageModelName (MassageModelNameFunc()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

loadSubtreeFromXmlFile

IModelStructure.loadSubtreeFromXmlFile(nodeId, xmlFilename, massageModelName, config)
Arguments:
  • nodeId (number()) – None
  • xmlFilename (string()) – None
  • massageModelName (MassageModelNameFunc()) – None
  • config (LoadSubtreeConfig()) – None
Return type:

Promise <[number]>

lookupAnyBody

IModelStructure.lookupAnyBody(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | AnyBody

lookupAnyTreeNode

IModelStructure.lookupAnyTreeNode(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | AnyTreeNode

lookupBodyInstance

IModelStructure.lookupBodyInstance(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | BodyInstance

preventMeshDeletion

IModelStructure.preventMeshDeletion(meshId)
Arguments:
  • meshId (MeshKey()) – None
Return type:

void

preventNodeDeletion

IModelStructure.preventNodeDeletion(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

void

registerGenericId

IModelStructure.registerGenericId(node, genericId)
Arguments:
  • node (AnyTreeNode()) – None
  • genericId (string()) – None
Return type:

void

registerGenericType

IModelStructure.registerGenericType(node, genericType)
Arguments:
  • node (AnyTreeNode()) – None
  • genericType (string()) – None
Return type:

void

requestNodes

IModelStructure.requestNodes(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <void>

reset

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

resetAllTransforms

IModelStructure.resetAllTransforms()
Return type:Promise <void>

resetAllVisibilities

IModelStructure.resetAllVisibilities()
Return type:Promise <void>

resetPmiColor

IModelStructure.resetPmiColor(startNodeId)
Arguments:
  • startNodeId (undefined | number()) – None
Return type:

void

resetToInitialMatrix

IModelStructure.resetToInitialMatrix(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Promise <void>

setBehaviorInitiallyHidden

IModelStructure.setBehaviorInitiallyHidden(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setBodyNodesVisibility

IModelStructure.setBodyNodesVisibility(startNode, visibilityFormatter)
Arguments:
  • startNode (AnyTreeNode()) – None
  • visibilityFormatter (boolean | function()) – None
Return type:

Promise <void>
IModelStructure.visibilityFormatter(node)
Arguments:
  • node (AnyTreeNode()) – None
Return type:

undefined | boolean

setEdgeProperty

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

void

setEnableAutomaticUnitScaling

IModelStructure.setEnableAutomaticUnitScaling(value)
Arguments:
  • value (boolean()) – None
Return type:

void

setFaceProperty

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

void

setMatrices

IModelStructure.setMatrices(nodeIds, matrices, setAsInitial)
Arguments:
  • nodeIds ([number]()) – None
  • matrices ([Matrix]()) – None
  • setAsInitial (boolean()) – None
Return type:

Promise <void>

setMatrix

IModelStructure.setMatrix(nodeId, matrix, setAsInitial)
Arguments:
  • nodeId (number()) – None
  • matrix (Matrix()) – None
  • setAsInitial (boolean()) – None
Return type:

Promise <void>

setMeshLevel

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

void

setPart

IModelStructure.setPart(nodeId, partId)
Arguments:
  • nodeId (number()) – None
  • partId (number()) – None
Return type:

boolean

setPhysicalProperties

IModelStructure.setPhysicalProperties(nodeId, centerOfGravity, surfaceArea, volume)
Arguments:
  • nodeId (number()) – None
  • centerOfGravity (Point3()) – None
  • surfaceArea (number()) – None
  • volume (number()) – None
Return type:

boolean

setPmiColor

IModelStructure.setPmiColor(color, startNodeId)
Arguments:
  • color (Color()) – None
  • startNodeId (undefined | number()) – None
Return type:

void

setPrefetchScsCutoffScale

IModelStructure.setPrefetchScsCutoffScale(prefetchCutoffScale)
Arguments:
  • prefetchCutoffScale (number()) – None
Return type:

void

setVisibilitiesByMap

IModelStructure.setVisibilitiesByMap(idToVisibility[, initiallyHiddenStayHidden])
Arguments:
  • idToVisibility (Map) – None
  • initiallyHiddenStayHidden (boolean()) – optional None
Return type:

Promise <void>

setVisibilitiesByValue

IModelStructure.setVisibilitiesByValue(nodeIds, visibility, initiallyHiddenStayHidden)
Arguments:
  • nodeIds ([number]()) – None
  • visibility (boolean()) – None
  • initiallyHiddenStayHidden (null | boolean()) – None
Return type:

Promise <void>

shutdown

IModelStructure.shutdown()
Return type:void

switchToModel

IModelStructure.switchToModel(newModelFilename)
Arguments:
  • newModelFilename (string()) – None
Return type:

Promise <[number]>

waitForReady

IModelStructure.waitForReady()
Return type:Promise <void>