IModel

class IModel()

Index

Methods

Methods

IModel._allowNodeDeletion()
_allowNodeDeletion(nodeId: number): void

Parameters

nodeId: number

Returns: void

IModel._firstAssemblyDataHeader()
_firstAssemblyDataHeader(): (None | AssemblyDataHeader)

Returns: (None | AssemblyDataHeader)

IModel._gatherInstanceIncsFromNodeIds()
_gatherInstanceIncsFromNodeIds(nodeIds: number[], allowedTypes: BodyTypeBits): InstanceIncs

Parameters

nodeIds: number[]

allowedTypes: BodyTypeBits

Returns: InstanceIncs

IModel._getModelStructure()
_getModelStructure(): IModelStructure

Returns: IModelStructure

IModel._getNodeFromInstanceInc()
_getNodeFromInstanceInc(markNodeLoadedIfCreated: boolean, inclusionKey: InclusionKey, instanceKey: InstanceKey, isOutOfHierarchy: boolean): number

Parameters

markNodeLoadedIfCreated: boolean

inclusionKey: InclusionKey

instanceKey: InstanceKey

isOutOfHierarchy: boolean

Returns: number

IModel._hwfAwaitAssemblyTreeReady()
_hwfAwaitAssemblyTreeReady(): Promise

Returns: Promise

IModel._preventMeshDeletion()
_preventMeshDeletion(meshId: MeshId): void

Parameters

meshId: MeshId

Returns: void

IModel._preventNodeDeletion()
_preventNodeDeletion(nodeId: number): void

Parameters

nodeId: number

Returns: void

IModel._setDefaultView()
_setDefaultView(view: IView): void

Parameters

view: IView

Returns: void

IModel._setInstanceModifier()
_setInstanceModifier(instanceModifier: InstanceModifier, nodeIds: number[], value: boolean, allowedTypes: BodyTypeBits): void

Parameters

instanceModifier: InstanceModifier

nodeIds: number[]

value: boolean

allowedTypes: BodyTypeBits

Returns: void

IModel._setModelStructure()
_setModelStructure(modelStructure: IModelStructure): void

Parameters

modelStructure: IModelStructure

Returns: void

IModel._setNodesMatrices()
_setNodesMatrices(nodeIds: number[], matrices: Matrix[], setAsInitial: boolean): Promise

Parameters

nodeIds: number[]

matrices: Matrix[]

setAsInitial: boolean

Returns: Promise

IModel.activateCadConfiguration()
activateCadConfiguration(nodeId: number, view: IView): Promise

Parameters

nodeId: number

view: IView

Returns: Promise

IModel.activateCadView()
activateCadView(nodeId: number, duration: number, massageCamera: boolean, view: IView): Promise

Parameters

nodeId: number

duration: number

massageCamera: boolean

view: IView

Returns: Promise

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

Parameters

fitNodes: boolean

view: IView

Returns: Promise

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

Parameters

duration: number

massageCamera: boolean

view: IView

Returns: Promise

IModel.addPropertyToNode()
addPropertyToNode(id: number, propertyName: string, propertyValue: string, propertyUnit: UnitElement[]): boolean

Parameters

id: number

propertyName: string

propertyValue: string

propertyUnit: UnitElement[]

Returns: boolean

IModel.cadConfigurationsEnabled()
cadConfigurationsEnabled(): Promise

Returns: Promise

IModel.clear()
clear(): Promise

Returns: Promise

IModel.clearNodeFaceVisibility()
clearNodeFaceVisibility(id: number): void

Parameters

id: number

Returns: void

IModel.clearNodeLineVisibility()
clearNodeLineVisibility(id: number): void

Parameters

id: number

Returns: void

IModel.clearNodePointVisibility()
clearNodePointVisibility(id: number): void

Parameters

id: number

Returns: void

IModel.computeMinimumBodyBodyDistance()
computeMinimumBodyBodyDistance(partId1: number, partId2: number): Promise

Parameters

partId1: number

partId2: number

Returns: Promise

IModel.computeMinimumFaceFaceDistance()
computeMinimumFaceFaceDistance(partId1: number, faceId1: number, partId2: number, faceId2: number): Promise

Parameters

partId1: number

faceId1: number

partId2: number

faceId2: number

Returns: Promise

IModel.computeMinimumFaceLineDistance()
computeMinimumFaceLineDistance(partId: number, faceId: number, ray: Ray): Promise

Parameters

partId: number

faceId: number

ray: Ray

Returns: Promise

IModel.computeMinimumFaceRayDistance()
computeMinimumFaceRayDistance(partId: number, faceId: number, ray: Ray): Promise

Parameters

partId: number

faceId: number

ray: Ray

Returns: Promise

IModel.createAndAddRepresentationItem()
createAndAddRepresentationItem(partNodeId: (undefined | None | number), repItemId: (None | number)): (None | number)

Parameters

partNodeId: (undefined | None | number)

repItemId: (None | number)

Returns: (None | number)

IModel.createCadView()
createCadView(nodeId: number, viewName: string, camera: Camera, pmiIds: (None | number[]), nodesToShow: (None | number[]), nodesToHide: (None | number[]), nodeIdsAndLocalTransforms: (None | [number, Matrix][]), cuttingPlane: (None | Plane), meshInstanceData: (None | MeshInstanceData)): (None | number)

Parameters

nodeId: number

viewName: string

camera: Camera

pmiIds: (None | number[])

nodesToShow: (None | number[])

nodesToHide: (None | number[])

nodeIdsAndLocalTransforms: (None | [number, Matrix][])

cuttingPlane: (None | Plane)

meshInstanceData: (None | MeshInstanceData)

Returns: (None | number)

IModel.createImage()
createImage(primaryImage: ImageOptions, thumbnailImage: ImageOptions): Promise

Parameters

primaryImage: ImageOptions

thumbnailImage: ImageOptions

Returns: Promise

IModel.createMesh()
createMesh(meshData: MeshData, config: { doNotDelete: boolean }): Promise

Parameters

meshData: MeshData

config: { doNotDelete: boolean }

Returns: Promise

IModel.createMeshInstance()
createMeshInstance(data: MeshInstanceData, parentNodeId: (None | number), preventFromResetting: (None | boolean), isOutOfHierarchy: (None | boolean)): Promise

Parameters

data: MeshInstanceData

parentNodeId: (None | number)

preventFromResetting: (None | boolean)

isOutOfHierarchy: (None | boolean)

Returns: Promise

IModel.createNode()
createNode(parentNodeId: (undefined | None | number), nodeName: string, nodeId: (None | number), localMatrix: (None | Matrix), visibility: (None | boolean), measurementUnit: (None | number)): number

Parameters

parentNodeId: (undefined | None | number)

nodeName: string

nodeId: (None | number)

localMatrix: (None | Matrix)

visibility: (None | boolean)

measurementUnit: (None | number)

Returns: number

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

Parameters

nodeId: (None | number)

Returns: number

IModel.createPmiInstance()
createPmiInstance(data: MeshInstanceData, pmiType: PmiType, pmiSubType: PmiSubType, refOnTopoItems: RefOnTopoItem[], parentNodeId: (None | number)): Promise

Parameters

data: MeshInstanceData

pmiType: PmiType

pmiSubType: PmiSubType

refOnTopoItems: RefOnTopoItem[]

parentNodeId: (None | number)

Returns: Promise

IModel.deleteImages()
deleteImages(imageIds: ImageId[]): Promise

Parameters

imageIds: ImageId[]

Returns: Promise

IModel.deleteMeshes()
deleteMeshes(ids: MeshId[]): Promise

Parameters

ids: MeshId[]

Returns: Promise

IModel.deleteMeshInstances()
deleteMeshInstances(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModel.deleteNode()
deleteNode(id: number): Promise

Parameters

id: number

Returns: Promise

IModel.getAbsoluteRootNode()
getAbsoluteRootNode(): number

Returns: number

IModel.getActiveCadConfiguration()
getActiveCadConfiguration(): (None | number)

Returns: (None | number)

IModel.getAssociatedModelKey()
getAssociatedModelKey(nodeId: number): Promise

Parameters

nodeId: number

Returns: Promise

IModel.getBimIdConnectedElements()
getBimIdConnectedElements(node: number, bimId: string, type: RelationshipType): { relateds: string[], relatings: string[] }

Parameters

node: number

bimId: string

type: RelationshipType

Returns: { relateds: string[], relatings: string[] }

IModel.getBimIdFromNode()
getBimIdFromNode(id: number): (None | string)

Parameters

id: number

Returns: (None | string)

IModel.getBimIdRelatedElements()
getBimIdRelatedElements(node: number, bimId: string, type: RelationshipType): string[]

Parameters

node: number

bimId: string

type: RelationshipType

Returns: string[]

IModel.getBimIdRelatingElements()
getBimIdRelatingElements(node: number, bimId: string, type: RelationshipType): string[]

Parameters

node: number

bimId: string

type: RelationshipType

Returns: string[]

IModel.getBimIdsFromGenericId()
getBimIdsFromGenericId(ifcGuid: string): string[]

Parameters

ifcGuid: string

Returns: string[]

IModel.getBimInfoFromBimId()
getBimInfoFromBimId(node: number, bimId: string): { connected: boolean, name: string }

Parameters

node: number

bimId: string

Returns: { connected: boolean, name: string }

IModel.getBranchVisibility()
getBranchVisibility(id: number): BranchVisibility

Parameters

id: number

Returns: BranchVisibility

IModel.getCadConfigurations()
getCadConfigurations(): IdStringMap

Returns: IdStringMap

IModel.getCadViewConfiguration()
getCadViewConfiguration(cadViewNodeId: number): (None | number)

Parameters

cadViewNodeId: number

Returns: (None | number)

IModel.getCadViewMap()
getCadViewMap(): Map

Returns: Map

IModel.getCadViewPmis()
getCadViewPmis(nodeId: number): number[]

Parameters

nodeId: number

Returns: number[]

IModel.getDataFromIds()
getDataFromIds(ids: DataIds): Promise

Parameters

ids: DataIds

Returns: Promise

IModel.getDefaultCadConfiguration()
getDefaultCadConfiguration(): (None | number)

Returns: (None | number)

IModel.getDefaultCadView()
getDefaultCadView(): (None | number)

Returns: (None | number)

IModel.getEdgeAttributes()
getEdgeAttributes(id: number, edgeIndex: number): Promise

Parameters

id: number

edgeIndex: number

Returns: Promise

IModel.getEdgeCount()
getEdgeCount(id: number): Promise

Parameters

id: number

Returns: Promise

IModel.getEdgeProperty()
getEdgeProperty(id: number, edgeId: number): Promise

Parameters

id: number

edgeId: number

Returns: Promise

IModel.getFaceAttributes()
getFaceAttributes(id: number, faceIndex: number): Promise

Parameters

id: number

faceIndex: number

Returns: Promise

IModel.getFaceCount()
getFaceCount(id: number): Promise

Parameters

id: number

Returns: Promise

IModel.getFaceProperty()
getFaceProperty(id: number, faceId: number): Promise

Parameters

id: number

faceId: number

Returns: Promise

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

Parameters

filterId: FilterId

Returns: (None | string)

IModel.getFilters()
getFilters(): Map

Returns: Map

IModel.getFiltersWithNode()
getFiltersWithNode(nodeIdSearched: number): FilterId[]

Parameters

nodeIdSearched: number

Returns: FilterId[]

IModel.getGenericIdFromBimId()
getGenericIdFromBimId(node: number, bimId: string): (None | string)

Parameters

node: number

bimId: string

Returns: (None | string)

IModel.getGenericTypeIdMap()
getGenericTypeIdMap(): Map

Returns: Map

IModel.getGenericTypes()
getGenericTypes(): string[]

Returns: string[]

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

Parameters

name: string

Returns: (None | LayerId[])

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

Parameters

layerId: LayerId

Returns: (None | string)

IModel.getLayers()
getLayers(): Map

Returns: Map

IModel.getLooseBounding()
getLooseBounding(): Promise

Returns: Promise

IModel.getLowestAvailableNodeId()
getLowestAvailableNodeId(): number

Returns: number

IModel.getMeshIds()
getMeshIds(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getMetallicRoughness()
getMetallicRoughness(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModel.getModelBounding()
getModelBounding(ignoreInvisible: boolean, includeExcluded: boolean, tightBounding: boolean): Promise

Parameters

ignoreInvisible: boolean

includeExcluded: boolean

tightBounding: boolean

Returns: Promise

IModel.getModelFileNameFromNode()
getModelFileNameFromNode(id: number): (None | string)

Parameters

id: number

Returns: (None | string)

IModel.getModelFileTypeFromNode()
getModelFileTypeFromNode(id: number): (None | FileType)

Parameters

id: number

Returns: (None | FileType)

IModel.getNodeCappingMeshData()
getNodeCappingMeshData(id: number): Promise

Parameters

id: number

Returns: Promise

IModel.getNodeChildren()
getNodeChildren(id: number, all: boolean): number[]

Parameters

id: number

all: boolean

Returns: number[]

IModel.getNodeColorMap()
getNodeColorMap(id: number, elementType: ElementType): Promise

Parameters

id: number

elementType: ElementType

Returns: Promise

IModel.getNodeEffectiveFaceColor()
getNodeEffectiveFaceColor(id: number, faceIndex: number, view: IView): Promise

Parameters

id: number

faceIndex: number

view: IView

Returns: Promise

IModel.getNodeEffectiveLineColor()
getNodeEffectiveLineColor(id: number, lineIndex: number, view: IView): Promise

Parameters

id: number

lineIndex: number

view: IView

Returns: Promise

IModel.getNodeEffectivePointColor()
getNodeEffectivePointColor(id: number, pointIndex: number, view: IView): Promise

Parameters

id: number

pointIndex: number

view: IView

Returns: Promise

IModel.getNodeExchangeId()
getNodeExchangeId(id: number): (None | string)

Parameters

id: number

Returns: (None | string)

IModel.getNodeFaceColor()
getNodeFaceColor(id: number, faceIndex: number): Promise

Parameters

id: number

faceIndex: number

Returns: Promise

IModel.getNodeFaceHighlighted()
getNodeFaceHighlighted(id: number, faceIndex: number): Promise

Parameters

id: number

faceIndex: number

Returns: Promise

IModel.getNodeGenericId()
getNodeGenericId(id: number): (None | string)

Parameters

id: number

Returns: (None | string)

IModel.getNodeGenericType()
getNodeGenericType(id: number): (None | string)

Parameters

id: number

Returns: (None | string)

IModel.getNodeIdFromBimId()
getNodeIdFromBimId(node: number, bimID: string): (None | number)

Parameters

node: number

bimID: string

Returns: (None | number)

IModel.getNodeIdFromScInstanceKey()
getNodeIdFromScInstanceKey(inclusionKey: InclusionKey, instanceKey: InstanceKey): (None | number)

Parameters

inclusionKey: InclusionKey

instanceKey: InstanceKey

Returns: (None | number)

IModel.getNodeIdOffset()
getNodeIdOffset(id: number): number

Parameters

id: number

Returns: number

IModel.getNodeIdsByGenericIds()
getNodeIdsByGenericIds(genericIds: string[]): number[]

Parameters

genericIds: string[]

Returns: number[]

IModel.getNodeLayerId()
getNodeLayerId(id: number): (None | LayerId)

Parameters

id: number

Returns: (None | LayerId)

IModel.getNodeLineColor()
getNodeLineColor(id: number, lineIndex: number): Promise

Parameters

id: number

lineIndex: number

Returns: Promise

IModel.getNodeLineHighlighted()
getNodeLineHighlighted(id: number, lineIndex: number): Promise

Parameters

id: number

lineIndex: number

Returns: Promise

IModel.getNodeMatrix()
getNodeMatrix(id: number): Matrix

Parameters

id: number

Returns: Matrix

IModel.getNodeMeshData()
getNodeMeshData(id: number): Promise

Parameters

id: number

Returns: Promise

IModel.getNodeName()
getNodeName(id: number): (None | string)

Parameters

id: number

Returns: (None | string)

IModel.getNodeNetMatrix()
getNodeNetMatrix(id: number): Matrix

Parameters

id: number

Returns: Matrix

IModel.getNodeParent()
getNodeParent(id: number): (None | number)

Parameters

id: number

Returns: (None | number)

IModel.getNodePointColor()
getNodePointColor(id: number, pointIndex: number): Promise

Parameters

id: number

pointIndex: number

Returns: Promise

IModel.getNodePointHighlighted()
getNodePointHighlighted(id: number, pointIndex: number): Promise

Parameters

id: number

pointIndex: number

Returns: Promise

IModel.getNodeProperties()
getNodeProperties(id: number, computeFromChildren: boolean): Promise

Parameters

id: number

computeFromChildren: boolean

Returns: Promise

IModel.getNodeRealBounding()
getNodeRealBounding(id: number, view: IView): Promise

Parameters

id: number

view: IView

Returns: Promise

IModel.getNodesAmbientColor()
getNodesAmbientColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesBounding()
getNodesBounding(ids: number[], config: GetNodesBoundingConfig): Promise

Parameters

ids: number[]

config: GetNodesBoundingConfig

Returns: Promise

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

Parameters

genericType: string

Returns: (None | Set)

IModel.getNodesCappingMeshData()
getNodesCappingMeshData(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModel.getNodesCullingVectors()
getNodesCullingVectors(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModel.getNodesDrawMode()
getNodesDrawMode(nodeIds: number[]): Record

Get overridden draw mode for the given node ids. Only leaf nodes attached to a body are considered. Other wont be in the returned record.

Parameters

nodeIds: number[]

The node ids to get the draw mode from.

Returns: Record

A record mapping node ids to their overridden draw modes.
IModel.getNodesEffectiveAmbientColor()
getNodesEffectiveAmbientColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesEffectiveEmissiveColor()
getNodesEffectiveEmissiveColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesEffectiveFaceColor()
getNodesEffectiveFaceColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesEffectiveLineColor()
getNodesEffectiveLineColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesEffectiveOpacity()
getNodesEffectiveOpacity(ids: number[], elementType: ElementType): Promise

Parameters

ids: number[]

elementType: ElementType

Returns: Promise

IModel.getNodesEffectivePointColor()
getNodesEffectivePointColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesEffectiveSpecularColor()
getNodesEffectiveSpecularColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesFaceColor()
getNodesFaceColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesFaceEmissiveColor()
getNodesFaceEmissiveColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesFaceSpecularColor()
getNodesFaceSpecularColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesFromFiltersId()
getNodesFromFiltersId(filtersId: FilterId[]): (None | FilteredNodes)

Parameters

filtersId: FilterId[]

Returns: (None | FilteredNodes)

IModel.getNodesFromLayer()
getNodesFromLayer(layerId: LayerId, onlyTreeNodes: boolean): (None | number[])

Parameters

layerId: LayerId

onlyTreeNodes: boolean

Returns: (None | number[])

IModel.getNodesFromLayerName()
getNodesFromLayerName(layerName: string, onlyTreeNodes: boolean): (None | number[])

Parameters

layerName: string

onlyTreeNodes: boolean

Returns: (None | number[])

IModel.getNodesFromLayers()
getNodesFromLayers(layersId: LayerId[], onlyTreeNodes: boolean): (None | number[])

Parameters

layersId: LayerId[]

onlyTreeNodes: boolean

Returns: (None | number[])

IModel.getNodesHaveTransparency()
getNodesHaveTransparency(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesHighlighted()
getNodesHighlighted(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesInstancingSamePart()
getNodesInstancingSamePart(id: number): Promise

Parameters

id: number

Returns: Promise

IModel.getNodesLineColor()
getNodesLineColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesMaterial()
getNodesMaterial(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModel.getNodesOpacity()
getNodesOpacity(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodesPointColor()
getNodesPointColor(ids: number[]): Promise

Parameters

ids: number[]

Returns: Promise

IModel.getNodeType()
getNodeType(id: number): NodeType

Parameters

id: number

Returns: NodeType

IModel.getNodeUnitMultiplier()
getNodeUnitMultiplier(id: number): number

Parameters

id: number

Returns: number

IModel.getNodeUserData()
getNodeUserData(id: number, index: UserDataIndex): Uint8Array

Parameters

id: number

index: UserDataIndex

Returns: Uint8Array

IModel.getNodeUserDataIndices()
getNodeUserDataIndices(id: number): UserDataIndex[]

Parameters

id: number

Returns: UserDataIndex[]

IModel.getNodeVisibility()
getNodeVisibility(id: number): boolean

Parameters

id: number

Returns: boolean

IModel.getOutOfHierarchy()
getOutOfHierarchy(id: number): boolean

Parameters

id: number

Returns: boolean

IModel.getPmiColor()
getPmiColor(): Color

Returns: Color

IModel.getPmiColorOverride()
getPmiColorOverride(): boolean

Returns: boolean

IModel.getPmis()
getPmis(): IdStringMap

Returns: IdStringMap

IModel.getPmiSubtype()
getPmiSubtype(pmiId: number): PmiSubType

Parameters

pmiId: number

Returns: PmiSubType

IModel.getPmiTopologyReferences()
getPmiTopologyReferences(pmiNodeId: number): (None | RefOnTopoItem[])

Parameters

pmiNodeId: number

Returns: (None | RefOnTopoItem[])

IModel.getPmiType()
getPmiType(pmiId: number): PmiType

Parameters

pmiId: number

Returns: PmiType

IModel.getPointAttributes()
getPointAttributes(id: number, pointIndex: number): Promise

Parameters

id: number

pointIndex: number

Returns: Promise

IModel.getRelationshipTypesFromBimId()
getRelationshipTypesFromBimId(node: number, bimId: string): RelationshipType[]

Parameters

node: number

bimId: string

Returns: RelationshipType[]

IModel.getScInstanceKey()
getScInstanceKey(nodeId: number): (None | InstanceInc)

Parameters

nodeId: number

Returns: (None | InstanceInc)

IModel.getUniqueLayerNames()
getUniqueLayerNames(): string[]

Returns: string[]

IModel.getViewAxes()
getViewAxes(): ViewAxes

Returns: ViewAxes

IModel.getVisibilityState()
getVisibilityState(id: number): Promise

Parameters

id: number

Returns: Promise

IModel.hasDepthRange()
hasDepthRange(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

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

Parameters

nodeId: number

genericType: string

Returns: boolean

IModel.isAnnotationView()
isAnnotationView(cadViewNodeId: number): boolean

Parameters

cadViewNodeId: number

Returns: boolean

IModel.isCombineStateView()
isCombineStateView(cadViewNodeId: number): boolean

Parameters

cadViewNodeId: number

Returns: boolean

IModel.isDrawing()
isDrawing(): boolean

Returns: boolean

IModel.isFaceMeasurable()
isFaceMeasurable(id: number, faceIndex: number): Promise

Parameters

id: number

faceIndex: number

Returns: Promise

IModel.isLineMeasurable()
isLineMeasurable(id: number, lineIndex: number): Promise

Parameters

id: number

lineIndex: number

Returns: Promise

IModel.isMeasurable()
isMeasurable(): boolean

Returns: boolean

IModel.isNodeLoaded()
isNodeLoaded(id: number): boolean

Parameters

id: number

Returns: boolean

IModel.isWithinExternalModel()
isWithinExternalModel(id: number): boolean

Parameters

id: number

Returns: boolean

IModel.loadMeasurementFromFile()
loadMeasurementFromFile(filename: string): Promise

Parameters

filename: string

Returns: Promise

IModel.loadMeasurementFromJson()
loadMeasurementFromJson(json: any): Promise

Parameters

json: any

Returns: Promise

IModel.loadMeasurementFromString()
loadMeasurementFromString(str: string): Promise

Parameters

str: string

Returns: Promise

IModel.loadSubtreeFromModel()
loadSubtreeFromModel(nodeId: number, modelName: string, args: any[]): Promise

Parameters

nodeId: number

modelName: string

args: any[]

Returns: Promise

IModel.loadSubtreeFromScsBuffer()
loadSubtreeFromScsBuffer(nodeId: number, buffer: ScsBuffer, args: any[]): Promise

Parameters

nodeId: number

buffer: ScsBuffer

args: any[]

Returns: Promise

IModel.loadSubtreeFromScsFile()
loadSubtreeFromScsFile(nodeId: number, scsFilename: string, args: any[]): Promise

Parameters

nodeId: number

scsFilename: string

args: any[]

Returns: Promise

IModel.loadSubtreeFromScsXmlBuffer()
loadSubtreeFromScsXmlBuffer(nodeId: number, xmlData: (string | Document), modelNameToScs: (None | ModelNameToScsFileFunc), args: any[]): Promise

Parameters

nodeId: number

xmlData: (string | Document)

modelNameToScs: (None | ModelNameToScsFileFunc)

args: any[]

Returns: Promise

IModel.loadSubtreeFromScsXmlFile()
loadSubtreeFromScsXmlFile(nodeId: number, xmlFilename: string, modelNameToScs: (None | ModelNameToScsFileFunc), args: any[]): Promise

Parameters

nodeId: number

xmlFilename: string

modelNameToScs: (None | ModelNameToScsFileFunc)

args: any[]

Returns: Promise

IModel.loadSubtreeFromXmlBuffer()
loadSubtreeFromXmlBuffer(nodeId: number, xmlData: (string | Document), massageModelName: (None | MassageModelNameFunc), args: any[]): Promise

Parameters

nodeId: number

xmlData: (string | Document)

massageModelName: (None | MassageModelNameFunc)

args: any[]

Returns: Promise

IModel.loadSubtreeFromXmlFile()
loadSubtreeFromXmlFile(nodeId: number, xmlFilename: string, massageModelName: (None | MassageModelNameFunc), args: any[]): Promise

Parameters

nodeId: number

xmlFilename: string

massageModelName: (None | MassageModelNameFunc)

args: any[]

Returns: Promise

IModel.registerBimNodes()
registerBimNodes(id: number, attributeToMask: (value: string) => BimMask, legacy_useAttributeTitle: (None | string | boolean)): Promise

Parameters

id: number

attributeToMask: (value: string) => BimMask

legacy_useAttributeTitle: (None | string | boolean)

Returns: Promise

IModel.registerIfcNodes()
registerIfcNodes(id: number, legacy_useAttributeTitle: (None | string | boolean)): Promise

Parameters

id: number

legacy_useAttributeTitle: (None | string | boolean)

Returns: Promise

IModel.replaceMesh()
replaceMesh(id: MeshId, data: MeshData): Promise

Parameters

id: MeshId

data: MeshData

Returns: Promise

IModel.requestNodes()
requestNodes(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModel.reset()
reset(): Promise

Returns: Promise

IModel.resetModelHighlight()
resetModelHighlight(): Promise

Returns: Promise

IModel.resetModelOpacity()
resetModelOpacity(): void

Returns: void

IModel.resetNodeMatrixToInitial()
resetNodeMatrixToInitial(id: number): void

Parameters

id: number

Returns: void

IModel.resetNodesColor()
resetNodesColor(): Promise

Returns: Promise

IModel.resetNodesMaterial()
resetNodesMaterial(nodeIds: number[], params: keyof IMaterial[]): void

Parameters

nodeIds: number[]

params: keyof IMaterial[]

Returns: void

IModel.resetNodesOpacity()
resetNodesOpacity(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.resetNodesTransform()
resetNodesTransform(): Promise

Returns: Promise

IModel.resetNodesVisibility()
resetNodesVisibility(): Promise

Returns: Promise

IModel.setBehaviorInitiallyHidden()
setBehaviorInitiallyHidden(enabled: boolean): void

Parameters

enabled: boolean

Returns: void

IModel.setBodyNodesVisibility()
setBodyNodesVisibility(id: number, visibilityFormatter: (boolean | (node: number) => (undefined | boolean))): Promise

Parameters

id: number

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

Returns: Promise

IModel.setDepthRange()
setDepthRange(nodeIds: number[], min: number, max: number): Promise

Parameters

nodeIds: number[]

min: number

max: number

Returns: Promise

IModel.setEdgeProperty()
setEdgeProperty(id: number, edgeId: number, prop: Base): void

Parameters

id: number

edgeId: number

prop: Base

Returns: void

IModel.setEnableAutomaticUnitScaling()
setEnableAutomaticUnitScaling(enabled: boolean): void

Parameters

enabled: boolean

Returns: void

IModel.setFaceProperty()
setFaceProperty(id: number, faceId: number, prop: Base): void

Parameters

id: number

faceId: number

prop: Base

Returns: void

IModel.setInstanceModifier()
setInstanceModifier(instanceModifier: InstanceModifier, nodeIds: number[], value: boolean): Promise

Parameters

instanceModifier: InstanceModifier

nodeIds: number[]

value: boolean

Returns: Promise

IModel.setMeshLevel()
setMeshLevel(nodeIds: number[], meshLevel: number): Promise

Parameters

nodeIds: number[]

meshLevel: number

Returns: Promise

IModel.setMetallicRoughness()
setMetallicRoughness(nodeIds: number[], metallicFactor: number, roughnessFactor: number): void

Parameters

nodeIds: number[]

metallicFactor: number

roughnessFactor: number

Returns: void

IModel.setNodeFaceColor()
setNodeFaceColor(id: number, faceId: number, color: Color): void

Parameters

id: number

faceId: number

color: Color

Returns: void

IModel.setNodeFaceHighlighted()
setNodeFaceHighlighted(id: number, faceId: number, highlighted: boolean): void

Parameters

id: number

faceId: number

highlighted: boolean

Returns: void

IModel.setNodeFaceVisibility()
setNodeFaceVisibility(id: number, faceId: number, visibility: boolean): void

Parameters

id: number

faceId: number

visibility: boolean

Returns: void

IModel.setNodeLineColor()
setNodeLineColor(id: number, lineId: number, color: Color): void

Parameters

id: number

lineId: number

color: Color

Returns: void

IModel.setNodeLineHighlighted()
setNodeLineHighlighted(id: number, lineId: number, highlighted: boolean): void

Parameters

id: number

lineId: number

highlighted: boolean

Returns: void

IModel.setNodeLineVisibility()
setNodeLineVisibility(id: number, lineId: number, visibility: boolean): void

Parameters

id: number

lineId: number

visibility: boolean

Returns: void

IModel.setNodeMatrix()
setNodeMatrix(id: number, matrix: Matrix, initial: boolean): Promise

Parameters

id: number

matrix: Matrix

initial: boolean

Returns: Promise

IModel.setNodePointColor()
setNodePointColor(id: number, pointId: number, color: Color): void

Parameters

id: number

pointId: number

color: Color

Returns: void

IModel.setNodePointHighlighted()
setNodePointHighlighted(id: number, pointId: number, highlighted: boolean): void

Parameters

id: number

pointId: number

highlighted: boolean

Returns: void

IModel.setNodePointVisibility()
setNodePointVisibility(id: number, pointId: number, visibility: boolean): void

Parameters

id: number

pointId: number

visibility: boolean

Returns: void

IModel.setNodesAmbientColor()
setNodesAmbientColor(ids: number[], color: Color): void

Parameters

ids: number[]

color: Color

Returns: void

IModel.setNodesAmbientMix()
setNodesAmbientMix(ids: number[], value: number): void

Parameters

ids: number[]

value: number

Returns: void

IModel.setNodesColors()
setNodesColors(colorMap: (Map | IdColorMap), alsoApplyToWireframe: boolean, alsoApplyToPoints: boolean): Promise

Parameters

colorMap: (Map | IdColorMap)

alsoApplyToWireframe: boolean

alsoApplyToPoints: boolean

Returns: Promise

IModel.setNodesCullingVector()
setNodesCullingVector(nodeIds: number[], space: CullingVectorSpace, vector: Point3, toleranceDegrees: number): Promise

Parameters

nodeIds: number[]

space: CullingVectorSpace

vector: Point3

toleranceDegrees: number

Returns: Promise

IModel.setNodesDrawModes()
setNodesDrawModes(nodesDrawModes: Record): void

Set the draw modes for the given node ids. Given nodes will be drawn according to their specified draw modes, overriding draw mode of the view. Only leaf nodes attached to a body can have overriden draw mode. If other nodes are passed, the draw mode will be applied recursively to the children and grand children which are attached to a body.

Parameters

nodesDrawModes: Record

A record mapping node ids to their desired draw modes.

Returns: void

IModel.setNodesFaceColor()
setNodesFaceColor(ids: number[], color: Color): void

Parameters

ids: number[]

color: Color

Returns: void

IModel.setNodesFaceEmissiveColor()
setNodesFaceEmissiveColor(ids: number[], color: Color): void

Parameters

ids: number[]

color: Color

Returns: void

IModel.setNodesFaceSpecularColor()
setNodesFaceSpecularColor(ids: number[], color: Color): void

Parameters

ids: number[]

color: Color

Returns: void

IModel.setNodesFaceSpecularIntensity()
setNodesFaceSpecularIntensity(ids: number[], value: number): void

Parameters

ids: number[]

value: number

Returns: void

IModel.setNodesHighlighted()
setNodesHighlighted(ids: number[], highlighted: boolean): void

Parameters

ids: number[]

highlighted: boolean

Returns: void

IModel.setNodesLineColor()
setNodesLineColor(ids: number[], color: Color): void

Parameters

ids: number[]

color: Color

Returns: void

IModel.setNodesLinePattern()
setNodesLinePattern(nodeIds: number[], pattern: LinePattern, patternLength: number, patternLengthUnit: LinePatternLengthUnit): void

Parameters

nodeIds: number[]

pattern: LinePattern

patternLength: number

patternLengthUnit: LinePatternLengthUnit

Returns: void

IModel.setNodesMaterial()
setNodesMaterial(nodeIds: number[], material: IMaterial): void

Parameters

nodeIds: number[]

material: IMaterial

Returns: void

IModel.setNodesOpacities()
setNodesOpacities(params: (Map | IdNumberMap)): void

Parameters

params: (Map | IdNumberMap)

Returns: void

IModel.setNodesOpacity()
setNodesOpacity(ids: number[], opacity: number): void

Parameters

ids: number[]

opacity: number

Returns: void

IModel.setNodesPointColor()
setNodesPointColor(ids: number[], color: Color): void

Parameters

ids: number[]

color: Color

Returns: void

IModel.setNodesTexture()
setNodesTexture(nodeIds: number[], options: TextureOptions): Promise

Parameters

nodeIds: number[]

options: TextureOptions

Returns: Promise

IModel.setNodesVisibilities()
setNodesVisibilities(mapping: (Map | IdBooleanMap), initiallyHiddenStayHidden: (None | boolean)): Promise

Parameters

mapping: (Map | IdBooleanMap)

initiallyHiddenStayHidden: (None | boolean)

Returns: Promise

IModel.setNodesVisibility()
setNodesVisibility(ids: number[], value: boolean, initiallyHiddenStayHidden: (None | boolean)): void

Parameters

ids: number[]

value: boolean

initiallyHiddenStayHidden: (None | boolean)

Returns: void

IModel.setPart()
setPart(assemblyNodeId: (undefined | None | number), partNodeId: (undefined | None | number)): boolean

Parameters

assemblyNodeId: (undefined | None | number)

partNodeId: (undefined | None | number)

Returns: boolean

IModel.setPhysicalProperties()
setPhysicalProperties(id: number, gravityCenter: Point3, surfaceArea: number, volume: number): boolean

Parameters

id: number

gravityCenter: Point3

surfaceArea: number

volume: number

Returns: boolean

IModel.setPmiColor()
setPmiColor(color: Color): void

Parameters

color: Color

Returns: void

IModel.setPmiColorOverride()
setPmiColorOverride(enableOverride: boolean, rootId: number): Promise

Parameters

enableOverride: boolean

rootId: number

Returns: Promise

IModel.setViewAxes()
setViewAxes(frontVector: Point3, upVector: Point3): void

Parameters

frontVector: Point3

upVector: Point3

Returns: void

IModel.switchToModel()
switchToModel(newModelFilename: string): Promise

Parameters

newModelFilename: string

Returns: Promise

IModel.triangulatePolygon()
triangulatePolygon(polygonPoints: (number[] | Float32Array), normal: Point3): Float32Array

Parameters

polygonPoints: (number[] | Float32Array)

normal: Point3

Returns: Float32Array

IModel.unsetDepthRange()
unsetDepthRange(nodeIds: number[]): void

Parameters

nodeIds: number[]

Returns: void

IModel.unsetMetallicRoughness()
unsetMetallicRoughness(nodeIds: number[]): void

Parameters

nodeIds: number[]

Returns: void

IModel.unsetNodeFaceColor()
unsetNodeFaceColor(id: number, faceId: number): void

Parameters

id: number

faceId: number

Returns: void

IModel.unsetNodeLineColor()
unsetNodeLineColor(id: number, lineId: number): void

Parameters

id: number

lineId: number

Returns: void

IModel.unsetNodePointColor()
unsetNodePointColor(id: number, pointId: number): void

Parameters

id: number

pointId: number

Returns: void

IModel.unsetNodesAmbientColor()
unsetNodesAmbientColor(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.unsetNodesCullingVectors()
unsetNodesCullingVectors(nodeIds: number[]): Promise

Parameters

nodeIds: number[]

Returns: Promise

IModel.unsetNodesFaceColor()
unsetNodesFaceColor(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.unsetNodesFaceEmissiveColor()
unsetNodesFaceEmissiveColor(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.unsetNodesFaceSpecularColor()
unsetNodesFaceSpecularColor(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.unsetNodesFaceSpecularIntensity()
unsetNodesFaceSpecularIntensity(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.unsetNodesLineColor()
unsetNodesLineColor(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.unsetNodesLinePattern()
unsetNodesLinePattern(nodeIds: number[]): void

Parameters

nodeIds: number[]

Returns: void

IModel.unsetNodesPointColor()
unsetNodesPointColor(ids: number[]): void

Parameters

ids: number[]

Returns: void

IModel.unsetNodesTexture()
unsetNodesTexture(nodeIds: number[]): void

Parameters

nodeIds: number[]

Returns: void

IModel.viewAxesHaveBeenSet()
viewAxesHaveBeenSet(): boolean

Returns: boolean