IModel

class core.IModel()

Methods

Methods

_allowNodeDeletion

IModel._allowNodeDeletion(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

void

_firstAssemblyDataHeader

IModel._firstAssemblyDataHeader()
Return type:null | AssemblyDataHeader

_gatherInstanceIncsFromNodeIds

IModel._gatherInstanceIncsFromNodeIds(nodeIds[, allowedTypes])
Arguments:
  • nodeIds ([number]()) – None
  • allowedTypes (BodyTypeBits()) – optional None
Return type:

InstanceIncs

_getModelStructure

IModel._getModelStructure()
Return type:IModelStructure

_getNodeFromInstanceInc

IModel._getNodeFromInstanceInc(markNodeLoadedIfCreated, inclusionKey, instanceKey, isOutOfHierarchy)
Arguments:
  • markNodeLoadedIfCreated (boolean()) – None
  • inclusionKey (InclusionKey()) – None
  • instanceKey (InstanceKey()) – None
  • isOutOfHierarchy (boolean()) – None
Return type:

number

_hwfAwaitAssemblyTreeReady

IModel._hwfAwaitAssemblyTreeReady()
Return type:Promise <void>

_preventMeshDeletion

IModel._preventMeshDeletion(meshId)
Arguments:
  • meshId (MeshId()) – None
Return type:

void

_preventNodeDeletion

IModel._preventNodeDeletion(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

void

_setDefaultView

IModel._setDefaultView(view)
Arguments:
Return type:

void

_setInstanceModifier

IModel._setInstanceModifier(instanceModifier, nodeIds, value, allowedTypes)
Arguments:
  • instanceModifier (InstanceModifier()) – None
  • nodeIds ([number]()) – None
  • value (boolean()) – None
  • allowedTypes (BodyTypeBits()) – None
Return type:

void

_setModelStructure

IModel._setModelStructure(modelStructure)
Arguments:
Return type:

void

_setNodesMatrices

IModel._setNodesMatrices(nodeIds, matrices[, setAsInitial])
Arguments:
  • nodeIds ([number]()) – None
  • matrices ([Matrix]()) – None
  • setAsInitial (boolean()) – optional None
Return type:

Promise <void>

activateCadConfiguration

IModel.activateCadConfiguration(nodeId[, view])
Arguments:
  • nodeId (number()) – None
  • view (IView()) – optional None
Return type:

Promise <void>

activateCadView

IModel.activateCadView(nodeId[, duration[, massageCamera[, view]]])
Arguments:
  • nodeId (number()) – None
  • duration (number()) – optional None
  • massageCamera (boolean()) – optional None
  • view (IView()) – optional None
Return type:

Promise <void>

activateDefaultCadConfiguration

IModel.activateDefaultCadConfiguration([fitNodes[, view]])
Arguments:
  • fitNodes (boolean()) – optional None
  • view (IView()) – optional None
Return type:

Promise <void>

activateDefaultCadView

IModel.activateDefaultCadView([duration[, massageCamera[, view]]])
Arguments:
  • duration (number()) – optional None
  • massageCamera (boolean()) – optional None
  • view (IView()) – optional None
Return type:

Promise <void>

addPropertyToNode

IModel.addPropertyToNode(id, propertyName, propertyValue, propertyUnit)
Arguments:
  • id (number()) – None
  • propertyName (string()) – None
  • propertyValue (string()) – None
  • propertyUnit ([UnitElement]()) – None
Return type:

boolean

cadConfigurationsEnabled

IModel.cadConfigurationsEnabled()
Return type:Promise <boolean>

clear

IModel.clear()
Return type:Promise <void>

clearNodeFaceVisibility

IModel.clearNodeFaceVisibility(id)
Arguments:
  • id (number()) – None
Return type:

void

clearNodeLineVisibility

IModel.clearNodeLineVisibility(id)
Arguments:
  • id (number()) – None
Return type:

void

clearNodePointVisibility

IModel.clearNodePointVisibility(id)
Arguments:
  • id (number()) – None
Return type:

void

computeMinimumBodyBodyDistance

IModel.computeMinimumBodyBodyDistance(partId1, partId2)
Arguments:
  • partId1 (number()) – None
  • partId2 (number()) – None
Return type:

Promise <FaceFaceDistanceItem>

computeMinimumFaceFaceDistance

IModel.computeMinimumFaceFaceDistance(partId1, faceId1, partId2, faceId2)
Arguments:
  • partId1 (number()) – None
  • faceId1 (number()) – None
  • partId2 (number()) – None
  • faceId2 (number()) – None
Return type:

Promise <FaceFaceDistanceItem>

computeMinimumFaceLineDistance

IModel.computeMinimumFaceLineDistance(partId, faceId, ray)
Arguments:
  • partId (number()) – None
  • faceId (number()) – None
  • ray (Ray()) – None
Return type:

Promise <FaceFaceDistanceItem>

computeMinimumFaceRayDistance

IModel.computeMinimumFaceRayDistance(partId, faceId, ray)
Arguments:
  • partId (number()) – None
  • faceId (number()) – None
  • ray (Ray()) – None
Return type:

Promise <FaceFaceDistanceItem>

createAndAddRepresentationItem

IModel.createAndAddRepresentationItem(partNodeId[, repItemId])
Arguments:
  • partNodeId (undefined | null | number()) – None
  • repItemId (null | number()) – optional None
Return type:

null | number

createCadView

IModel.createCadView(nodeId, viewName, camera[, pmiIds[, nodesToShow[, nodesToHide[, nodeIdsAndLocalTransforms[, cuttingPlane[, meshInstanceData]]]]]])
Arguments:
  • nodeId (number()) – None
  • viewName (string()) – None
  • camera (Camera()) – None
  • pmiIds (null | [number]()) – optional None
  • nodesToShow (null | [number]()) – optional None
  • nodesToHide (null | [number]()) – optional None
  • nodeIdsAndLocalTransforms (null | [(number, Matrix)]()) – optional None
  • cuttingPlane (null | Plane()) – optional None
  • meshInstanceData (null | MeshInstanceData()) – optional None
Return type:

null | number

createImage

IModel.createImage(primaryImage[, thumbnailImage])
Arguments:
Return type:

Promise <ImageId>

createMesh

IModel.createMesh(meshData[, config])
Arguments:
  • meshData (MeshData()) – None
  • config (function()) – optional None
Return type:

Promise <MeshId>

createMeshInstance

IModel.createMeshInstance(data[, parentNodeId[, preventFromResetting[, isOutOfHierarchy]]])
Arguments:
  • data (MeshInstanceData()) – None
  • parentNodeId (null | number()) – optional None
  • preventFromResetting (null | boolean()) – optional None
  • isOutOfHierarchy (null | boolean()) – optional None
Return type:

Promise <number>

createNode

IModel.createNode(parentNodeId, nodeName[, nodeId[, localMatrix[, visibility[, measurementUnit]]]])
Arguments:
  • parentNodeId (undefined | null | number()) – None
  • nodeName (string()) – None
  • nodeId (null | number()) – optional None
  • localMatrix (null | Matrix()) – optional None
  • visibility (null | boolean()) – optional None
  • measurementUnit (null | number()) – optional None
Return type:

number

createPart

IModel.createPart([nodeId])
Arguments:
  • nodeId (null | number()) – optional None
Return type:

number

createPmiInstance

IModel.createPmiInstance(data, pmiType, pmiSubType, refOnTopoItems[, parentNodeId])
Arguments:
  • data (MeshInstanceData()) – None
  • pmiType (PmiType()) – None
  • pmiSubType (PmiSubType()) – None
  • refOnTopoItems ([RefOnTopoItem]()) – None
  • parentNodeId (null | number()) – optional None
Return type:

Promise <number>

deleteImages

IModel.deleteImages(imageIds)
Arguments:
  • imageIds ([ImageId]()) – None
Return type:

Promise <void>

deleteMeshes

IModel.deleteMeshes(ids)
Arguments:
  • ids ([MeshId]()) – None
Return type:

Promise <void>

deleteMeshInstances

IModel.deleteMeshInstances(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <void>

deleteNode

IModel.deleteNode(id)
Arguments:
  • id (number()) – None
Return type:

Promise <void>

getAbsoluteRootNode

IModel.getAbsoluteRootNode()
Return type:number

getActiveCadConfiguration

IModel.getActiveCadConfiguration()
Return type:null | number

getAssociatedModelKey

IModel.getAssociatedModelKey(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

Promise <null | ModelKey>

getBimIdConnectedElements

IModel.getBimIdConnectedElements(node, bimId, type)
Arguments:
  • node (number()) – None
  • bimId (string()) – None
  • type (RelationshipType()) – None
Return type:

function

getBimIdFromNode

IModel.getBimIdFromNode(id)
Arguments:
  • id (number()) – None
Return type:

null | string

getBimIdRelatedElements

IModel.getBimIdRelatedElements(node, bimId, type)
Arguments:
  • node (number()) – None
  • bimId (string()) – None
  • type (RelationshipType()) – None
Return type:

[string]

getBimIdRelatingElements

IModel.getBimIdRelatingElements(node, bimId, type)
Arguments:
  • node (number()) – None
  • bimId (string()) – None
  • type (RelationshipType()) – None
Return type:

[string]

getBimIdsFromGenericId

IModel.getBimIdsFromGenericId(ifcGuid)
Arguments:
  • ifcGuid (string()) – None
Return type:

[string]

getBimInfoFromBimId

IModel.getBimInfoFromBimId(node, bimId)
Arguments:
  • node (number()) – None
  • bimId (string()) – None
Return type:

function

getBranchVisibility

IModel.getBranchVisibility(id)
Arguments:
  • id (number()) – None
Return type:

BranchVisibility

getCadConfigurations

IModel.getCadConfigurations()
Return type:IdStringMap

getCadViewConfiguration

IModel.getCadViewConfiguration(cadViewNodeId)
Arguments:
  • cadViewNodeId (number()) – None
Return type:

null | number

getCadViewMap

IModel.getCadViewMap()
Return type:Map <number, string>

getCadViewPmis

IModel.getCadViewPmis(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

[number]

getDataFromIds

IModel.getDataFromIds(ids)
Arguments:
  • ids (DataIds()) – None
Return type:

Promise <[Uint8Array]>

getDefaultCadConfiguration

IModel.getDefaultCadConfiguration()
Return type:null | number

getDefaultCadView

IModel.getDefaultCadView()
Return type:null | number

getEdgeAttributes

IModel.getEdgeAttributes(id, edgeIndex)
Arguments:
  • id (number()) – None
  • edgeIndex (number()) – None
Return type:

Promise <null | SubentityAttributes>

getEdgeCount

IModel.getEdgeCount(id)
Arguments:
  • id (number()) – None
Return type:

Promise <number>

getEdgeProperty

IModel.getEdgeProperty(id, edgeId)
Arguments:
  • id (number()) – None
  • edgeId (number()) – None
Return type:

Promise <null | Edge>

getFaceAttributes

IModel.getFaceAttributes(id, faceIndex)
Arguments:
  • id (number()) – None
  • faceIndex (number()) – None
Return type:

Promise <null | SubentityAttributes>

getFaceCount

IModel.getFaceCount(id)
Arguments:
  • id (number()) – None
Return type:

Promise <number>

getFaceProperty

IModel.getFaceProperty(id, faceId)
Arguments:
  • id (number()) – None
  • faceId (number()) – None
Return type:

Promise <null | Face>

getFilterName

IModel.getFilterName(filterId)
Arguments:
  • filterId (FilterId()) – None
Return type:

null | string

getFilters

IModel.getFilters()
Return type:Map <FilterId, string>

getFiltersWithNode

IModel.getFiltersWithNode(nodeIdSearched)
Arguments:
  • nodeIdSearched (number()) – None
Return type:

[FilterId]

getGenericIdFromBimId

IModel.getGenericIdFromBimId(node, bimId)
Arguments:
  • node (number()) – None
  • bimId (string()) – None
Return type:

null | string

getGenericTypeIdMap

IModel.getGenericTypeIdMap()
Return type:Map <string, Set <number>>

getGenericTypes

IModel.getGenericTypes()
Return type:[string]

getLayerIdsFromName

IModel.getLayerIdsFromName(name)
Arguments:
  • name (string()) – None
Return type:

null | [LayerId]

getLayerName

IModel.getLayerName(layerId)
Arguments:
  • layerId (LayerId()) – None
Return type:

null | string

getLayers

IModel.getLayers()
Return type:Map <LayerId, string>

getLooseBounding

IModel.getLooseBounding()
Return type:Promise <Box>

getLowestAvailableNodeId

IModel.getLowestAvailableNodeId()
Return type:number

getMeshIds

IModel.getMeshIds(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[MeshId]>

getMetallicRoughness

IModel.getMetallicRoughness(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <[null | MetallicRoughnessValue]>

getModelBounding

IModel.getModelBounding(ignoreInvisible, includeExcluded[, tightBounding])
Arguments:
  • ignoreInvisible (boolean()) – None
  • includeExcluded (boolean()) – None
  • tightBounding (boolean()) – optional None
Return type:

Promise <Box>

getModelFileNameFromNode

IModel.getModelFileNameFromNode(id)
Arguments:
  • id (number()) – None
Return type:

null | string

getModelFileTypeFromNode

IModel.getModelFileTypeFromNode(id)
Arguments:
  • id (number()) – None
Return type:

null | FileType

getNodeCappingMeshData

IModel.getNodeCappingMeshData(id)
Arguments:
  • id (number()) – None
Return type:

Promise <null | MeshDataCopy>

getNodeChildren

IModel.getNodeChildren(id[, all])
Arguments:
  • id (number()) – None
  • all (boolean()) – optional None
Return type:

[number]

getNodeColorMap

IModel.getNodeColorMap(id, elementType)
Arguments:
  • id (number()) – None
  • elementType (ElementType()) – None
Return type:

Promise <Map <number, Color>>

getNodeEffectiveFaceColor

IModel.getNodeEffectiveFaceColor(id, faceIndex[, view])
Arguments:
  • id (number()) – None
  • faceIndex (number()) – None
  • view (IView()) – optional None
Return type:

Promise <null | Color>

getNodeEffectiveLineColor

IModel.getNodeEffectiveLineColor(id, lineIndex[, view])
Arguments:
  • id (number()) – None
  • lineIndex (number()) – None
  • view (IView()) – optional None
Return type:

Promise <null | Color>

getNodeEffectivePointColor

IModel.getNodeEffectivePointColor(id, pointIndex[, view])
Arguments:
  • id (number()) – None
  • pointIndex (number()) – None
  • view (IView()) – optional None
Return type:

Promise <null | Color>

getNodeExchangeId

IModel.getNodeExchangeId(id)
Arguments:
  • id (number()) – None
Return type:

null | string

getNodeFaceColor

IModel.getNodeFaceColor(id, faceIndex)
Arguments:
  • id (number()) – None
  • faceIndex (number()) – None
Return type:

Promise <null | Color>

getNodeFaceHighlighted

IModel.getNodeFaceHighlighted(id, faceIndex)
Arguments:
  • id (number()) – None
  • faceIndex (number()) – None
Return type:

Promise <boolean>

getNodeGenericId

IModel.getNodeGenericId(id)
Arguments:
  • id (number()) – None
Return type:

null | string

getNodeGenericType

IModel.getNodeGenericType(id)
Arguments:
  • id (number()) – None
Return type:

null | string

getNodeIdFromBimId

IModel.getNodeIdFromBimId(node, bimID)
Arguments:
  • node (number()) – None
  • bimID (string()) – None
Return type:

null | number

getNodeIdFromScInstanceKey

IModel.getNodeIdFromScInstanceKey(inclusionKey, instanceKey)
Arguments:
  • inclusionKey (InclusionKey()) – None
  • instanceKey (InstanceKey()) – None
Return type:

null | number

getNodeIdOffset

IModel.getNodeIdOffset(id)
Arguments:
  • id (number()) – None
Return type:

number

getNodeIdsByGenericIds

IModel.getNodeIdsByGenericIds(genericIds)
Arguments:
  • genericIds ([string]()) – None
Return type:

[number]

getNodeLayerId

IModel.getNodeLayerId(id)
Arguments:
  • id (number()) – None
Return type:

null | LayerId

getNodeLineColor

IModel.getNodeLineColor(id, lineIndex)
Arguments:
  • id (number()) – None
  • lineIndex (number()) – None
Return type:

Promise <null | Color>

getNodeLineHighlighted

IModel.getNodeLineHighlighted(id, lineIndex)
Arguments:
  • id (number()) – None
  • lineIndex (number()) – None
Return type:

Promise <boolean>

getNodeMatrix

IModel.getNodeMatrix(id)
Arguments:
  • id (number()) – None
Return type:

Matrix

getNodeMeshData

IModel.getNodeMeshData(id)
Arguments:
  • id (number()) – None
Return type:

Promise <MeshDataCopy>

getNodeName

IModel.getNodeName(id)
Arguments:
  • id (number()) – None
Return type:

null | string

getNodeNetMatrix

IModel.getNodeNetMatrix(id)
Arguments:
  • id (number()) – None
Return type:

Matrix

getNodeParent

IModel.getNodeParent(id)
Arguments:
  • id (number()) – None
Return type:

null | number

getNodePointColor

IModel.getNodePointColor(id, pointIndex)
Arguments:
  • id (number()) – None
  • pointIndex (number()) – None
Return type:

Promise <null | Color>

getNodePointHighlighted

IModel.getNodePointHighlighted(id, pointIndex)
Arguments:
  • id (number()) – None
  • pointIndex (number()) – None
Return type:

Promise <boolean>

getNodeProperties

IModel.getNodeProperties(id[, computeFromChildren])
Arguments:
  • id (number()) – None
  • computeFromChildren (boolean()) – optional None
Return type:

Promise <null | StringStringMap>

getNodeRealBounding

IModel.getNodeRealBounding(id[, view])
Arguments:
  • id (number()) – None
  • view (IView()) – optional None
Return type:

Promise <Box>

getNodesAmbientColor

IModel.getNodesAmbientColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[null | Color]>

getNodesBounding

IModel.getNodesBounding(ids[, config])
Arguments:
Return type:

Promise <Box>

getNodesByGenericType

IModel.getNodesByGenericType(genericType)
Arguments:
  • genericType (string()) – None
Return type:

null | Set <number>

getNodesCappingMeshData

IModel.getNodesCappingMeshData(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <[MeshDataCopy]>

getNodesCullingVectors

IModel.getNodesCullingVectors(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <[null | CullingVector]>

getNodesEffectiveAmbientColor

IModel.getNodesEffectiveAmbientColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[Color]>

getNodesEffectiveEmissiveColor

IModel.getNodesEffectiveEmissiveColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[Color]>

getNodesEffectiveFaceColor

IModel.getNodesEffectiveFaceColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[Color]>

getNodesEffectiveLineColor

IModel.getNodesEffectiveLineColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[Color]>

getNodesEffectiveOpacity

IModel.getNodesEffectiveOpacity(ids, elementType)
Arguments:
  • ids ([number]()) – None
  • elementType (ElementType()) – None
Return type:

Promise <[number]>

getNodesEffectivePointColor

IModel.getNodesEffectivePointColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[Color]>

getNodesEffectiveSpecularColor

IModel.getNodesEffectiveSpecularColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[Color]>

getNodesFaceColor

IModel.getNodesFaceColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[null | Color]>

getNodesFaceEmissiveColor

IModel.getNodesFaceEmissiveColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[null | Color]>

getNodesFaceSpecularColor

IModel.getNodesFaceSpecularColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[null | Color]>

getNodesFromFiltersId

IModel.getNodesFromFiltersId(filtersId)
Arguments:
  • filtersId ([FilterId]()) – None
Return type:

null | FilteredNodes

getNodesFromLayer

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

null | [number]

getNodesFromLayerName

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

null | [number]

getNodesFromLayers

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

null | [number]

getNodesHaveTransparency

IModel.getNodesHaveTransparency(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[boolean]>

getNodesHighlighted

IModel.getNodesHighlighted(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[boolean]>

getNodesInstancingSamePart

IModel.getNodesInstancingSamePart(id)
Arguments:
  • id (number()) – None
Return type:

Promise <null | [number]>

getNodesLineColor

IModel.getNodesLineColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[null | Color]>

getNodesOpacity

IModel.getNodesOpacity(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[null | number]>

getNodesPointColor

IModel.getNodesPointColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

Promise <[null | Color]>

getNodeType

IModel.getNodeType(id)
Arguments:
  • id (number()) – None
Return type:

NodeType

getNodeUnitMultiplier

IModel.getNodeUnitMultiplier(id)
Arguments:
  • id (number()) – None
Return type:

number

getNodeUserData

IModel.getNodeUserData(id, index)
Arguments:
  • id (number()) – None
  • index (UserDataIndex()) – None
Return type:

Uint8Array

getNodeUserDataIndices

IModel.getNodeUserDataIndices(id)
Arguments:
  • id (number()) – None
Return type:

[UserDataIndex]

getNodeVisibility

IModel.getNodeVisibility(id)
Arguments:
  • id (number()) – None
Return type:

boolean

getOutOfHierarchy

IModel.getOutOfHierarchy(id)
Arguments:
  • id (number()) – None
Return type:

boolean

getPmiColor

IModel.getPmiColor()
Return type:Color

getPmiColorOverride

IModel.getPmiColorOverride()
Return type:boolean

getPmis

IModel.getPmis()
Return type:IdStringMap

getPmiSubtype

IModel.getPmiSubtype(pmiId)
Arguments:
  • pmiId (number()) – None
Return type:

PmiSubType

getPmiTopologyReferences

IModel.getPmiTopologyReferences(pmiNodeId)
Arguments:
  • pmiNodeId (number()) – None
Return type:

null | [RefOnTopoItem]

getPmiType

IModel.getPmiType(pmiId)
Arguments:
  • pmiId (number()) – None
Return type:

PmiType

getPointAttributes

IModel.getPointAttributes(id, pointIndex)
Arguments:
  • id (number()) – None
  • pointIndex (number()) – None
Return type:

Promise <null | SubentityAttributes>

getRelationshipTypesFromBimId

IModel.getRelationshipTypesFromBimId(node, bimId)
Arguments:
  • node (number()) – None
  • bimId (string()) – None
Return type:

[RelationshipType]

getScInstanceKey

IModel.getScInstanceKey(nodeId)
Arguments:
  • nodeId (number()) – None
Return type:

null | InstanceInc

getUniqueLayerNames

IModel.getUniqueLayerNames()
Return type:[string]

getViewAxes

IModel.getViewAxes()
Return type:ViewAxes

getVisibilityState

IModel.getVisibilityState(id)
Arguments:
  • id (number()) – None
Return type:

Promise <VisibilityState>

hasDepthRange

IModel.hasDepthRange(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <[boolean]>

hasEffectiveGenericType

IModel.hasEffectiveGenericType(nodeId, genericType)
Arguments:
  • nodeId (number()) – None
  • genericType (string()) – None
Return type:

boolean

isAnnotationView

IModel.isAnnotationView(cadViewNodeId)
Arguments:
  • cadViewNodeId (number()) – None
Return type:

boolean

isCombineStateView

IModel.isCombineStateView(cadViewNodeId)
Arguments:
  • cadViewNodeId (number()) – None
Return type:

boolean

isDrawing

IModel.isDrawing()
Return type:boolean

isFaceMeasurable

IModel.isFaceMeasurable(id, faceIndex)
Arguments:
  • id (number()) – None
  • faceIndex (number()) – None
Return type:

Promise <boolean>

isLineMeasurable

IModel.isLineMeasurable(id, lineIndex)
Arguments:
  • id (number()) – None
  • lineIndex (number()) – None
Return type:

Promise <boolean>

isMeasurable

IModel.isMeasurable()
Return type:boolean

isNodeLoaded

IModel.isNodeLoaded(id)
Arguments:
  • id (number()) – None
Return type:

boolean

isWithinExternalModel

IModel.isWithinExternalModel(id)
Arguments:
  • id (number()) – None
Return type:

boolean

loadMeasurementFromFile

IModel.loadMeasurementFromFile(filename)
Arguments:
  • filename (string()) – None
Return type:

Promise <void>

loadMeasurementFromJson

IModel.loadMeasurementFromJson(json)
Arguments:
  • json (any()) – None
Return type:

Promise <void>

loadMeasurementFromString

IModel.loadMeasurementFromString(str)
Arguments:
  • str (string()) – None
Return type:

Promise <void>

loadSubtreeFromModel

IModel.loadSubtreeFromModel(nodeId, modelName, args)
Arguments:
  • nodeId (number()) – None
  • modelName (string()) – None
  • args ([any]()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsBuffer

IModel.loadSubtreeFromScsBuffer(nodeId, buffer, args)
Arguments:
  • nodeId (number()) – None
  • buffer (Uint8Array()) – None
  • args ([any]()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsFile

IModel.loadSubtreeFromScsFile(nodeId, scsFilename, args)
Arguments:
  • nodeId (number()) – None
  • scsFilename (string()) – None
  • args ([any]()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsXmlBuffer

IModel.loadSubtreeFromScsXmlBuffer(nodeId, xmlData[, modelNameToScs, args])
Arguments:
  • nodeId (number()) – None
  • xmlData (string | Document()) – None
  • modelNameToScs (null | ModelNameToScsFileFunc()) – optional None
  • args ([any]()) – None
Return type:

Promise <[number]>

loadSubtreeFromScsXmlFile

IModel.loadSubtreeFromScsXmlFile(nodeId, xmlFilename[, modelNameToScs, args])
Arguments:
  • nodeId (number()) – None
  • xmlFilename (string()) – None
  • modelNameToScs (null | ModelNameToScsFileFunc()) – optional None
  • args ([any]()) – None
Return type:

Promise <[number]>

loadSubtreeFromXmlBuffer

IModel.loadSubtreeFromXmlBuffer(nodeId, xmlData[, massageModelName, args])
Arguments:
  • nodeId (number()) – None
  • xmlData (string | Document()) – None
  • massageModelName (null | MassageModelNameFunc()) – optional None
  • args ([any]()) – None
Return type:

Promise <[number]>

loadSubtreeFromXmlFile

IModel.loadSubtreeFromXmlFile(nodeId, xmlFilename[, massageModelName, args])
Arguments:
  • nodeId (number()) – None
  • xmlFilename (string()) – None
  • massageModelName (null | MassageModelNameFunc()) – optional None
  • args ([any]()) – None
Return type:

Promise <[number]>

registerBimNodes

IModel.registerBimNodes(id, attributeToMask[, legacy_useAttributeTitle])
Arguments:
  • id (number()) – None
  • attributeToMask (function()) – None
  • legacy_useAttributeTitle (null | string | boolean()) – optional None
Return type:

Promise <void>
IModel.attributeToMask(value)
Arguments:
  • value (string()) – None
Return type:

BimMask

registerIfcNodes

IModel.registerIfcNodes(id[, legacy_useAttributeTitle])
Arguments:
  • id (number()) – None
  • legacy_useAttributeTitle (null | string | boolean()) – optional None
Return type:

Promise <void>

replaceMesh

IModel.replaceMesh(id, data)
Arguments:
  • id (MeshId()) – None
  • data (MeshData()) – None
Return type:

Promise <void>

requestNodes

IModel.requestNodes(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <void>

reset

IModel.reset()
Return type:Promise <void>

resetModelHighlight

IModel.resetModelHighlight()
Return type:Promise <void>

resetModelOpacity

IModel.resetModelOpacity()
Return type:void

resetNodeMatrixToInitial

IModel.resetNodeMatrixToInitial(id)
Arguments:
  • id (number()) – None
Return type:

void

resetNodesColor

IModel.resetNodesColor()
Return type:Promise <void>

resetNodesOpacity

IModel.resetNodesOpacity(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

resetNodesTransform

IModel.resetNodesTransform()
Return type:Promise <void>

resetNodesVisibility

IModel.resetNodesVisibility()
Return type:Promise <void>

setBehaviorInitiallyHidden

IModel.setBehaviorInitiallyHidden(enabled)
Arguments:
  • enabled (boolean()) – None
Return type:

void

setBodyNodesVisibility

IModel.setBodyNodesVisibility(id, visibilityFormatter)
Arguments:
  • id (number()) – None
  • visibilityFormatter (boolean | function()) – None
Return type:

Promise <void>
IModel.visibilityFormatter(node)
Arguments:
  • node (number()) – None
Return type:

undefined | boolean

setDepthRange

IModel.setDepthRange(nodeIds, min, max)
Arguments:
  • nodeIds ([number]()) – None
  • min (number()) – None
  • max (number()) – None
Return type:

Promise <void>

setEdgeProperty

IModel.setEdgeProperty(id, edgeId, prop)
Arguments:
  • id (number()) – None
  • edgeId (number()) – None
  • prop (Base()) – None
Return type:

void

setEnableAutomaticUnitScaling

IModel.setEnableAutomaticUnitScaling(enabled)
Arguments:
  • enabled (boolean()) – None
Return type:

void

setFaceProperty

IModel.setFaceProperty(id, faceId, prop)
Arguments:
  • id (number()) – None
  • faceId (number()) – None
  • prop (Base()) – None
Return type:

void

setInstanceModifier

IModel.setInstanceModifier(instanceModifier, nodeIds, value)
Arguments:
  • instanceModifier (InstanceModifier()) – None
  • nodeIds ([number]()) – None
  • value (boolean()) – None
Return type:

Promise <void>

setMeshLevel

IModel.setMeshLevel(nodeIds, meshLevel)
Arguments:
  • nodeIds ([number]()) – None
  • meshLevel (number()) – None
Return type:

Promise <void>

setMetallicRoughness

IModel.setMetallicRoughness(nodeIds, metallicFactor, roughnessFactor)
Arguments:
  • nodeIds ([number]()) – None
  • metallicFactor (number()) – None
  • roughnessFactor (number()) – None
Return type:

void

setNodeFaceColor

IModel.setNodeFaceColor(id, faceId, color)
Arguments:
  • id (number()) – None
  • faceId (number()) – None
  • color (Color()) – None
Return type:

void

setNodeFaceHighlighted

IModel.setNodeFaceHighlighted(id, faceId, highlighted)
Arguments:
  • id (number()) – None
  • faceId (number()) – None
  • highlighted (boolean()) – None
Return type:

void

setNodeFaceVisibility

IModel.setNodeFaceVisibility(id, faceId, visibility)
Arguments:
  • id (number()) – None
  • faceId (number()) – None
  • visibility (boolean()) – None
Return type:

void

setNodeLineColor

IModel.setNodeLineColor(id, lineId, color)
Arguments:
  • id (number()) – None
  • lineId (number()) – None
  • color (Color()) – None
Return type:

void

setNodeLineHighlighted

IModel.setNodeLineHighlighted(id, lineId, highlighted)
Arguments:
  • id (number()) – None
  • lineId (number()) – None
  • highlighted (boolean()) – None
Return type:

void

setNodeLineVisibility

IModel.setNodeLineVisibility(id, lineId, visibility)
Arguments:
  • id (number()) – None
  • lineId (number()) – None
  • visibility (boolean()) – None
Return type:

void

setNodeMatrix

IModel.setNodeMatrix(id, matrix[, initial])
Arguments:
  • id (number()) – None
  • matrix (Matrix()) – None
  • initial (boolean()) – optional None
Return type:

Promise <void>

setNodePointColor

IModel.setNodePointColor(id, pointId, color)
Arguments:
  • id (number()) – None
  • pointId (number()) – None
  • color (Color()) – None
Return type:

void

setNodePointHighlighted

IModel.setNodePointHighlighted(id, pointId, highlighted)
Arguments:
  • id (number()) – None
  • pointId (number()) – None
  • highlighted (boolean()) – None
Return type:

void

setNodePointVisibility

IModel.setNodePointVisibility(id, pointId, visibility)
Arguments:
  • id (number()) – None
  • pointId (number()) – None
  • visibility (boolean()) – None
Return type:

void

setNodesAmbientColor

IModel.setNodesAmbientColor(ids, color)
Arguments:
  • ids ([number]()) – None
  • color (Color()) – None
Return type:

void

setNodesAmbientMix

IModel.setNodesAmbientMix(ids, value)
Arguments:
  • ids ([number]()) – None
  • value (number()) – None
Return type:

void

setNodesColors

IModel.setNodesColors(colorMap[, alsoApplyToWireframe[, alsoApplyToPoints]])
Arguments:
  • colorMap (Map <number, Color> | IdColorMap()) – None
  • alsoApplyToWireframe (boolean()) – optional None
  • alsoApplyToPoints (boolean()) – optional None
Return type:

Promise <void>

setNodesCullingVector

IModel.setNodesCullingVector(nodeIds, space, vector, toleranceDegrees)
Arguments:
  • nodeIds ([number]()) – None
  • space (CullingVectorSpace()) – None
  • vector (Point3()) – None
  • toleranceDegrees (number()) – None
Return type:

Promise <void>

setNodesFaceColor

IModel.setNodesFaceColor(ids, color)
Arguments:
  • ids ([number]()) – None
  • color (Color()) – None
Return type:

void

setNodesFaceEmissiveColor

IModel.setNodesFaceEmissiveColor(ids, color)
Arguments:
  • ids ([number]()) – None
  • color (Color()) – None
Return type:

void

setNodesFaceSpecularColor

IModel.setNodesFaceSpecularColor(ids, color)
Arguments:
  • ids ([number]()) – None
  • color (Color()) – None
Return type:

void

setNodesFaceSpecularIntensity

IModel.setNodesFaceSpecularIntensity(ids, value)
Arguments:
  • ids ([number]()) – None
  • value (number()) – None
Return type:

void

setNodesHighlighted

IModel.setNodesHighlighted(ids, highlighted)
Arguments:
  • ids ([number]()) – None
  • highlighted (boolean()) – None
Return type:

void

setNodesLineColor

IModel.setNodesLineColor(ids, color)
Arguments:
  • ids ([number]()) – None
  • color (Color()) – None
Return type:

void

setNodesLinePattern

IModel.setNodesLinePattern(nodeIds, pattern, patternLength, patternLengthUnit)
Arguments:
  • nodeIds ([number]()) – None
  • pattern (LinePattern()) – None
  • patternLength (number()) – None
  • patternLengthUnit (LinePatternLengthUnit()) – None
Return type:

void

setNodesOpacities

IModel.setNodesOpacities(params)
Arguments:
  • params (Map <number, number> | IdNumberMap()) – None
Return type:

void

setNodesOpacity

IModel.setNodesOpacity(ids, opacity)
Arguments:
  • ids ([number]()) – None
  • opacity (number()) – None
Return type:

void

setNodesPointColor

IModel.setNodesPointColor(ids, color)
Arguments:
  • ids ([number]()) – None
  • color (Color()) – None
Return type:

void

setNodesTexture

IModel.setNodesTexture(nodeIds, options)
Arguments:
Return type:

Promise <void>

setNodesVisibilities

IModel.setNodesVisibilities(mapping[, initiallyHiddenStayHidden])
Arguments:
  • mapping (Map <number, boolean> | IdBooleanMap()) – None
  • initiallyHiddenStayHidden (null | boolean()) – optional None
Return type:

Promise <void>

setNodesVisibility

IModel.setNodesVisibility(ids, value[, initiallyHiddenStayHidden])
Arguments:
  • ids ([number]()) – None
  • value (boolean()) – None
  • initiallyHiddenStayHidden (null | boolean()) – optional None
Return type:

void

setPart

IModel.setPart(assemblyNodeId, partNodeId)
Arguments:
  • assemblyNodeId (undefined | null | number()) – None
  • partNodeId (undefined | null | number()) – None
Return type:

boolean

setPhysicalProperties

IModel.setPhysicalProperties(id, gravityCenter, surfaceArea, volume)
Arguments:
  • id (number()) – None
  • gravityCenter (Point3()) – None
  • surfaceArea (number()) – None
  • volume (number()) – None
Return type:

boolean

setPmiColor

IModel.setPmiColor(color)
Arguments:
Return type:

void

setPmiColorOverride

IModel.setPmiColorOverride(enableOverride[, rootId])
Arguments:
  • enableOverride (boolean()) – None
  • rootId (number()) – optional None
Return type:

Promise <void>

setViewAxes

IModel.setViewAxes(frontVector, upVector)
Arguments:
Return type:

void

switchToModel

IModel.switchToModel(newModelFilename)
Arguments:
  • newModelFilename (string()) – None
Return type:

Promise <[number]>

triangulatePolygon

IModel.triangulatePolygon(polygonPoints, normal)
Arguments:
  • polygonPoints (Float32Array | [number]()) – None
  • normal (Point3()) – None
Return type:

Float32Array

unsetDepthRange

IModel.unsetDepthRange(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

void

unsetMetallicRoughness

IModel.unsetMetallicRoughness(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

void

unsetNodeFaceColor

IModel.unsetNodeFaceColor(id, faceId)
Arguments:
  • id (number()) – None
  • faceId (number()) – None
Return type:

void

unsetNodeLineColor

IModel.unsetNodeLineColor(id, lineId)
Arguments:
  • id (number()) – None
  • lineId (number()) – None
Return type:

void

unsetNodePointColor

IModel.unsetNodePointColor(id, pointId)
Arguments:
  • id (number()) – None
  • pointId (number()) – None
Return type:

void

unsetNodesAmbientColor

IModel.unsetNodesAmbientColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

unsetNodesCullingVectors

IModel.unsetNodesCullingVectors(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

Promise <void>

unsetNodesFaceColor

IModel.unsetNodesFaceColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

unsetNodesFaceEmissiveColor

IModel.unsetNodesFaceEmissiveColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

unsetNodesFaceSpecularColor

IModel.unsetNodesFaceSpecularColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

unsetNodesFaceSpecularIntensity

IModel.unsetNodesFaceSpecularIntensity(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

unsetNodesLineColor

IModel.unsetNodesLineColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

unsetNodesLinePattern

IModel.unsetNodesLinePattern(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

void

unsetNodesPointColor

IModel.unsetNodesPointColor(ids)
Arguments:
  • ids ([number]()) – None
Return type:

void

unsetNodesTexture

IModel.unsetNodesTexture(nodeIds)
Arguments:
  • nodeIds ([number]()) – None
Return type:

void

viewAxesHaveBeenSet

IModel.viewAxesHaveBeenSet()
Return type:boolean