IModelStructure

class IModelStructure()

Index

Methods

• _disableCadConfigurations
• $mapBimRelationshipTypes
• activateCadConfiguration
• activateCadView
• activateDefaultCadConfiguration
• activateDefaultCadView
• addProperty
• allowNodeDeletion
• applyFilters
• cadConfigurationsEnabled
• clear
• createAndAddRepItem
• createCadView
• createMeshInstance
• createNode
• createPart
• createPmiInstance
• deleteNode
• firstAssemblyDataHeader
• gatherAnyBodiesFromNodeId
• 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
• getPmis
• getPmiSubType
• getPmiTopologyReferences
• getPmiType
• 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

IModelStructure._disableCadConfigurations()

_disableCadConfigurations(): Promise

Returns: Promise

IModelStructure.$mapBimRelationshipTypes()

$mapBimRelationshipTypes(nodeId: string, relationships: Relationship[]): RelationshipInfo[]

Parameters

nodeId: string

relationships: Relationship[]

Returns: RelationshipInfo[]

IModelStructure.activateCadConfiguration()

activateCadConfiguration(view: IView, cadConfigId: number, fitNodes: boolean): Promise

Parameters

view: IView

cadConfigId: number

fitNodes: boolean

Returns: Promise

IModelStructure.activateCadView()

activateCadView(view: IView, cadViewId: number, duration: number, massageCamera: boolean): Promise

Parameters

view: IView

cadViewId: number

duration: number

massageCamera: boolean

Returns: Promise

IModelStructure.activateDefaultCadConfiguration()

activateDefaultCadConfiguration(view: IView, fitNodes: boolean): Promise

Parameters

view: IView

fitNodes: boolean

Returns: Promise

IModelStructure.activateDefaultCadView()

activateDefaultCadView(view: IView, duration: number, massageCamera: boolean): Promise

Parameters

view: IView

duration: number

massageCamera: boolean

Returns: Promise

IModelStructure.addProperty()

addProperty(nodeId: number, propertyName: string, propertyValue: string, propertyUnit: UnitElement[]): boolean

Parameters

nodeId: number

propertyName: string

propertyValue: string

propertyUnit: UnitElement[]

Returns: boolean

IModelStructure.allowNodeDeletion()

allowNodeDeletion(nodeId: number): void

Parameters

nodeId: number

Returns: void

IModelStructure.applyFilters()

applyFilters(filterIds: FilterId[]): Promise

Parameters

filterIds: FilterId[]

Returns: Promise

IModelStructure.cadConfigurationsEnabled()

cadConfigurationsEnabled(): Promise

Returns: Promise

IModelStructure.clear()

clear(): Promise

Returns: Promise

IModelStructure.createAndAddRepItem()

createAndAddRepItem(partId: number, repItemId: (None | number)): (None | number)

Parameters

partId: number

repItemId: (None | number)

Returns: (None | number)

IModelStructure.createCadView()

createCadView(parentId: number, viewName: string, camera: Camera, pmiIds: (None | number[]), nodesToShow: number[], nodesToHide: number[], nodesIdAndLocalTransforms: [number, Matrix][], cuttingPlane: (None | Plane), meshInstanceData: (None | MeshInstanceData)): (None | number)

Parameters

parentId: number

viewName: string

camera: Camera

pmiIds: (None | number[])

nodesToShow: number[]

nodesToHide: number[]

nodesIdAndLocalTransforms: [number, Matrix][]

cuttingPlane: (None | Plane)

meshInstanceData: (None | MeshInstanceData)

Returns: (None | number)

IModelStructure.createMeshInstance()

createMeshInstance(inclusionKey: InclusionKey, instanceKey: InstanceKey, name: (None | string), parentId: (None | number), preventFromResetting: boolean, isOutOfHierarchy: boolean, implicitBody: boolean): number

Parameters

inclusionKey: InclusionKey

instanceKey: InstanceKey

name: (None | string)

parentId: (None | number)

preventFromResetting: boolean

isOutOfHierarchy: boolean

implicitBody: boolean

Returns: number

IModelStructure.createNode()

createNode(parentId: (None | number), nodeName: string, nodeId: (None | number), localMatrix: (None | Matrix), visibility: boolean, measurementUnit: (None | number)): number

Parameters

parentId: (None | number)

nodeName: string

nodeId: (None | number)

localMatrix: (None | Matrix)

visibility: boolean

measurementUnit: (None | number)

Returns: number

IModelStructure.createPart()

createPart(nodeId: (None | number)): number

Parameters

nodeId: (None | number)

Returns: number

IModelStructure.createPmiInstance()

createPmiInstance(inclusionKey: InclusionKey, instanceKey: InstanceKey, pmiType: PmiType, pmiSubType: PmiSubType, topoRefs: ReferenceOnTopology[], name: (None | string), parentId: (None | number)): number

Parameters

inclusionKey: InclusionKey

instanceKey: InstanceKey

pmiType: PmiType

pmiSubType: PmiSubType

topoRefs: ReferenceOnTopology[]

name: (None | string)

parentId: (None | number)

Returns: number

IModelStructure.deleteNode()

deleteNode(nodeId: number): Promise

Parameters

nodeId: number

Returns: Promise

IModelStructure.firstAssemblyDataHeader()

firstAssemblyDataHeader(): (None | AssemblyDataHeader)

Returns: (None | AssemblyDataHeader)

IModelStructure.gatherAnyBodiesFromNodeId()

gatherAnyBodiesFromNodeId(nodeId: number): AnyBody[]

Walk the assembly tree from the given nodeId and gather all the AnyBody nodes found.

Parameters

nodeId: number

The starting nodeId to walk from.

Returns: AnyBody[]

An array of AnyBody nodes found during the walk.

IModelStructure.gatherInclusionKeysFromNodeIds()

gatherInclusionKeysFromNodeIds(nodeIds: number[]): InclusionKey[]

Parameters

nodeIds: number[]

Returns: InclusionKey[]

IModelStructure.gatherInstanceIncsFromNodeIds()

gatherInstanceIncsFromNodeIds(nodeIds: number[], allowedTypes: BodyTypeBits, restriction: WalkRestriction): InstanceIncs

Parameters

nodeIds: number[]

allowedTypes: BodyTypeBits

restriction: WalkRestriction

Returns: InstanceIncs

IModelStructure.getAbsoluteRootNodeId()

getAbsoluteRootNodeId(): number

Returns: number

IModelStructure.getActiveCadConfiguration()

getActiveCadConfiguration(): (None | number)

Returns: (None | number)

IModelStructure.getAllRelationships()

getAllRelationships(nodeId: number): Relationship[]

Parameters

nodeId: number

Returns: Relationship[]

IModelStructure.getAssociatedModelKey()

getAssociatedModelKey(nodeId: number): (None | ModelKey)

Parameters

nodeId: number

Returns: (None | ModelKey)

IModelStructure.getAttributes()

getAttributes(nodeId: number): Promise

Parameters

nodeId: number

Returns: Promise

IModelStructure.getBimIdFromNode()

getBimIdFromNode(nodeId: number): (None | string)

Parameters

nodeId: number

Returns: (None | string)

IModelStructure.getBimIdRelationshipTypes()

getBimIdRelationshipTypes(contextNodeId: number, nodeId: string): RelationshipInfo[]

Parameters

contextNodeId: number

nodeId: string

Returns: RelationshipInfo[]

IModelStructure.getBounding()

getBounding(nodeIds: number[], allowedTypes: BodyTypeBits, ignoreInvisible: boolean, tightBounding: boolean): Promise

Parameters

nodeIds: number[]

allowedTypes: BodyTypeBits

ignoreInvisible: boolean

tightBounding: boolean

Returns: Promise

IModelStructure.getBranchVisibility()

getBranchVisibility(nodeId: number): BranchVisibility

Parameters

nodeId: number

Returns: BranchVisibility

IModelStructure.getCadConfigurations()

getCadConfigurations(): IdStringMap

Returns: IdStringMap

IModelStructure.getCadViewConfiguration()

getCadViewConfiguration(nodeId: number): (None | number)

Parameters

nodeId: number

Returns: (None | number)

IModelStructure.getCadViewMap()

getCadViewMap(): Map

Returns: Map

IModelStructure.getCadViewPmis()

getCadViewPmis(cadViewId: number): number[]

Parameters

cadViewId: number

Returns: number[]

IModelStructure.getChildIds()

getChildIds(nodeId: number, includeOutOfHierarchy: boolean): number[]

Parameters

nodeId: number

includeOutOfHierarchy: boolean

Returns: number[]

IModelStructure.getDefaultCadConfiguration()

getDefaultCadConfiguration(): (None | number)

Returns: (None | number)

IModelStructure.getDefaultCadView()

getDefaultCadView(): (None | number)

Returns: (None | number)

IModelStructure.getEdgeAttributes()

getEdgeAttributes(nodeId: number, edgeId: number): Promise

Parameters

nodeId: number

edgeId: number

Returns: Promise

IModelStructure.getEdgeCount()

getEdgeCount(nodeId: number): Promise

Parameters

nodeId: number

Returns: Promise

IModelStructure.getEdgeProperty()

getEdgeProperty(nodeId: number, edgeId: number): Promise

Parameters

nodeId: number

edgeId: number

Returns: Promise

IModelStructure.getFaceAttributes()

getFaceAttributes(nodeId: number, faceId: number): Promise

Parameters

nodeId: number

faceId: number

Returns: Promise

IModelStructure.getFaceCount()

getFaceCount(nodeId: number): Promise

Parameters

nodeId: number

Returns: Promise

IModelStructure.getFaceProperty()

getFaceProperty(prcId: number, faceId: number): Promise

Parameters

prcId: number

faceId: number

Returns: Promise

IModelStructure.getFilterName()

getFilterName(filterId: FilterId): (None | string)

Parameters

filterId: FilterId

Returns: (None | string)

IModelStructure.getFilters()

getFilters(): Map

Returns: Map

IModelStructure.getFiltersFromView()

getFiltersFromView(nodeId: number): FilterId[]

Parameters

nodeId: number

Returns: FilterId[]

IModelStructure.getFiltersWithNode()

getFiltersWithNode(nodeId: number): FilterId[]

Parameters

nodeId: number

Returns: FilterId[]

IModelStructure.getGenericTypeIdMap()

getGenericTypeIdMap(): Map

Returns: Map

IModelStructure.getGenericTypes()

getGenericTypes(): string[]

Returns: string[]

IModelStructure.getIdOffset()

getIdOffset(nodeId: number): number

Parameters

nodeId: number

Returns: number

IModelStructure.getInfoOfBimId()

getInfoOfBimId(nodeID: number, bimId: string): { connected: boolean, name: string }

Parameters

nodeID: number

bimId: string

Returns: { connected: boolean, name: string }

IModelStructure.getInstanceIncs()

getInstanceIncs(nodeId: number, allowedTypes: BodyTypeBits): InstanceIncs

Parameters

nodeId: number

allowedTypes: BodyTypeBits

Returns: InstanceIncs

IModelStructure.getLayerIdsFromName()

getLayerIdsFromName(name: string): (None | LayerId[])

Parameters

name: string

Returns: (None | LayerId[])

IModelStructure.getLayerName()

getLayerName(layerId: LayerId): (None | string)

Parameters

layerId: LayerId

Returns: (None | string)

IModelStructure.getLayers()

getLayers(): Map

Returns: Map

IModelStructure.getLowestAvailableNodeId()

getLowestAvailableNodeId(): number

Returns: number

IModelStructure.getMatrix()

getMatrix(nodeId: number): Matrix

Parameters

nodeId: number

Returns: Matrix

IModelStructure.getModelFileNameFromNode()

getModelFileNameFromNode(nodeId: number): (None | string)

Parameters

nodeId: number

Returns: (None | string)

IModelStructure.getModelFileTypeFromNode()

getModelFileTypeFromNode(nodeId: number): (None | FileType)

Parameters

nodeId: number

Returns: (None | FileType)

IModelStructure.getName()

getName(nodeId: number): (None | string)

Parameters

nodeId: number

Returns: (None | string)

IModelStructure.getNetMatrix()

getNetMatrix(nodeId: number): Matrix16

Parameters

nodeId: number

Returns: Matrix16

IModelStructure.getNodeExchangeId()

getNodeExchangeId(nodeId: number): (None | string)

Parameters

nodeId: number

Returns: (None | string)

IModelStructure.getNodeFromInstanceInc()

getNodeFromInstanceInc(markNodeLoadedIfCreated: boolean, inclusionKey: InclusionKey, instanceKey: InstanceKey, isOutOfHierarchy: boolean): number

Parameters

markNodeLoadedIfCreated: boolean

inclusionKey: InclusionKey

instanceKey: InstanceKey

isOutOfHierarchy: boolean

Returns: number

IModelStructure.getNodeGenericId()

getNodeGenericId(nodeId: number): (None | string)

Parameters

nodeId: number

Returns: (None | string)

IModelStructure.getNodeGenericType()

getNodeGenericType(nodeId: number): (None | string)

Parameters

nodeId: number

Returns: (None | string)

IModelStructure.getNodeLayerId()

getNodeLayerId(nodeId: number): (None | LayerId)

Parameters

nodeId: number

Returns: (None | LayerId)

IModelStructure.getNodeOrRepItem()

getNodeOrRepItem(node: AnyNode): Promise

Parameters

node: AnyNode

Returns: Promise

IModelStructure.getNodesByGenericId()

getNodesByGenericId(genericId: string): (None | Set)

Parameters

genericId: string

Returns: (None | Set)

IModelStructure.getNodesByGenericType()

getNodesByGenericType(genericType: string): (None | Set)

Parameters

genericType: string

Returns: (None | Set)

IModelStructure.getNodesFromFilterIds()

getNodesFromFilterIds(filterIds: FilterId[]): (None | FilteredNodes)

Parameters

filterIds: FilterId[]

Returns: (None | FilteredNodes)

IModelStructure.getParentId()

getParentId(nodeId: number): (None | number)

Parameters

nodeId: number

Returns: (None | number)

IModelStructure.getPartReferrers()

getPartReferrers(nodeId: number): Promise

Parameters

nodeId: number

Returns: Promise

IModelStructure.getPmis()

getPmis(): IdStringMap

Returns: IdStringMap

IModelStructure.getPmiSubType()

getPmiSubType(pmiId: number): PmiSubType

Parameters

pmiId: number

Returns: PmiSubType

IModelStructure.getPmiTopologyReferences()

getPmiTopologyReferences(pmiNodeId: number): (None | PmiTopologyReference[])

Parameters

pmiNodeId: number

Returns: (None | PmiTopologyReference[])

IModelStructure.getPmiType()

getPmiType(pmiId: number): PmiType

Parameters

pmiId: number

Returns: PmiType

IModelStructure.getPointAttributes()

getPointAttributes(nodeId: number, pointId: number): Promise

Parameters

nodeId: number

pointId: number

Returns: Promise

IModelStructure.getProperties()

getProperties(nodeId: number, computeFromChildren: boolean): Promise

Parameters

nodeId: number

computeFromChildren: boolean

Returns: Promise

IModelStructure.getRelationsByTypeFromNode()

getRelationsByTypeFromNode(contextNodeId: number, nodeId: string): (None | Map)

Parameters

contextNodeId: number

nodeId: string

Returns: (None | Map)

IModelStructure.getRuntimeNodeFromBimId()

getRuntimeNodeFromBimId(contextNodeId: number, bimId: string): (None | number)

Parameters

contextNodeId: number

bimId: string

Returns: (None | number)

IModelStructure.getRuntimeNodesFromLayer()

getRuntimeNodesFromLayer(layerId: LayerId, onlyTreeNodes: boolean): (None | number[])

Parameters

layerId: LayerId

onlyTreeNodes: boolean

Returns: (None | number[])

IModelStructure.getRuntimeNodesFromLayerName()

getRuntimeNodesFromLayerName(layerName: string, onlyTreeNodes: boolean): (None | number[])

Parameters

layerName: string

onlyTreeNodes: boolean

Returns: (None | number[])

IModelStructure.getRuntimeNodesFromLayers()

getRuntimeNodesFromLayers(layersId: LayerId[], onlyTreeNodes: boolean): (None | number[])

Parameters

layersId: LayerId[]

onlyTreeNodes: boolean

Returns: (None | number[])

IModelStructure.getType()

getType(nodeId: number): NodeType

Parameters

nodeId: number

Returns: NodeType

IModelStructure.getUniqueLayerNames()

getUniqueLayerNames(): string[]

Returns: string[]

IModelStructure.getUnit()

getUnit(nodeId: number): number

Parameters

nodeId: number

Returns: number

IModelStructure.getUserData()

getUserData(nodeId: number, index: UserDataIndex): Uint8Array

Parameters

nodeId: number

index: UserDataIndex

Returns: Uint8Array

IModelStructure.getUserDataIndices()

getUserDataIndices(nodeId: number): UserDataIndex[]

Parameters

nodeId: number

Returns: UserDataIndex[]

IModelStructure.hasEffectiveGenericType()

hasEffectiveGenericType(nodeId: number, genericType: string): boolean

Parameters

nodeId: number

genericType: string

Returns: boolean

IModelStructure.hasRelationships()

hasRelationships(nodeId: number): boolean

Parameters

nodeId: number

Returns: boolean

IModelStructure.init()

init(view: IView, maxConcurrentAttachments: (None | number)): Promise

Parameters

view: IView

maxConcurrentAttachments: (None | number)

Returns: Promise

IModelStructure.isACadDrawing()

isACadDrawing(): boolean

Returns: boolean

IModelStructure.isAnnotationView()

isAnnotationView(cadViewNodeId: number): boolean

Parameters

cadViewNodeId: number

Returns: boolean

IModelStructure.isCombineStateView()

isCombineStateView(cadViewNodeId: number): boolean

Parameters

cadViewNodeId: number

Returns: boolean

IModelStructure.isFaceMeasurable()

isFaceMeasurable(bodyId: number, faceIndex: number): Promise

Parameters

bodyId: number

faceIndex: number

Returns: Promise

IModelStructure.isIdValid()

isIdValid(nodeId: number): boolean

Parameters

nodeId: number

Returns: boolean

IModelStructure.isLineMeasurable()

isLineMeasurable(bodyId: number, lineIndex: number): Promise

Parameters

bodyId: number

lineIndex: number

Returns: Promise

IModelStructure.isMeasurable()

isMeasurable(): boolean

Returns: boolean

IModelStructure.isNodeLoaded()

isNodeLoaded(nodeId: number): boolean

Parameters

nodeId: number

Returns: boolean

IModelStructure.isOutOfHierarchy()

isOutOfHierarchy(nodeId: number): boolean

Parameters

nodeId: number

Returns: boolean

IModelStructure.isReady()

isReady(): boolean

Returns: boolean

IModelStructure.isVisible()

isVisible(nodeId: number): boolean

Parameters

nodeId: number

Returns: boolean

IModelStructure.isWithinExternalModel()

isWithinExternalModel(nodeId: number): boolean

Parameters

nodeId: number

Returns: boolean

IModelStructure.loadMeasurementFromFile()

loadMeasurementFromFile(zipFilename: string): Promise

Parameters

zipFilename: string

Returns: Promise

IModelStructure.loadMeasurementFromJson()

loadMeasurementFromJson(json: any): Promise

Parameters

json: any

Returns: Promise

IModelStructure.loadMeasurementFromString()

loadMeasurementFromString(str: string): Promise

Parameters

str: string

Returns: Promise

IModelStructure.loadSubtreeFromAssemblyData()

loadSubtreeFromAssemblyData(nodeId: number, modelInc: ModelInc, assemblyData: AssemblyData, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

modelInc: ModelInc

assemblyData: AssemblyData

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.loadSubtreeFromScsBuffer()

loadSubtreeFromScsBuffer(nodeId: number, scsBuffer: ScsBuffer, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

scsBuffer: ScsBuffer

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.loadSubtreeFromScsFile()

loadSubtreeFromScsFile(nodeId: number, scsFilename: string, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

scsFilename: string

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.loadSubtreeFromScsXmlDoc()

loadSubtreeFromScsXmlDoc(nodeId: number, xmlData: (string | Document), modelNameToScs: ModelNameToScsFileFunc, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

xmlData: (string | Document)

modelNameToScs: ModelNameToScsFileFunc

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.loadSubtreeFromScsXmlFile()

loadSubtreeFromScsXmlFile(nodeId: number, xmlFilename: string, modelNameToScs: ModelNameToScsFileFunc, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

xmlFilename: string

modelNameToScs: ModelNameToScsFileFunc

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.loadSubtreeFromStream()

loadSubtreeFromStream(nodeId: number, modelName: string, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

modelName: string

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.loadSubtreeFromXmlDoc()

loadSubtreeFromXmlDoc(nodeId: number, xml: (string | Document), massageModelName: MassageModelNameFunc, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

xml: (string | Document)

massageModelName: MassageModelNameFunc

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.loadSubtreeFromXmlFile()

loadSubtreeFromXmlFile(nodeId: number, xmlFilename: string, massageModelName: MassageModelNameFunc, config: LoadSubtreeConfig): Promise

Parameters

nodeId: number

xmlFilename: string

massageModelName: MassageModelNameFunc

config: LoadSubtreeConfig

Returns: Promise

IModelStructure.lookupAnyBody()

lookupAnyBody(nodeId: number): (None | AnyBody)

Parameters

nodeId: number

Returns: (None | AnyBody)

IModelStructure.lookupAnyTreeNode()

lookupAnyTreeNode(nodeId: number): (None | AnyTreeNode)

Parameters

nodeId: number

Returns: (None | AnyTreeNode)

IModelStructure.lookupBodyInstance()

lookupBodyInstance(nodeId: number): (None | BodyInstance)

Parameters

nodeId: number

Returns: (None | BodyInstance)

IModelStructure.preventMeshDeletion()

preventMeshDeletion(meshId: MeshKey): void

Parameters

meshId: MeshKey

Returns: void

IModelStructure.preventNodeDeletion()

preventNodeDeletion(nodeId: number): void

Parameters

nodeId: number

Returns: void

IModelStructure.registerGenericId()

registerGenericId(node: AnyTreeNode, genericId: string): void

Parameters

node: AnyTreeNode

genericId: string

Returns: void

IModelStructure.registerGenericType()

registerGenericType(node: AnyTreeNode, genericType: string): void

Parameters

node: AnyTreeNode

genericType: string

Returns: void

IModelStructure.requestNodes()

requestNodes(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModelStructure.reset()

reset(): Promise

Returns: Promise

IModelStructure.resetAllTransforms()

resetAllTransforms(): Promise

Returns: Promise

IModelStructure.resetAllVisibilities()

resetAllVisibilities(): Promise

Returns: Promise

IModelStructure.resetPmiColor()

resetPmiColor(startNodeId: (undefined | number)): void

Parameters

startNodeId: (undefined | number)

Returns: void

IModelStructure.resetToInitialMatrix()

resetToInitialMatrix(nodeId: number): Promise

Parameters

nodeId: number

Returns: Promise

IModelStructure.setBehaviorInitiallyHidden()

setBehaviorInitiallyHidden(value: boolean): void

Parameters

value: boolean

Returns: void

IModelStructure.setBodyNodesVisibility()

setBodyNodesVisibility(startNode: AnyTreeNode, visibilityFormatter: (boolean | (node: AnyTreeNode) => (undefined | boolean))): Promise

Parameters

startNode: AnyTreeNode

visibilityFormatter: (boolean | (node: AnyTreeNode) => (undefined | boolean))

Returns: Promise

IModelStructure.setEdgeProperty()

setEdgeProperty(nodeId: number, edgeId: number, prop: Base): void

Parameters

nodeId: number

edgeId: number

prop: Base

Returns: void

IModelStructure.setEnableAutomaticUnitScaling()

setEnableAutomaticUnitScaling(value: boolean): void

Parameters

value: boolean

Returns: void

IModelStructure.setFaceProperty()

setFaceProperty(nodeId: number, faceId: number, prop: Base): void

Parameters

nodeId: number

faceId: number

prop: Base

Returns: void

IModelStructure.setMatrices()

setMatrices(nodeIds: number[], matrices: Matrix[], setAsInitial: boolean): Promise

Parameters

nodeIds: number[]

matrices: Matrix[]

setAsInitial: boolean

Returns: Promise

IModelStructure.setMatrix()

setMatrix(nodeId: number, matrix: Matrix, setAsInitial: boolean): Promise

Parameters

nodeId: number

matrix: Matrix

setAsInitial: boolean

Returns: Promise

IModelStructure.setMeshLevel()

setMeshLevel(nodeIds: number[], meshLevel: number): void

Parameters

nodeIds: number[]

meshLevel: number

Returns: void

IModelStructure.setPart()

setPart(nodeId: number, partId: number): boolean

Parameters

nodeId: number

partId: number

Returns: boolean

IModelStructure.setPhysicalProperties()

setPhysicalProperties(nodeId: number, centerOfGravity: Point3, surfaceArea: number, volume: number): boolean

Parameters

nodeId: number

centerOfGravity: Point3

surfaceArea: number

volume: number

Returns: boolean

IModelStructure.setPmiColor()

setPmiColor(color: Color, startNodeId: (undefined | number)): void

Parameters

color: Color

startNodeId: (undefined | number)

Returns: void

IModelStructure.setPrefetchScsCutoffScale()

setPrefetchScsCutoffScale(prefetchCutoffScale: number): void

Parameters

prefetchCutoffScale: number

Returns: void

IModelStructure.setVisibilitiesByMap()

setVisibilitiesByMap(idToVisibility: Map, initiallyHiddenStayHidden: boolean): Promise

Parameters

idToVisibility: Map

initiallyHiddenStayHidden: boolean

Returns: Promise

IModelStructure.setVisibilitiesByValue()

setVisibilitiesByValue(nodeIds: number[], visibility: boolean, initiallyHiddenStayHidden: (None | boolean)): Promise

Parameters

nodeIds: number[]

visibility: boolean

initiallyHiddenStayHidden: (None | boolean)

Returns: Promise

IModelStructure.shutdown()

shutdown(): void

Returns: void

IModelStructure.switchToModel()

switchToModel(newModelFilename: string): Promise

Parameters

newModelFilename: string

Returns: Promise

IModelStructure.waitForReady()

waitForReady(): Promise

Returns: Promise