chore: keep documenting the BCF integration

packages/core/src/core/Viewpoints/index.ts

@@ -21,6 +21,9 @@ interface ViewpointsConfig {
   overwriteColors: boolean;
 }
 
+/*
+ * The viewpoints component manages and applies BCF compliant viewpoint to a world.
+ */
 export class Viewpoints
   extends Component
   implements Disposable, Configurable<ViewpointsConfig>
@@ -58,6 +61,7 @@ export class Viewpoints
   onSetup = new Event();
   config: Required<ViewpointsConfig> = { overwriteColors: false };
 
+  /** {@link Disposable.onDisposed} */
   readonly onDisposed = new Event();
 
   /**

packages/core/src/core/Viewpoints/src/Viewpoint.ts

@@ -21,14 +21,22 @@ import { Classifier, Hider } from "../../../fragments";
 import { SimplePlane } from "../../Clipper";
 import { Viewpoints } from "..";
 
+/**
+ * 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.
+ */
 export class Viewpoint implements BCFViewpoint {
   title?: string;
-  guid = UUID.create();
+  readonly guid = UUID.create();
 
   /**
    * ClippingPlanes can be used to define a subsection of a building model that is related to the topic.
    * Each clipping plane is defined by Location and Direction.
    * The Direction vector points in the invisible direction meaning the half-space that is clipped.
+   * @experimental
    */
   clippingPlanes = new DataSet<SimplePlane>();
 
@@ -229,8 +237,6 @@ export class Viewpoint implements BCFViewpoint {
    * Adds components to the viewpoint based on the provided fragment ID map.
    *
    * @param fragmentIdMap - A map containing fragment IDs as keys and arrays of express IDs as values.
-   *
-   * @returns A Promise that resolves when the components have been added to the viewpoint.
    */
   addComponentsFromMap(fragmentIdMap: FRAGS.FragmentIdMap) {
     const fragments = this._components.get(FragmentsManager);
@@ -241,9 +247,10 @@ export class Viewpoint implements BCFViewpoint {
   }
 
   /**
-   * Sets the properties of the viewpoint with the provided data.
+   * Replace the properties of the viewpoint with the provided data.
    *
    * @remarks The guid will be ommited as it shouldn't change after it has been initially set.
+   * @remarks The existing selection and exception components will be fully replaced in case new ones are provided.
    *
    * @param data - An object containing the properties to be set.
    *               The properties not included in the object will remain unchanged.
@@ -256,6 +263,16 @@ export class Viewpoint implements BCFViewpoint {
     for (const key in data) {
       if (key === "guid") continue;
       const value = _data[key];
+      if (key === "selectionComponents") {
+        this.selectionComponents.clear();
+        this.selectionComponents.add(...value);
+        continue;
+      }
+      if (key === "exceptionComponents") {
+        this.exceptionComponents.clear();
+        this.exceptionComponents.add(...value);
+        continue;
+      }
       if (key in this) _this[key] = value;
     }
     const manager = this._components.get(Viewpoints);

packages/core/src/core/Viewpoints/src/types.ts

@@ -15,6 +15,9 @@ export interface ViewpointOrthographicCamera extends ViewpointCamera {
   viewToWorldScale: number;
 }
 
+/**
+ * Represents a viewpoint in a BCF file.
+ */
 export interface BCFViewpoint {
   title?: string;
   guid: string;

packages/core/src/openbim/BCFTopics/index.ts

@@ -27,6 +27,10 @@ import { Clipper } from "../../core/Clipper";
 
 // TODO: Extract import/export logic in its own class for better maintenance.
 
+/**
+ * BCFTopics manages Building Collaboration Format (BCF) data the engine.
+ * It provides functionality for importing, exporting, and manipulating BCF data.
+ */
 export class BCFTopics
   extends Component
   implements Disposable, Configurable<BCFTopicsConfig>