IAssemblyTree

class IAssemblyTree()

Methods


Methods

activateCadConfiguration

IAssemblyTree.activateCadConfiguration(node)
Arguments:
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:
Return type:

void

allowNodeDeletion

IAssemblyTree.allowNodeDeletion(node)
Arguments:
Return type:

void

containsDrawings

IAssemblyTree.containsDrawings()
Return type:boolean

createCadView

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

CadView()

createLayer

IAssemblyTree.createLayer(authoredLayerId, layerName, loadContext)
Arguments:
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 (AuthoredNodeId | null) – None
  • name (string | null()) – 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 (AuthoredNodeId | null) – None
  • localMatrix (Matrix16 | null()) – None
  • visibility (boolean()) – None
  • measurementUnit (number | null()) – optional None
Return type:

ProductOccurrence()

createPart

IAssemblyTree.createPart(authoredNodeId)
Arguments:
Return type:

PartDefinition()

createPmiInstance

IAssemblyTree.createPmiInstance(inclusionKey, instanceKey, authoredId, name, parent, pmiType, pmiSubType, topoRefs)
Arguments:
Return type:

Pmi()

deactivateActiveCadView

IAssemblyTree.deactivateActiveCadView()
Return type:Promise <void>

deleteNode

IAssemblyTree.deleteNode(node)
Arguments:
Return type:

Promise <void>

disableAutomaticFitWorld

IAssemblyTree.disableAutomaticFitWorld()
Return type:boolean

enqueue

IAssemblyTree.enqueue(lazyPromise)
Arguments:
  • lazyPromise (LazyLike <Promise <T>>) – None
Return type:

Promise <T>

forEachCadConfiguration

IAssemblyTree.forEachCadConfiguration(callback)
Arguments:
  • callback (function()) – None
Return type:

void

IAssemblyTree.callback(node)
Arguments:
Return type:

void

forEachCadView

IAssemblyTree.forEachCadView(callback)
Arguments:
  • callback (function()) – None
Return type:

void

IAssemblyTree.callback(node)
Arguments:
Return type:

void

forEachPmi

IAssemblyTree.forEachPmi(callback)
Arguments:
  • callback (function()) – None
Return type:

void

IAssemblyTree.callback(node)
Arguments:
Return type:

void

generateDrawingSheetName

IAssemblyTree.generateDrawingSheetName()
Return type:string

generateDrawingViewName

IAssemblyTree.generateDrawingViewName()
Return type:string

generateDynamicNodeId

IAssemblyTree.generateDynamicNodeId()
Return type:DynamicNodeId

generateGroupName

IAssemblyTree.generateGroupName()
Return type:string

generateProductName

IAssemblyTree.generateProductName()
Return type:string

genericTypeToNodes

IAssemblyTree.genericTypeToNodes()
Return type:Map <GenericType, Set <AnyTreeNode>>

getAbstractScEngine

IAssemblyTree.getAbstractScEngine()
Return type:IScEngine()

getActiveCadConfiguration

IAssemblyTree.getActiveCadConfiguration()
Return type:ProductOccurrence() | null

getAutomaticMeasurementUnitScaling

IAssemblyTree.getAutomaticMeasurementUnitScaling()
Return type:boolean

getCadConfigurations

IAssemblyTree.getCadConfigurations()
Return type:[ProductOccurrence()]

getCadViewPmis

IAssemblyTree.getCadViewPmis(cadView)
Arguments:
Return type:

[Pmi()]

getDefaultCadConfiguration

IAssemblyTree.getDefaultCadConfiguration()
Return type:ProductOccurrence() | null

getDefaultCadView

IAssemblyTree.getDefaultCadView(node)
Arguments:
Return type:

CadView() | null

getFilterName

IAssemblyTree.getFilterName(filterId)
Arguments:
Return type:

FilterName | null

getFilters

IAssemblyTree.getFilters()
Return type:Map <FilterId, FilterName>

getFiltersWithNode

IAssemblyTree.getFiltersWithNode(targetNode)
Arguments:
Return type:

[FilterId]

getFirstProductOccurrenceWithView

IAssemblyTree.getFirstProductOccurrenceWithView()
Return type:ProductOccurrence() | null

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:
Return type:

LayerName | null

getLayers

IAssemblyTree.getLayers()
Return type:Map <LayerId, LayerName>

getLayersIdFromName

IAssemblyTree.getLayersIdFromName(name)
Arguments:
Return type:

[LayerId] | null

getLowestAvailableNodeId

IAssemblyTree.getLowestAvailableNodeId()
Return type:RuntimeNodeId

getNodesByGenericId

IAssemblyTree.getNodesByGenericId(genericId)
Arguments:
Return type:

Set <AnyTreeNode> | null

getNodesByGenericType

IAssemblyTree.getNodesByGenericType(genericType)
Arguments:
Return type:

Set <AnyTreeNode> | null

getNodesFromFilterIds

IAssemblyTree.getNodesFromFilterIds(filterIds)
Arguments:
Return type:

FilteredNodes() | null

getNodesFromLayer

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

[AnyTreeNode] | null

getNodesFromLayerName

IAssemblyTree.getNodesFromLayerName(layerName[, onlyTreeNodes])
Arguments:
  • layerName (LayerName) – None
  • onlyTreeNodes (boolean()) – optional None
Return type:

[AnyTreeNode] | null

getNodesFromLayers

IAssemblyTree.getNodesFromLayers(layerIds[, onlyTreeNodes])
Arguments:
  • layerIds ([LayerId]) – None
  • onlyTreeNodes (boolean()) – optional None
Return type:

[AnyTreeNode] | null

getRelationshipsOfItem

IAssemblyTree.getRelationshipsOfItem(contextNodeId, node)
Arguments:
Return type:

Map <RelationshipType, BimRelationship()>

getRootNode

IAssemblyTree.getRootNode()
Return type:ProductOccurrence()

getUniqueLayerNames

IAssemblyTree.getUniqueLayerNames()
Return type:[LayerName]

hasActiveCadView

IAssemblyTree.hasActiveCadView()
Return type:boolean

initialize

IAssemblyTree.initialize(scAttacher)
Arguments:
Return type:

void

isBeingRequested

IAssemblyTree.isBeingRequested(startNode)
Arguments:
Return type:

boolean

isInitialized

IAssemblyTree.isInitialized()
Return type:boolean

isMeasurable

IAssemblyTree.isMeasurable()
Return type:boolean

lookupAnyBody

IAssemblyTree.lookupAnyBody(nodeId)
Arguments:
Return type:

AnyBody | null

lookupAnyBodyByInstanceInc

IAssemblyTree.lookupAnyBodyByInstanceInc(inclusionKey, instanceKey)
Arguments:
  • inclusionKey (InclusionKey()) – None
  • instanceKey (InstanceKey()) – None
Return type:

AnyBody | null

lookupAnyNode

IAssemblyTree.lookupAnyNode(nodeId)
Arguments:
Return type:

AnyNode | null

lookupAnyNonTreeNode

IAssemblyTree.lookupAnyNonTreeNode(nodeId)
Arguments:
Return type:

AnyNonTreeNode | null

lookupAnyTreeNode

IAssemblyTree.lookupAnyTreeNode(nodeId)
Arguments:
Return type:

AnyTreeNode | null

lookupBodyInstance

IAssemblyTree.lookupBodyInstance(nodeId)
Arguments:
Return type:

BodyInstance() | null

lookupCadView

IAssemblyTree.lookupCadView(nodeId)
Arguments:
Return type:

CadView() | null

lookupPartDefinition

IAssemblyTree.lookupPartDefinition(nodeId)
Arguments:
Return type:

PartDefinition() | null

lookupPartDefinitionByDataId

IAssemblyTree.lookupPartDefinitionByDataId(loadContext, modelKey, dataKey)
Arguments:
  • loadContext (LoadContext()) – None
  • modelKey (ModelKey()) – None
  • dataKey (DataKey()) – None
Return type:

LazyPromise() <PartDefinition()> | null

lookupPmi

IAssemblyTree.lookupPmi(nodeId)
Arguments:
Return type:

Pmi() | null

lookupPmiBody

IAssemblyTree.lookupPmiBody(nodeId)
Arguments:
Return type:

PmiBody() | null

lookupProductOccurrence

IAssemblyTree.lookupProductOccurrence(nodeId)
Arguments:
Return type:

ProductOccurrence() | null

lookupPrototypeByDataId

IAssemblyTree.lookupPrototypeByDataId(loadContext, modelKey, dataKey)
Arguments:
  • loadContext (LoadContext()) – None
  • modelKey (ModelKey()) – None
  • dataKey (DataKey()) – None
Return type:

SharedPrototypeContext() | null

lookupRepresentationItem

IAssemblyTree.lookupRepresentationItem(nodeId)
Arguments:
Return type:

RepresentationItem() | null

lookupViewFrame

IAssemblyTree.lookupViewFrame(nodeId)
Arguments:
Return type:

ViewFrame() | null

markImplicitNodesOutOfHierarchy

IAssemblyTree.markImplicitNodesOutOfHierarchy()
Return type:boolean

markSeenExternalModel

IAssemblyTree.markSeenExternalModel()
Return type:void

massageAuthoredUserId

IAssemblyTree.massageAuthoredUserId(inclusionContext, authoredId)
Arguments:
Return type:

AuthoredNodeId | DynamicNodeId

newNodeIdOffset

IAssemblyTree.newNodeIdOffset()
Return type:NodeIdOffset

onDemandRequestsActive

IAssemblyTree.onDemandRequestsActive()
Return type:boolean

onLoadBegin

IAssemblyTree.onLoadBegin()
Return type:LoadId

onLoadEnd

IAssemblyTree.onLoadEnd(loadId)
Arguments:
  • loadId (number()) – None
Return type:

void

preventMeshDeletion

IAssemblyTree.preventMeshDeletion(meshKey)
Arguments:
Return type:

void

preventNodeDeletion

IAssemblyTree.preventNodeDeletion(node)
Arguments:
Return type:

void

registerBodyInstance

IAssemblyTree.registerBodyInstance(node, inclusionKey)
Arguments:
  • node (BodyInstance()) – None
  • inclusionKey (InclusionKey()) – None
Return type:

void

registerCadView

IAssemblyTree.registerCadView(node)
Arguments:
Return type:

void

registerGenericGlobalId

IAssemblyTree.registerGenericGlobalId(node, genericId)
Arguments:
Return type:

void

registerGenericType

IAssemblyTree.registerGenericType(node, genericType)
Arguments:
Return type:

void

registerInclusionContext

IAssemblyTree.registerInclusionContext(context)
Arguments:
Return type:

void

registerNodeInLayer

IAssemblyTree.registerNodeInLayer(node, authoredLayerId)
Arguments:
Return type:

void

registerPartDefinition

IAssemblyTree.registerPartDefinition(partDef)
Arguments:
Return type:

void

registerPartDefinitionByDataId

IAssemblyTree.registerPartDefinitionByDataId(loadContext, modelKey, dataKey, partDefinition)
Arguments:
Return type:

void

registerPmi

IAssemblyTree.registerPmi(node)
Arguments:
Return type:

void

registerPmiBody

IAssemblyTree.registerPmiBody(node, inclusionKey)
Arguments:
  • node (PmiBody()) – None
  • inclusionKey (InclusionKey()) – None
Return type:

void

registerProductOccurrence

IAssemblyTree.registerProductOccurrence(node)
Arguments:
Return type:

void

registerPrototypeByDataId

IAssemblyTree.registerPrototypeByDataId(loadContext, modelKey, dataKey, prototype)
Arguments:
Return type:

void

registerRepresentationItem

IAssemblyTree.registerRepresentationItem(repItem)
Arguments:
Return type:

void

registerTreeNodeInLayer

IAssemblyTree.registerTreeNodeInLayer(node, authoredLayerId)
Arguments:
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:
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:
Return type:

void

setViewAxes

IAssemblyTree.setViewAxes(frontVec, upVec)
Arguments:
Return type:

void

tryParseHeader

IAssemblyTree.tryParseHeader(possibleHeaderData)
Arguments:
  • possibleHeaderData (Uint8Array()) – None
Return type:

Promise <AssemblyDataHeader()> | null

updateLayerName

IAssemblyTree.updateLayerName(layerId, layerName)
Arguments:
Return type:

void