| AsyncEvent | Simple event handler by Jason Kleban. Keep in mind that if you want to remove it later, you might want to declare the callback as an object. If you want to maintain the reference to this, you will need to declare the callback as an arrow function. |
| BCFTopics | BCFTopics manages Building Collaboration Format (BCF) data the engine. It provides functionality for importing, exporting, and manipulating BCF data. 📕 Tutorial. 📘 API. |
| Base | Base class of the library. Useful for finding out the interfaces something implements. |
| BaseCamera | Abstract class representing a camera in a 3D world. All cameras should use this class as a base. |
| BaseRenderer | Abstract class representing a renderer for a 3D world. All renderers should use this class as a base. |
| BaseScene | Abstract class representing a base scene in the application. All scenes should use this class as a base. |
| BaseWorldItem | One of the elements that make a world. It can be either a scene, a camera or a renderer. |
| BoundingBoxer | An implementation of bounding box utilities that works for fragments. 📕 Tutorial. 📘 API. |
| Classifier | The Classifier component is responsible for grouping items from different models based on criteria. 📕 Tutorial. 📘 API. |
| Clipper | A lightweight component to easily create, delete and handle clipping planes. 📕 Tutorial. 📘 API. |
| Comment | Represents a comment in a BCF Topic. |
| Component | Components are the building blocks of this library. Components are singleton elements that contain specific functionality. For instance, the Clipper Component can create, delete and handle 3D clipping planes. Components must be unique (they can't be instanced more than once per Components instance), and have a static UUID that identifies them uniquely. The can be accessed globally using the Components instance. |
| Components | The entry point of the Components library. It can create, delete and access all the components of the library globally, update all the updatable components automatically and dispose all the components, preventing memory leaks. |
| ConfigManager | A tool to manage all the configuration from the app centrally. 📘 API. |
| DataMap | A class that extends the built-in Map class and provides additional events for item set, update, delete, and clear operations. |
| DataSet | A class that extends the built-in Set class and provides additional functionality. It triggers events when items are added, deleted, or the set is cleared. |
| Disposer | A tool to safely remove meshes, geometries, materials and other items from memory to prevent memory leaks. 📘 API. |
| Event | Simple event handler by Jason Kleban. Keep in mind that if you want to remove it later, you might want to declare the callback as an object. If you want to maintain the reference to this, you will need to declare the callback as an arrow function. |
| EventManager | Simple class to easily toggle and reset event lists. |
| FinderQuery | Represents a finder query for retrieving items based on specified parameters. This class encapsulates the query logic, caching mechanism, and result management. |
| FirstPersonMode | A NavigationMode that allows first person navigation, simulating FPS video games. |
| FragmentsManager | Component to load, delete and manage fragments efficiently. 📕 Tutorial. 📘 API. |
| Grids | A component that manages grid instances. Each grid is associated with a unique world. 📕 Tutorial. 📘 API. |
| Hider | A component that manages visibility of fragments within a 3D scene. It extends the base Component class and provides methods to control fragment visibility and isolation. 📕 Tutorial. 📘 API. |
| IDSSpecification | Represents a single specification from the Information Delivery Specification (IDS) standard. |
| IDSSpecifications | Component that manages Information Delivery Specification (IDS) data. It provides functionality for importing, exporting, and manipulating IDS data. 📕 Tutorial. 📘 API. |
| IfcFragmentSettings | Configuration of the IFC-fragment conversion. |
| IfcLoader | The IfcLoader component is responsible of converting IFC files into Fragments. 📕 Tutorial. 📘 API. |
| ItemsFinder | Manages and executes queries to find items within models based on specified criteria. This class provides functionalities to create, store, and execute FinderQuery instances, allowing for efficient retrieval of items that match given query parameters. 📕 Tutorial. 📘 API. |
| MeasurementUtils | Utility component for performing measurements on 3D meshes by providing methods for measuring distances between edges and faces. 📘 API. |
| ModelIdMapUtils | Utility class for manipulating and managing ModelIdMap objects. A ModelIdMap is a mapping of model identifiers (strings) to sets of local IDs (numbers). This class provides methods for joining, intersecting, cloning, adding, removing, and comparing ModelIdMap objects, as well as converting between ModelIdMap and plain JavaScript objects. |
| Mouse | A helper to easily get the real position of the mouse in the Three.js canvas to work with tools like the raycaster, even if it has been transformed through CSS or doesn't occupy the whole screen. |
| OrbitMode | A NavigationMode that allows 3D navigation and panning like in many 3D and CAD softwares. |
| OrthoPerspectiveCamera | A flexible camera that uses yomotsu's cameracontrols to control the camera in 2D and 3D. It supports multiple navigation modes, such as 2D floor plan navigation, first person and 3D orbit. This class extends the SimpleCamera class and adds additional functionality for managing different camera projections and navigation modes. 📕 Tutorial. 📘 API. |
| PlanMode | A NavigationMode that allows to navigate floorplans in 2D, like many BIM tools. |
| ProjectionManager | Object to control the CameraProjection of the OrthoPerspectiveCamera. |
| Raycasters | A component that manages a raycaster for each world and automatically disposes it when its corresponding world is disposed. 📕 Tutorial. 📘 API. |
| ShadowedScene | A scene that supports efficient cast shadows. 📕 Tutorial. 📘 API. |
| SimpleCamera | A basic camera that uses yomotsu's cameracontrols to control the camera in 2D and 3D. Check out it's API to find out what features it offers. |
| SimpleGrid | An infinite grid. Created by fyrestar and translated to typescript by dkaraush. |
| SimplePlane | Each of the clipping planes created by the clipper. |
| SimpleRaycaster | A simple raycaster that allows to easily get items from the scene using the mouse and touch events. |
| SimpleRenderer | A basic renderer capable of rendering Objec3Ds. |
| SimpleScene | A basic 3D scene to add objects hierarchically, and easily dispose them when you are finished with it. |
| SimpleWorld | A class representing a simple world in a 3D environment. It extends the Base class and implements the World interface. |
| VertexPicker | A class that provides functionality for picking vertices in a 3D scene. |
| Viewpoint | Represents a BCF compliant viewpoint from BuildingSMART. The Viewpoint class provides methods for managing and interacting with viewpoints. It includes functionality for setting viewpoint properties, updating the camera, applying color to components, and serializing the viewpoint for export. |
| Views | The Views class is responsible for managing and interacting with a collection of 2D sections. It provides methods for creating, opening, closing, and managing views, as well as generating views from specific configurations such as IFC storeys or bounding boxes. 📕 Tutorial. 📘 API. |
| Worlds | A class representing a collection of worlds within a game engine. It manages the creation, deletion, and update of worlds. 📕 Tutorial. 📘 API. |