AssemblyTree

class AssemblyTree()

Constructors

constructor()

Properties

__AssemblyTree

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()

Constructors

AssemblyTree.constructor(config, engine, callbackManager, cuttingManager, model)

Arguments:	config (`AssemblyTreeConfig()`) – None engine (`IScEngine()`) – None callbackManager (`ICallbackManager()`) – None cuttingManager (`AbstractCuttingManager()`) – None model (`IModel()`) – None
Return type:	`AssemblyTree()`

Properties

AssemblyTree.__AssemblyTree

Type:	PhantomMember

Methods

activateCadConfiguration

AssemblyTree.activateCadConfiguration(node)

Arguments:	node (`ProductOccurrence()`) – None
Return type:	void

activateCadView

AssemblyTree.activateCadView(view, cadView, duration, massageCamera)

Arguments:	view (`IView()`) – None cadView (`CadView()`) – None duration (`number()`) – None massageCamera (`boolean()`) – None
Return type:	Promise <void>

addFilter

AssemblyTree.addFilter(filter, loadContext)

Arguments:	filter (`Filter()`) – None loadContext (`LoadContext()`) – None
Return type:	void

allowNodeDeletion

AssemblyTree.allowNodeDeletion(node)

Arguments:	node (DeletableNode) – None
Return type:	void

containsDrawings

AssemblyTree.containsDrawings()

Return type:	boolean

createCadView

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

Arguments:

engine (IScEngine()) – None
parent (CadViewParent) – None
name (string()) – None
camera (Camera()) – None
pmis ([Pmi()] | null) – None
productOccurrencesToShow ([RuntimeNodeId]) – None
productOccurrencesToHide ([RuntimeNodeId]) – None
transformMap (Map <RuntimeNodeId, Matrix16>) – None
cuttingPlane (Plane | null) – None
meshInstanceData (MeshInstanceData() | null) – None

Return type:

CadView()

createLayer

AssemblyTree.createLayer(authoredLayerId, layerName, loadContext)

Arguments:	authoredLayerId (AuthoredLayerId) – layerName (LayerName \| null) – loadContext (`LoadContext()`) –
Return type:	`Layer()`

createMeshInstance

AssemblyTree.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

AssemblyTree.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()`) – None
Return type:	`ProductOccurrence()`

createPart

AssemblyTree.createPart(authoredNodeId)

Arguments:	authoredNodeId (AuthoredNodeId \| null) – None
Return type:	`PartDefinition()`

createPmiInstance

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

Arguments:	inclusionKey (`InclusionKey()`) – None instanceKey (`InstanceKey()`) – None authoredId (AuthoredNodeId \| null) – None name (`string \| null()`) – None parent (`ProductOccurrence()`) – None pmiType (`PmiType()`) – None pmiSubType (PmiSubType) – None topoRefs ([`ReferenceOnTopology()`]) – None
Return type:	`Pmi()`

deactivateActiveCadView

AssemblyTree.deactivateActiveCadView()

Return type:	Promise <void>

deleteNode

AssemblyTree.deleteNode(node)

Arguments:	node (`ProductOccurrence()` \| `BodyInstance()` \| `Pmi()`) – None
Return type:	Promise <void>

disableAutomaticFitWorld

AssemblyTree.disableAutomaticFitWorld()

Return type:	boolean

enqueue

AssemblyTree.enqueue(lazyPromise)

Arguments:	lazyPromise (LazyLike <Promise <T>>) – None
Return type:	Promise <T>

forEachCadConfiguration

AssemblyTree.forEachCadConfiguration(callback)

Arguments:	callback (`function()`) – None
Return type:	void

AssemblyTree.callback(node)

Arguments:	node (`ProductOccurrence()`) – None
Return type:	void

forEachCadView

AssemblyTree.forEachCadView(callback)

Arguments:	callback (`function()`) – None
Return type:	void

AssemblyTree.callback(node)

Arguments:	node (`CadView()`) – None
Return type:	void

forEachPmi

AssemblyTree.forEachPmi(callback)

Arguments:	callback (`function()`) – None
Return type:	void

AssemblyTree.callback(node)

Arguments:	node (`Pmi()`) – None
Return type:	void

generateDrawingSheetName

AssemblyTree.generateDrawingSheetName()

Return type:	string

generateDrawingViewName

AssemblyTree.generateDrawingViewName()

Return type:	string

generateDynamicNodeId

AssemblyTree.generateDynamicNodeId()

Return type:	DynamicNodeId

generateGroupName

AssemblyTree.generateGroupName()

Return type:	string

generateProductName

AssemblyTree.generateProductName()

Return type:	string

genericTypeToNodes

AssemblyTree.genericTypeToNodes()

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

getAbstractScEngine

AssemblyTree.getAbstractScEngine()

Return type:	`IScEngine()`

getActiveCadConfiguration

AssemblyTree.getActiveCadConfiguration()

Return type:	`ProductOccurrence()` \| null

getAutomaticMeasurementUnitScaling

AssemblyTree.getAutomaticMeasurementUnitScaling()

Return type:	boolean

getCadConfigurations

AssemblyTree.getCadConfigurations()

Return type:	[`ProductOccurrence()`]

getCadViewPmis

AssemblyTree.getCadViewPmis(cadView)

Arguments:	cadView (`CadView()`) – None
Return type:	[`Pmi()`]

getDefaultCadConfiguration

AssemblyTree.getDefaultCadConfiguration()

Return type:	`ProductOccurrence()` \| null

getDefaultCadView

AssemblyTree.getDefaultCadView(node)

Arguments:	node (`ProductOccurrence()` \| null) – None
Return type:	`CadView()` \| null

getFilterName

AssemblyTree.getFilterName(filterId)

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

getFilters

AssemblyTree.getFilters()

Return type:	Map <FilterId, FilterName>

getFiltersWithNode

AssemblyTree.getFiltersWithNode(targetNode)

Arguments:	targetNode (AnyTreeNode) – None
Return type:	[FilterId]

getFirstProductOccurrenceWithView

AssemblyTree.getFirstProductOccurrenceWithView()

Return type:	`ProductOccurrence()` \| null

getInclusionContexts

AssemblyTree.getInclusionContexts(inclusionKey)

Arguments:	inclusionKey (`InclusionKey()`) – None
Return type:	[`InclusionContext()`]

getInitiallyHiddenStayHidden

AssemblyTree.getInitiallyHiddenStayHidden()

Return type:	boolean

getInstanceCountByInclusion

AssemblyTree.getInstanceCountByInclusion(inclusionKey)

Arguments:	inclusionKey (`InclusionKey()`) – None
Return type:	number

getLayerName

AssemblyTree.getLayerName(layerId)

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

getLayers

AssemblyTree.getLayers()

Return type:	Map <LayerId, LayerName>

getLayersIdFromName

AssemblyTree.getLayersIdFromName(name)

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

getLowestAvailableNodeId

AssemblyTree.getLowestAvailableNodeId()

Return type:	RuntimeNodeId

getNodesByGenericId

AssemblyTree.getNodesByGenericId(genericId)

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

getNodesByGenericType

AssemblyTree.getNodesByGenericType(genericType)

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

getNodesFromFilterIds

AssemblyTree.getNodesFromFilterIds(filterIds)

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

getNodesFromLayer

AssemblyTree.getNodesFromLayer(layerId[, onlyTreeNodes])

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

getNodesFromLayerName

AssemblyTree.getNodesFromLayerName(layerName[, onlyTreeNodes])

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

getNodesFromLayers

AssemblyTree.getNodesFromLayers(layerIds[, onlyTreeNodes])

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

getRelationshipsOfItem

AssemblyTree.getRelationshipsOfItem(contextNodeId, node)

Arguments:	contextNodeId (RuntimeNodeId) – None node (BimId) – None
Return type:	Map <RelationshipType, `BimRelationship()`>

getRootNode

AssemblyTree.getRootNode()

Return type:	`ProductOccurrence()`

getUniqueLayerNames

AssemblyTree.getUniqueLayerNames()

Return type:	[LayerName]

hasActiveCadView

AssemblyTree.hasActiveCadView()

Return type:	boolean

initialize

AssemblyTree.initialize(scAttacher)

Arguments:	scAttacher (`ScAttacher()`) – None
Return type:	void

isBeingRequested

AssemblyTree.isBeingRequested(startNode)

Arguments:	startNode (AnyTreeNode \| AnyTreeContext) – None
Return type:	boolean

isInitialized

AssemblyTree.isInitialized()

Return type:	boolean

isMeasurable

AssemblyTree.isMeasurable()

Return type:	boolean

lookupAnyBody

AssemblyTree.lookupAnyBody(nodeId)

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

lookupAnyBodyByInstanceInc

AssemblyTree.lookupAnyBodyByInstanceInc(inclusionKey, instanceKey)

Arguments:	inclusionKey (`InclusionKey()`) – None instanceKey (`InstanceKey()`) – None
Return type:	AnyBody \| null

lookupAnyNode

AssemblyTree.lookupAnyNode(nodeId)

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

lookupAnyNonTreeNode

AssemblyTree.lookupAnyNonTreeNode(nodeId)

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

lookupAnyTreeNode

AssemblyTree.lookupAnyTreeNode(nodeId)

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

lookupBodyInstance

AssemblyTree.lookupBodyInstance(nodeId)

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

lookupCadView

AssemblyTree.lookupCadView(nodeId)

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

lookupPartDefinition

AssemblyTree.lookupPartDefinition(nodeId)

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

lookupPartDefinitionByDataId

AssemblyTree.lookupPartDefinitionByDataId(loadContext, modelKey, dataKey)

Arguments:	loadContext (`LoadContext()`) – None modelKey (`ModelKey()`) – None dataKey (`DataKey()`) – None
Return type:	`LazyPromise()` <`PartDefinition()`> \| null

lookupPmi

AssemblyTree.lookupPmi(nodeId)

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

lookupPmiBody

AssemblyTree.lookupPmiBody(nodeId)

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

lookupProductOccurrence

AssemblyTree.lookupProductOccurrence(nodeId)

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

lookupPrototypeByDataId

AssemblyTree.lookupPrototypeByDataId(loadContext, modelKey, dataKey)

Arguments:	loadContext (`LoadContext()`) – None modelKey (`ModelKey()`) – None dataKey (`DataKey()`) – None
Return type:	`SharedPrototypeContext()` \| null

lookupRepresentationItem

AssemblyTree.lookupRepresentationItem(nodeId)

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

lookupViewFrame

AssemblyTree.lookupViewFrame(nodeId)

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

markImplicitNodesOutOfHierarchy

AssemblyTree.markImplicitNodesOutOfHierarchy()

Return type:	boolean

markSeenExternalModel

AssemblyTree.markSeenExternalModel()

Return type:	void

massageAuthoredUserId

AssemblyTree.massageAuthoredUserId(inclusionContext, authoredId)

Arguments:	inclusionContext (`InclusionContext()`) – None authoredId (AuthoredNodeId \| null) – None
Return type:	AuthoredNodeId \| DynamicNodeId

newNodeIdOffset

AssemblyTree.newNodeIdOffset()

Return type:	NodeIdOffset

onDemandRequestsActive

AssemblyTree.onDemandRequestsActive()

Return type:	boolean

onLoadBegin

AssemblyTree.onLoadBegin()

Return type:	LoadId

onLoadEnd

AssemblyTree.onLoadEnd(loadId)

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

preventMeshDeletion

AssemblyTree.preventMeshDeletion(meshKey)

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

preventNodeDeletion

AssemblyTree.preventNodeDeletion(node)

Arguments:	node (DeletableNode) – None
Return type:	void

registerBodyInstance

AssemblyTree.registerBodyInstance(node, inclusionKey)

Arguments:	node (`BodyInstance()`) – None inclusionKey (`InclusionKey()`) – None
Return type:	void

registerCadView

AssemblyTree.registerCadView(node)

Arguments:	node (`CadView()`) – None
Return type:	void

registerGenericGlobalId

AssemblyTree.registerGenericGlobalId(node, genericId)

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

registerGenericType

AssemblyTree.registerGenericType(node, genericType)

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

registerInclusionContext

AssemblyTree.registerInclusionContext(context)

Arguments:	context (`InclusionContext()`) – None
Return type:	void

registerNodeInLayer

AssemblyTree.registerNodeInLayer(node, authoredLayerId)

Arguments:	node (AnyTreeNode) – authoredLayerId (AuthoredLayerId) –
Return type:	void

registerPartDefinition

AssemblyTree.registerPartDefinition(partDef)

Arguments:	partDef (`PartDefinition()`) – None
Return type:	void

registerPartDefinitionByDataId

AssemblyTree.registerPartDefinitionByDataId(loadContext, modelKey, dataKey, partDefinition)

Arguments:	loadContext (`LoadContext()`) – None modelKey (`ModelKey()`) – None dataKey (`DataKey()`) – None partDefinition (`LazyPromise()` <`PartDefinition()`>) – None
Return type:	void

registerPmi

AssemblyTree.registerPmi(node)

Arguments:	node (`Pmi()`) – None
Return type:	void

registerPmiBody

AssemblyTree.registerPmiBody(node, inclusionKey)

Arguments:	node (`PmiBody()`) – None inclusionKey (`InclusionKey()`) – None
Return type:	void

registerProductOccurrence

AssemblyTree.registerProductOccurrence(node)

Arguments:	node (`ProductOccurrence()`) – None
Return type:	void

registerPrototypeByDataId

AssemblyTree.registerPrototypeByDataId(loadContext, modelKey, dataKey, prototype)

Arguments:	loadContext (`LoadContext()`) – None modelKey (`ModelKey()`) – None dataKey (`DataKey()`) – None prototype (`SharedPrototypeContext()`) – None
Return type:	void

registerRepresentationItem

AssemblyTree.registerRepresentationItem(repItem)

Arguments:	repItem (`RepresentationItem()`) – None
Return type:	void

registerTreeNodeInLayer

AssemblyTree.registerTreeNodeInLayer(node, authoredLayerId)

Arguments:	node (AnyTreeNode) – authoredLayerId (AuthoredLayerId) –
Return type:	void

registerViewFrame

AssemblyTree.registerViewFrame(node, inclusionKey)

Arguments:	node (`ViewFrame()`) – None inclusionKey (`InclusionKey()`) – None
Return type:	void

requestNodes

AssemblyTree.requestNodes(treeLoader, nodes, isImplicitlyRequested)

Arguments:	treeLoader (`TreeLoader()`) – None nodes ([AnyTreeNode]) – None isImplicitlyRequested (`boolean()`) – None
Return type:	Promise <void>

reset

AssemblyTree.reset()

Return type:	Promise <void>

seenExternalModel

AssemblyTree.seenExternalModel()

Return type:	boolean

setAutomaticMeasurementUnitScaling

AssemblyTree.setAutomaticMeasurementUnitScaling(value)

Arguments:	value (`boolean()`) – None
Return type:	void

setInitiallyHiddenStayHidden

AssemblyTree.setInitiallyHiddenStayHidden(value)

Arguments:	value (`boolean()`) – None
Return type:	void

setPart

AssemblyTree.setPart(referrer, partDef)

Arguments:	referrer (`ProductOccurrence()`) – None partDef (`PartDefinition()`) – None
Return type:	void

setViewAxes

AssemblyTree.setViewAxes(frontVec, upVec)

Arguments:	frontVec (`Point3()`) – None upVec (`Point3()`) – None
Return type:	void

tryParseHeader

AssemblyTree.tryParseHeader(possibleHeaderData)

Arguments:	possibleHeaderData (`Uint8Array()`) – None
Return type:	Promise <`AssemblyDataHeader()`> \| null

updateLayerName

AssemblyTree.updateLayerName(layerId, layerName)

Arguments:	layerId (LayerId) – layerName (LayerName) –
Return type:	void