Communicator

Modules

• Animation

• Event

• GUID

• Markup

• Operator

• Selection

• Settings

• StaticGenericType

• SubentityProperties

• UUID

• Util

Enumerations

• AntiAliasingMode

• AttributeType

• Axis

• BCFFileType

• BCFVersion

• BasicUnit

• BimMask

• BlurIntervalUnit

• BoundingPreviewMode

• BranchVisibility

• BuiltinOverlayIndex

• Button

• Buttons

• CullingVectorSpace

• DrawMode

• ElementType

• EventType

• FaceWinding

• FileType

• FilterId

• FloorplanAutoActivation

• FloorplanOrientation

• HandleEventType

• HandleType

• ImageFormat

• InfoType

• InstanceModifier

• KeyCode

• KeyInputType

• KeyModifiers

• LayerId

• LightSpace

• LightType

• LinePatternLengthUnit

• MeshInstanceCreationFlags

• MouseInputType

• NodeSource

• NodeType

• OperatorId

• OrbitFallbackMode

• OverlayAnchor

• OverlayUnit

• PmiSubType

• PmiTopoRef

• PmiType

• PointShape

• PointSizeUnit

• Projection

• RelationshipType

• RendererType

• ScreenConfiguration

• SelectionHighlightMode

• SelectionMask

• SelectionMode

• SelectionType

• SimpleReflectionAttenuationUnit

• SnapshotLayer

• StreamingMode

• TextureModifier

• TextureParameterization

• TextureTiling

• TouchInputType

• TransparencyMode

• TreeWalkMode

• ViewOrientation

• WalkDirection

• WalkMode

• XRayGroup

• XRayTransparencyMode

Classes

• AssemblyDataParseError()

• AxisTriad()

• BCFComment()

• BCFData()

• BCFManager()

• BCFMarkup()

• BCFMarkupHeaderFile()

• BCFMarkupViewpoint()

• BCFSnapshot()

• BCFTopic()

• BCFViewpoint()

• Box()

• Camera()

• Color()

• CommunicatorError()

• CuttingManager()

• CuttingSection()

• ExplodeManager()

• FaceFaceDistanceItem()

• FilteredNodes()

• FloorplanConfig()

• FloorplanManager()

• IncrementalPickConfig()

• InternalLogicError()

• InvalidIndexError()

• InvalidNodeIdError()

• InvalidNodeTypeError()

• Light()

• LineManager()

• LoadCancelledError()

• LoadError()

• LoadSubtreeConfig()

• MarkupManager()

• MarkupTypeManager()

• Matrix()

• MeasureManager()

• MeshData()

• MeshInstanceData()

• MissingModelError()

• Model()

• NavCube()

• OperatorManager()

• OverlayManager()

• ParseError()

• PickConfig()

• PickOutsideCanvasError()

• Plane()

• Point2()

• Point3()

• Point4()

• Ray()

• RefOnTopoItem()

• SelectionInvalidatedError()

• SelectionManager()

• SheetManager()

• SnapshotConfig()

• SubentityAttributes()

• SvgConfig()

• VerticalGradient()

• View()

• ViewAxes()

• VisibilityState()

• WebViewer()

• XmlParseError()

Interfaces

• Attribute()

• BcfNode()

• BloomLayerInfo()

• CallbackMap()

• ComparisonConfig()

• CullingVector()

• DeprecatedPromise()

• GetNodesBoundingConfig()

• GroundPlane()

• IdBooleanMap()

• IdColorMap()

• IdNumberMap()

• IdStringMap()

• ImageBasedLightingOrientation()

• ImageOptions()

• MarkupData()

• MeshDataCopy()

• MeshDataCopyElement()

• MeshDataCopyElementGroup()

• MeshDataCopyIterator()

• MeshDataCopyVertex()

• MetallicRoughnessValue()

• RelationshipInfo()

• StringStringMap()

• TextureOptions()

• UnitElement()

• WebViewerConfig()

Type aliases

• BCFCommentId

• BCFMarkupName

• BCFName

• BCFTopicId

• BCFViewpointName

• BimId

• BodyId

• BuiltInOperatorId

• CadViewId

• Degrees

• ExchangeId

• ExternalModelName

• FilterName

• GenericId

• GenericType

• Guid

• HtmlId

• IfcGuid

• IfcType

• ImageId

• LayerName

• LightKey

• LinePattern

• MassageModelNameFunc

• MeshId

• MetaDataParseError

• Milliseconds

• ModelNameToScsFileFunc

• NodeId

• NodeIdOffset

• OverlayIndex

• PMISubType

• PMITopoRef

• PMIType

• PartId

• Pixels

• PmiId

• Radians

• ScModelName

• ScsBuffer

• ScsUri

• SelectionFilter

• SheetId

• Unreferenced

• UserDataIndex

• Uuid

• VolumePickConfig

• XmlFilename

Variables

• DefaultTransitionDuration

• EmptyModelName

• InvalidNodeId

• MetaDataParseError

• PMISubType

• PMITopoRef

• PMIType

---

Type aliases

BCFCommentId

BCFMarkupName

BCFName

BCFTopicId

BCFViewpointName

BimId

Type for the relationships ID

BodyId

Type used to denote assembly tree body IDs. All BodyIds are NodeIds.

BuiltInOperatorId

Enumerates IDs for built-in operators

CadViewId

Type used to denote assembly tree CAD view IDs. All CadViewIds are NodeIds.

Degrees

Type used to denote the degrees of angles.

ExchangeId

Type used to denote Exchange IDs.

ExternalModelName

Type used to denote an XML ExternalModel name.

FilterName

Type used to denote Filter names.

GenericId

Type used to denote generic id

GenericType

Type used to denote generic types

Guid

Note

Guid is deprecated: Use uuid instead.

HtmlId

Type used to denote HTML IDs.

IfcGuid

Note

IfcGuid is deprecated: Use GenericId instead.

IfcType

Note

IfcType is deprecated: Use GenericType instead.

ImageId

A pair of numbers identifying an image.

LayerName

Type used to denote Layer names.

LightKey

Type used to denote light keys

LinePattern

Specifies the appearance of a single repetion of a line pattern. The format is an arbitrary-length array of 1s and 0s, where pixels covered by a 1 in the pattern are visible and pixels covered by a 0 are invisible.

Examples: - [1,0]: a dashed line with equal-length dashes and gaps - [1,1,1,1,1,1,1,1,1,0,0,0,0,1,0,0,0,0]: a dash followed by a gap of equal length with a dot in the center

MassageModelNameFunc

Callback to massage ExternalModel names within an XML load file to SC model names. Return null to skip the model. Returned value can be synchronous (non-Promise) or asynchronous (Promise).

MeshId

A pair of numbers identifying a mesh.

MetaDataParseError

Note

MetaDataParseError is deprecated

Milliseconds

A number typed in millisecond units.

ModelNameToScsFileFunc

Callback to map ExternalModel names within an XML load file to SCS file URis or SCS file buffers. Return null to skip the model. Returned value can be synchronous (non-Promise) or asynchronous (Promise).

NodeId

Type used to denote assembly tree node IDs.

NodeIdOffset

OverlayIndex

Type used to denote overlay indices.

PMISubType

Note

PMISubType is deprecated: Use PmiSubType instead.

PMITopoRef

Note

PMITopoRef is deprecated: Use PmiTopoRef instead.

PMIType

Note

PMIType is deprecated: Use PmiType instead.

PartId

Type used to denote assembly tree part IDs. All PartIds are NodeIds.

Pixels

A number typed in pixel units.

PmiId

Type used to denote assembly tree PMI IDs. All PmiIds are NodeIds.

Radians

Type used to denote the radians of angles.

ScModelName

Type used to denote an SC model name.

ScsBuffer

Type used to denote an SCS model’s byte buffer.

ScsUri

Type used to denote an SCS model’s URI.

SelectionFilter

SheetId

Type used to denote assembly tree sheet IDs. All SheetIds are NodeIds.

Unreferenced

Used to silence TypeScript unused variable warnings.

Usage:

x as Unreferenced;

UserDataIndex

This is the User Data Index for a node.

Values of this type are unsigned 64 bit numbers.

A value is of type number when it can be represented precisely as such.

Otherwise a value is of type string, where the string is the hex encoding of the index. The hex representation is in uppercase and does not have a leading 0x.

Uuid

Type used to denote GUIDs.

VolumePickConfig

Note

VolumePickConfig is deprecated: Use IncrementalPickConfig instead.

XmlFilename

Type used to denote an XML filename.

Variables

Communicator.DefaultTransitionDuration

The default duration in milliseconds of camera transitions.

Communicator.EmptyModelName

Communicator.InvalidNodeId

Communicator.MetaDataParseError

Note

MetaDataParseError is deprecated

Communicator.PMISubType

Note

PMISubType is deprecated: Use PmiSubType instead.

Communicator.PMITopoRef

Note

PMITopoRef is deprecated: Use PmiTopoRef instead.

Communicator.PMIType

Note

PMIType is deprecated: Use PmiType instead.