communicator Reference

Deprecated List

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Action

ActionLike

ActionResult

AnyBody

AnyContainerNode

AnyEvent

AnyNode

AnyNonTreeNode

AnyTreeContext

AnyTreeNode

AssemblyDataHeaderVersion

AttachContextParent

AttachData

AttachPriority

AuthoredNodeId

BCFCommentId

BCFMarkupName

BCFName

BCFTopicId

BCFViewpointName

Base

BeginConfig

BimId

BodyId

BodyInstanceInfo

BodyInstanceParent

BuiltInOperatorId

CadViewId

CadViewParent

CameraRotateFunction

CanvasEventName

CanvasImageSource

ChildContext

ColorMap

CompareGreater

Degrees

DeletableNode

DocumentEventName

DynamicNodeId

Edge

Exact

ExchangeId

ExternalModelInfo

ExternalModelName

Face

FilterName

GenericId

GenericType

GenericTypeMaps

HasInclusionContext

HtmlId

ImageId

KeyframeIndex

LayerName

LazyLike

LightKey

LinePattern

LoadContextParent

LoadId

MassageModelNameFunc

MaterialParam

MeshId

Mode

ModelFileNodeInfo

ModelNameToScsFileFunc

NodeId

NodeIdOffset

NonXmlAttachPriorityValue

PartDefinitionReferrer

PartId

PhantomMember

Pixels

PmiBodyInfo

PmiBodyParent

PmiId

PmiParent

Predicate

ProductOccurrenceParent

Radians

RepresentationItemParent

RuntimeNodeId

ScsUri

SelectionDriver

SelectionFilter

SheetId

StateReducer

TerseArray0

TerseArray1

ToAttachDataFunc

UserDataIndex

Uuid

Vector3

Vector4

VersionNumber

VersionedToAttachDataFunc

ViewFrameInfo

ViewFrameParent

VisibilityFormatter

XRayTransparencyMode

XmlAttachPriorityProxy

XmlFilename

Variables

ArcSegmentCount
Type:30
BUILD_ID
Type:‘<BUILD_ID>’
DefaultTransitionDuration
Type:400
EmptyModelName
Type:‘_empty’
IfcColumn
Type:‘IFCCOLUMN’
IfcCovering
Type:‘IFCCOVERING’
IfcCurtainWall
Type:‘IFCCURTAINWALL’
IfcDoor
Type:‘IFCDOOR’
IfcRamp
Type:‘IFCRAMP’
IfcRoof
Type:‘IFCROOF’
IfcSlab
Type:‘IFCSLAB’
IfcSpace
Type:‘IFCSPACE’
IfcStair
Type:‘IFCSTAIR’
IfcStairFlight
Type:‘IFCSTAIRFLIGHT’
IfcTransportElement
Type:‘IFCTRANSPORTELEMENT’
IfcWall
Type:‘IFCWALL’
IfcWallStandardCase
Type:‘IFCWALLSTANDARDCASE’
IfcWindow
Type:‘IFCWINDOW’
InvalidNodeId
Type:NodeId
MAX_ANGLE
Type:150
MAX_TILT
Type:45
MIN_ANGLE
Type:30
MIN_TILT
Type:-45
MaxModelFileVersion
Type:VersionNumber
Ohm
Type:‘Ω’
Subscript1
Type:‘¹’
Subscript2
Type:‘²’
Subscript3
Type:‘³’
SubscriptNeg
Type:‘⁻’
VIEWER_VERSION_STRING
Type:string
absoluteRootNodeId
Type:DynamicNodeId
bankCapacity
Type:1024
compressionTable
Type:[string]
defaultEndcapSize
Type:Pixels
defaultMaxConcurrentAttachments
Type:13
defaultNodeBits
Type:NodeBits
defaultOriginatingSystem
Type:‘HOOPS Communicator’
digitsRegex
Type:RegExp
disable
Type:boolean
enable
Type:boolean
invalidNodeId
Type:DynamicNodeId | RuntimeNodeId
jszip
Type:any
missingNodeName
Type:‘Missing’
nodeIdOffsetDelta
Type:NodeIdOffset
objectFactories
Type:Map <string, function>
objectFactories(flyWeight, args)
Arguments:
  • flyWeight (object()) – None
  • args ([any]()) – None
Return type:

any
svgNamespace
Type:‘http://www.w3.org/2000/svg’
top
Type:0
zeroPads
Type:[string]

Functions

TypeAssert

TypeAssert(_x)
Arguments:
  • _x (T()) – None
Return type:

void

TypeAssertNever

TypeAssertNever(_x)
Arguments:
  • _x (never()) – None
Return type:

never

_createCameraChannel

_createCameraChannel(animation, name, channelType, interpolationType)
Arguments:
Return type:

CameraChannel()

_createCircle

_createCircle(numSegments)
Arguments:
  • numSegments (number()) – None
Return type:

[number]

_createCircleFromPointAndNormal

_createCircleFromPointAndNormal(numSegments, position, normal, scale)
Arguments:
  • numSegments (number()) – None
  • position (Point3()) – None
  • normal (Point3()) – None
  • scale (number()) – None
Return type:

[Point3]

_createCone

_createCone(radius, numSegments, yOffset, height, matrix)
Arguments:
  • radius (number()) – None
  • numSegments (number()) – None
  • yOffset (number()) – None
  • height (number()) – None
  • matrix (Matrix()) – None
Return type:

[[number]]

_createCylinder

_createCylinder(radius, numSegments, height, matrix)
Arguments:
  • radius (number()) – None
  • numSegments (number()) – None
  • height (number()) – None
  • matrix (Matrix()) – None
Return type:

[[number]]

_createCylinderPosNorms

_createCylinderPosNorms(center1, center2, circle1, circle2, taperNormal)
Arguments:
  • center1 (Point3()) – None
  • center2 (Point3()) – None
  • circle1 ([Point3]()) – None
  • circle2 ([Point3]()) – None
  • taperNormal (boolean()) – None
Return type:

[[Point3]]

_createTaper

_createTaper(cylinderRadius, coneBaseRadius, numSegments, stemHeight, taperHeight)
Arguments:
  • cylinderRadius (number()) – None
  • coneBaseRadius (number()) – None
  • numSegments (number()) – None
  • stemHeight (number()) – None
  • taperHeight (number()) – None
Return type:

[[number]]

_timerStressTest

_timerStressTest()
Return type:void

_updateVisibilities

_updateVisibilities(options, visitorArgs)
Arguments:
  • options (function()) – None
  • visitorArgs ([any]()) – None
Return type:

Promise <void>

add3

add3(u, v)
Arguments:
Return type:

Vector3

add4

add4(u, v)
Arguments:
Return type:

Vector4

addElem

addElem(doc, parentElem, elementName, elementContent)
Arguments:
  • doc (XMLDocument()) – None
  • parentElem (HTMLElement()) – None
  • elementName (string()) – None
  • elementContent (string()) – None
Return type:

void

alwaysFollow

alwaysFollow()
Return type:boolean

appendPoint3

appendPoint3(doc, elem, p)
Arguments:
  • doc (XMLDocument()) – None
  • elem (HTMLElement()) – None
  • p (Point3()) – None
Return type:

void

applyGravity

applyGravity(view, pointObject, downVector, maxFallDistance)
Arguments:
Return type:

Promise <Point3 | null>

argbStringFromColor

argbStringFromColor(color, alpha)
Arguments:
  • color (Color) – None
  • alpha (number | undefined()) – None
Return type:

string

arrayBufferToBase64

arrayBufferToBase64(buffer)
Arguments:
  • buffer (Uint8Array()) – None
Return type:

string

boolToString

boolToString(b)
Arguments:
  • b (boolean()) – None
Return type:

string

buildCollisionRayConfig

buildCollisionRayConfig(bimMask, maxWorldDistance)
Arguments:
  • bimMask (BimMask()) –
  • maxWorldDistance (number | null()) –
Return type:

PickConfig()

canImplicitlyLoad

canImplicitlyLoad(info)
Arguments:
Return type:

boolean

checkXmlParseError

checkXmlParseError(xmlDoc)
Arguments:
  • xmlDoc (Document()) – None
Return type:

void

checkXmlVersion

checkXmlVersion(version)
Arguments:
Return type:

boolean

chunkify

chunkify(xs, chunkCapacity)
Arguments:
  • xs ([T]()) – None
  • chunkCapacity (number()) – None
Return type:

[[T]]

clamp

clamp(value, min, max)
Arguments:
  • value (number()) – None
  • min (number()) – None
  • max (number()) – None
Return type:

number

col4

col4(matrix, colIndex)
Arguments:
  • matrix (Matrix()) – None
  • colIndex (number()) – None
Return type:

Vector4

collectBodyInstances

collectBodyInstances(startNode)
Arguments:
Return type:

Promise <[BodyInstance()]>

collectBodyParents

collectBodyParents(startNode)
Arguments:
Return type:

Promise <[ProductOccurrence()]>

compareUserDataIndices

compareUserDataIndices(x, y)
Arguments:
Return type:

-1 | 0 | 1

compositeScreenShot

compositeScreenShot(canvas, layeredImageSources)
Arguments:
  • canvas (HTMLCanvasElement()) – None
  • layeredImageSources ([CanvasImageSource]) – None
Return type:

Promise <HTMLImageElement>

compressUint

compressUint(n)
Arguments:
  • n (number()) – None
Return type:

string

conditionalAddElem

conditionalAddElem(doc, parentElem, elementName, elementContent)
Arguments:
  • doc (XMLDocument()) – None
  • parentElem (HTMLElement()) – None
  • elementName (string()) – None
  • elementContent (string | undefined | null()) – None
Return type:

void

conditionalBoolToString

conditionalBoolToString(b)
Arguments:
  • b (boolean | undefined | null()) – None
Return type:

string | null

conditionalDateToString

conditionalDateToString(d)
Arguments:
  • d (Date | undefined | null()) – None
Return type:

string | null

conditionalNumberToString

conditionalNumberToString(n)
Arguments:
  • n (number | undefined | null()) – None
Return type:

string | null

conditionalSetAttribute

conditionalSetAttribute(elem, attrName, attrVal)
Arguments:
  • elem (HTMLElement()) – None
  • attrName (string()) – None
  • attrVal (string | undefined | null()) – None
Return type:

void

copyCanvas

copyCanvas(inCanvas)
Arguments:
  • inCanvas (HTMLCanvasElement()) – None
Return type:

HTMLCanvasElement

copyMap

copyMap(input)
Arguments:
  • input (Map) –
Return type:

Map <K, V>

copyOwnProperties

copyOwnProperties(from, to)
Arguments:
  • from (T()) – None
  • to (T()) – None
Return type:

void

copySet

copySet(input)
Arguments:
  • input (Set) –
Return type:

Set <T>

createCameraChannels

createCameraChannels(animation, namePrefix, interpolationType)
Arguments:
Return type:

[CameraChannel()]

createCircleMarker

createCircleMarker(position, strokeWidth, size, color)
Arguments:
Return type:

SVGCircleElement

createCompositeSelectionObject

createCompositeSelectionObject(scPick)
Arguments:
  • scPick (PickResult()) – None
Return type:

CompositeSelectionItem()

createCylinderMeshDataFromArc

createCylinderMeshDataFromArc(arc, axisDirection, numSegments, scale)
Arguments:
  • arc ([number]()) –
  • axisDirection (Point3()) –
  • numSegments (number()) –
  • scale (number()) –
Return type:

MeshData()

createDummyAttachment

createDummyAttachment(assemblyTree, remapper, parent, noModelInfo, attachScope, attachedInvisibly)
Arguments:
Return type:

AttachContext()

createEndArrowMarker

createEndArrowMarker(size, color)
Arguments:
Return type:

SVGMarkerElement

createOpenPromise

createOpenPromise()
Return type:OpenPromise() <T>

createSelectionObject

createSelectionObject(scPick)
Arguments:
  • scPick (PickResult()) – None
Return type:

NodeEntitySelectionItem() | null

createSelectionObjects

createSelectionObjects(scPick)
Arguments:
  • scPick (PickResult()) – None
Return type:

[NodeEntitySelectionItem()]

createSimpleAttachInfo

createSimpleAttachInfo(attachScope, attachInvisibly, inclusionKey, modelKey)
Arguments:
  • attachScope (AttachScope()) – None
  • attachInvisibly (boolean()) – None
  • inclusionKey (InclusionKey()) – None
  • modelKey (ModelKey()) – None
Return type:

AttachInfo()

createStartArrowMarker

createStartArrowMarker(size, color)
Arguments:
Return type:

SVGMarkerElement

createTrackedOpenPromise

createTrackedOpenPromise()
Return type:TrackedOpenPromise() <T>

createUnsafePromise

createUnsafePromise(promisedValue, readyPromise)
Arguments:
  • promisedValue (T()) –
  • readyPromise (Promise) –
Return type:

UnsafePromise() <T>

createUuid

createUuid()
Return type:Uuid

createXHR

createXHR()
Return type:XMLHttpRequest

cwiseAbs3

cwiseAbs3(v)
Arguments:
  • v ([number]()) – None
Return type:

Vector3

cwiseProduct3

cwiseProduct3(u, v)
Arguments:
  • u ([number]()) – None
  • v ([number]()) – None
Return type:

Vector3

deepClone

deepClone(obj)
Arguments:
  • obj (T()) – None
Return type:

T

delayCall

delayCall(cb, args)
Arguments:
  • cb (function()) –
  • args ([unknown]()) –
Return type:

ReturnType <setTimeout>
cb(cbArgs)
Arguments:
  • cbArgs ([unknown]()) – None
Return type:

unknown

dot3

dot3(u, v)
Arguments:
  • u ([number]()) – None
  • v ([number]()) – None
Return type:

number

exchangeIdEqual

exchangeIdEqual(exchangeIdA, exchangeIdB)
Arguments:
Return type:

boolean

exportAnimations

exportAnimations(animations)
Arguments:
Return type:

object

exportAnimationsImpl

exportAnimationsImpl(animations)
Arguments:
Return type:

function

exportColorMap

exportColorMap(colorMap)
Arguments:
Return type:

[any]

exportComponent

exportComponent(doc, component)
Arguments:
  • doc (XMLDocument()) – None
  • component (Component()) – None
Return type:

HTMLElement

filterInPlace

filterInPlace(xs, pred)
Arguments:
  • xs ([T]()) –
  • pred (function()) –
Return type:

void
pred(x)
Arguments:
  • x (T()) – None
Return type:

boolean

findCanvas

findCanvas(node)
Arguments:
Return type:

HTMLCanvasElement | null

followLoaded

followLoaded(node)
Arguments:
Return type:

boolean

forEach

forEach(nodes, callback)
Arguments:
  • nodes ([T]()) – None
  • callback (function()) – None
Return type:

Promise <void>
callback(node)
Arguments:
  • node (T()) – None
Return type:

void | Promise <void>

forcePartDefinition

forcePartDefinition(node)
Arguments:
Return type:

Promise <void> | void

forcePartDefinitionImpl

forcePartDefinitionImpl(node)
Arguments:
Return type:

Promise <void> | void

forcePartDefinitions

forcePartDefinitions(startNode)
Arguments:
Return type:

Promise <void>

forcePrototype

forcePrototype(node)
Arguments:
Return type:

Promise <void> | void

forcePrototypes

forcePrototypes(startNode)
Arguments:
Return type:

Promise <void>

fromArray

fromArray(xs)
Arguments:
  • xs ([T]()) –
Return type:

TerseArray0 <T, null>

fromIntegerMap

fromIntegerMap(obj)
Arguments:
Return type:

Map <K, V>

fromRealNumberMap

fromRealNumberMap(obj)
Arguments:
Return type:

Map <K, V>

fromStringMap

fromStringMap(obj)
Arguments:
Return type:

Map <K, V>

gatherAllNonPrototypeNodes

gatherAllNonPrototypeNodes(startNode, outNodes)
Arguments:
Return type:

Promise <void>

gatherBimNodes

gatherBimNodes(attributeToMask, modelStructure, nodes, legacy_useAttributeTitle)
Arguments:
Return type:

Promise <BimNodes()>
attributeToMask(value)
Arguments:
  • value (string()) – None
Return type:

BimMask

gatherInclusionKeysFromNodeIdsSync

gatherInclusionKeysFromNodeIdsSync(assemblyTree, nodeIds, restriction)
Arguments:
Return type:

[InclusionKey]

gatherInclusionKeysSync

gatherInclusionKeysSync(startNode, allowOutOfHierarchy, visited, restriction)
Arguments:
Return type:

[InclusionKey]

gatherInstanceIncs

gatherInstanceIncs(startNode, allowedTypes, allowOutOfHierarchy, visited)
Arguments:
Return type:

Promise <InstanceIncs>

gatherInstanceIncsByNodeIdsSync

gatherInstanceIncsByNodeIdsSync(assemblyTree, nodeIds, allowedTypes, restriction)
Arguments:
Return type:

InstanceIncs

gatherInstanceIncsSync

gatherInstanceIncsSync(startNode, allowedTypes, allowOutOfHierarchy, visited, restriction)
Arguments:
Return type:

InstanceIncs

gatherParentsOfPendingExternalModels

gatherParentsOfPendingExternalModels(startNode)
Arguments:
Return type:

Promise <[ProductOccurrence()]>

generateConeCylinderMeshData

generateConeCylinderMeshData(cylinderRadius, numSegments, stemHeight, coneBaseRadius, capHeight, taperHeight)
Arguments:
  • cylinderRadius (number()) –
  • numSegments (number()) –
  • stemHeight (number()) –
  • coneBaseRadius (number()) –
  • capHeight (number()) –
  • taperHeight (number()) –
Return type:

MeshData()

generateSphereMeshData

generateSphereMeshData()
Return type:MeshData()

getAuthoredId

getAuthoredId(nodeId)
Arguments:
Return type:

AuthoredNodeId

getBimType

getBimType(attributeToMask, modelStructure, inputNode, legacy_useAttributeTitle)
Arguments:
  • attributeToMask (function()) – None
  • modelStructure (IModelStructure()) – None
  • inputNode (AnyTreeNode) – None
  • legacy_useAttributeTitle (string | null()) – None
Return type:

Promise <BimMask>
attributeToMask(value)
Arguments:
  • value (string()) – None
Return type:

BimMask

getBinaryContent

getBinaryContent(path, options)
Arguments:
  • path (string()) – None
  • options (function | function()) – None
Return type:

any
options(args)
Arguments:
  • args ([any]()) – None
Return type:

any

getBodyInstancesVisibility

getBodyInstancesVisibility(node)
Arguments:
Return type:

BranchVisibility | undefined

getBoundingByNodeId

getBoundingByNodeId(assemblyTree, engine, nodeIds, bodyTypeMask, ignoreInvisible, tightBounding)
Arguments:
Return type:

Promise <Box>

getBranchVisibility

getBranchVisibility(node)
Arguments:
Return type:

BranchVisibility

getCadViewsVisibility

getCadViewsVisibility(node)
Arguments:
Return type:

BranchVisibility | undefined

getChildrenVisibility

getChildrenVisibility(node)
Arguments:
Return type:

BranchVisibility | undefined

getCrypto

getCrypto()
Return type:Crypto

getDownAxis

getDownAxis(model)
Arguments:
Return type:

Point3

getIndex

getIndex(xs, index)
Arguments:
  • xs ([T] | undefined()) – None
  • index (number()) – None
Return type:

T | null

getInstanceIncs

getInstanceIncs(bodies)
Arguments:
Return type:

InstanceIncs

getNetMatrix

getNetMatrix(startNode)
Arguments:
Return type:

Matrix16

getNodeColorMap

getNodeColorMap(startNode, engine, elementType)
Arguments:
Return type:

Promise <Map <RuntimeNodeId, Color>>

getNodeGenericType

getNodeGenericType(node)
Arguments:
Return type:

GenericType | null

getNodeType

getNodeType(node)
Arguments:
Return type:

NodeType

getObjectFactory

getObjectFactory(className)
Arguments:
  • className (string()) – None
Return type:

function | undefined

getPmisVisibility

getPmisVisibility(node)
Arguments:
Return type:

BranchVisibility | undefined

getRuntimeId

getRuntimeId(nodeId, node)
Arguments:
Return type:

RuntimeNodeId

getRuntimeIds

getRuntimeIds(nodes)
Arguments:
Return type:

[RuntimeNodeId]

getSubBranchVisibilities

getSubBranchVisibilities(node)
Arguments:
Return type:

BranchVisibility | null

getSubItemVisibility

getSubItemVisibility(nodes)
Arguments:
Return type:

BranchVisibility | undefined

getVisibilityState

getVisibilityState(startNode, initialState)
Arguments:
  • startNode (AnyTreeNode) – None
  • initialState (boolean()) – None
Return type:

Promise <VisibilityState()>

getWithDefault

getWithDefault(maybeValue, defaultValue)
Arguments:
  • maybeValue (T | undefined()) – None
  • defaultValue (T()) – None
Return type:

T

getXmlVersion

getXmlVersion(xmlDoc)
Arguments:
  • xmlDoc (Document()) – None
Return type:

VersionNumber | null

hasBits

hasBits(storedBits, desiredBits)
Arguments:
  • storedBits (number()) – None
  • desiredBits (number()) – None
Return type:

boolean

hasEffectiveGenericType

hasEffectiveGenericType(startNode, genericType)
Arguments:
Return type:

boolean

httpRequest

httpRequest(filename[, responseType])
Arguments:
  • filename (string()) – None
  • responseType (XMLHttpRequestResponseType()) – optional None
Return type:

Promise <XMLHttpRequest>

httpRequestBuffer

httpRequestBuffer(filename)
Arguments:
  • filename (string()) – None
Return type:

Promise <Uint8Array>

identity

identity(x)
Arguments:
  • x (T()) – None
Return type:

T

ifcAttributeToBimMask

ifcAttributeToBimMask(value)
Arguments:
  • value (string()) – None
Return type:

BimMask

ifcSelectionFilter

ifcSelectionFilter(nodeId, model)
Arguments:
Return type:

NodeId | null

importAnimations

importAnimations(exportedObj)
Arguments:
  • exportedObj (object()) – None
Return type:

[Animation()]

importColorMap

importColorMap(colorMapData)
Arguments:
Return type:

ColorMap

isAuthoredId

isAuthoredId(nodeId)
Arguments:
Return type:

nodeId

isBase10Number

isBase10Number(s)
Arguments:
  • s (string()) – None
Return type:

boolean

isCircleElement

isCircleElement(prop)
Arguments:
  • prop (object()) –
Return type:

boolean

isConvexPolyhedronConfig

isConvexPolyhedronConfig(config)
Arguments:
Return type:

config

isDirectlyUnderLoadContext

isDirectlyUnderLoadContext(inclusionContext)
Arguments:
Return type:

boolean

isEdge

isEdge(prop)
Arguments:
  • prop (Base) – None
Return type:

prop

isEmpty

isEmpty(xs)
Arguments:
Return type:

boolean

isFace

isFace(prop)
Arguments:
  • prop (object()) –
Return type:

boolean

isIncInfo

isIncInfo(info)
Arguments:
Return type:

info

isLineElement

isLineElement(prop)
Arguments:
  • prop (object()) –
Return type:

boolean

isMeasurable

isMeasurable(model, selectionItem)
Arguments:
Return type:

Promise <boolean>

isMouseEventType

isMouseEventType(eventType)
Arguments:
Return type:

boolean

isNameInfo

isNameInfo(info)
Arguments:
Return type:

info

isOtherEdgeElement

isOtherEdgeElement(prop)
Arguments:
  • prop (object()) –
Return type:

boolean

isOutOfHierarchy

isOutOfHierarchy(node)
Arguments:
Return type:

boolean

isPlaneElement

isPlaneElement(prop)
Arguments:
  • prop (object()) –
Return type:

boolean

isPointInBox

isPointInBox(point, box)
Arguments:
Return type:

boolean

isPointInBoxOnlyZ

isPointInBoxOnlyZ(point, box)
Arguments:
Return type:

boolean

isRayDrillConfig

isRayDrillConfig(config)
Arguments:
Return type:

config

isScreenByAreaConfig

isScreenByAreaConfig(config)
Arguments:
Return type:

config

isSphereConfig

isSphereConfig(config)
Arguments:
Return type:

config

keyframeCamera

keyframeCamera(t, camera, animation)
Arguments:
Return type:

void

left

left(i)
Arguments:
  • i (number()) – None
Return type:

number

majorAxis

majorAxis(p)
Arguments:
Return type:

Point3 | null

makeFaceFaceDistanceItem

makeFaceFaceDistanceItem(f)
Arguments:
Return type:

FaceFaceDistanceItem()

makeFetchScsCallback

makeFetchScsCallback(modelNameToScs)
Arguments:
Return type:

VersionedToAttachDataFunc

markContextsLoaded

markContextsLoaded(contexts)
Arguments:
Return type:

Promise <void>

markLoaded

markLoaded(partDef)
Arguments:
Return type:

void

mergeProximityItems

mergeProximityItems(items, lineResult, pointResult, proximityFaceResult)
Arguments:
  • items ([NodeEntitySelectionItem()]) – None
  • lineResult (LinePickResult | null()) – None
  • pointResult (PointPickResult | null()) – None
  • proximityFaceResult (ProximityFacePickResult | null()) – None
Return type:

void

modelFileNodeInfoAsProdOccInfo

modelFileNodeInfoAsProdOccInfo(nodeInfo)
Arguments:
Return type:

ProductOccurrenceInfo()

mostRelevantEntityArray

mostRelevantEntityArray(entitiesList)
Arguments:
  • entitiesList ([[ProximityEntity]]()) – None
Return type:

[ProximityEntity] | null

multiplyInMatrix

multiplyInMatrix(prodOccInfo, additionalMatrix)
Arguments:
Return type:

ProductOccurrenceInfo()

multiplyMatrices

multiplyMatrices(matrices)
Arguments:
  • matrices ([Matrix]()) – None
Return type:

Matrix

narrowAttachDataToScsBufferOrResponse

narrowAttachDataToScsBufferOrResponse(data)
Arguments:
Return type:

ScsBuffer | Response | null

nop

nop()
Return type:void

norm3

norm3(v)
Arguments:
  • v ([number]()) – None
Return type:

number

normalizeDirections

normalizeDirections(directions)
Arguments:
Return type:

void

padHexString

padHexString(hexValue)
Arguments:
  • hexValue (string()) – None
Return type:

string

parent

parent(i)
Arguments:
  • i (number()) – None
Return type:

number

parseBinary

parseBinary(parser)
Arguments:
Return type:

Face

parseXmlDocument

parseXmlDocument(xmlStr)
Arguments:
  • xmlStr (string()) – None
Return type:

Document

projectOnto

projectOnto(source, target)
Arguments:
Return type:

Point3

projectSquaredSize

projectSquaredSize(center, squaredSize, viewProjectionW)
Arguments:
  • center (Vector3) – None
  • squaredSize (number()) – None
  • viewProjectionW (Vector4) – None
Return type:

number

push

push(xs, x)
Arguments:
  • xs (TerseArray0 <T, null | undefined>) –
  • x (T()) –
Return type:

TerseArray1 <T>

rawGatherInclusionKeys

rawGatherInclusionKeys(walker, startNode, allowOutOfHierarchy, visited, restriction)
Arguments:
Return type:

Promise <[InclusionKey]> | [InclusionKey]

rawGatherInstanceIncs

rawGatherInstanceIncs(walker, startNode, allowedTypes, allowOutOfHierarchy, visited, restriction)
Arguments:
Return type:

Promise <InstanceIncs> | InstanceIncs

reformatMarkerStyle

reformatMarkerStyle(xml)
Arguments:
  • xml (string()) – None
Return type:

string

registerBimNodes

registerBimNodes(attributeToMask, engine, modelStructure, startNode, legacy_useAttributeTitle)
Arguments:
  • attributeToMask (function()) – None
  • engine (IScEngine()) – None
  • modelStructure (IModelStructure()) – None
  • startNode (AnyTreeNode) – None
  • legacy_useAttributeTitle (string | null()) – None
Return type:

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

BimMask

registerObjectFactory

registerObjectFactory(className, factory)
Arguments:
  • className (string()) – None
  • factory (function()) – None
Return type:

void
factory(flyWeight, args)
Arguments:
  • flyWeight (object()) – None
  • args ([any]()) – None
Return type:

any

removeOpposing

removeOpposing(set, x, y)
Arguments:
  • set (Set) –
  • x (T()) –
  • y (T()) –
Return type:

void

replaceCuttingPlanes

replaceCuttingPlanes(cuttingSection, cuttingPlanes)
Arguments:
  • cuttingSection (AbstractCuttingSection()) – None
  • cuttingPlanes ([Plane]) – None
Return type:

Promise <void>

requestXmlDocument

requestXmlDocument(xmlFilename)
Arguments:
Return type:

Promise <Document>

resetNodeTransform

resetNodeTransform(transformedNodes, node)
Arguments:
Return type:

void

resetTransforms

resetTransforms(startNode)
Arguments:
Return type:

Promise <boolean>

row4

row4(matrix, rowIndex)
Arguments:
  • matrix (Matrix()) – None
  • rowIndex (number()) – None
Return type:

Vector4

scale3

scale3(k, v)
Arguments:
  • k (number()) – None
  • v (Vector3) – None
Return type:

Vector3

scale4

scale4(k, v)
Arguments:
  • k (number()) – None
  • v (Vector4) – None
Return type:

Vector4

selectFaceEntity

selectFaceEntity(entity, isProximityFace)
Arguments:
  • entity (ScFaceEntity()) – None
  • isProximityFace (boolean()) – None
Return type:

FaceSelectionItem()

selectLineEntity

selectLineEntity(entity)
Arguments:
  • entity (ScLineEntity()) – None
Return type:

LineSelectionItem()

selectPointEntity

selectPointEntity(entity)
Arguments:
  • entity (ScPointEntity()) – None
Return type:

PointSelectionItem()

setBit

setBit(mask, bit, turnOn)
Arguments:
  • mask (number()) – None
  • bit (number()) – None
  • turnOn (boolean()) – None
Return type:

number

setIndex

setIndex(xs, index, x)
Arguments:
  • xs ([T] | undefined()) – None
  • index (number()) – None
  • x (T()) – None
Return type:

[T]

setMeshLevels

setMeshLevels(engine, startNodes, meshLevel)
Arguments:
Return type:

void

setSubtraction

setSubtraction(setA, setB)
Arguments:
  • setA (Set) –
  • setB (Set) –
Return type:

Set <T>

setToArray

setToArray(set)
Arguments:
  • set (Set) –
Return type:

[T]

sigmoidLike

sigmoidLike(x)
Arguments:
  • x (number()) – None
Return type:

number

sleep

sleep(duration)
Arguments:
  • duration (Milliseconds()) –
Return type:

Promise <void>

squaredNorm3

squaredNorm3(v)
Arguments:
  • v ([number]()) – None
Return type:

number

squaredNorm4

squaredNorm4(v)
Arguments:
  • v ([number]()) – None
Return type:

number

sub3

sub3(u, v)
Arguments:
Return type:

Vector3

sub4

sub4(u, v)
Arguments:
Return type:

Vector4

svgColorRgbString

svgColorRgbString(color)
Arguments:
Return type:

string

svgPointString

svgPointString(points)
Arguments:
  • points ([Point2]()) – None
Return type:

string

synchronizePmiVisibilities

synchronizePmiVisibilities(engine, startNode)
Arguments:
Return type:

Promise <void>

testWallCollision

testWallCollision(view, position, movementVector, maxCollisionDistance)
Arguments:
  • view (IView()) – None
  • position (Point3()) – None
  • movementVector (Point3()) – None
  • maxCollisionDistance (number()) – None
Return type:

Promise <FaceSelectionItem() | null>

toArray

toArray(xs)
Arguments:
Return type:

[T]

toIntegerMap

toIntegerMap(map)
Arguments:
Return type:

NumberMap() <V>

toScElementMask

toScElementMask(selectionMask)
Arguments:
Return type:

ElementMask

toScIncrementalConfig

toScIncrementalConfig(inputConfig)
Arguments:
Return type:

VolumeSelectionConfig

toScRay

toScRay(ray)
Arguments:
Return type:

ScRay

toScRayConfig

toScRayConfig(inputConfig, cullSuboptimalEntities, isDrawing)
Arguments:
  • inputConfig (PickConfig()) – None
  • cullSuboptimalEntities (boolean()) – None
  • isDrawing (boolean()) – None
Return type:

RaySelectionConfig

toSet

toSet(xs)
Arguments:
  • xs ([T]()) –
Return type:

Set <T>

toVec3

toVec3(v)
Arguments:
Return type:

Vector3

toVec4

toVec4(v)
Arguments:
Return type:

Vector4

towardAttachContext

towardAttachContext(startNode)
Arguments:
Return type:

AttachContext()

towardAttachRoot

towardAttachRoot(startNode)
Arguments:
Return type:

ProductOccurrence()

towardContainerNode

towardContainerNode(startNode)
Arguments:
Return type:

AnyContainerNode | null

towardInclusionContext

towardInclusionContext(startNode)
Arguments:
Return type:

InclusionContext()

towardLoadContext

towardLoadContext(startNode)
Arguments:
Return type:

LoadContext()

towardProductOccurrence

towardProductOccurrence(startNode)
Arguments:
Return type:

ProductOccurrence() | null

updateBodyNodesVisibilities

updateBodyNodesVisibilities(options)
Arguments:
  • options (function()) – None
Return type:

Promise <void>

updateBodyNodesVisibilitiesByAttachment

updateBodyNodesVisibilitiesByAttachment(options)
Arguments:
  • options (function()) – None
Return type:

Promise <void>

updateNodeTransformByMap

updateNodeTransformByMap(transformMap, transformedNodes, node)
Arguments:
Return type:

void

updateScMatrices

updateScMatrices(engine, callbackManager, startNodes, allowOutOfHierarchy)
Arguments:
Return type:

Promise <void>

updateVisibilities

updateVisibilities(options)
Arguments:
  • options (function()) – None
Return type:

Promise <void>

updateVisibilitiesByAttachment

updateVisibilitiesByAttachment(options)
Arguments:
  • options (function()) – None
Return type:

Promise <void>

utf8ArrayToStr

utf8ArrayToStr(bytes)
Arguments:
  • bytes (Uint8Array()) – None
Return type:

string

versionAtLeast

versionAtLeast(version, atLeast)
Arguments:
Return type:

boolean

versionString

versionString(version)
Arguments:
Return type:

string

waitForAll

waitForAll(promises)
Arguments:
  • promises ([Promise <void>]()) –
Return type:

Promise <void>

worldPointToScreenPoint

worldPointToScreenPoint(view, worldPosition)
Arguments:
Return type:

Point2

zeroPadHex32

zeroPadHex32(n)
Arguments:
  • n (number()) – None
Return type:

string