IAssemblyTree

class core.IAssemblyTree()

Methods

• activateCadConfiguration()
• activateCadView()
• addFilter()
• allowNodeDeletion()
• containsDrawings()
• createCadView()
• createLayer()
• createMeshInstance()
• createNode()
• createPart()
• createPmiInstance()
• deactivateActiveCadView()
• deleteNode()
• disableAutomaticFitWorld()
• enqueue()
• forEachCadConfiguration()
• forEachCadView()
• forEachPmi()
• generateDrawingSheetName()
• generateDrawingViewName()
• generateDynamicNodeId()
• generateGroupName()
• generateProductName()
• genericTypeToNodes()
• getAbstractScEngine()
• getActiveCadConfiguration()
• getAutomaticMeasurementUnitScaling()
• getCadConfigurations()
• getCadViewPmis()
• getDefaultCadConfiguration()
• getDefaultCadView()
• getFilterName()
• getFilters()
• getFiltersWithNode()
• getFirstProductOccurrenceWithView()
• getInclusionContexts()
• getInitiallyHiddenStayHidden()
• getInstanceCountByInclusion()
• getLayerName()
• getLayers()
• getLayersIdFromName()
• getLowestAvailableNodeId()
• getNodesByGenericId()
• getNodesByGenericType()
• getNodesFromFilterIds()
• getNodesFromLayer()
• getNodesFromLayerName()
• getNodesFromLayers()
• getRelationshipsOfItem()
• getRootNode()
• getUniqueLayerNames()
• hasActiveCadView()
• initialize()
• isBeingRequested()
• isInitialized()
• isMeasurable()
• lookupAnyBody()
• lookupAnyBodyByInstanceInc()
• lookupAnyNode()
• lookupAnyNonTreeNode()
• lookupAnyTreeNode()
• lookupBodyInstance()
• lookupCadView()
• lookupPartDefinition()
• lookupPartDefinitionByDataId()
• lookupPmi()
• lookupPmiBody()
• lookupProductOccurrence()
• lookupPrototypeByDataId()
• lookupRepresentationItem()
• lookupViewFrame()
• markImplicitNodesOutOfHierarchy()
• markSeenExternalModel()
• massageAuthoredUserId()
• newNodeIdOffset()
• onDemandRequestsActive()
• onLoadBegin()
• onLoadEnd()
• preventMeshDeletion()
• preventNodeDeletion()
• registerBodyInstance()
• registerCadView()
• registerGenericGlobalId()
• registerGenericType()
• registerInclusionContext()
• registerNodeInLayer()
• registerPartDefinition()
• registerPartDefinitionByDataId()
• registerPmi()
• registerPmiBody()
• registerProductOccurrence()
• registerPrototypeByDataId()
• registerRepresentationItem()
• registerTreeNodeInLayer()
• registerViewFrame()
• requestNodes()
• reset()
• seenExternalModel()
• setAutomaticMeasurementUnitScaling()
• setInitiallyHiddenStayHidden()
• setPart()
• setViewAxes()
• tryParseHeader()
• updateLayerName()

---

Methods

activateCadConfiguration

IAssemblyTree.activateCadConfiguration(node)

Arguments:

• node (ProductOccurrence()) – None

Return type:

void

activateCadView

IAssemblyTree.activateCadView(view, cadView, duration, massageCamera)

Arguments:

• view (IView()) – None
• cadView (CadView()) – None
• duration (number()) – None
• massageCamera (boolean()) – None

Return type:

Promise <void>

addFilter

IAssemblyTree.addFilter(filter, loadContext)

Arguments:

• filter (Filter()) – None
• loadContext (LoadContext()) – None

Return type:

void

allowNodeDeletion

IAssemblyTree.allowNodeDeletion(node)

Arguments:

• node (DeletableNode()) – None

Return type:

void

containsDrawings

IAssemblyTree.containsDrawings()

Return type:boolean

createCadView

IAssemblyTree.createCadView(engine, parent, name, camera, pmis, productOccurrencesToShow, productOccurrencesToHide, transformMap, cuttingPlane, meshInstanceData)

Arguments:

• engine (IScEngine()) – None
• parent (ProductOccurrence()) – None
• name (string()) – None
• camera (Camera()) – None
• pmis (null | [Pmi]()) – None
• productOccurrencesToShow ([number]()) – None
• productOccurrencesToHide ([number]()) – None
• transformMap (Map) – None
• cuttingPlane (null | Plane()) – None
• meshInstanceData (null | MeshInstanceData()) – None

Return type:

CadView

createLayer

IAssemblyTree.createLayer(authoredLayerId, layerName, loadContext)

Arguments:

• authoredLayerId (AuthoredLayerId()) – None
• layerName (null | string()) – None
• loadContext (LoadContext()) – None

Return type:

Layer

createMeshInstance

IAssemblyTree.createMeshInstance(markLoaded, inclusionKey, instanceKey, authoredId, name, parent, preventFromResetting, isOutOfHierarchy, initiallyVisible, implicitBody)

Arguments:

• markLoaded (boolean()) – None
• inclusionKey (InclusionKey()) – None
• instanceKey (InstanceKey()) – None
• authoredId (null | number()) – None
• name (null | string()) – None
• parent (ProductOccurrence()) – None
• preventFromResetting (boolean()) – None
• isOutOfHierarchy (boolean()) – None
• initiallyVisible (boolean()) – None
• implicitBody (boolean()) – None

Return type:

BodyInstance

createNode

IAssemblyTree.createNode(parent, nodeName, authoredId, localMatrix, visibility[, measurementUnit])

Arguments:

• parent (ProductOccurrence()) – None
• nodeName (string()) – None
• authoredId (null | number()) – None
• localMatrix (null | Matrix16()) – None
• visibility (boolean()) – None
• measurementUnit (null | number()) – optional None

Return type:

ProductOccurrence

createPart

IAssemblyTree.createPart(authoredNodeId)

Arguments:

• authoredNodeId (null | number()) – None

Return type:

PartDefinition

createPmiInstance

IAssemblyTree.createPmiInstance(inclusionKey, instanceKey, authoredId, name, parent, pmiType, pmiSubType, topoRefs)

Arguments:

• inclusionKey (InclusionKey()) – None
• instanceKey (InstanceKey()) – None
• authoredId (null | number()) – None
• name (null | string()) – None
• parent (ProductOccurrence()) – None
• pmiType (PmiType()) – None
• pmiSubType (PmiSubType()) – None
• topoRefs ([ReferenceOnTopology]()) – None

Return type:

Pmi

deactivateActiveCadView

IAssemblyTree.deactivateActiveCadView()

Return type:Promise <void>

deleteNode

IAssemblyTree.deleteNode(node)

Arguments:

• node (ProductOccurrence | Pmi | BodyInstance()) – None

Return type:

Promise <void>

disableAutomaticFitWorld

IAssemblyTree.disableAutomaticFitWorld()

Return type:boolean

enqueue

IAssemblyTree.enqueue(lazyPromise)

Arguments:

• lazyPromise (LazyLike) – None

Return type:

Promise <T>

forEachCadConfiguration

IAssemblyTree.forEachCadConfiguration(callback)

Arguments:

• callback (function()) – None

Return type:

void

IAssemblyTree.callback(node)

Arguments:

• node (ProductOccurrence()) – None

Return type:

void

forEachCadView

IAssemblyTree.forEachCadView(callback)

Arguments:

• callback (function()) – None

Return type:

void

IAssemblyTree.callback(node)

Arguments:

• node (CadView()) – None

Return type:

void

forEachPmi

IAssemblyTree.forEachPmi(callback)

Arguments:

• callback (function()) – None

Return type:

void

IAssemblyTree.callback(node)

Arguments:

• node (Pmi()) – None

Return type:

void

generateDrawingSheetName

IAssemblyTree.generateDrawingSheetName()

Return type:string

generateDrawingViewName

IAssemblyTree.generateDrawingViewName()

Return type:string

generateDynamicNodeId

IAssemblyTree.generateDynamicNodeId()

Return type:number

generateGroupName

IAssemblyTree.generateGroupName()

Return type:string

generateProductName

IAssemblyTree.generateProductName()

Return type:string

genericTypeToNodes

IAssemblyTree.genericTypeToNodes()

Return type:Map <string, Set <AnyTreeNode>>

getAbstractScEngine

IAssemblyTree.getAbstractScEngine()

Return type:IScEngine

getActiveCadConfiguration

IAssemblyTree.getActiveCadConfiguration()

Return type:null | ProductOccurrence

getAutomaticMeasurementUnitScaling

IAssemblyTree.getAutomaticMeasurementUnitScaling()

Return type:boolean

getCadConfigurations

IAssemblyTree.getCadConfigurations()

Return type:[ProductOccurrence]

getCadViewPmis

IAssemblyTree.getCadViewPmis(cadView)

Arguments:

• cadView (CadView()) – None

Return type:

[Pmi]

getDefaultCadConfiguration

IAssemblyTree.getDefaultCadConfiguration()

Return type:null | ProductOccurrence

getDefaultCadView

IAssemblyTree.getDefaultCadView(node)

Arguments:

• node (null | ProductOccurrence()) – None

Return type:

null | CadView

getFilterName

IAssemblyTree.getFilterName(filterId)

Arguments:

• filterId (FilterId()) – None

Return type:

null | string

getFilters

IAssemblyTree.getFilters()

Return type:Map <FilterId, string>

getFiltersWithNode

IAssemblyTree.getFiltersWithNode(targetNode)

Arguments:

• targetNode (AnyTreeNode()) – None

Return type:

[FilterId]

getFirstProductOccurrenceWithView

IAssemblyTree.getFirstProductOccurrenceWithView()

Return type:null | ProductOccurrence

getInclusionContexts

IAssemblyTree.getInclusionContexts(inclusionKey)

Arguments:

• inclusionKey (InclusionKey()) – None

Return type:

[InclusionContext]

getInitiallyHiddenStayHidden

IAssemblyTree.getInitiallyHiddenStayHidden()

Return type:boolean

getInstanceCountByInclusion

IAssemblyTree.getInstanceCountByInclusion(inclusionKey)

Arguments:

• inclusionKey (InclusionKey()) – None

Return type:

number

getLayerName

IAssemblyTree.getLayerName(layerId)

Arguments:

• layerId (LayerId()) – None

Return type:

null | string

getLayers

IAssemblyTree.getLayers()

Return type:Map <LayerId, string>

getLayersIdFromName

IAssemblyTree.getLayersIdFromName(name)

Arguments:

• name (string()) – None

Return type:

null | [LayerId]

getLowestAvailableNodeId

IAssemblyTree.getLowestAvailableNodeId()

Return type:number

getNodesByGenericId

IAssemblyTree.getNodesByGenericId(genericId)

Arguments:

• genericId (string()) – None

Return type:

null | Set <AnyTreeNode>

getNodesByGenericType

IAssemblyTree.getNodesByGenericType(genericType)

Arguments:

• genericType (string()) – None

Return type:

null | Set <AnyTreeNode>

getNodesFromFilterIds

IAssemblyTree.getNodesFromFilterIds(filterIds)

Arguments:

• filterIds ([FilterId]()) – None

Return type:

null | FilteredNodes

getNodesFromLayer

IAssemblyTree.getNodesFromLayer(layerId[, onlyTreeNodes])

Arguments:

• layerId (LayerId()) – None
• onlyTreeNodes (boolean()) – optional None

Return type:

null | [AnyTreeNode]

getNodesFromLayerName

IAssemblyTree.getNodesFromLayerName(layerName[, onlyTreeNodes])

Arguments:

• layerName (string()) – None
• onlyTreeNodes (boolean()) – optional None

Return type:

null | [AnyTreeNode]

getNodesFromLayers

IAssemblyTree.getNodesFromLayers(layerIds[, onlyTreeNodes])

Arguments:

• layerIds ([LayerId]()) – None
• onlyTreeNodes (boolean()) – optional None

Return type:

null | [AnyTreeNode]

getRelationshipsOfItem

IAssemblyTree.getRelationshipsOfItem(contextNodeId, node)

Arguments:

• contextNodeId (number()) – None
• node (string()) – None

Return type:

Map <RelationshipType, BimRelationship>

getRootNode

IAssemblyTree.getRootNode()

Return type:ProductOccurrence

getUniqueLayerNames

IAssemblyTree.getUniqueLayerNames()

Return type:[string]

hasActiveCadView

IAssemblyTree.hasActiveCadView()

Return type:boolean

initialize

IAssemblyTree.initialize(scAttacher)

Arguments:

• scAttacher (ScAttacher()) – None

Return type:

void

isBeingRequested

IAssemblyTree.isBeingRequested(startNode)

Arguments:

• startNode (AnyTreeNode | AnyTreeContext()) – None

Return type:

boolean

isInitialized

IAssemblyTree.isInitialized()

Return type:boolean

isMeasurable

IAssemblyTree.isMeasurable()

Return type:boolean

lookupAnyBody

IAssemblyTree.lookupAnyBody(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | AnyBody

lookupAnyBodyByInstanceInc

IAssemblyTree.lookupAnyBodyByInstanceInc(inclusionKey, instanceKey)

Arguments:

• inclusionKey (InclusionKey()) – None
• instanceKey (InstanceKey()) – None

Return type:

null | AnyBody

lookupAnyNode

IAssemblyTree.lookupAnyNode(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | AnyNode

lookupAnyNonTreeNode

IAssemblyTree.lookupAnyNonTreeNode(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | AnyNonTreeNode

lookupAnyTreeNode

IAssemblyTree.lookupAnyTreeNode(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | AnyTreeNode

lookupBodyInstance

IAssemblyTree.lookupBodyInstance(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | BodyInstance

lookupCadView

IAssemblyTree.lookupCadView(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | CadView

lookupPartDefinition

IAssemblyTree.lookupPartDefinition(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | PartDefinition

lookupPartDefinitionByDataId

IAssemblyTree.lookupPartDefinitionByDataId(loadContext, modelKey, dataKey)

Arguments:

• loadContext (LoadContext()) – None
• modelKey (ModelKey()) – None
• dataKey (DataKey()) – None

Return type:

null | LazyPromise <PartDefinition>

lookupPmi

IAssemblyTree.lookupPmi(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | Pmi

lookupPmiBody

IAssemblyTree.lookupPmiBody(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | PmiBody

lookupProductOccurrence

IAssemblyTree.lookupProductOccurrence(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | ProductOccurrence

lookupPrototypeByDataId

IAssemblyTree.lookupPrototypeByDataId(loadContext, modelKey, dataKey)

Arguments:

• loadContext (LoadContext()) – None
• modelKey (ModelKey()) – None
• dataKey (DataKey()) – None

Return type:

null | SharedPrototypeContext

lookupRepresentationItem

IAssemblyTree.lookupRepresentationItem(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | RepresentationItem

lookupViewFrame

IAssemblyTree.lookupViewFrame(nodeId)

Arguments:

• nodeId (number()) – None

Return type:

null | ViewFrame

markImplicitNodesOutOfHierarchy

IAssemblyTree.markImplicitNodesOutOfHierarchy()

Return type:boolean

markSeenExternalModel

IAssemblyTree.markSeenExternalModel()

Return type:void

massageAuthoredUserId

IAssemblyTree.massageAuthoredUserId(inclusionContext, authoredId)

Arguments:

• inclusionContext (InclusionContext()) – None
• authoredId (null | number()) – None

Return type:

number

newNodeIdOffset

IAssemblyTree.newNodeIdOffset()

Return type:number

onDemandRequestsActive

IAssemblyTree.onDemandRequestsActive()

Return type:boolean

onLoadBegin

IAssemblyTree.onLoadBegin()

Return type:number

onLoadEnd

IAssemblyTree.onLoadEnd(loadId)

Arguments:

• loadId (number()) – None

Return type:

void

preventMeshDeletion

IAssemblyTree.preventMeshDeletion(meshKey)

Arguments:

• meshKey (MeshKey()) – None

Return type:

void

preventNodeDeletion

IAssemblyTree.preventNodeDeletion(node)

Arguments:

• node (DeletableNode()) – None

Return type:

void

registerBodyInstance

IAssemblyTree.registerBodyInstance(node, inclusionKey)

Arguments:

• node (BodyInstance()) – None
• inclusionKey (InclusionKey()) – None

Return type:

void

registerCadView

IAssemblyTree.registerCadView(node)

Arguments:

• node (CadView()) – None

Return type:

void

registerGenericGlobalId

IAssemblyTree.registerGenericGlobalId(node, genericId)

Arguments:

• node (AnyTreeNode()) – None
• genericId (string()) – None

Return type:

void

registerGenericType

IAssemblyTree.registerGenericType(node, genericType)

Arguments:

• node (AnyTreeNode()) – None
• genericType (string()) – None

Return type:

void

registerInclusionContext

IAssemblyTree.registerInclusionContext(context)

Arguments:

• context (InclusionContext()) – None

Return type:

void

registerNodeInLayer

IAssemblyTree.registerNodeInLayer(node, authoredLayerId)

Arguments:

• node (AnyTreeNode()) – None
• authoredLayerId (AuthoredLayerId()) – None

Return type:

void

registerPartDefinition

IAssemblyTree.registerPartDefinition(partDef)

Arguments:

• partDef (PartDefinition()) – None

Return type:

void

registerPartDefinitionByDataId

IAssemblyTree.registerPartDefinitionByDataId(loadContext, modelKey, dataKey, partDefinition)

Arguments:

• loadContext (LoadContext()) – None
• modelKey (ModelKey()) – None
• dataKey (DataKey()) – None
• partDefinition (LazyPromise) – None

Return type:

void

registerPmi

IAssemblyTree.registerPmi(node)

Arguments:

• node (Pmi()) – None

Return type:

void

registerPmiBody

IAssemblyTree.registerPmiBody(node, inclusionKey)

Arguments:

• node (PmiBody()) – None
• inclusionKey (InclusionKey()) – None

Return type:

void

registerProductOccurrence

IAssemblyTree.registerProductOccurrence(node)

Arguments:

• node (ProductOccurrence()) – None

Return type:

void

registerPrototypeByDataId

IAssemblyTree.registerPrototypeByDataId(loadContext, modelKey, dataKey, prototype)

Arguments:

• loadContext (LoadContext()) – None
• modelKey (ModelKey()) – None
• dataKey (DataKey()) – None
• prototype (SharedPrototypeContext()) – None

Return type:

void

registerRepresentationItem

IAssemblyTree.registerRepresentationItem(repItem)

Arguments:

• repItem (RepresentationItem()) – None

Return type:

void

registerTreeNodeInLayer

IAssemblyTree.registerTreeNodeInLayer(node, authoredLayerId)

Arguments:

• node (AnyTreeNode()) – None
• authoredLayerId (AuthoredLayerId()) – None

Return type:

void

registerViewFrame

IAssemblyTree.registerViewFrame(node, inclusionKey)

Arguments:

• node (ViewFrame()) – None
• inclusionKey (InclusionKey()) – None

Return type:

void

requestNodes

IAssemblyTree.requestNodes(treeLoader, nodes, isImplicitlyRequested)

Arguments:

• treeLoader (TreeLoader()) – None
• nodes ([AnyTreeNode]()) – None
• isImplicitlyRequested (boolean()) – None

Return type:

Promise <void>

reset

IAssemblyTree.reset()

Return type:Promise <void>

seenExternalModel

IAssemblyTree.seenExternalModel()

Return type:boolean

setAutomaticMeasurementUnitScaling

IAssemblyTree.setAutomaticMeasurementUnitScaling(value)

Arguments:

• value (boolean()) – None

Return type:

void

setInitiallyHiddenStayHidden

IAssemblyTree.setInitiallyHiddenStayHidden(value)

Arguments:

• value (boolean()) – None

Return type:

void

setPart

IAssemblyTree.setPart(referrer, partDef)

Arguments:

• referrer (ProductOccurrence()) – None
• partDef (PartDefinition()) – None

Return type:

void

setViewAxes

IAssemblyTree.setViewAxes(frontVec, upVec)

Arguments:

• frontVec (Point3()) – None
• upVec (Point3()) – None

Return type:

void

tryParseHeader

IAssemblyTree.tryParseHeader(possibleHeaderData)

Arguments:

• possibleHeaderData (Uint8Array()) – None

Return type:

null | Promise <AssemblyDataHeader>

updateLayerName

IAssemblyTree.updateLayerName(layerId, layerName)

Arguments:

• layerId (LayerId()) – None
• layerName (string()) – None

Return type:

void