Getting Started
Tutorials
Programming Guide
API References
Animation
BatchedCameraValues
BatchedNodeValues
BatchedValues
CameraChannel
ColorPosition
ExportContext
ImportContext
IndexedSet
KeyframeBuffer
Manager
NodeChannel
NodeValues
Player
Sampler
AssemblyDataParseError
AssemblyDataParseError.constructor()
AssemblyDataParseError.message
AssemblyDataParseError.name
AssemblyDataParseError.stack
AssemblyDataParseError.prepareStackTrace
AssemblyDataParseError.stackTraceLimit
Attribute
AxisTriad
ArgbColor
BCFComment
BCFData
BCFMarkup
BCFMarkupHeaderFile
BCFMarkupViewpoint
BcfNode
BCFSnapshot
BCFTopic
BCFViewpoint
ClippingPlane
Component
Line
MarkupBimSnippet
MarkupDocumentReference
MarkupRelatedTopic
MarkupTopic
OrthogonalCamera
PerspectiveCamera
ViewpointComponents
ViewSetupHints
Bcf.defaultOriginatingSystem
DoorConfig
FloorConfig
WallConfig
BloomLayerInfo
BloomLayerInfo.blurInterval
BloomLayerInfo.blurSamples
BloomLayerInfo.intensity
Box
Box.constructor()
Box.max
Box.min
CallbackMap
CallbackMap.XHRonerror
CallbackMap.XHRonloadend
CallbackMap.XHRonprogress
CallbackMap.addCuttingSection
CallbackMap.assemblyTreeReady
CallbackMap.bcfLoaded
CallbackMap.bcfRemoved
CallbackMap.beginInteraction
CallbackMap.cadViewCreated
CallbackMap.camera
CallbackMap.cappingIdle
CallbackMap.configurationActivated
CallbackMap.contextMenu
CallbackMap.cuttingPlaneDrag
CallbackMap.cuttingPlaneDragEnd
CallbackMap.cuttingPlaneDragStart
CallbackMap.cuttingSectionsLoaded
CallbackMap.endInteraction
CallbackMap.explode
CallbackMap.firstModelLoaded
CallbackMap.frameDrawn
CallbackMap.handleEvent
CallbackMap.handleEventEnd
CallbackMap.handleEventStart
CallbackMap.hwfParseComplete
CallbackMap.incrementalSelectionBatchBegin
CallbackMap.incrementalSelectionBatchEnd
CallbackMap.incrementalSelectionEnd
CallbackMap.info
CallbackMap.lineCreated
CallbackMap.lineDeleted
CallbackMap.lineLoaded
CallbackMap.measurementBegin
CallbackMap.measurementCreated
CallbackMap.measurementDeleted
CallbackMap.measurementHidden
CallbackMap.measurementLoaded
CallbackMap.measurementShown
CallbackMap.measurementValueSet
CallbackMap.missingModel
CallbackMap.modelLoadBegin
CallbackMap.modelLoadFailure
CallbackMap.modelStructureHeaderParsed
CallbackMap.modelStructureReady
CallbackMap.modelSwitchStart
CallbackMap.modelSwitched
CallbackMap.noteTextCreated
CallbackMap.noteTextHidden
CallbackMap.noteTextShown
CallbackMap.overlayViewportSet
CallbackMap.redlineCreated
CallbackMap.redlineDeleted
CallbackMap.redlineUpdated
CallbackMap.removeCuttingSection
CallbackMap.sceneReady
CallbackMap.selectionArray
CallbackMap.sheetActivated
CallbackMap.sheetDeactivated
CallbackMap.streamingActivated
CallbackMap.streamingDeactivated
CallbackMap.subtreeDeleted
CallbackMap.subtreeLoaded
CallbackMap.timeout
CallbackMap.timeoutWarning
CallbackMap.transitionBegin
CallbackMap.transitionEnd
CallbackMap.viewAxes
CallbackMap.viewCreated
CallbackMap.viewDeactivated
CallbackMap.viewDeleted
CallbackMap.viewLoaded
CallbackMap.viewOrientation
CallbackMap.visibilityChanged
CallbackMap.walkOperatorActivated
CallbackMap.walkOperatorDeactivated
CallbackMap.webGlContextLost
CallbackMap.websocketConnectionClosed
Camera
Camera.constructor()
Color
Color.constructor()
Color.b
Color.g
Color.r
CommunicatorError
CommunicatorError.constructor()
CommunicatorError.message
CommunicatorError.name
CommunicatorError.stack
CommunicatorError.prepareStackTrace
CommunicatorError.stackTraceLimit
ComparisonConfig
ComparisonConfig.only1Color
ComparisonConfig.only2Color
ComparisonConfig.sameColor
CullingVector
CullingVector.space
CullingVector.toleranceDegrees
CullingVector.vector
CuttingManager
CuttingPlane
CuttingPlane.constructor()
CuttingPlane.color
CuttingPlane.instanceNodeId
CuttingPlane.lineColor
CuttingPlane.matrix
CuttingPlane.meshId
CuttingPlane.opacity
CuttingPlane.plane
CuttingPlane.referenceGeometry
CuttingPlaneData
CuttingPlaneData.plane
CuttingPlaneData.referenceGeometry
CuttingSection
InputEvent
KeyInputEvent
MouseInputEvent
MouseInputEventBase
MouseWheelInputEvent
NodeSelectionEvent
TouchInputEvent
ExplodeManager
FaceFaceDistanceItem
FaceFaceDistanceItem.constructor()
FaceFaceDistanceItem.distance
FaceFaceDistanceItem.pos1
FaceFaceDistanceItem.pos2
FaceFaceDistanceObject
FaceFaceDistanceObject.distance
FaceFaceDistanceObject.point1
FaceFaceDistanceObject.point2
FaceMeshData
FaceMeshData.constructor()
FaceMeshData.bits
FaceMeshData.normalData
FaceMeshData.rgba32data
FaceMeshData.uvData
FaceMeshData.vertexData
FilteredNodes
FilteredNodes.constructor()
FilteredNodes.isInclusive
FilteredNodes.nodeIds
FloorplanConfig
FloorplanManager
GetNodesBoundingConfig
GetNodesBoundingConfig.bodyInstance
GetNodesBoundingConfig.ignoreInvisible
GetNodesBoundingConfig.pmiBody
GetNodesBoundingConfig.tightBounding
GetNodesBoundingConfig.viewFrame
GroundPlane
GroundPlane.followViewAxes
GroundPlane.normal
GroundPlane.position
IBox
IBox.max
IBox.min
IColor
IColor.b
IColor.g
IColor.r
IdBooleanMap
IdColorMap
IdNumberMap
IdStringMap
ImageBasedLightingOrientation
ImageBasedLightingOrientation.followViewAxes
ImageBasedLightingOrientation.matrix
ImageOptions
ImageOptions.data
ImageOptions.format
ImageOptions.height
ImageOptions.width
IncrementalPickConfig
IncrementalPickConfig.constructor()
IncrementalPickConfig.allowFaces
IncrementalPickConfig.allowLines
IncrementalPickConfig.allowPoints
IncrementalPickConfig.bimMask
IncrementalPickConfig.forceEffectiveSceneVisibilityMask
IncrementalPickConfig.forceEffectiveVisibilityMask
IncrementalPickConfig.ignoreCuttingSections
IncrementalPickConfig.ignoreUnrequestedInstances
IncrementalPickConfig.mustBeFullyContained
IncrementalPickConfig.onlyStreamedInstances
IncrementalPickConfig.respectVisibility
InternalLogicError
InternalLogicError.constructor()
InternalLogicError.message
InternalLogicError.name
InternalLogicError.stack
InternalLogicError.prepareStackTrace
InternalLogicError.stackTraceLimit
InvalidIndexError
InvalidIndexError.constructor()
InvalidIndexError.message
InvalidIndexError.name
InvalidIndexError.stack
InvalidIndexError.prepareStackTrace
InvalidIndexError.stackTraceLimit
InvalidNodeIdError
InvalidNodeIdError.constructor()
InvalidNodeIdError.message
InvalidNodeIdError.name
InvalidNodeIdError.nodeId
InvalidNodeIdError.stack
InvalidNodeIdError.prepareStackTrace
InvalidNodeIdError.stackTraceLimit
InvalidNodeTypeError
InvalidNodeTypeError.constructor()
InvalidNodeTypeError.expectedTypes
InvalidNodeTypeError.message
InvalidNodeTypeError.name
InvalidNodeTypeError.nodeId
InvalidNodeTypeError.stack
InvalidNodeTypeError.prepareStackTrace
InvalidNodeTypeError.stackTraceLimit
IPoint2
IPoint2.x
IPoint2.y
IPoint3
IPoint3.x
IPoint3.y
IPoint3.z
IPoint4
IPoint4.w
IPoint4.x
IPoint4.y
IPoint4.z
IRay
IRay.direction
IRay.origin
Light
Light.constructor()
Light.color
Light.position
Light.space
Light.type
LineManager
LoadCancelledError
LoadCancelledError.constructor()
LoadCancelledError.message
LoadCancelledError.name
LoadCancelledError.stack
LoadCancelledError.prepareStackTrace
LoadCancelledError.stackTraceLimit
LoadError
LoadError.constructor()
LoadError.message
LoadError.name
LoadError.stack
LoadError.prepareStackTrace
LoadError.stackTraceLimit
LoadSubtreeConfig
LoadSubtreeConfig.constructor()
LoadSubtreeConfig.additionalMatrix
LoadSubtreeConfig.allowMissingExternalModels
LoadSubtreeConfig.attachInvisibly
LoadSubtreeConfig.ignoreBimRelationships
LoadSubtreeConfig.ignoreCadViews
LoadSubtreeConfig.ignoreFilters
LoadSubtreeConfig.ignoreGenericTypes
LoadSubtreeConfig.ignoreLayers
LoadSubtreeConfig.implicitlyLoadXmlExternalModels
MarkupItem
MarkupItemManager
MarkupRenderer
MarkupView
MarkupData
MarkupManager
MarkupTypeManager
MarkupTypeManager.constructor()
Matrix
Matrix.constructor()
Matrix.m
MeasureManager
MeshData
MeshData.constructor()
MeshDataCopy
MeshDataCopy.faces
MeshDataCopy.isManifold
MeshDataCopy.isTwoSided
MeshDataCopy.lines
MeshDataCopy.points
MeshDataCopy.winding
MeshDataCopyElement
MeshDataCopyElement.bits
MeshDataCopyElement.vertexCount
MeshDataCopyElementGroup
MeshDataCopyElementGroup.elementCount
MeshDataCopyElementGroup.hasNormals
MeshDataCopyElementGroup.hasRGBAs
MeshDataCopyElementGroup.hasUVs
MeshDataCopyElementGroup.vertexCount
MeshDataCopyIterator
MeshDataCopyVertex
MeshDataCopyVertex.RGBA
MeshDataCopyVertex.UV
MeshDataCopyVertex.normal
MeshDataCopyVertex.position
MeshInstanceData
MeshInstanceData.constructor()
MeshInstanceData.overlayId
MetallicRoughnessValue
MetallicRoughnessValue.metallic
MetallicRoughnessValue.roughness
MissingModelError
MissingModelError.constructor()
MissingModelError.message
MissingModelError.name
MissingModelError.stack
MissingModelError.prepareStackTrace
MissingModelError.stackTraceLimit
Model
NavCube
ObjectConstructor
OperatorManager
AreaSelectionOperator
AxisTriadOperator
CuttingPlaneOperator
FloorplanOperator
HandleOperator
NavCubeOperator
NoteOperator
Operator
RayDrillSelectionOperator
SelectionOperator
SpaceMouseOperator
OverlayManager
OverlayViewport
ParseError
ParseError.constructor()
ParseError.message
ParseError.name
ParseError.stack
ParseError.prepareStackTrace
ParseError.stackTraceLimit
PickConfig
PickConfig.constructor()
PickConfig.bimMask
PickConfig.enableProximityFaces
PickConfig.forceEffectiveSceneVisibilityMask
PickConfig.forceEffectiveVisibilityMask
PickConfig.ignoreCappingGeometry
PickConfig.ignoreOverlays
PickConfig.maxWorldDistance
PickConfig.oneEntityPerTypePerInstance
PickConfig.rejectionBitsAll
PickConfig.rejectionBitsAny
PickConfig.requiredBitsAll
PickConfig.requiredBitsAny
PickConfig.respectDepthRange
PickConfig.respectVisibility
PickConfig.restrictLinesAndPointsToSelectedFaceInstances
PickConfig.restrictToOverlays
PickConfig.selectionMask
PickOutsideCanvasError
PickOutsideCanvasError.constructor()
PickOutsideCanvasError.message
PickOutsideCanvasError.name
PickOutsideCanvasError.stack
PickOutsideCanvasError.prepareStackTrace
PickOutsideCanvasError.stackTraceLimit
Plane
Plane.constructor()
Plane.d
Plane.normal
Point2
Point2.constructor()
Point2.x
Point2.y
Point3
Point3.constructor()
Point3.x
Point3.y
Point3.z
Point4
Point4.constructor()
Point4.w
Point4.x
Point4.y
Point4.z
PointMeshData
PointMeshData.constructor()
PointMeshData.bits
PointMeshData.rgba32data
PointMeshData.vertexData
PolylineMeshData
PolylineMeshData.constructor()
PolylineMeshData.bits
PolylineMeshData.rgba32data
PolylineMeshData.vertexData
Ray
Ray.constructor()
Ray.direction
Ray.origin
RefOnTopoItem
RefOnTopoItem.constructor()
RefOnTopoItem.bodyId
RefOnTopoItem.subElementIndex
RefOnTopoItem.subElementType
RelationshipInfo
RelationshipInfo.relateds
RelationshipInfo.relatings
RelationshipInfo.type
BadDataData
CuttingSectionLimits
DiscriminatedError
EntityBase
Error
FaceEntity
FacePickResult
FrameStats
ImageInterface
Instance
LineEntity
LinePickResult
LoadConfig
MatrixInterface
MeshDataBuilder
MeshDataBuilderFaceOptions
MeshDataBuilderLineOptions
MeshDataBuilderPointOptions
MeshDataInterface
MeshInstanceInterface
OpenModelFailedData
OverlayId
OverlayInterface
PickResult
PointEntity
PointPickResult
ProximityFaceEntity
ProximityFacePickResult
RaySelectionConfig
SsrQualityConfig
StartArgs
Statistics
StreamcacheModule
SvgConfig
VolumeSelectionConfig
Sc.UnspecifiedMeasurementUnit
CompositeSelectionItem
EntitySelectionItem
FaceSelectionItem
IncrementalSelectionId
LineSelectionItem
NodeCounts
NodeEntitySelectionItem
NodeSelectionItem
PointSelectionItem
SelectionItem
SelectionManager
TemporalLink
SelectionInvalidatedError
SelectionInvalidatedError.constructor()
SelectionInvalidatedError.message
SelectionInvalidatedError.name
SelectionInvalidatedError.stack
SelectionInvalidatedError.prepareStackTrace
SelectionInvalidatedError.stackTraceLimit
SheetManager
SheetManager.constructor()
SnapshotConfig
SnapshotConfig.constructor()
SnapshotConfig.height
SnapshotConfig.layers
SnapshotConfig.viewKey
SnapshotConfig.width
StringStringMap
SubentityAttributes
SubentityAttributes.constructor()
SubentityAttributes.attributes
SvgConfig.constructor()
SvgConfig.linesClipProximityToPlane
SvgConfig.linesClipZNudgeFactor
SvgConfig.linesCssColor
SvgConfig.linesDrawModelLinesEnabled
SvgConfig.linesStrokeWidth
SvgConfig.logDiagnostics
SvgConfig.logProgress
SvgConfig.polygonsForceDrawCssColor
SvgConfig.silhouettesEnabled
SvgConfig.svgBackgroundCssColor
SvgConfig.svgXmlPrologEnabled
TextureOptions
TextureOptions.imageId
TextureOptions.interpolation
TextureOptions.matrix
TextureOptions.mipMapping
TextureOptions.modifiers
TextureOptions.parameterization
TextureOptions.tiling
UnitElement
UnitElement.basicUnit
UnitElement.exponent
UnitElement.factor
ActionQueue
CurrentAction
Lazy
OpenPromise
StateMachine
StateMachineAction
Timer
TrackedOpenPromise
UnsafePromise
VerticalGradient
VerticalGradient.constructor()
VerticalGradient.bottom
VerticalGradient.top
View
View.domElements
View.floorplanManager
View.operatorManager
View.overlayManager
ViewAxes
ViewAxes.constructor()
ViewAxes.frontVector
ViewAxes.upVector
ViewConfig
ViewConfig.container
VisibilityState
VisibilityState.constructor()
VisibilityState.defaultVisibility
VisibilityState.visibilityExceptions
WebViewer
WebViewer.constructor()
WebViewer.BCFManager
WebViewer._views
WebViewer.animationManager
WebViewer.cuttingManager
WebViewer.explodeManager
WebViewer.lineManager
WebViewer.markupManager
WebViewer.measureManager
WebViewer.model
WebViewer.noteTextManager
WebViewer.selectionManager
WebViewer.sheetManager
WebViewerConfig
WebViewerConfig.boundingPreviewMode
WebViewerConfig.buffer
WebViewerConfig.calculateDefaultViewAxes
WebViewerConfig.container
WebViewerConfig.containerId
WebViewerConfig.defaultMeshLevel
WebViewerConfig.defaultMetallicFactor
WebViewerConfig.defaultRoughnessFactor
WebViewerConfig.disableAutomaticBackgroundSheets
WebViewerConfig.disableAutomaticFitWorld
WebViewerConfig.disableAutomaticFloorplanOverlay
WebViewerConfig.empty
WebViewerConfig.enableShatteredModelUiViews
WebViewerConfig.endpointUri
WebViewerConfig.enginePath
WebViewerConfig.memoryLimit
WebViewerConfig.model
WebViewerConfig.rendererType
WebViewerConfig.sessionToken
WebViewerConfig.streamCutoffScale
WebViewerConfig.streamingMode
WebViewerConfig.usePointerEvents
XmlParseError
XmlParseError.constructor()
XmlParseError.message
XmlParseError.name
XmlParseError.stack
XmlParseError.prepareStackTrace
XmlParseError.stackTraceLimit
DefaultTransitionDuration
EmptyModelName
InvalidNodeId
Ohm
Subscript1
Subscript2
Subscript3
SubscriptNeg
closestPointFromPointToSegment()
closestPointScalarFromPointToSegment()
computeAngleBetweenVector()
computeOffaxisRotation()
computePointToLineDistance()
createUuid()
degreesToRadians()
distanceLineLine()
formatWithUnit()
generateArcPoints()
generatePointsOnCircle()
getLongUnitString()
intersect3d2Planes()
intersectionPlaneLine()
intersectionPlaneLine2()
isIColor()
isIPoint2()
isIPoint3()
isIPoint4()
isPointInRect2d()
isPointOnLineSegment()
isPointOnLineSegment2d()
lineLineIntersect()
oneVectorCross()
radiansToDegrees()
Additional Resources
Support
Table of Contents
This are APIs that are now considered legacy with HOOPS Communicator.
