IAssemblyTree

class IAssemblyTree()

Index

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

IAssemblyTree.activateCadConfiguration()

activateCadConfiguration(node: ProductOccurrence): void

Parameters

node: ProductOccurrence

Returns: void

IAssemblyTree.activateCadView()

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

Parameters

view: IView

cadView: CadView

duration: number

massageCamera: boolean

Returns: Promise

IAssemblyTree.addFilter()

addFilter(filter: Filter, loadContext: LoadContext): void

Parameters

filter: Filter

loadContext: LoadContext

Returns: void

IAssemblyTree.allowNodeDeletion()

allowNodeDeletion(node: DeletableNode): void

Parameters

node: DeletableNode

Returns: void

IAssemblyTree.containsDrawings()

containsDrawings(): boolean

Returns: boolean

IAssemblyTree.createCadView()

createCadView(engine: IScEngine, parent: ProductOccurrence, name: string, camera: Camera, pmis: (None | Pmi[]), productOccurrencesToShow: number[], productOccurrencesToHide: number[], transformMap: Map, cuttingPlane: (None | Plane), meshInstanceData: (None | MeshInstanceData)): CadView

Parameters

engine: IScEngine

parent: ProductOccurrence

name: string

camera: Camera

pmis: (None | Pmi[])

productOccurrencesToShow: number[]

productOccurrencesToHide: number[]

transformMap: Map

cuttingPlane: (None | Plane)

meshInstanceData: (None | MeshInstanceData)

Returns: CadView

IAssemblyTree.createLayer()

createLayer(authoredLayerId: AuthoredLayerId, layerName: (None | string), loadContext: LoadContext): Layer

Parameters

authoredLayerId: AuthoredLayerId

layerName: (None | string)

loadContext: LoadContext

Returns: Layer

IAssemblyTree.createMeshInstance()

createMeshInstance(markLoaded: boolean, inclusionKey: InclusionKey, instanceKey: InstanceKey, authoredId: (None | number), name: (None | string), parent: ProductOccurrence, preventFromResetting: boolean, isOutOfHierarchy: boolean, initiallyVisible: boolean, implicitBody: boolean): BodyInstance

Parameters

markLoaded: boolean

inclusionKey: InclusionKey

instanceKey: InstanceKey

authoredId: (None | number)

name: (None | string)

parent: ProductOccurrence

preventFromResetting: boolean

isOutOfHierarchy: boolean

initiallyVisible: boolean

implicitBody: boolean

Returns: BodyInstance

IAssemblyTree.createNode()

createNode(parent: ProductOccurrence, nodeName: string, authoredId: (None | number), localMatrix: (None | Matrix16), visibility: boolean, measurementUnit: (None | number)): ProductOccurrence

Parameters

parent: ProductOccurrence

nodeName: string

authoredId: (None | number)

localMatrix: (None | Matrix16)

visibility: boolean

measurementUnit: (None | number)

Returns: ProductOccurrence

IAssemblyTree.createPart()

createPart(authoredNodeId: (None | number)): PartDefinition

Parameters

authoredNodeId: (None | number)

Returns: PartDefinition

IAssemblyTree.createPmiInstance()

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

Parameters

inclusionKey: InclusionKey

instanceKey: InstanceKey

authoredId: (None | number)

name: (None | string)

parent: ProductOccurrence

pmiType: PmiType

pmiSubType: PmiSubType

topoRefs: ReferenceOnTopology[]

Returns: Pmi

IAssemblyTree.deactivateActiveCadView()

deactivateActiveCadView(): Promise

Returns: Promise

IAssemblyTree.deleteNode()

deleteNode(node: (ProductOccurrence | Pmi | BodyInstance)): Promise

Parameters

node: (ProductOccurrence | Pmi | BodyInstance)

Returns: Promise

IAssemblyTree.disableAutomaticFitWorld()

disableAutomaticFitWorld(): boolean

Returns: boolean

IAssemblyTree.enqueue()

enqueue(lazyPromise: LazyLike<Promise>): Promise

Parameters

lazyPromise: LazyLike<Promise>

Returns: Promise

IAssemblyTree.forEachCadConfiguration()

forEachCadConfiguration(callback: (node: ProductOccurrence) => void): void

Parameters

callback: (node: ProductOccurrence) => void

Returns: void

IAssemblyTree.forEachCadView()

forEachCadView(callback: (node: CadView) => void): void

Parameters

callback: (node: CadView) => void

Returns: void

IAssemblyTree.forEachPmi()

forEachPmi(callback: (node: Pmi) => void): void

Parameters

callback: (node: Pmi) => void

Returns: void

IAssemblyTree.generateDrawingSheetName()

generateDrawingSheetName(): string

Returns: string

IAssemblyTree.generateDrawingViewName()

generateDrawingViewName(): string

Returns: string

IAssemblyTree.generateDynamicNodeId()

generateDynamicNodeId(): number

Returns: number

IAssemblyTree.generateGroupName()

generateGroupName(): string

Returns: string

IAssemblyTree.generateProductName()

generateProductName(): string

Returns: string

IAssemblyTree.genericTypeToNodes()

genericTypeToNodes(): Map

Returns: Map

IAssemblyTree.getAbstractScEngine()

getAbstractScEngine(): IScEngine

Returns: IScEngine

IAssemblyTree.getActiveCadConfiguration()

getActiveCadConfiguration(): (None | ProductOccurrence)

Returns: (None | ProductOccurrence)

IAssemblyTree.getAutomaticMeasurementUnitScaling()

getAutomaticMeasurementUnitScaling(): boolean

Returns: boolean

IAssemblyTree.getCadConfigurations()

getCadConfigurations(): ProductOccurrence[]

Returns: ProductOccurrence[]

IAssemblyTree.getCadViewPmis()

getCadViewPmis(cadView: CadView): Pmi[]

Parameters

cadView: CadView

Returns: Pmi[]

IAssemblyTree.getDefaultCadConfiguration()

getDefaultCadConfiguration(): (None | ProductOccurrence)

Returns: (None | ProductOccurrence)

IAssemblyTree.getDefaultCadView()

getDefaultCadView(node: (None | ProductOccurrence)): (None | CadView)

Parameters

node: (None | ProductOccurrence)

Returns: (None | CadView)

IAssemblyTree.getFilterName()

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

Parameters

filterId: FilterId

Returns: (None | string)

IAssemblyTree.getFilters()

getFilters(): Map

Returns: Map

IAssemblyTree.getFiltersWithNode()

getFiltersWithNode(targetNode: AnyTreeNode): FilterId[]

Parameters

targetNode: AnyTreeNode

Returns: FilterId[]

IAssemblyTree.getFirstProductOccurrenceWithView()

getFirstProductOccurrenceWithView(): (None | ProductOccurrence)

Returns: (None | ProductOccurrence)

IAssemblyTree.getInclusionContexts()

getInclusionContexts(inclusionKey: InclusionKey): InclusionContext[]

Parameters

inclusionKey: InclusionKey

Returns: InclusionContext[]

IAssemblyTree.getInitiallyHiddenStayHidden()

getInitiallyHiddenStayHidden(): boolean

Returns: boolean

IAssemblyTree.getInstanceCountByInclusion()

getInstanceCountByInclusion(inclusionKey: InclusionKey): number

Parameters

inclusionKey: InclusionKey

Returns: number

IAssemblyTree.getLayerName()

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

Parameters

layerId: LayerId

Returns: (None | string)

IAssemblyTree.getLayers()

getLayers(): Map

Returns: Map

IAssemblyTree.getLayersIdFromName()

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

Parameters

name: string

Returns: (None | LayerId[])

IAssemblyTree.getLowestAvailableNodeId()

getLowestAvailableNodeId(): number

Returns: number

IAssemblyTree.getNodesByGenericId()

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

Parameters

genericId: string

Returns: (None | Set)

IAssemblyTree.getNodesByGenericType()

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

Parameters

genericType: string

Returns: (None | Set)

IAssemblyTree.getNodesFromFilterIds()

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

Parameters

filterIds: FilterId[]

Returns: (None | FilteredNodes)

IAssemblyTree.getNodesFromLayer()

getNodesFromLayer(layerId: LayerId, onlyTreeNodes: boolean): (None | AnyTreeNode[])

Parameters

layerId: LayerId

onlyTreeNodes: boolean

Returns: (None | AnyTreeNode[])

IAssemblyTree.getNodesFromLayerName()

getNodesFromLayerName(layerName: string, onlyTreeNodes: boolean): (None | AnyTreeNode[])

Parameters

layerName: string

onlyTreeNodes: boolean

Returns: (None | AnyTreeNode[])

IAssemblyTree.getNodesFromLayers()

getNodesFromLayers(layerIds: LayerId[], onlyTreeNodes: boolean): (None | AnyTreeNode[])

Parameters

layerIds: LayerId[]

onlyTreeNodes: boolean

Returns: (None | AnyTreeNode[])

IAssemblyTree.getRelationshipsOfItem()

getRelationshipsOfItem(contextNodeId: number, node: string): Map

Parameters

contextNodeId: number

node: string

Returns: Map

IAssemblyTree.getRootNode()

getRootNode(): ProductOccurrence

Returns: ProductOccurrence

IAssemblyTree.getUniqueLayerNames()

getUniqueLayerNames(): string[]

Returns: string[]

IAssemblyTree.hasActiveCadView()

hasActiveCadView(): boolean

Returns: boolean

IAssemblyTree.initialize()

initialize(scAttacher: ScAttacher): void

Parameters

scAttacher: ScAttacher

Returns: void

IAssemblyTree.isBeingRequested()

isBeingRequested(startNode: (AnyTreeNode | AnyTreeContext)): boolean

Parameters

startNode: (AnyTreeNode | AnyTreeContext)

Returns: boolean

IAssemblyTree.isInitialized()

isInitialized(): boolean

Returns: boolean

IAssemblyTree.isMeasurable()

isMeasurable(): boolean

Returns: boolean

IAssemblyTree.lookupAnyBody()

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

Parameters

nodeId: number

Returns: (None | AnyBody)

IAssemblyTree.lookupAnyBodyByInstanceInc()

lookupAnyBodyByInstanceInc(inclusionKey: InclusionKey, instanceKey: InstanceKey): (None | AnyBody)

Parameters

inclusionKey: InclusionKey

instanceKey: InstanceKey

Returns: (None | AnyBody)

IAssemblyTree.lookupAnyNode()

lookupAnyNode(nodeId: number): (None | AnyNode)

Parameters

nodeId: number

Returns: (None | AnyNode)

IAssemblyTree.lookupAnyNonTreeNode()

lookupAnyNonTreeNode(nodeId: number): (None | AnyNonTreeNode)

Parameters

nodeId: number

Returns: (None | AnyNonTreeNode)

IAssemblyTree.lookupAnyTreeNode()

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

Parameters

nodeId: number

Returns: (None | AnyTreeNode)

IAssemblyTree.lookupBodyInstance()

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

Parameters

nodeId: number

Returns: (None | BodyInstance)

IAssemblyTree.lookupCadView()

lookupCadView(nodeId: number): (None | CadView)

Parameters

nodeId: number

Returns: (None | CadView)

IAssemblyTree.lookupPartDefinition()

lookupPartDefinition(nodeId: number): (None | PartDefinition)

Parameters

nodeId: number

Returns: (None | PartDefinition)

IAssemblyTree.lookupPartDefinitionByDataId()

lookupPartDefinitionByDataId(loadContext: LoadContext, modelKey: ModelKey, dataKey: DataKey): (None | LazyPromise)

Parameters

loadContext: LoadContext

modelKey: ModelKey

dataKey: DataKey

Returns: (None | LazyPromise)

IAssemblyTree.lookupPmi()

lookupPmi(nodeId: number): (None | Pmi)

Parameters

nodeId: number

Returns: (None | Pmi)

IAssemblyTree.lookupPmiBody()

lookupPmiBody(nodeId: number): (None | PmiBody)

Parameters

nodeId: number

Returns: (None | PmiBody)

IAssemblyTree.lookupProductOccurrence()

lookupProductOccurrence(nodeId: number): (None | ProductOccurrence)

Parameters

nodeId: number

Returns: (None | ProductOccurrence)

IAssemblyTree.lookupPrototypeByDataId()

lookupPrototypeByDataId(loadContext: LoadContext, modelKey: ModelKey, dataKey: DataKey): (None | SharedPrototypeContext)

Parameters

loadContext: LoadContext

modelKey: ModelKey

dataKey: DataKey

Returns: (None | SharedPrototypeContext)

IAssemblyTree.lookupRepresentationItem()

lookupRepresentationItem(nodeId: number): (None | RepresentationItem)

Parameters

nodeId: number

Returns: (None | RepresentationItem)

IAssemblyTree.lookupViewFrame()

lookupViewFrame(nodeId: number): (None | ViewFrame)

Parameters

nodeId: number

Returns: (None | ViewFrame)

IAssemblyTree.markImplicitNodesOutOfHierarchy()

markImplicitNodesOutOfHierarchy(): boolean

Returns: boolean

IAssemblyTree.markSeenExternalModel()

markSeenExternalModel(): void

Returns: void

IAssemblyTree.massageAuthoredUserId()

massageAuthoredUserId(inclusionContext: InclusionContext, authoredId: (None | number)): number

Parameters

inclusionContext: InclusionContext

authoredId: (None | number)

Returns: number

IAssemblyTree.newNodeIdOffset()

newNodeIdOffset(): number

Returns: number

IAssemblyTree.onDemandRequestsActive()

onDemandRequestsActive(): boolean

Returns: boolean

IAssemblyTree.onLoadBegin()

onLoadBegin(): number

Returns: number

IAssemblyTree.onLoadEnd()

onLoadEnd(loadId: number): void

Parameters

loadId: number

Returns: void

IAssemblyTree.preventMeshDeletion()

preventMeshDeletion(meshKey: MeshKey): void

Parameters

meshKey: MeshKey

Returns: void

IAssemblyTree.preventNodeDeletion()

preventNodeDeletion(node: DeletableNode): void

Parameters

node: DeletableNode

Returns: void

IAssemblyTree.registerBodyInstance()

registerBodyInstance(node: BodyInstance, inclusionKey: InclusionKey): void

Parameters

node: BodyInstance

inclusionKey: InclusionKey

Returns: void

IAssemblyTree.registerCadView()

registerCadView(node: CadView): void

Parameters

node: CadView

Returns: void

IAssemblyTree.registerGenericGlobalId()

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

Parameters

node: AnyTreeNode

genericId: string

Returns: void

IAssemblyTree.registerGenericType()

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

Parameters

node: AnyTreeNode

genericType: string

Returns: void

IAssemblyTree.registerInclusionContext()

registerInclusionContext(context: InclusionContext): void

Parameters

context: InclusionContext

Returns: void

IAssemblyTree.registerNodeInLayer()

registerNodeInLayer(node: AnyTreeNode, authoredLayerId: AuthoredLayerId): void

Parameters

node: AnyTreeNode

authoredLayerId: AuthoredLayerId

Returns: void

IAssemblyTree.registerPartDefinition()

registerPartDefinition(partDef: PartDefinition): void

Parameters

partDef: PartDefinition

Returns: void

IAssemblyTree.registerPartDefinitionByDataId()

registerPartDefinitionByDataId(loadContext: LoadContext, modelKey: ModelKey, dataKey: DataKey, partDefinition: LazyPromise): void

Parameters

loadContext: LoadContext

modelKey: ModelKey

dataKey: DataKey

partDefinition: LazyPromise

Returns: void

IAssemblyTree.registerPmi()

registerPmi(node: Pmi): void

Parameters

node: Pmi

Returns: void

IAssemblyTree.registerPmiBody()

registerPmiBody(node: PmiBody, inclusionKey: InclusionKey): void

Parameters

node: PmiBody

inclusionKey: InclusionKey

Returns: void

IAssemblyTree.registerProductOccurrence()

registerProductOccurrence(node: ProductOccurrence): void

Parameters

node: ProductOccurrence

Returns: void

IAssemblyTree.registerPrototypeByDataId()

registerPrototypeByDataId(loadContext: LoadContext, modelKey: ModelKey, dataKey: DataKey, prototype: SharedPrototypeContext): void

Parameters

loadContext: LoadContext

modelKey: ModelKey

dataKey: DataKey

prototype: SharedPrototypeContext

Returns: void

IAssemblyTree.registerRepresentationItem()

registerRepresentationItem(repItem: RepresentationItem): void

Parameters

repItem: RepresentationItem

Returns: void

IAssemblyTree.registerTreeNodeInLayer()

registerTreeNodeInLayer(node: AnyTreeNode, authoredLayerId: AuthoredLayerId): void

Parameters

node: AnyTreeNode

authoredLayerId: AuthoredLayerId

Returns: void

IAssemblyTree.registerViewFrame()

registerViewFrame(node: ViewFrame, inclusionKey: InclusionKey): void

Parameters

node: ViewFrame

inclusionKey: InclusionKey

Returns: void

IAssemblyTree.requestNodes()

requestNodes(treeLoader: TreeLoader, nodes: AnyTreeNode[], isImplicitlyRequested: boolean): Promise

Parameters

treeLoader: TreeLoader

nodes: AnyTreeNode[]

isImplicitlyRequested: boolean

Returns: Promise

IAssemblyTree.reset()

reset(): Promise

Returns: Promise

IAssemblyTree.seenExternalModel()

seenExternalModel(): boolean

Returns: boolean

IAssemblyTree.setAutomaticMeasurementUnitScaling()

setAutomaticMeasurementUnitScaling(value: boolean): void

Parameters

value: boolean

Returns: void

IAssemblyTree.setInitiallyHiddenStayHidden()

setInitiallyHiddenStayHidden(value: boolean): void

Parameters

value: boolean

Returns: void

IAssemblyTree.setPart()

setPart(referrer: ProductOccurrence, partDef: PartDefinition): void

Parameters

referrer: ProductOccurrence

partDef: PartDefinition

Returns: void

IAssemblyTree.setViewAxes()

setViewAxes(frontVec: Point3, upVec: Point3): void

Parameters

frontVec: Point3

upVec: Point3

Returns: void

IAssemblyTree.tryParseHeader()

tryParseHeader(possibleHeaderData: Uint8Array): (None | Promise)

Parameters

possibleHeaderData: Uint8Array

Returns: (None | Promise)

IAssemblyTree.updateLayerName()

updateLayerName(layerId: LayerId, layerName: string): void

Parameters

layerId: LayerId

layerName: string

Returns: void