Communicator
Modules
The Event module exposes UI event listeners for the… |
|
The Markup module factilitates interactions with markup… |
|
Operators provide hooks into various events provided by… |
|
A set of Classes and Interfaces to facilitate Selection… |
|
This contains constants for commonly known GenericType… |
|
Properties returned from Model.getFaceProperty and… |
|
Enumerations
Enumerates anti-aliasing modes available in the viewer |
|
Enumerated values used when referring to an axis |
|
Specifies the units in which the interval between samples… |
|
Visibity of a node’s branch, including all children of… |
|
Enumerated values used when referring to the buttons on a… |
|
Bitmask for buttons being pressed when referring to the… |
|
The space in which a culling vector is defined. |
|
Enumerates drawing modes available in the viewer. More… |
|
Enumerates EventTypes for Operators |
|
Enumerates face winding for use with geometry. Face… |
|
FileType |
|
Type used to denote Filter IDs. |
|
Different conditions on which the floorplan can be… |
|
Used to allow different orientations of the floorplan… |
|
Enumerated values for types of handle events for… |
|
Enumerated values for types of handles for… |
|
Formats accepted when specifying texture images. |
|
Enumerates the type of message passed via an info… |
|
Enumerates instance modifier modes. More information can… |
|
Enumerates JavaScript Key Codes. We recommend using this… |
|
Enumerates types of keyboard input |
|
Enumerates Modifier Keys. Note this enumeration may not… |
|
Type used to denote Layer IDs. |
|
Specifies the space in which a light’s position is… |
|
Specifies how a light affects the scene. See Light |
|
Specifies the units in which the length of a LinePattern… |
|
Flags used when creating a mesh instance |
|
Enumerates types of mouse input |
|
Enumerates of the types returned by Model.getNodeType() |
|
Enumerates IDs for operators. For more information see… |
|
Enumerates Camera Orbit Fallback Modes |
|
Enumerates the unit types that an overlay viewport value… |
|
PMI subtype |
|
PMI reference to topology (brep) |
|
PMI type |
|
Specifies the appearance of points. |
|
Specifies how point size is interpreted. |
|
Enumerated values used for setting camera projection. |
|
Define the IFC relationships type |
|
Enumerates the mode that is used for rendering |
|
Enumerates the visual indications for selected objects |
|
Bitmask for allowed selection types |
|
Enumerates the modes to be used when performing… |
|
Enumerates a type of selection |
|
Units in which attenuation distances are specified for… |
|
Specifies which layers to include in a snapshot. These… |
|
Enumerates the mode the viewer will use when streaming… |
|
Flags that control how textures are applied. |
|
Indicates how texture coordinates are specified or… |
|
Controls how UV coordinates are interpreted outside the… |
|
Enumerates types of touch input |
|
Enumerates ways of displaying transparent geometry |
|
Possible modes to use when performing operations which… |
|
Enumerated values used when setting pre-defined view… |
|
Enumerates directions for the walk operator |
|
Enumerates Walk Modes |
|
Specifies a category of nodes in x-ray mode. See… |
|
Enumerates ways of displaying transparent (unselected)… |
Classes
Error object that is thrown when assembly tree data could… |
|
This class provides an interface to the axis triad which… |
|
This class contains data corresponding to the BCF file… |
|
This class provides an interface to the BIM Collaboration… |
|
This class contains data corresponding to a BCF file… |
|
Represents an axis-aligned bounding box. A box is… |
|
Object representing a viewpoint from which the scene can… |
|
An object representing an RGB Color. Values are specified… |
|
Base error class for all Communicator errors. Extends… |
|
Main interface into the cutting functionality of the… |
|
Object representing an individual cutting section, more… |
|
This class provides an interface to the explode related… |
|
Allows customization of the FloorplanManager user… |
|
Main interface into the 2D floorplan functionality for… |
|
Error object that is thrown when the viewer has entered… |
|
Error object that is thrown when a user supplies an… |
|
Error object that is thrown when the user passes an non… |
|
Error object that is thrown when the user passes a node… |
|
Contains properties of a light. More information can be… |
|
This class provides an interface to 3D line management… |
|
Error object that is thrown when a model load is… |
|
Error object that is thrown when a model could not be… |
|
Configuration for all loadSubtree functions in the Model… |
|
This class provides an interface into working with markup… |
|
The markup manager exports JSON data for markup in the… |
|
Object representing the 4x4 Matrix. More information can… |
|
This class provides an interface to measurement… |
|
Object which represents geometry data which will be… |
|
Object representing a Mesh instance that will be created… |
|
Error object that is thrown when an invalid model path is… |
|
Object representing the model geometry and its associated… |
|
This class provides an interface to the navigational cube… |
|
Main interface into the Operator functionality of the… |
|
The OverlayManager exposes functionality for creating… |
|
Error object that is thrown when invalid data is supplied… |
|
Configuration for all pick functions in the View class. |
|
Error object that is thrown when a user attempts to pick… |
|
Object representing a Plane. |
|
Object representing a Ray. |
|
Object which identifies a reference to an element on a… |
|
Error object that is thrown when an asynchronous… |
|
This class provides the main interface into the selection… |
|
This class contains configuration properties for creating… |
|
Properties returned from Model’s getEdgeAttributes and… |
|
Allows customization of an exported SVG. |
|
Object representing the view associated to a model. All… |
|
Object representing the up and front vectors for the… |
|
Contains a defaultVisibility boolean and… |
|
Error object that is thrown when attempting to parse XML… |
Interfaces
Describes a single layer in the bloom effect. |
|
Object which maps callback names to functions. Used by… |
|
Settings that control the behavior of visual node… |
|
A vector and angle used to determine an object’s… |
|
A promise that can be safely ignored. Functions that… |
|
Defines the invisible ground plane onto which simple… |
|
Object which maps an Id to a boolean value |
|
Object which maps an Id to a color value |
|
Object which maps an Id to a number value |
|
Object which maps an Id to a string value |
|
Defines the orientation of the image-based lighting… |
|
Parameters that describe an image to be used as a texture… |
|
A self-contained copy of the data of a single mesh. The… |
|
Provides access to mesh data of a single face, line, or… |
|
Provides access to all data of a particular type (faces,… |
|
An iterator over the vertices of a MeshDataCopyElement or… |
|
The data for a single vertex in a MeshDataCopy returned… |
|
Represents a node’s metallic and roughness values when… |
|
Object which maps a string to a string |
|
Parameters that describe a texture and control how it is… |
|
Type aliases
Type for the relationships ID |
|
Type used to denote assembly tree body IDs. All BodyIds… |
|
Enumerates IDs for built-in operators |
|
Type used to denote assembly tree CAD view IDs. All… |
|
Type used to denote the degrees of angles. |
|
Type used to denote Exchange IDs. |
|
Type used to denote an XML ExternalModel name. |
|
Type used to denote Filter names. |
|
Type used to denote generic id |
|
Type used to denote generic types |
|
Type used to denote HTML IDs. |
|
A pair of numbers identifying an image. |
|
Type used to denote Layer names. |
|
Type used to denote light keys |
|
Specifies the appearance of a single repetion of a line… |
|
Callback to massage ExternalModel names within an XML… |
|
A pair of numbers identifying a mesh. |
|
A number typed in millisecond units. |
|
Callback to map ExternalModel names within an XML load… |
|
Type used to denote assembly tree node IDs. |
|
Type used to denote overlay indices. |
|
Type used to denote assembly tree part IDs. All PartIds… |
|
A number typed in pixel units. |
|
Type used to denote assembly tree PMI IDs. All PmiIds are… |
|
Type used to denote the radians of angles. |
|
Type used to denote an SC model name. |
|
Type used to denote an SCS model’s byte buffer. |
|
Type used to denote an SCS model’s URI. |
|
Type used to denote assembly tree sheet IDs. All SheetIds… |
|
Used to silence TypeScript unused variable warnings. |
|
This is the User Data Index for a node. |
|
Type used to denote GUIDs. |
|
Type used to denote an XML filename. |
Variables
The default duration in milliseconds of camera… |
|
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 1
s and 0
s, 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.
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.