IModel
-
class
IModel
()
Methods
_allowNodeDeletion()
_firstAssemblyDataHeader()
_gatherInstanceIncsFromNodeIds()
_getModelStructure()
_getNodeFromInstanceInc()
_hwfAwaitAssemblyTreeReady()
_preventMeshDeletion()
_preventNodeDeletion()
_setDefaultView()
_setInstanceModifier()
_setModelStructure()
_setNodesMatrices()
activateCadConfiguration()
activateCadView()
activateDefaultCadConfiguration()
activateDefaultCadView()
addPropertyToNode()
cadConfigurationsEnabled()
clear()
clearNodeFaceVisibility()
clearNodeLineVisibility()
clearNodePointVisibility()
computeMinimumBodyBodyDistance()
computeMinimumFaceFaceDistance()
computeMinimumFaceLineDistance()
computeMinimumFaceRayDistance()
createAndAddRepresentationItem()
createCadView()
createImage()
createMesh()
createMeshInstance()
createNode()
createPart()
createPmiInstance()
deleteImages()
deleteMeshInstances()
deleteMeshes()
deleteNode()
getAbsoluteRootNode()
getActiveCadConfiguration()
getAssociatedModelKey()
getBimIdConnectedElements()
getBimIdFromNode()
getBimIdRelatedElements()
getBimIdRelatingElements()
getBimIdsFromGenericId()
getBimInfoFromBimId()
getBranchVisibility()
getCadConfigurations()
getCadViewConfiguration()
getCadViewMap()
getCadViewPmis()
getDataFromIds()
getDefaultCadConfiguration()
getDefaultCadView()
getEdgeAttributes()
getEdgeCount()
getEdgeProperty()
getFaceAttributes()
getFaceCount()
getFaceProperty()
getFilterName()
getFilters()
getFiltersWithNode()
getGenericIdFromBimId()
getGenericTypeIdMap()
getGenericTypes()
getLayerIdsFromName()
getLayerName()
getLayers()
getLooseBounding()
getLowestAvailableNodeId()
getMeshIds()
getMetallicRoughness()
getModelBounding()
getModelFileNameFromNode()
getModelFileTypeFromNode()
getNodeCappingMeshData()
getNodeChildren()
getNodeColorMap()
getNodeEffectiveFaceColor()
getNodeEffectiveLineColor()
getNodeEffectivePointColor()
getNodeExchangeId()
getNodeFaceColor()
getNodeFaceHighlighted()
getNodeGenericId()
getNodeGenericType()
getNodeIdFromBimId()
getNodeIdFromScInstanceKey()
getNodeIdOffset()
getNodeIdsByGenericIds()
getNodeLayerId()
getNodeLineColor()
getNodeLineHighlighted()
getNodeMatrix()
getNodeMeshData()
getNodeName()
getNodeNetMatrix()
getNodeParent()
getNodePointColor()
getNodePointHighlighted()
getNodeProperties()
getNodeRealBounding()
getNodeType()
getNodeUnitMultiplier()
getNodeUserData()
getNodeUserDataIndices()
getNodeVisibility()
getNodesAmbientColor()
getNodesBounding()
getNodesByGenericType()
getNodesCappingMeshData()
getNodesCullingVectors()
getNodesEffectiveAmbientColor()
getNodesEffectiveEmissiveColor()
getNodesEffectiveFaceColor()
getNodesEffectiveLineColor()
getNodesEffectiveOpacity()
getNodesEffectivePointColor()
getNodesEffectiveSpecularColor()
getNodesFaceColor()
getNodesFaceEmissiveColor()
getNodesFaceSpecularColor()
getNodesFromFiltersId()
getNodesFromLayer()
getNodesFromLayerName()
getNodesFromLayers()
getNodesHaveTransparency()
getNodesHighlighted()
getNodesInstancingSamePart()
getNodesLineColor()
getNodesMaterial()
getNodesOpacity()
getNodesPointColor()
getOutOfHierarchy()
getPmiColor()
getPmiColorOverride()
getPmiSubtype()
getPmiTopologyReferences()
getPmiType()
getPmis()
getPointAttributes()
getRelationshipTypesFromBimId()
getScInstanceKey()
getUniqueLayerNames()
getViewAxes()
getVisibilityState()
hasDepthRange()
hasEffectiveGenericType()
isAnnotationView()
isCombineStateView()
isDrawing()
isFaceMeasurable()
isLineMeasurable()
isMeasurable()
isNodeLoaded()
isWithinExternalModel()
loadMeasurementFromFile()
loadMeasurementFromJson()
loadMeasurementFromString()
loadSubtreeFromModel()
loadSubtreeFromScsBuffer()
loadSubtreeFromScsFile()
loadSubtreeFromScsXmlBuffer()
loadSubtreeFromScsXmlFile()
loadSubtreeFromXmlBuffer()
loadSubtreeFromXmlFile()
registerBimNodes()
registerIfcNodes()
replaceMesh()
requestNodes()
reset()
resetModelHighlight()
resetModelOpacity()
resetNodeMatrixToInitial()
resetNodesColor()
resetNodesMaterial()
resetNodesOpacity()
resetNodesTransform()
resetNodesVisibility()
setBehaviorInitiallyHidden()
setBodyNodesVisibility()
setDepthRange()
setEdgeProperty()
setEnableAutomaticUnitScaling()
setFaceProperty()
setInstanceModifier()
setMeshLevel()
setMetallicRoughness()
setNodeFaceColor()
setNodeFaceHighlighted()
setNodeFaceVisibility()
setNodeLineColor()
setNodeLineHighlighted()
setNodeLineVisibility()
setNodeMatrix()
setNodePointColor()
setNodePointHighlighted()
setNodePointVisibility()
setNodesAmbientColor()
setNodesAmbientMix()
setNodesColors()
setNodesCullingVector()
setNodesFaceColor()
setNodesFaceEmissiveColor()
setNodesFaceSpecularColor()
setNodesFaceSpecularIntensity()
setNodesHighlighted()
setNodesLineColor()
setNodesLinePattern()
setNodesMaterial()
setNodesOpacities()
setNodesOpacity()
setNodesPointColor()
setNodesTexture()
setNodesVisibilities()
setNodesVisibility()
setPart()
setPhysicalProperties()
setPmiColor()
setPmiColorOverride()
setViewAxes()
switchToModel()
triangulatePolygon()
unsetDepthRange()
unsetMetallicRoughness()
unsetNodeFaceColor()
unsetNodeLineColor()
unsetNodePointColor()
unsetNodesAmbientColor()
unsetNodesCullingVectors()
unsetNodesFaceColor()
unsetNodesFaceEmissiveColor()
unsetNodesFaceSpecularColor()
unsetNodesFaceSpecularIntensity()
unsetNodesLineColor()
unsetNodesLinePattern()
unsetNodesPointColor()
unsetNodesTexture()
viewAxesHaveBeenSet()
Methods
_allowNodeDeletion
_firstAssemblyDataHeader
-
IModel.
_firstAssemblyDataHeader
() Return type: AssemblyDataHeader()
| null
_gatherInstanceIncsFromNodeIds
-
IModel.
_gatherInstanceIncsFromNodeIds
(nodeIds[, allowedTypes]) Arguments: - nodeIds ([NodeId]) – None
- allowedTypes (BodyTypeBits) – optional None
Return type: InstanceIncs
_getModelStructure
-
IModel.
_getModelStructure
() Return type: IModelStructure()
_getNodeFromInstanceInc
_preventMeshDeletion
_preventNodeDeletion
_setInstanceModifier
-
IModel.
_setInstanceModifier
(instanceModifier, nodeIds, value, allowedTypes) Arguments: - instanceModifier (InstanceModifier) – None
- nodeIds ([NodeId]) – None
- value (
boolean()
) – None - allowedTypes (BodyTypeBits) – None
Return type: void
_setModelStructure
-
IModel.
_setModelStructure
(modelStructure) Arguments: - modelStructure (
IModelStructure()
) – None
Return type: void
- modelStructure (
_setNodesMatrices
activateCadConfiguration
activateCadView
activateDefaultCadConfiguration
activateDefaultCadView
addPropertyToNode
clearNodeFaceVisibility
clearNodeLineVisibility
clearNodePointVisibility
computeMinimumBodyBodyDistance
-
IModel.
computeMinimumBodyBodyDistance
(partId1, partId2) Arguments: Return type: Promise <
FaceFaceDistanceItem()
>
computeMinimumFaceFaceDistance
-
IModel.
computeMinimumFaceFaceDistance
(partId1, faceId1, partId2, faceId2) Arguments: Return type: Promise <
FaceFaceDistanceItem()
>
computeMinimumFaceLineDistance
-
IModel.
computeMinimumFaceLineDistance
(partId, faceId, ray) Arguments: Return type: Promise <
FaceFaceDistanceItem()
>
computeMinimumFaceRayDistance
-
IModel.
computeMinimumFaceRayDistance
(partId, faceId, ray) Arguments: Return type: Promise <
FaceFaceDistanceItem()
>
createAndAddRepresentationItem
createCadView
-
IModel.
createCadView
(nodeId, viewName, camera[, pmiIds[, nodesToShow[, nodesToHide[, nodeIdsAndLocalTransforms[, cuttingPlane[, meshInstanceData]]]]]]) Arguments: - nodeId (NodeId) – None
- viewName (
string()
) – None - camera (
Camera()
) – None - pmiIds ([PmiId] | null) – optional None
- nodesToShow ([NodeId] | null) – optional None
- nodesToHide ([NodeId] | null) – optional None
- nodeIdsAndLocalTransforms ([(NodeId, Matrix)] | null) – optional None
- cuttingPlane (Plane | null) – optional None
- meshInstanceData (
MeshInstanceData()
| null) – optional None
Return type: CadViewId | null
createImage
-
IModel.
createImage
(primaryImage[, thumbnailImage]) Arguments: - primaryImage (
ImageOptions()
) – None - thumbnailImage (
ImageOptions()
) – optional None
Return type: Promise <ImageId>
- primaryImage (
createMesh
-
IModel.
createMesh
(meshData[, config]) Arguments: - meshData (
MeshData()
) – None - config (
function()
) – optional None
Return type: Promise <MeshId>
- meshData (
createMeshInstance
-
IModel.
createMeshInstance
(data[, parentNodeId[, preventFromResetting[, isOutOfHierarchy]]]) Arguments: - data (
MeshInstanceData()
) – None - parentNodeId (NodeId | null) – optional None
- preventFromResetting (
boolean | null()
) – optional None - isOutOfHierarchy (
boolean | null()
) – optional None
Return type: Promise <NodeId>
- data (
createNode
-
IModel.
createNode
(parentNodeId, nodeName[, nodeId[, localMatrix[, visibility[, measurementUnit]]]]) Arguments: Return type:
createPart
createPmiInstance
-
IModel.
createPmiInstance
(data, pmiType, pmiSubType, refOnTopoItems[, parentNodeId]) Arguments: - data (
MeshInstanceData()
) – None - pmiType (
PmiType()
) – None - pmiSubType (PmiSubType) – None
- refOnTopoItems ([
RefOnTopoItem()
]) – None - parentNodeId (NodeId | null) – optional None
Return type: Promise <PmiId>
- data (
deleteImages
deleteMeshInstances
getAssociatedModelKey
getBimIdConnectedElements
-
IModel.
getBimIdConnectedElements
(node, bimId, type) Arguments: - node (NodeId) – None
- bimId (BimId) – None
- type (RelationshipType) – None
Return type: function
getBimIdFromNode
getBimIdRelatingElements
-
IModel.
getBimIdRelatingElements
(node, bimId, type) Arguments: - node (NodeId) – None
- bimId (BimId) – None
- type (RelationshipType) – None
Return type: [BimId]
getBimIdsFromGenericId
getBimInfoFromBimId
getCadConfigurations
-
IModel.
getCadConfigurations
() Return type: IdStringMap()
getCadViewConfiguration
getCadViewPmis
getDataFromIds
-
IModel.
getDataFromIds
(ids) Arguments: - ids (
DataIds()
) – None
Return type: Promise <[Uint8Array]>
- ids (
getEdgeAttributes
-
IModel.
getEdgeAttributes
(id, edgeIndex) Arguments: - id (NodeId) – None
- edgeIndex (
number()
) – None
Return type: Promise <
SubentityAttributes()
| null>
getEdgeProperty
getFaceAttributes
-
IModel.
getFaceAttributes
(id, faceIndex) Arguments: - id (NodeId) – None
- faceIndex (
number()
) – None
Return type: Promise <
SubentityAttributes()
| null>
getFaceProperty
getFilterName
-
IModel.
getFilterName
(filterId) Arguments: - filterId (FilterId) – None
Return type: FilterName | null
getFilters
-
IModel.
getFilters
() Return type: Map <FilterId, FilterName>
getFiltersWithNode
getGenericIdFromBimId
getGenericTypeIdMap
-
IModel.
getGenericTypeIdMap
() Return type: Map <GenericType, Set <NodeId>>
getGenericTypes
-
IModel.
getGenericTypes
() Return type: [GenericType]
getLayerIdsFromName
getLayerName
getMetallicRoughness
-
IModel.
getMetallicRoughness
(nodeIds) Arguments: - nodeIds ([NodeId]) – None
Return type: Promise <[
MetallicRoughnessValue()
]>
getModelBounding
-
IModel.
getModelBounding
(ignoreInvisible, includeExcluded[, tightBounding]) Arguments: - ignoreInvisible (
boolean()
) – None - includeExcluded (
boolean()
) – None - tightBounding (
boolean()
) – optional None
Return type: Promise <Box>
- ignoreInvisible (
getModelFileNameFromNode
getModelFileTypeFromNode
getNodeCappingMeshData
-
IModel.
getNodeCappingMeshData
(id) Arguments: - id (NodeId) – None
Return type: Promise <
MeshDataCopy()
| null>
getNodeChildren
getNodeColorMap
-
IModel.
getNodeColorMap
(id, elementType) Arguments: - id (NodeId) – None
- elementType (ElementType) – None
Return type:
getNodeEffectiveFaceColor
getNodeEffectiveLineColor
getNodeEffectivePointColor
getNodeExchangeId
-
IModel.
getNodeExchangeId
(id) Arguments: - id (NodeId) – None
Return type: ExchangeId | null
getNodeFaceColor
getNodeFaceHighlighted
getNodeGenericId
getNodeGenericType
-
IModel.
getNodeGenericType
(id) Arguments: - id (NodeId) – None
Return type: GenericType | null
getNodeIdFromBimId
getNodeIdFromScInstanceKey
getNodeIdsByGenericIds
getNodeLineColor
getNodeLineHighlighted
getNodeMeshData
-
IModel.
getNodeMeshData
(id) Arguments: - id (NodeId) – None
Return type: Promise <
MeshDataCopy()
>
getNodePointColor
getNodePointHighlighted
getNodeProperties
-
IModel.
getNodeProperties
(id[, computeFromChildren]) Arguments: - id (NodeId) – None
- computeFromChildren (
boolean()
) – optional None
Return type: Promise <
StringStringMap()
| null>
getNodeRealBounding
getNodeUnitMultiplier
getNodeUserData
-
IModel.
getNodeUserData
(id, index) Arguments: - id (NodeId) – None
- index (UserDataIndex) – None
Return type: Uint8Array
getNodeUserDataIndices
getNodesAmbientColor
getNodesBounding
-
IModel.
getNodesBounding
(ids[, config]) Arguments: - ids ([NodeId]) – None
- config (
GetNodesBoundingConfig()
) – optional None
Return type: Promise <Box>
getNodesByGenericType
-
IModel.
getNodesByGenericType
(genericType) Arguments: - genericType (GenericType) – None
Return type: Set <NodeId> | null
getNodesCappingMeshData
-
IModel.
getNodesCappingMeshData
(nodeIds) Arguments: - nodeIds ([NodeId]) – None
Return type: Promise <[
MeshDataCopy()
]>
getNodesCullingVectors
-
IModel.
getNodesCullingVectors
(nodeIds) Arguments: - nodeIds ([NodeId]) – None
Return type: Promise <[
CullingVector()
]>
getNodesEffectiveAmbientColor
getNodesEffectiveEmissiveColor
getNodesEffectiveFaceColor
getNodesEffectiveLineColor
getNodesEffectiveOpacity
-
IModel.
getNodesEffectiveOpacity
(ids, elementType) Arguments: - ids ([NodeId]) – None
- elementType (ElementType) – None
Return type: Promise <[number]>
getNodesEffectivePointColor
getNodesEffectiveSpecularColor
getNodesFaceColor
getNodesFaceEmissiveColor
getNodesFaceSpecularColor
getNodesFromFiltersId
-
IModel.
getNodesFromFiltersId
(filtersId) Arguments: - filtersId ([FilterId]) – None
Return type: FilteredNodes()
| null
getNodesFromLayer
getNodesFromLayerName
getNodesFromLayers
getNodesHaveTransparency
getNodesHighlighted
getNodesInstancingSamePart
getNodesLineColor
getNodesMaterial
-
IModel.
getNodesMaterial
(nodeIds) Arguments: - nodeIds ([NodeId]) – None
Return type: Promise <[
IMaterial()
]>
getNodesOpacity
getNodesPointColor
getPmiTopologyReferences
-
IModel.
getPmiTopologyReferences
(pmiNodeId) Arguments: - pmiNodeId (NodeId) – None
Return type: [
RefOnTopoItem()
] | null
getPmis
-
IModel.
getPmis
() Return type: IdStringMap()
getPointAttributes
-
IModel.
getPointAttributes
(id, pointIndex) Arguments: - id (NodeId) – None
- pointIndex (
number()
) – None
Return type: Promise <
SubentityAttributes()
| null>
getRelationshipTypesFromBimId
-
IModel.
getRelationshipTypesFromBimId
(node, bimId) Arguments: Return type:
getScInstanceKey
getViewAxes
-
IModel.
getViewAxes
() Return type: ViewAxes()
getVisibilityState
-
IModel.
getVisibilityState
(id) Arguments: - id (NodeId) – None
Return type: Promise <
VisibilityState()
>
hasDepthRange
hasEffectiveGenericType
-
IModel.
hasEffectiveGenericType
(nodeId, genericType) Arguments: - nodeId (NodeId) – None
- genericType (GenericType) – None
Return type: boolean
isAnnotationView
isCombineStateView
isFaceMeasurable
isLineMeasurable
isWithinExternalModel
loadMeasurementFromFile
-
IModel.
loadMeasurementFromFile
(filename) Arguments: - filename (
string()
) – None
Return type: Promise <void>
- filename (
loadMeasurementFromJson
-
IModel.
loadMeasurementFromJson
(json) Arguments: - json (
any()
) – None
Return type: Promise <void>
- json (
loadMeasurementFromString
-
IModel.
loadMeasurementFromString
(str) Arguments: - str (
string()
) – None
Return type: Promise <void>
- str (
loadSubtreeFromModel
loadSubtreeFromScsBuffer
loadSubtreeFromScsFile
loadSubtreeFromScsXmlBuffer
-
IModel.
loadSubtreeFromScsXmlBuffer
(nodeId, xmlData[, modelNameToScs, args]) Arguments: - nodeId (NodeId) – None
- xmlData (
string | Document()
) – None - modelNameToScs (ModelNameToScsFileFunc | null) – optional None
- args (
[any]()
) – None
Return type: Promise <[NodeId]>
loadSubtreeFromScsXmlFile
-
IModel.
loadSubtreeFromScsXmlFile
(nodeId, xmlFilename[, modelNameToScs, args]) Arguments: - nodeId (NodeId) – None
- xmlFilename (XmlFilename) – None
- modelNameToScs (ModelNameToScsFileFunc | null) – optional None
- args (
[any]()
) – None
Return type: Promise <[NodeId]>
loadSubtreeFromXmlBuffer
-
IModel.
loadSubtreeFromXmlBuffer
(nodeId, xmlData[, massageModelName, args]) Arguments: - nodeId (NodeId) – None
- xmlData (
string | Document()
) – None - massageModelName (MassageModelNameFunc | null) – optional None
- args (
[any]()
) – None
Return type: Promise <[NodeId]>
loadSubtreeFromXmlFile
-
IModel.
loadSubtreeFromXmlFile
(nodeId, xmlFilename[, massageModelName, args]) Arguments: - nodeId (NodeId) – None
- xmlFilename (XmlFilename) – None
- massageModelName (MassageModelNameFunc | null) – optional None
- args (
[any]()
) – None
Return type: Promise <[NodeId]>
registerBimNodes
-
IModel.
registerBimNodes
(id, attributeToMask[, legacy_useAttributeTitle]) Arguments: - id (NodeId) – None
- attributeToMask (
function()
) – None - legacy_useAttributeTitle (
string | boolean | null()
) – optional None
Return type: Promise <void>
-
IModel.
attributeToMask
(value) Arguments: - value (
string()
) – None
Return type: BimMask
- value (
registerIfcNodes
replaceMesh
-
IModel.
replaceMesh
(id, data) Arguments: - id (MeshId) – None
- data (
MeshData()
) – None
Return type: Promise <void>
requestNodes
resetNodeMatrixToInitial
resetNodesMaterial
-
IModel.
resetNodesMaterial
(nodeIds[, params]) Arguments: - nodeIds ([NodeId]) – None
- params ([MaterialParam]) – optional None
Return type: void
setBodyNodesVisibility
setDepthRange
setEdgeProperty
setEnableAutomaticUnitScaling
-
IModel.
setEnableAutomaticUnitScaling
(enabled) Arguments: - enabled (
boolean()
) – None
Return type: void
- enabled (
setFaceProperty
setInstanceModifier
-
IModel.
setInstanceModifier
(instanceModifier, nodeIds, value) Arguments: - instanceModifier (InstanceModifier) – None
- nodeIds ([NodeId]) – None
- value (
boolean()
) – None
Return type: Promise <void>
setMeshLevel
setMetallicRoughness
setNodeFaceColor
setNodeFaceHighlighted
setNodeFaceVisibility
setNodeLineColor
setNodeLineHighlighted
setNodeLineVisibility
setNodeMatrix
setNodePointColor
setNodePointHighlighted
setNodePointVisibility
setNodesAmbientColor
setNodesAmbientMix
setNodesColors
-
IModel.
setNodesColors
(colorMap[, alsoApplyToWireframe[, alsoApplyToPoints]]) Arguments: - colorMap (Map <NodeId, Color> |
IdColorMap()
) – None - alsoApplyToWireframe (
boolean()
) – optional None - alsoApplyToPoints (
boolean()
) – optional None
Return type: Promise <void>
- colorMap (Map <NodeId, Color> |
setNodesCullingVector
-
IModel.
setNodesCullingVector
(nodeIds, space, vector, toleranceDegrees) Arguments: - nodeIds ([NodeId]) – None
- space (CullingVectorSpace) – None
- vector (
Point3()
) – None - toleranceDegrees (Degrees) – None
Return type: Promise <void>
setNodesFaceColor
setNodesFaceEmissiveColor
setNodesFaceSpecularColor
setNodesFaceSpecularIntensity
setNodesHighlighted
setNodesLineColor
setNodesLinePattern
-
IModel.
setNodesLinePattern
(nodeIds, pattern, patternLength, patternLengthUnit) Arguments: - nodeIds ([NodeId]) – None
- pattern (LinePattern) – None
- patternLength (
number()
) – None - patternLengthUnit (LinePatternLengthUnit) – None
Return type: void
setNodesMaterial
-
IModel.
setNodesMaterial
(nodeIds, material) Arguments: - nodeIds ([NodeId]) – None
- material (
IMaterial()
) – None
Return type: void
setNodesOpacities
-
IModel.
setNodesOpacities
(params) Arguments: - params (Map <NodeId, number> |
IdNumberMap()
) – None
Return type: void
- params (Map <NodeId, number> |
setNodesOpacity
setNodesPointColor
setNodesTexture
-
IModel.
setNodesTexture
(nodeIds, options) Arguments: - nodeIds ([NodeId]) – None
- options (
TextureOptions()
) – None
Return type: Promise <void>
setNodesVisibilities
-
IModel.
setNodesVisibilities
(mapping[, initiallyHiddenStayHidden]) Arguments: - mapping (Map <NodeId, boolean> |
IdBooleanMap()
) – None - initiallyHiddenStayHidden (
boolean | null()
) – optional None
Return type: Promise <void>
- mapping (Map <NodeId, boolean> |