Communicator

 Communicator

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Type aliases

BCFCommentId

BCFCommentId: Uuid

BCFMarkupName

BCFMarkupName: string

BCFName

BCFName: string

BCFTopicId

BCFTopicId: Uuid

BCFViewpointName

BCFViewpointName: string

BodyId

BodyId: NodeId

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

BuiltInOperatorId

Enumerates IDs for built-in operators

CadViewId

CadViewId: NodeId

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

Degrees

Degrees: number

Type used to denote the degrees of angles.

ExchangeId

ExchangeId: string

Type used to denote Exchange IDs.

ExternalModelName

ExternalModelName: string

Type used to denote an XML ExternalModel name.

FilterName

FilterName: string

Type used to denote Filter names.

GenericId

GenericId: string

Type used to denote generic id

GenericType

GenericType: string

Type used to denote generic types

Guid    [deprecated]

Guid: string
deprecated

Use [[uuid]] instead.

HtmlId

HtmlId: string

Type used to denote HTML IDs.

IfcGuid    [deprecated]

IfcGuid: string
deprecated

Use GenericId instead.

IfcType    [deprecated]

IfcType: string
deprecated

Use GenericType instead.

ImageId

ImageId: [number, number]

A pair of numbers identifying an image.

LayerName

LayerName: string

Type used to denote Layer names.

LightKey

LightKey: number

Type used to denote light keys

LinePattern

LinePattern: number[] | Uint8Array

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

MassageModelNameFunc: function

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).

Type declaration

MeshId

MeshId: [number, number]

A pair of numbers identifying a mesh.

MetaDataParseError    [deprecated]

MetaDataParseError: AssemblyDataParseError
deprecated

Milliseconds

Milliseconds: number

A number typed in millisecond units.

ModelNameToScsFileFunc

ModelNameToScsFileFunc: function

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).

Type declaration

NodeId

NodeId: number

Type used to denote assembly tree node IDs.

NodeIdOffset

NodeIdOffset: number

OverlayIndex

OverlayIndex: SC.OverlayIndex

Type used to denote overlay indices.

PMISubType    [deprecated]

PMISubType: PmiSubType
deprecated

Use PmiSubType instead.

PMITopoRef    [deprecated]

PMITopoRef: PmiTopoRef
deprecated

Use PmiTopoRef instead.

PMIType    [deprecated]

PMIType: PmiType
deprecated

Use PmiType instead.

PartId

PartId: NodeId

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

Pixels

Pixels: number

A number typed in pixel units.

PmiId

PmiId: NodeId

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

Radians

Radians: number

Type used to denote the radians of angles.

ScModelName

ScModelName: string

Type used to denote an SC model name.

ScsBuffer

ScsBuffer: Uint8Array

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

ScsUri

ScsUri: string

Type used to denote an SCS model's URI.

SelectionFilter

SelectionFilter: function

Type declaration

SheetId

SheetId: NodeId

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

Unreferenced

Unreferenced: any

Used to silence TypeScript unused variable warnings.


Usage:

x as Unreferenced

UserDataIndex

UserDataIndex: number | string

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

Uuid: string

Type used to denote GUIDs.

VolumePickConfig    [deprecated]

VolumePickConfig: IncrementalPickConfig
deprecated

Use IncrementalPickConfig instead.

XmlFilename

XmlFilename: string

Type used to denote an XML filename.

Variables

Const DefaultTransitionDuration

DefaultTransitionDuration: 400

Const EmptyModelName

EmptyModelName: "_empty"

Const InvalidNodeId

InvalidNodeId: NodeId

Const MetaDataParseError    [deprecated]

MetaDataParseError: AssemblyDataParseError
deprecated

Const PMISubType    [deprecated]

PMISubType: PmiSubType
deprecated

Use PmiSubType instead.

Const PMITopoRef    [deprecated]

PMITopoRef: PmiTopoRef
deprecated

Use PmiTopoRef instead.

Const PMIType    [deprecated]

PMIType: PmiType
deprecated

Use PmiType instead.