IModelStructure

class IModelStructure()

Methods

$mapBimRelationshipTypes()
_disableCadConfigurations()
activateCadConfiguration()
activateCadView()
activateDefaultCadConfiguration()
activateDefaultCadView()
addProperty()
allowNodeDeletion()
applyFilters()
cadConfigurationsEnabled()
clear()
createAndAddRepItem()
createCadView()
createMeshInstance()
createNode()
createPart()
createPmiInstance()
deleteNode()
firstAssemblyDataHeader()
gatherInclusionKeysFromNodeIds()
gatherInstanceIncsFromNodeIds()
getAbsoluteRootNodeId()
getActiveCadConfiguration()
getAllRelationships()
getAssociatedModelKey()
getAttributes()
getBimIdFromNode()
getBimIdRelationshipTypes()
getBounding()
getBranchVisibility()
getCadConfigurations()
getCadViewConfiguration()
getCadViewMap()
getCadViewPmis()
getChildIds()
getDefaultCadConfiguration()
getDefaultCadView()
getEdgeAttributes()
getEdgeCount()
getEdgeProperty()
getFaceAttributes()
getFaceCount()
getFaceProperty()
getFilterName()
getFilters()
getFiltersFromView()
getFiltersWithNode()
getGenericTypeIdMap()
getGenericTypes()
getIdOffset()
getInfoOfBimId()
getInstanceIncs()
getLayerIdsFromName()
getLayerName()
getLayers()
getLowestAvailableNodeId()
getMatrix()
getModelFileNameFromNode()
getModelFileTypeFromNode()
getName()
getNetMatrix()
getNodeExchangeId()
getNodeFromInstanceInc()
getNodeGenericId()
getNodeGenericType()
getNodeLayerId()
getNodeOrRepItem()
getNodesByGenericId()
getNodesByGenericType()
getNodesFromFilterIds()
getParentId()
getPartReferrers()
getPmiSubType()
getPmiTopologyReferences()
getPmiType()
getPmis()
getPointAttributes()
getProperties()
getRelationsByTypeFromNode()
getRuntimeNodeFromBimId()
getRuntimeNodesFromLayer()
getRuntimeNodesFromLayerName()
getRuntimeNodesFromLayers()
getType()
getUniqueLayerNames()
getUnit()
getUserData()
getUserDataIndices()
hasEffectiveGenericType()
hasRelationships()
init()
isACadDrawing()
isAnnotationView()
isCombineStateView()
isFaceMeasurable()
isIdValid()
isLineMeasurable()
isMeasurable()
isNodeLoaded()
isOutOfHierarchy()
isReady()
isVisible()
isWithinExternalModel()
loadMeasurementFromFile()
loadMeasurementFromJson()
loadMeasurementFromString()
loadSubtreeFromAssemblyData()
loadSubtreeFromScsBuffer()
loadSubtreeFromScsFile()
loadSubtreeFromScsXmlDoc()
loadSubtreeFromScsXmlFile()
loadSubtreeFromStream()
loadSubtreeFromXmlDoc()
loadSubtreeFromXmlFile()
lookupAnyBody()
lookupAnyTreeNode()
lookupBodyInstance()
preventMeshDeletion()
preventNodeDeletion()
registerGenericId()
registerGenericType()
requestNodes()
reset()
resetAllTransforms()
resetAllVisibilities()
resetPmiColor()
resetToInitialMatrix()
setBehaviorInitiallyHidden()
setBodyNodesVisibility()
setEdgeProperty()
setEnableAutomaticUnitScaling()
setFaceProperty()
setMatrices()
setMatrix()
setMeshLevel()
setPart()
setPhysicalProperties()
setPmiColor()
setPrefetchScsCutoffScale()
setVisibilitiesByMap()
setVisibilitiesByValue()
shutdown()
switchToModel()
waitForReady()

Methods

$mapBimRelationshipTypes

IModelStructure.$mapBimRelationshipTypes(nodeId, relationships)

Arguments:	nodeId (BimId) – None relationships ([`Relationship()`]) – None
Return type:	[`RelationshipInfo()`]

_disableCadConfigurations

IModelStructure._disableCadConfigurations()

Return type:	Promise <void>

activateCadConfiguration

IModelStructure.activateCadConfiguration(view, cadConfigId, fitNodes)

Arguments:	view (`IView()`) – None cadConfigId (RuntimeNodeId) – None fitNodes (`boolean()`) – None
Return type:	Promise <void>

activateCadView

IModelStructure.activateCadView(view, cadViewId, duration, massageCamera)

Arguments:	view (`IView()`) – None cadViewId (RuntimeNodeId) – 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 (RuntimeNodeId) – None propertyName (`string()`) – None propertyValue (`string()`) – None propertyUnit (`[UnitElement]()`) – None
Return type:	boolean

allowNodeDeletion

IModelStructure.allowNodeDeletion(nodeId)

Arguments:	nodeId (NodeId) – 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 (RuntimeNodeId) – None repItemId (AuthoredNodeId \| null) – None
Return type:	RuntimeNodeId \| null

createCadView

IModelStructure.createCadView(parentId, viewName, camera, pmiIds, nodesToShow, nodesToHide, nodesIdAndLocalTransforms, cuttingPlane, meshInstanceData)

Arguments:

parentId (RuntimeNodeId) – None
viewName (string()) – None
camera (Camera()) – None
pmiIds ([RuntimeNodeId] | null) – None
nodesToShow ([RuntimeNodeId]) – None
nodesToHide ([RuntimeNodeId]) – None
nodesIdAndLocalTransforms ([(RuntimeNodeId, Matrix)]) – None
cuttingPlane (Plane | null) – None
meshInstanceData (MeshInstanceData() | null) – None

Return type:

RuntimeNodeId | null

createMeshInstance

IModelStructure.createMeshInstance(inclusionKey, instanceKey, name, parentId, preventFromResetting, isOutOfHierarchy, implicitBody)

Arguments:	inclusionKey (`InclusionKey()`) – None instanceKey (`InstanceKey()`) – None name (`string \| null()`) – None parentId (RuntimeNodeId \| null) – None preventFromResetting (`boolean()`) – None isOutOfHierarchy (`boolean()`) – None implicitBody (`boolean()`) – None
Return type:	RuntimeNodeId

createNode

IModelStructure.createNode(parentId, nodeName, nodeId[, localMatrix[, visibility[, measurementUnit]]])

Arguments:	parentId (RuntimeNodeId \| null) – None nodeName (`string()`) – None nodeId (AuthoredNodeId \| null) – None localMatrix (`Matrix \| null()`) – optional None visibility (`boolean()`) – optional None measurementUnit (`number \| null()`) – optional None
Return type:	RuntimeNodeId

createPart

IModelStructure.createPart(nodeId)

Arguments:	nodeId (AuthoredNodeId \| null) – None
Return type:	RuntimeNodeId

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 (`string \| null()`) – None parentId (RuntimeNodeId \| null) – None
Return type:	RuntimeNodeId

deleteNode

IModelStructure.deleteNode(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	Promise <void>

firstAssemblyDataHeader

IModelStructure.firstAssemblyDataHeader()

Return type:	`AssemblyDataHeader()` \| null

gatherInclusionKeysFromNodeIds

IModelStructure.gatherInclusionKeysFromNodeIds(nodeIds)

Arguments:	nodeIds ([RuntimeNodeId]) – None
Return type:	[InclusionKey]

gatherInstanceIncsFromNodeIds

IModelStructure.gatherInstanceIncsFromNodeIds(nodeIds, allowedTypes, restriction)

Arguments:	nodeIds ([RuntimeNodeId]) – None allowedTypes (BodyTypeBits) – None restriction (WalkRestriction) – None
Return type:	InstanceIncs

getAbsoluteRootNodeId

IModelStructure.getAbsoluteRootNodeId()

Return type:	RuntimeNodeId

getActiveCadConfiguration

IModelStructure.getActiveCadConfiguration()

Return type:	RuntimeNodeId \| null

getAllRelationships

IModelStructure.getAllRelationships(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	[`Relationship()`]

getAssociatedModelKey

IModelStructure.getAssociatedModelKey(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	ModelKey \| null

getAttributes

IModelStructure.getAttributes(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	Promise <[Attribute]>

getBimIdFromNode

IModelStructure.getBimIdFromNode(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	BimId \| null

getBimIdRelationshipTypes

IModelStructure.getBimIdRelationshipTypes(contextNodeId, nodeId)

Arguments:	contextNodeId (RuntimeNodeId) – None nodeId (BimId) – None
Return type:	[`RelationshipInfo()`]

getBounding

IModelStructure.getBounding(nodeIds, allowedTypes, ignoreInvisible, tightBounding)

Arguments:	nodeIds ([RuntimeNodeId]) – None allowedTypes (BodyTypeBits) – None ignoreInvisible (`boolean()`) – None tightBounding (`boolean()`) – None
Return type:	Promise <Box>

getBranchVisibility

IModelStructure.getBranchVisibility(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	BranchVisibility

getCadConfigurations

IModelStructure.getCadConfigurations()

Return type:	`IdStringMap()`

getCadViewConfiguration

IModelStructure.getCadViewConfiguration(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	RuntimeNodeId \| null

getCadViewMap

IModelStructure.getCadViewMap()

Return type:	Map <NodeId, string>

getCadViewPmis

IModelStructure.getCadViewPmis(cadViewId)

Arguments:	cadViewId (RuntimeNodeId) – None
Return type:	[RuntimeNodeId]

getChildIds

IModelStructure.getChildIds(nodeId, includeOutOfHierarchy)

Arguments:	nodeId (RuntimeNodeId) – None includeOutOfHierarchy (`boolean()`) – None
Return type:	[RuntimeNodeId]

getDefaultCadConfiguration

IModelStructure.getDefaultCadConfiguration()

Return type:	RuntimeNodeId \| null

getDefaultCadView

IModelStructure.getDefaultCadView()

Return type:	RuntimeNodeId \| null

getEdgeAttributes

IModelStructure.getEdgeAttributes(nodeId, edgeId)

Arguments:	nodeId (RuntimeNodeId) – None edgeId (`number()`) – None
Return type:	Promise <`SubentityAttributes()` \| null>

getEdgeCount

IModelStructure.getEdgeCount(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	Promise <number>

getEdgeProperty

IModelStructure.getEdgeProperty(nodeId, edgeId)

Arguments:	nodeId (RuntimeNodeId) – None edgeId (`number()`) – None
Return type:	Promise <Edge \| null>

getFaceAttributes

IModelStructure.getFaceAttributes(nodeId, faceId)

Arguments:	nodeId (RuntimeNodeId) – None faceId (`number()`) – None
Return type:	Promise <`SubentityAttributes()` \| null>

getFaceCount

IModelStructure.getFaceCount(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	Promise <number>

getFaceProperty

IModelStructure.getFaceProperty(prcId, faceId)

Arguments:	prcId (RuntimeNodeId) – None faceId (`number()`) – None
Return type:	Promise <Face \| null>

getFilterName

IModelStructure.getFilterName(filterId)

Arguments:	filterId (FilterId) – None
Return type:	FilterName \| null

getFilters

IModelStructure.getFilters()

Return type:	Map <FilterId, FilterName>

getFiltersFromView

IModelStructure.getFiltersFromView(nodeId)

Arguments:	nodeId (CadViewId) – None
Return type:	[FilterId]

getFiltersWithNode

IModelStructure.getFiltersWithNode(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	[FilterId]

getGenericTypeIdMap

IModelStructure.getGenericTypeIdMap()

Return type:	Map <GenericType, Set <RuntimeNodeId>>

getGenericTypes

IModelStructure.getGenericTypes()

Return type:	[GenericType]

getIdOffset

IModelStructure.getIdOffset(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	NodeIdOffset

getInfoOfBimId

IModelStructure.getInfoOfBimId(nodeID, bimId)

Arguments:	nodeID (RuntimeNodeId) – None bimId (BimId) – None
Return type:	function

getInstanceIncs

IModelStructure.getInstanceIncs(nodeId, allowedTypes)

Arguments:	nodeId (RuntimeNodeId) – None allowedTypes (BodyTypeBits) – None
Return type:	InstanceIncs

getLayerIdsFromName

IModelStructure.getLayerIdsFromName(name)

Arguments:	name (LayerName) – None
Return type:	[LayerId] \| null

getLayerName

IModelStructure.getLayerName(layerId)

Arguments:	layerId (LayerId) – None
Return type:	LayerName \| null

getLayers

IModelStructure.getLayers()

Return type:	Map <LayerId, LayerName>

getLowestAvailableNodeId

IModelStructure.getLowestAvailableNodeId()

Return type:	RuntimeNodeId

getMatrix

IModelStructure.getMatrix(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	Matrix

getModelFileNameFromNode

IModelStructure.getModelFileNameFromNode(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	string \| null

getModelFileTypeFromNode

IModelStructure.getModelFileTypeFromNode(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	FileType \| null

getName

IModelStructure.getName(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	string \| null

getNetMatrix

IModelStructure.getNetMatrix(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	Matrix16

getNodeExchangeId

IModelStructure.getNodeExchangeId(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	ExchangeId \| null

getNodeFromInstanceInc

IModelStructure.getNodeFromInstanceInc(markNodeLoadedIfCreated, inclusionKey, instanceKey, isOutOfHierarchy)

Arguments:	markNodeLoadedIfCreated (`boolean()`) – None inclusionKey (`InclusionKey()`) – None instanceKey (`InstanceKey()`) – None isOutOfHierarchy (`boolean()`) – None
Return type:	RuntimeNodeId

getNodeGenericId

IModelStructure.getNodeGenericId(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	GenericId \| null

getNodeGenericType

IModelStructure.getNodeGenericType(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	GenericType \| null

getNodeLayerId

IModelStructure.getNodeLayerId(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	LayerId \| null

getNodeOrRepItem

IModelStructure.getNodeOrRepItem(node)

Arguments:	node (AnyNode) – None
Return type:	Promise <`ProductOccurrence()` \| `Pmi()` \| `CadView()` \| `PartDefinition()` \| `RepresentationItem()` \| null>

getNodesByGenericId

IModelStructure.getNodesByGenericId(genericId)

Arguments:	genericId (GenericId) – None
Return type:	Set <RuntimeNodeId> \| null

getNodesByGenericType

IModelStructure.getNodesByGenericType(genericType)

Arguments:	genericType (GenericType) – None
Return type:	Set <RuntimeNodeId> \| null

getNodesFromFilterIds

IModelStructure.getNodesFromFilterIds(filterIds)

Arguments:	filterIds ([FilterId]) – None
Return type:	`FilteredNodes()` \| null

getParentId

IModelStructure.getParentId(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	RuntimeNodeId \| null

getPartReferrers

IModelStructure.getPartReferrers(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	Promise <[RuntimeNodeId] \| null>

getPmiSubType

IModelStructure.getPmiSubType(pmiId)

Arguments:	pmiId (RuntimeNodeId) – None
Return type:	PmiSubType

getPmiTopologyReferences

IModelStructure.getPmiTopologyReferences(pmiNodeId)

Arguments:	pmiNodeId (RuntimeNodeId) – None
Return type:	[`PmiTopologyReference()`] \| null

getPmiType

IModelStructure.getPmiType(pmiId)

Arguments:	pmiId (RuntimeNodeId) – None
Return type:	PmiType

getPmis

IModelStructure.getPmis()

Return type:	`IdStringMap()`

getPointAttributes

IModelStructure.getPointAttributes(nodeId, pointId)

Arguments:	nodeId (RuntimeNodeId) – None pointId (`number()`) – None
Return type:	Promise <`SubentityAttributes()` \| null>

getProperties

IModelStructure.getProperties(nodeId, computeFromChildren)

Arguments:	nodeId (RuntimeNodeId) – None computeFromChildren (`boolean()`) – None
Return type:	Promise <`StringStringMap()` \| null>

getRelationsByTypeFromNode

IModelStructure.getRelationsByTypeFromNode(contextNodeId, nodeId)

Arguments:	contextNodeId (RuntimeNodeId) – None nodeId (BimId) – None
Return type:	Map <RelationshipType, `BimRelationship()`> \| null

getRuntimeNodeFromBimId

IModelStructure.getRuntimeNodeFromBimId(contextNodeId, bimId)

Arguments:	contextNodeId (RuntimeNodeId) – None bimId (BimId) – None
Return type:	RuntimeNodeId \| null

getRuntimeNodesFromLayer

IModelStructure.getRuntimeNodesFromLayer(layerId[, onlyTreeNodes])

Arguments:	layerId (LayerId) – None onlyTreeNodes (`boolean()`) – optional None
Return type:	[RuntimeNodeId] \| null

getRuntimeNodesFromLayerName

IModelStructure.getRuntimeNodesFromLayerName(layerName[, onlyTreeNodes])

Arguments:	layerName (LayerName) – None onlyTreeNodes (`boolean()`) – optional None
Return type:	[RuntimeNodeId] \| null

getRuntimeNodesFromLayers

IModelStructure.getRuntimeNodesFromLayers(layersId[, onlyTreeNodes])

Arguments:	layersId ([LayerId]) – None onlyTreeNodes (`boolean()`) – optional None
Return type:	[RuntimeNodeId] \| null

getType

IModelStructure.getType(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	NodeType

getUniqueLayerNames

IModelStructure.getUniqueLayerNames()

Return type:	[LayerName]

getUnit

IModelStructure.getUnit(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	number

getUserData

IModelStructure.getUserData(nodeId, index)

Arguments:	nodeId (RuntimeNodeId) – None index (UserDataIndex) – None
Return type:	Uint8Array

getUserDataIndices

IModelStructure.getUserDataIndices(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	[UserDataIndex]

hasEffectiveGenericType

IModelStructure.hasEffectiveGenericType(nodeId, genericType)

Arguments:	nodeId (NodeId) – None genericType (GenericType) – None
Return type:	boolean

hasRelationships

IModelStructure.hasRelationships(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	boolean

init

IModelStructure.init(view, maxConcurrentAttachments)

Arguments:	view (`IView()`) – None maxConcurrentAttachments (`number \| null()`) – None
Return type:	Promise <void>

isACadDrawing

IModelStructure.isACadDrawing()

Return type:	boolean

isAnnotationView

IModelStructure.isAnnotationView(cadViewNodeId)

Arguments:	cadViewNodeId (RuntimeNodeId) – None
Return type:	boolean

isCombineStateView

IModelStructure.isCombineStateView(cadViewNodeId)

Arguments:	cadViewNodeId (RuntimeNodeId) – None
Return type:	boolean

isFaceMeasurable

IModelStructure.isFaceMeasurable(bodyId, faceIndex)

Arguments:	bodyId (NodeId) – None faceIndex (`number()`) – None
Return type:	Promise <boolean>

isIdValid

IModelStructure.isIdValid(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	boolean

isLineMeasurable

IModelStructure.isLineMeasurable(bodyId, lineIndex)

Arguments:	bodyId (NodeId) – None lineIndex (`number()`) – None
Return type:	Promise <boolean>

isMeasurable

IModelStructure.isMeasurable()

Return type:	boolean

isNodeLoaded

IModelStructure.isNodeLoaded(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	boolean

isOutOfHierarchy

IModelStructure.isOutOfHierarchy(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	boolean

isReady

IModelStructure.isReady()

Return type:	boolean

isVisible

IModelStructure.isVisible(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	boolean

isWithinExternalModel

IModelStructure.isWithinExternalModel(nodeId)

Arguments:	nodeId (RuntimeNodeId) – 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 (RuntimeNodeId) – None modelInc (`ModelInc()`) – None assemblyData (`AssemblyData()`) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

loadSubtreeFromScsBuffer

IModelStructure.loadSubtreeFromScsBuffer(nodeId, scsBuffer, config)

Arguments:	nodeId (RuntimeNodeId) – None scsBuffer (`ScsBuffer()`) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

loadSubtreeFromScsFile

IModelStructure.loadSubtreeFromScsFile(nodeId, scsFilename, config)

Arguments:	nodeId (RuntimeNodeId) – None scsFilename (ScsUri) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

loadSubtreeFromScsXmlDoc

IModelStructure.loadSubtreeFromScsXmlDoc(nodeId, xmlData, modelNameToScs, config)

Arguments:	nodeId (RuntimeNodeId) – None xmlData (`string \| Document()`) – None modelNameToScs (ModelNameToScsFileFunc) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

loadSubtreeFromScsXmlFile

IModelStructure.loadSubtreeFromScsXmlFile(nodeId, xmlFilename, modelNameToScs, config)

Arguments:	nodeId (RuntimeNodeId) – None xmlFilename (XmlFilename) – None modelNameToScs (ModelNameToScsFileFunc) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

loadSubtreeFromStream

IModelStructure.loadSubtreeFromStream(nodeId, modelName, config)

Arguments:	nodeId (RuntimeNodeId) – None modelName (`ScModelName()`) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

loadSubtreeFromXmlDoc

IModelStructure.loadSubtreeFromXmlDoc(nodeId, xml, massageModelName, config)

Arguments:	nodeId (RuntimeNodeId) – None xml (`string \| Document()`) – None massageModelName (MassageModelNameFunc) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

loadSubtreeFromXmlFile

IModelStructure.loadSubtreeFromXmlFile(nodeId, xmlFilename, massageModelName, config)

Arguments:	nodeId (RuntimeNodeId) – None xmlFilename (XmlFilename) – None massageModelName (MassageModelNameFunc) – None config (`LoadSubtreeConfig()`) – None
Return type:	Promise <[RuntimeNodeId]>

lookupAnyBody

IModelStructure.lookupAnyBody(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	AnyBody \| null

lookupAnyTreeNode

IModelStructure.lookupAnyTreeNode(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	AnyTreeNode \| null

lookupBodyInstance

IModelStructure.lookupBodyInstance(nodeId)

Arguments:	nodeId (RuntimeNodeId) – None
Return type:	`BodyInstance()` \| null

preventMeshDeletion

IModelStructure.preventMeshDeletion(meshId)

Arguments:	meshId (MeshKey) – None
Return type:	void

preventNodeDeletion

IModelStructure.preventNodeDeletion(nodeId)

Arguments:	nodeId (NodeId) – None
Return type:	void

registerGenericId

IModelStructure.registerGenericId(node, genericId)

Arguments:	node (AnyTreeNode) – None genericId (GenericId) – None
Return type:	void

registerGenericType

IModelStructure.registerGenericType(node, genericType)

Arguments:	node (AnyTreeNode) – None genericType (GenericType) – None
Return type:	void

requestNodes

IModelStructure.requestNodes(nodeIds)

Arguments:	nodeIds ([RuntimeNodeId]) – 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 (RuntimeNodeId \| undefined) – None
Return type:	void

resetToInitialMatrix

IModelStructure.resetToInitialMatrix(nodeId)

Arguments:	nodeId (RuntimeNodeId) – 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:	boolean \| undefined

setEdgeProperty

IModelStructure.setEdgeProperty(nodeId, edgeId, prop)

Arguments:	nodeId (RuntimeNodeId) – 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 (RuntimeNodeId) – None faceId (`number()`) – None prop (Base) – None
Return type:	void

setMatrices

IModelStructure.setMatrices(nodeIds, matrices, setAsInitial)

Arguments:	nodeIds ([RuntimeNodeId]) – None matrices (`[Matrix]()`) – None setAsInitial (`boolean()`) – None
Return type:	Promise <void>

setMatrix

IModelStructure.setMatrix(nodeId, matrix, setAsInitial)

Arguments:	nodeId (RuntimeNodeId) – None matrix (`Matrix()`) – None setAsInitial (`boolean()`) – None
Return type:	Promise <void>

setMeshLevel

IModelStructure.setMeshLevel(nodeIds, meshLevel)

Arguments:	nodeIds ([RuntimeNodeId]) – None meshLevel (`number()`) – None
Return type:	void

setPart

IModelStructure.setPart(nodeId, partId)

Arguments:	nodeId (RuntimeNodeId) – None partId (RuntimeNodeId) – None
Return type:	boolean

setPhysicalProperties

IModelStructure.setPhysicalProperties(nodeId, centerOfGravity, surfaceArea, volume)

Arguments:	nodeId (RuntimeNodeId) – None centerOfGravity (`Point3()`) – None surfaceArea (`number()`) – None volume (`number()`) – None
Return type:	boolean

setPmiColor

IModelStructure.setPmiColor(color, startNodeId)

Arguments:	color (Color) – None startNodeId (RuntimeNodeId \| undefined) – None
Return type:	void

setPrefetchScsCutoffScale

IModelStructure.setPrefetchScsCutoffScale(prefetchCutoffScale)

Arguments:	prefetchCutoffScale (`number()`) – None
Return type:	void

setVisibilitiesByMap

IModelStructure.setVisibilitiesByMap(idToVisibility[, initiallyHiddenStayHidden])

Arguments:	idToVisibility (Map <RuntimeNodeId, boolean>) – None initiallyHiddenStayHidden (`boolean()`) – optional None
Return type:	Promise <void>

setVisibilitiesByValue

IModelStructure.setVisibilitiesByValue(nodeIds, visibility, initiallyHiddenStayHidden)

Arguments:	nodeIds ([RuntimeNodeId]) – None visibility (`boolean()`) – None initiallyHiddenStayHidden (`boolean \| null()`) – None
Return type:	Promise <void>

shutdown

IModelStructure.shutdown()

Return type:	void

switchToModel

IModelStructure.switchToModel(newModelFilename)

Arguments:	newModelFilename (`string()`) – None
Return type:	Promise <[RuntimeNodeId]>

waitForReady

IModelStructure.waitForReady()

Return type:	Promise <void>