@thatopen/fragments

Enumerations

Enumeration	Description
CurrentLod	Enum representing the current level of detail (LOD) for a mesh.
ItemConfigClass	Enum representing the configuration class for an item in a Fragments model.
SnappingClass	Enum representing the snapping class for a raycast operation.

Classes

Class	Description
FragmentsModel	The main class for managing a 3D model loaded from a fragments file. Handles geometry, materials, visibility, highlighting, sections, and more. This class orchestrates multiple specialized managers to handle different aspects of the model like mesh management, item data, raycasting, etc. It maintains the overall state and provides the main interface for interacting with the model. The model data is loaded and processed asynchronously across multiple threads.
FragmentsModels	The main class for managing multiple 3D models loaded from fragments files. Handles loading, disposing, updating, raycasting, highlighting and coordinating multiple FragmentsModel instances. This class acts as the main entry point for working with fragments models.
IfcImporter	An objet to convert IFC files into fragments.

Interfaces

Interface	Description
Attributes	Interface representing the attributes of a model item.
ItemAttribute	Interface representing the attributes of an item in a Fragments model.
ItemData	Interface representing the data of an item in a Fragments model.
ItemsDataConfig	Interface representing the configuration for item data in a Fragments model.
MappedInformationResult	Interface representing the result of an information query for a specific item type.
MappedResultInput	Interface representing the input for a result query in a Fragments model.
MappedSelectionInput	Interface representing the input for a selection query in a Fragments model.
ModelIdMap	Interface representing a map of model IDs to their corresponding local IDs.
RaycastData	Interface representing the data for a raycast operation.
RaycastResult	Interface representing the result of a raycast operation.
RectangleRaycastData	Interface representing the data for a rectangle raycast operation.
RectangleRaycastResult	Interface representing the result of a rectangle raycast operation.
RelsModifyChange	Interface representing a change event when relations are modified in a model item.
SpatialTreeItem	Interface representing an item in a spatial tree.
VirtualModelConfig	Interface representing the configuration for a virtual model.
VirtualPropertiesConfig	Interface representing the configuration for virtual properties in a Fragments model.

Type Aliases

Type alias	Description
AttributeData	Represents attribute data for a model item.
AttrsChange	Union type representing all possible attribute change types.
BIMMaterial	Union type representing all possible material types.
BIMMesh	Union type representing all possible mesh types.
DataBuffer	Union type representing all possible data buffer types.
Identifier	Type representing a unique identifier for a model item. This can be either a string or a number.
InformationResultType	Type representing the result of an information query for a specific item type.
ItemInformationType	Union type representing all possible item information types.
ItemSelectionType	Union type representing all possible item selection types.
MaterialDefinition	Interface representing the definition of a material.
MeshData	Interface representing the data of a mesh.
RelsChange	Union type representing all possible relation change types.
ResultInputType	Union type representing all possible result input types.
SelectionInputType	Union type representing all possible selection input types.

Variables

Variable	Description
ifcCategoryMap	A map that associates each unique integer identifier (IFC Entity ID) with its corresponding category name. This map is used to map IFC entities to their respective categories for easier identification and processing.
limitOf2Bytes	The maximum value for a 2-byte unsigned integer.

Functions

Function	Description
getObject	Recursively converts a Flatbuffers object into a plain JavaScript object. This function traverses the prototype chain of the Flatbuffers object and extracts all properties and their values, handling both primitive values and nested objects/arrays.