diff --git a/index.html b/index.html index afe995e1f..324788769 100644 --- a/index.html +++ b/index.html @@ -30,6 +30,7 @@

Choose an example

front/EdgeMeasurement front/AreaMeasurement front/AngleMeasurement +front/Sections front/Plans front/IfcStreamer front/Highlighter @@ -41,6 +42,7 @@

Choose an example

front/CivilElevationNavigator front/CivilCrossSectionNavigator front/Civil3DNavigator +core/BCFTopics core/MeasurementUtils core/IfcRelationsIndexer core/IfcPropertiesManager @@ -61,6 +63,27 @@

Choose an example

core/Grids core/Cullers core/Clipper +core/BCFTopics +core/MeasurementUtils +core/IfcRelationsIndexer +core/IfcPropertiesManager +core/IfcJsonExporter +core/IfcPropertiesTiler +core/IfcLoader +core/IfcGeometryTiler +core/Hider +core/FragmentsManager +core/Exploder +core/Classifier +core/BoundingBoxer +core/Worlds +core/ShadowedScene +core/Raycasters +core/OrthoPerspectiveCamera +core/MiniMap +core/Grids +core/Cullers +core/Clipper diff --git a/packages/core/package.json b/packages/core/package.json index 45e1f8815..5b6c588d1 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,7 +1,7 @@ { "name": "@thatopen/components", "description": "Collection of core functionalities to author BIM apps.", - "version": "2.1.27", + "version": "2.2.0-alpha.1", "author": "That Open Company", "contributors": [ "Antonio Gonzalez Viegas (https://github.com/agviegas)", @@ -46,6 +46,8 @@ }, "dependencies": { "camera-controls": "2.7.3", + "fast-xml-parser": "4.4.1", + "jszip": "3.10.1", "three-mesh-bvh": "0.7.0" }, "peerDependencies": { diff --git a/packages/core/src/core/Components/index.ts b/packages/core/src/core/Components/index.ts index 6f514237b..e8d9c442d 100644 --- a/packages/core/src/core/Components/index.ts +++ b/packages/core/src/core/Components/index.ts @@ -14,7 +14,7 @@ export class Components implements Disposable { /** * The version of the @thatopen/components library. */ - static readonly release = "2.1.27"; + static readonly release = "2.2.0-alpha.0"; /** {@link Disposable.onDisposed} */ readonly onDisposed = new Event(); diff --git a/packages/core/src/core/Types/src/data-map.ts b/packages/core/src/core/Types/src/data-map.ts index c1d8d1b02..64caa9a87 100644 --- a/packages/core/src/core/Types/src/data-map.ts +++ b/packages/core/src/core/Types/src/data-map.ts @@ -20,7 +20,7 @@ export class DataMap extends Map { /** * An event triggered when an item is deleted from the map. */ - readonly onItemDeleted = new Event(); + readonly onItemDeleted = new Event(); /** * An event triggered when the map is cleared. @@ -53,6 +53,8 @@ export class DataMap extends Map { */ set(key: K, value: V) { const triggerUpdate = this.has(key); + const isValid = this.guard(key, value); + if (!isValid) return this; const result = super.set(key, value); if (triggerUpdate) { if (!this.onItemUpdated) { @@ -68,6 +70,18 @@ export class DataMap extends Map { return result; } + /** + * A function that acts as a guard for adding items to the set. + * It determines whether a given value should be allowed to be added to the set. + * + * @param key - The key of the entry to be checked against the guard. + * @param value - The value of the entry to be checked against the guard. + * @returns A boolean indicating whether the value should be allowed to be added to the set. + * By default, this function always returns true, allowing all values to be added. + * You can override this behavior by providing a custom implementation. + */ + guard: (key: K, value: V) => boolean = () => true; + /** * Deletes the specified key from the map and triggers the onItemDeleted event if the key was found. * @@ -76,7 +90,7 @@ export class DataMap extends Map { */ delete(key: K) { const deleted = super.delete(key); - if (deleted) this.onItemDeleted.trigger(); + if (deleted) this.onItemDeleted.trigger(key); return deleted; } diff --git a/packages/core/src/core/Types/src/data-set.ts b/packages/core/src/core/Types/src/data-set.ts index 417115455..10af5ce2b 100644 --- a/packages/core/src/core/Types/src/data-set.ts +++ b/packages/core/src/core/Types/src/data-set.ts @@ -40,20 +40,35 @@ export class DataSet extends Set { } /** - * Adds a value to the set and triggers the onItemAdded event. + * Adds one or multiple values to the set and triggers the onItemAdded event per each. * * @param value - The value to add to the set. * @returns - The set instance. */ - add(value: T) { - const existing = this.has(value); - if (existing) return this; - const result = super.add(value); - if (!this.onItemAdded) (this.onItemAdded as any) = new Event(); - this.onItemAdded.trigger(value); - return result; + add(...value: T[]) { + for (const item of value) { + const existing = this.has(item); + if (existing) continue; + const isValid = this.guard(item); + if (!isValid) continue; + super.add(item); + if (!this.onItemAdded) (this.onItemAdded as any) = new Event(); + this.onItemAdded.trigger(item); + } + return this; } + /** + * A function that acts as a guard for adding items to the set. + * It determines whether a given value should be allowed to be added to the set. + * + * @param value - The value to be checked against the guard. + * @returns A boolean indicating whether the value should be allowed to be added to the set. + * By default, this function always returns true, allowing all values to be added. + * You can override this behavior by providing a custom implementation. + */ + guard: (value: T) => boolean = () => true; + /** * Deletes a value from the set and triggers the onItemDeleted event. * diff --git a/packages/core/src/core/Viewpoints/index.ts b/packages/core/src/core/Viewpoints/index.ts new file mode 100644 index 000000000..0942a8667 --- /dev/null +++ b/packages/core/src/core/Viewpoints/index.ts @@ -0,0 +1,77 @@ +import { + World, + Component, + Disposable, + Event, + DataMap, + Configurable, +} from "../Types"; +import { Components } from "../Components"; +import { BCFViewpoint, Viewpoint } from "./src"; + +/** + * Configuration interface for the Viewpoints general behavior. + */ +interface ViewpointsConfig { + /** + * Indicates whether to overwrite the fragments colors when applying viewpoints. + * @remarks BCF Viewpoints comes with information to indicate the colors to be applied to components, if any. + * @default false + */ + overwriteColors: boolean; +} + +export class Viewpoints + extends Component + implements Disposable, Configurable +{ + static readonly uuid = "ee867824-a796-408d-8aa0-4e5962a83c66" as const; + enabled = true; + + /** + * A DataMap that stores Viewpoint instances, indexed by their unique identifiers (guid). + * This map is used to manage and retrieve Viewpoint instances within the Viewpoints component. + */ + readonly list = new DataMap(); + + /** + * Creates a new Viewpoint instance and adds it to the list. + * + * @param world - The world in which the Viewpoint will be created. + * @param data - Optional partial data for the Viewpoint. If not provided, default data will be used. + * + * @returns The newly created Viewpoint instance. + */ + create(world: World, data?: Partial): Viewpoint { + const viewpoint = new Viewpoint(this.components, world, { data }); + if (!data) this.list.set(viewpoint.guid, viewpoint); + return viewpoint; + } + + constructor(components: Components) { + super(components); + components.add(Viewpoints.uuid, this); + } + + isSetup = false; + setup() {} + onSetup = new Event(); + config: Required = { overwriteColors: false }; + + readonly onDisposed = new Event(); + + /** + * Disposes of the Viewpoints component and its associated resources. + * + * This method is responsible for cleaning up any resources held by the Viewpoints component, + * such as disposing of the DataMap of Viewpoint instances and triggering and resetting the + * onDisposed event. + */ + dispose() { + this.list.dispose(); + this.onDisposed.trigger(); + this.onDisposed.reset(); + } +} + +export * from "./src"; diff --git a/packages/core/src/core/Viewpoints/src/Viewpoint.ts b/packages/core/src/core/Viewpoints/src/Viewpoint.ts new file mode 100644 index 000000000..793c2eeb5 --- /dev/null +++ b/packages/core/src/core/Viewpoints/src/Viewpoint.ts @@ -0,0 +1,562 @@ +import * as THREE from "three"; +import * as FRAGS from "@thatopen/fragments"; +import { UUID } from "../../../utils"; +import { + BCFViewpoint, + ViewpointCamera, + ViewpointOrthographicCamera, + ViewpointPerspectiveCamera, +} from "./types"; +import { + CameraProjection, + OrthoPerspectiveCamera, +} from "../../OrthoPerspectiveCamera"; +import { Components } from "../../Components"; +import { DataMap, DataSet, World } from "../../Types"; +import { FragmentsManager } from "../../../fragments/FragmentsManager"; +import { BCFTopics } from "../../../openbim/BCFTopics"; +import { Raycasters } from "../../Raycasters"; +import { BoundingBoxer } from "../../../fragments/BoundingBoxer"; +import { Classifier, Hider } from "../../../fragments"; +import { SimplePlane } from "../../Clipper"; +import { Viewpoints } from ".."; + +export class Viewpoint implements BCFViewpoint { + title?: string; + 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. + */ + clippingPlanes = new DataSet(); + + camera: ViewpointPerspectiveCamera | ViewpointOrthographicCamera = { + aspectRatio: 0, + fov: 0, + direction: { x: 0, y: 0, z: 80 }, + position: { x: 0, y: 0, z: 0 }, + }; + + /** + * A list of components GUIDs to hide when defaultVisibility = true or to show when defaultVisibility = false + */ + readonly exceptionComponents = new DataSet(); + + /** + * A list of components GUIDs that should be selected (highlighted) when displaying a viewpoint. + */ + readonly selectionComponents = new DataSet(); + + /** + * A map of colors and components GUIDs that should be colorized when displaying a viewpoint. + * For this to work, call viewpoint.colorize() + */ + readonly componentColors = new DataMap(); + + /** + * Boolean flags to allow fine control over the visibility of spaces. + * A typical use of these flags is when DefaultVisibility=true but spaces should remain hidden. + * @default false + */ + spacesVisible = false; + + /** + * Boolean flags to allow fine control over the visibility of space boundaries. + * A typical use of these flags is when DefaultVisibility=true but space boundaries should remain hidden. + * @default false + */ + spaceBoundariesVisible = false; + + /** + * Boolean flags to allow fine control over the visibility of openings. + * A typical use of these flags is when DefaultVisibility=true but openings should remain hidden. + * @default false + */ + openingsVisible = false; + + /** + * When true, all components should be visible unless listed in the exceptions + * When false all components should be invisible unless listed in the exceptions + */ + defaultVisibility = true; + + private get _selectionModelIdMap() { + const fragments = this._components.get(FragmentsManager); + const modelIdMap: { [modelID: string]: Set } = {}; + for (const [id, model] of fragments.groups) { + if (!(id in modelIdMap)) modelIdMap[id] = new Set(); + for (const globalId of this.selectionComponents) { + const expressID = model.globalToExpressIDs.get(globalId); + if (expressID) modelIdMap[id].add(expressID); + } + } + return modelIdMap; + } + + private get _exceptionModelIdMap() { + const fragments = this._components.get(FragmentsManager); + const modelIdMap: { [modelID: string]: Set } = {}; + for (const [id, model] of fragments.groups) { + if (!(id in modelIdMap)) modelIdMap[id] = new Set(); + for (const globalId of this.exceptionComponents) { + const expressID = model.globalToExpressIDs.get(globalId); + if (expressID) modelIdMap[id].add(expressID); + } + } + return modelIdMap; + } + + /** + * A list of components that should be selected (highlighted) when displaying a viewpoint. + * @returns The fragmentIdMap for components marked as selections. + */ + get selection() { + const fragments = this._components.get(FragmentsManager); + const fragmentIdMap = fragments.modelIdToFragmentIdMap( + this._selectionModelIdMap, + ); + return fragmentIdMap; + } + + /** + * A list of components to hide when defaultVisibility = true or to show when defaultVisibility = false + * @returns The fragmentIdMap for components marked as exceptions. + */ + get exception() { + const fragments = this._components.get(FragmentsManager); + const fragmentIdMap = fragments.modelIdToFragmentIdMap( + this._exceptionModelIdMap, + ); + return fragmentIdMap; + } + + /** + * Retrieves the projection type of the viewpoint's camera. + * + * @returns A string representing the projection type of the viewpoint's camera. + * It can be either 'Perspective' or 'Orthographic'. + */ + get projection(): CameraProjection { + if ("fov" in this.camera) return "Perspective"; + return "Orthographic"; + } + + /** + * Retrieves the position vector of the viewpoint's camera. + * + * @remarks + * The position vector represents the camera's position in the world coordinate system. + * The function applies the base coordinate system transformation to the position vector. + * + * @returns A THREE.Vector3 representing the position of the viewpoint's camera. + */ + get position() { + const fragments = this._components.get(FragmentsManager); + const { position } = this.camera; + const { x, y, z } = position; + const vector = new THREE.Vector3(x, y, z); + fragments.applyBaseCoordinateSystem(vector, new THREE.Matrix4()); + return vector; + } + /** + * Retrieves the direction vector of the viewpoint's camera. + * + * @remarks + * The direction vector represents the direction in which the camera is pointing. + * It is calculated by extracting the x, y, and z components from the camera's direction property. + * + * @returns A THREE.Vector3 representing the direction of the viewpoint's camera. + */ + get direction() { + const { direction } = this.camera; + const { x, y, z } = direction; + const vector = new THREE.Vector3(x, y, z); + return vector; + } + + private _components: Components; + + /** + * Represents the world in which the viewpoints are created and managed. + */ + readonly world: World; + + private get _managerVersion() { + const manager = this._components.get(BCFTopics); + return manager.config.version; + } + + /** + * Retrieves the list of BCF topics associated with the current viewpoint. + * + * @remarks + * This function retrieves the BCFTopics manager from the components, + * then filters the list of topics to find those associated with the current viewpoint. + * + * @returns An array of BCF topics associated with the current viewpoint. + */ + get topics() { + const manager = this._components.get(BCFTopics); + const topicsList = [...manager.list.values()]; + const topics = topicsList.filter((topic) => + topic.viewpoints.has(this.guid), + ); + return topics; + } + + constructor( + components: Components, + world: World, + _config?: { + data?: Partial; + setCamera?: boolean; + }, + ) { + const config = { setCamera: true, ..._config }; + const { data, setCamera } = config; + this._components = components; + this.world = world; + if (data) { + this.guid = data.guid ?? this.guid; + this.set(data); + } + if (setCamera) this.updateCamera(); + } + + /** + * 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. + */ + async addComponentsFromMap(fragmentIdMap: FRAGS.FragmentIdMap) { + const fragments = this._components.get(FragmentsManager); + for (const fragmentID in fragmentIdMap) { + const fragment = fragments.list.get(fragmentID); + if (!(fragment && fragment.group)) continue; + const model = fragment.group; + const expressIDs = fragmentIdMap[fragmentID]; + for (const expressID of expressIDs) { + const attrs = await model.getProperties(expressID); + if (!attrs) continue; + const globalId = attrs.GlobalId?.value; + if (globalId) this.selectionComponents.add(globalId); + } + } + const manager = this._components.get(Viewpoints); + manager.list.set(this.guid, this); + } + + /** + * Sets 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. + * + * @param data - An object containing the properties to be set. + * The properties not included in the object will remain unchanged. + * + * @returns The viewpoint instance with the updated properties. + */ + set(data: Partial) { + const _data = data as any; + const _this = this as any; + for (const key in data) { + if (key === "guid") continue; + const value = _data[key]; + if (key in this) _this[key] = value; + } + const manager = this._components.get(Viewpoints); + manager.list.set(this.guid, this); + return this; + } + + /** + * Sets the viewpoint of the camera in the world. + * + * @remarks + * This function calculates the target position based on the viewpoint information. + * It sets the visibility of the viewpoint components and then applies the viewpoint using the camera's controls. + * + * @param transition - Indicates whether the camera movement should have a transition effect. + * Default value is `true`. + * + * @throws An error if the world's camera does not have camera controls. + * + * @returns A Promise that resolves when the camera has been set. + */ + async go(transition = true) { + const { camera } = this.world; + if (!camera.hasCameraControls()) { + throw new Error( + "Viewpoint: the world's camera need controls to set the viewpoint.", + ); + } + + if (camera instanceof OrthoPerspectiveCamera) { + camera.projection.set(this.projection); + } + + const position = this.position; + const direction = this.direction; + + // Default target based on the viewpoint information + let target = { + x: position.x + direction.x * 80, + y: position.y + direction.y * 80, + z: position.z + direction.z * 80, + }; + + const selection = this.selection; + if (Object.keys(selection).length === 0) { + // In case there are not selection components, use the raycaster to calculate one + const raycasters = this._components.get(Raycasters); + const raycaster = raycasters.get(this.world); + const result = raycaster.castRayFromVector(position, this.direction); + if (result) target = result.point; + } else { + // In case there are selection components, use their center as the target + const bb = this._components.get(BoundingBoxer); + bb.reset(); + bb.addFragmentIdMap(selection); + target = bb.getSphere().center; + bb.reset(); + } + + // Sets the viewpoint components visibility + const hider = this._components.get(Hider); + hider.set(this.defaultVisibility); + hider.set(!this.defaultVisibility, this.exception); + hider.set(true, selection); // Always make sure the selection is visible + + await camera.controls.setLookAt( + position.x, + position.y, + position.z, + target.x, + target.y, + target.z, + transition, + ); + } + + /** + * Updates the camera settings of the viewpoint based on the current world's camera and renderer. + * + * @remarks + * This function retrieves the camera's position, direction, and aspect ratio from the world's camera and renderer. + * It then calculates the camera's perspective or orthographic settings based on the camera type. + * Finally, it updates the viewpoint's camera settings and updates the viewpoint to the Viewpoints manager. + * + * @throws An error if the world's camera does not have camera controls. + * @throws An error if the world's renderer is not available. + */ + updateCamera() { + const { camera, renderer } = this.world; + if (!renderer) { + throw new Error("Viewpoint: the world needs to have a renderer!"); + } + + if (!camera.hasCameraControls()) { + throw new Error("Viewpoint: world's camera need camera controls!"); + } + + const position = new THREE.Vector3(); + camera.controls.getPosition(position); + + const threeCamera = camera.three; + + const direction = new THREE.Vector3(0, 0, -1).applyEuler( + threeCamera.rotation, + ); + + const { width, height } = renderer.getSize(); + let aspectRatio = width / height; + + // If the renderer exists but there is no HTMLElement, then aspect will be 0 / 0. In that case, use 1 as a fallback. + if (Number.isNaN(aspectRatio)) aspectRatio = 1; + + const fragments = this._components.get(FragmentsManager); + position.applyMatrix4(fragments.baseCoordinationMatrix.clone().invert()); + + const partialCamera: ViewpointCamera = { + aspectRatio, + position: { x: position.x, y: position.y, z: position.z }, + direction: { x: direction.x, y: direction.y, z: direction.z }, + }; + + if (threeCamera instanceof THREE.PerspectiveCamera) { + this.camera = { + ...partialCamera, + fov: threeCamera.fov, + }; + } else if (threeCamera instanceof THREE.OrthographicCamera) { + this.camera = { + ...partialCamera, + viewToWorldScale: threeCamera.top - threeCamera.bottom, + }; + } + + const manager = this._components.get(Viewpoints); + manager.list.set(this.guid, this); + } + + /** + * Applies color to the components in the viewpoint based on their GUIDs. + * + * This function iterates through the `componentColors` map, retrieves the fragment IDs + * corresponding to each color, and then uses the `Classifier` to apply the color to those fragments. + * + * @remarks + * The color is applied using the `Classifier.setColor` method, which sets the color of the specified fragments. + * The color is provided as a hexadecimal string, prefixed with a '#'. + */ + colorize() { + const manager = this._components.get(Viewpoints); + const fragments = this._components.get(FragmentsManager); + const classifier = this._components.get(Classifier); + for (const [color, guids] of this.componentColors) { + const fragmentIdMap = fragments.guidToFragmentIdMap(guids); + const threeColor = new THREE.Color(`#${color}`); + classifier.setColor( + fragmentIdMap, + threeColor, + manager.config.overwriteColors, + ); + } + } + + /** + * Resets the colors of all components in the viewpoint to their original color. + * This method iterates through the `componentColors` map, retrieves the fragment IDs + * corresponding to each color, and then uses the `Classifier` to reset the color of those fragments. + */ + resetColors() { + const fragments = this._components.get(FragmentsManager); + const classifier = this._components.get(Classifier); + for (const [_, guids] of this.componentColors) { + const fragmentIdMap = fragments.guidToFragmentIdMap(guids); + classifier.resetColor(fragmentIdMap); + } + } + + private async createComponentTags(from: "selection" | "exception") { + const fragments = this._components.get(FragmentsManager); + const manager = this._components.get(BCFTopics); + let tags = ""; + if (manager.config.includeSelectionTag) { + const modelIdMap = + from === "selection" + ? this._selectionModelIdMap + : this._exceptionModelIdMap; + for (const modelID in modelIdMap) { + const model = fragments.groups.get(modelID); + if (!model) continue; + const expressIDs = modelIdMap[modelID]; + for (const expressID of expressIDs) { + const attrs = await model.getProperties(expressID); + if (!attrs) continue; + const globalID = attrs.GlobalId?.value; + if (!globalID) continue; + const tag = attrs.Tag?.value; + let tagAttribute: string | null = null; + if (tag) tagAttribute = `AuthoringToolId="${tag}"`; + tags += `\n`; + } + } + } else { + tags = [...this.selectionComponents] + .map((globalId) => ``) + .join(`\n`); + } + return tags; + } + + /** + * Serializes the viewpoint into a buildingSMART compliant XML string for export. + * + * @param version - The version of the BCF Manager to use for serialization. + * If not provided, the current version of the manager will be used. + * + * @returns A Promise that resolves to an XML string representing the viewpoint. + * The XML string follows the BCF VisualizationInfo schema. + * + * @throws An error if the world's camera does not have camera controls. + * @throws An error if the world's renderer is not available. + */ + async serialize(version = this._managerVersion) { + const fragments = this._components.get(FragmentsManager); + + // Set the position back to the original transformation for exporting purposes + const position = this.position; + position.applyMatrix4(fragments.baseCoordinationMatrix.clone().invert()); + + // Set the direction back to the original transformation for exporting purposes + const direction = this.direction; + direction.normalize(); + + // The up vector doesn't seem to do anything in other software + const rotationMatrix = new THREE.Matrix4().makeRotationX(Math.PI / 2); + const upVector = direction.clone().applyMatrix4(rotationMatrix); + upVector.normalize(); + + const cameraViewpointXML = ` + ${position.x} + ${-position.z} + ${position.y} + `; + + const cameraDirectionXML = ` + ${direction.x} + ${-direction.z} + ${direction.y} + `; + + const cameraUpVectorXML = ` + ${upVector.x} + ${-upVector.z} + ${upVector.y} + `; + + const cameraRatioXML = `${this.camera.aspectRatio}`; + + let cameraXML = ""; + if ("viewToWorld" in this.camera) { + cameraXML = ` + ${cameraViewpointXML} + ${cameraDirectionXML} + ${cameraUpVectorXML} + ${cameraRatioXML} + ${this.camera.viewToWorld} + `; + } else if ("fov" in this.camera) { + cameraXML = ` + ${cameraViewpointXML} + ${cameraDirectionXML} + ${cameraUpVectorXML} + ${cameraRatioXML} + ${this.camera.fov} + `; + } + + const viewSetupHints = ``; + + const selectionTags = (await this.createComponentTags("selection")).trim(); + const exceptionTags = (await this.createComponentTags("exception")).trim(); + + return ` + + + ${version === "2.1" ? viewSetupHints : ""} + ${selectionTags.length !== 0 ? `${selectionTags}` : ""} + + ${version === "3" ? viewSetupHints : ""} + ${exceptionTags.length !== 0 ? `${exceptionTags}` : ""} + + + ${cameraXML} + `; + } +} diff --git a/packages/core/src/core/Viewpoints/src/index.ts b/packages/core/src/core/Viewpoints/src/index.ts new file mode 100644 index 000000000..415d33534 --- /dev/null +++ b/packages/core/src/core/Viewpoints/src/index.ts @@ -0,0 +1,2 @@ +export * from "./types"; +export * from "./Viewpoint"; diff --git a/packages/core/src/core/Viewpoints/src/types.ts b/packages/core/src/core/Viewpoints/src/types.ts new file mode 100644 index 000000000..877e9a67c --- /dev/null +++ b/packages/core/src/core/Viewpoints/src/types.ts @@ -0,0 +1,29 @@ +import { SimplePlane } from "../../Clipper"; +import { DataSet } from "../../Types"; + +export interface ViewpointCamera { + direction: { x: number; y: number; z: number }; + position: { x: number; y: number; z: number }; + aspectRatio: number; +} + +export interface ViewpointPerspectiveCamera extends ViewpointCamera { + fov: number; +} + +export interface ViewpointOrthographicCamera extends ViewpointCamera { + viewToWorldScale: number; +} + +export interface BCFViewpoint { + title?: string; + guid: string; + camera: ViewpointPerspectiveCamera | ViewpointOrthographicCamera; + selectionComponents: Iterable; + exceptionComponents: Iterable; + clippingPlanes: DataSet; + spacesVisible: boolean; + spaceBoundariesVisible: boolean; + openingsVisible: boolean; + defaultVisibility: boolean; +} diff --git a/packages/core/src/core/index.ts b/packages/core/src/core/index.ts index 2c8c01513..dc7ff1b4d 100644 --- a/packages/core/src/core/index.ts +++ b/packages/core/src/core/index.ts @@ -7,5 +7,6 @@ export * from "./Worlds"; export * from "./Grids"; export * from "./Clipper"; export * from "./Cullers"; +export * from "./Viewpoints"; export * from "./MiniMap"; export * from "./OrthoPerspectiveCamera"; diff --git a/packages/core/src/fragments/FragmentsManager/index.ts b/packages/core/src/fragments/FragmentsManager/index.ts index addcb4000..99b7cdec2 100644 --- a/packages/core/src/fragments/FragmentsManager/index.ts +++ b/packages/core/src/fragments/FragmentsManager/index.ts @@ -280,9 +280,11 @@ export class FragmentsManager extends Component implements Disposable { */ applyBaseCoordinateSystem( object: THREE.Object3D | THREE.Vector3, - originalCoordinateSystem: THREE.Matrix4, + originalCoordinateSystem?: THREE.Matrix4, ) { - object.applyMatrix4(originalCoordinateSystem.clone().invert()); + if (originalCoordinateSystem) { + object.applyMatrix4(originalCoordinateSystem.clone().invert()); + } object.applyMatrix4(this.baseCoordinationMatrix); } diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index 69e98255c..e49907fa0 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -3,3 +3,4 @@ export * from "./fragments"; export * from "./ifc"; export * from "./measurement"; export * from "./utils"; +export * from "./openbim"; diff --git a/packages/core/src/openbim/BCFTopics/example.html b/packages/core/src/openbim/BCFTopics/example.html new file mode 100644 index 000000000..2d0a2edbc --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/example.html @@ -0,0 +1,49 @@ + + + + + + + BCF Topics + + + + + + + + + \ No newline at end of file diff --git a/packages/core/src/openbim/BCFTopics/example.ts b/packages/core/src/openbim/BCFTopics/example.ts new file mode 100644 index 000000000..3e07d728d --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/example.ts @@ -0,0 +1,271 @@ +// eslint-disable-next-line import/no-extraneous-dependencies +import * as BUI from "@thatopen/ui"; +import * as THREE from "three"; +import * as FRAGS from "@thatopen/fragments"; +// eslint-disable-next-line import/no-extraneous-dependencies +import { createRef } from "lit/directives/ref.js"; +// eslint-disable-next-line import/no-extraneous-dependencies +import * as OBC from "../.."; +// import { bcfTopicsList } from "./src/TopicsList"; +// import { topicForm } from "./src/TopicForm"; +// import { topicPanel } from "./src/TopicPanel"; +// import { viewpointsList } from "./src/ViewpointsList"; + +BUI.Manager.init(); + +const components = new OBC.Components(); + +const worlds = components.get(OBC.Worlds); +const world = worlds.create(); + +const sceneComponent = new OBC.SimpleScene(components); +sceneComponent.setup(); +world.scene = sceneComponent; + +world.scene.three.add(new THREE.AxesHelper(10)); + +const viewport = document.createElement("bim-viewport"); +const rendererComponent = new OBC.SimpleRenderer(components, viewport); +world.renderer = rendererComponent; + +const cameraComponent = new OBC.SimpleCamera(components); +world.camera = cameraComponent; + +viewport.addEventListener("resize", () => { + rendererComponent.resize(); + cameraComponent.updateAspect(); +}); + +const viewportGrid = document.createElement("bim-grid"); +viewportGrid.floating = true; +viewport.append(viewportGrid); + +const viewerGrids = components.get(OBC.Grids); +viewerGrids.create(world); + +components.init(); + +const ifcLoader = components.get(OBC.IfcLoader); +await ifcLoader.setup(); + +const indexer = components.get(OBC.IfcRelationsIndexer); + +const fragments = components.get(OBC.FragmentsManager); +fragments.onFragmentsLoaded.add(async (model) => { + world.scene.three.add(model); + if (model.hasProperties) await indexer.process(model); + for (const fragment of model.items) world.meshes.add(fragment.mesh); +}); + +const loadModels = async (urls: string[]) => { + const models: FRAGS.FragmentsGroup[] = []; + for (const url of urls) { + const file = await fetch(url); + const data = await file.arrayBuffer(); + const buffer = new Uint8Array(data); + const model = await ifcLoader.load(buffer); + models.push(model); + } + return models; +}; + +const models = await loadModels([ + "https://thatopen.github.io/engine_components/resources/small.ifc", +]); + +// const models = await loadModels([ +// "/resources/NAV-IPI-ET1_E03-ZZZ-M3D-EST.ifc", +// "/resources/NAV-IPI-ET1_E07-ZZZ-M3D-EST.ifc", +// ]); + +const model = models[0]; + +const bcfTopics = components.get(OBC.BCFTopics); +bcfTopics.setup({ + types: new Set([...bcfTopics.config.types, "Information", "Coordination"]), + statuses: new Set(["Active", "In Progress", "Done", "In Review", "Closed"]), + users: new Set(["juan.hoyos4@gmail.com"]), +}); + +const viewpoints = components.get(OBC.Viewpoints); + +// Creating a custom Topic +const topicsUIStyles = { + users: { + "jhon.doe@example.com": { + name: "Jhon Doe", + picture: + "https://www.profilebakery.com/wp-content/uploads/2023/04/Profile-Image-AI.jpg", + }, + "juan.hoyos4@gmail.com": { + name: "Juan Hoyos", + picture: + "https://media.licdn.com/dms/image/D4E03AQEo2otgxQ8Y3A/profile-displayphoto-shrink_200_200/0/1718545012590?e=1728518400&v=beta&t=6s2ULNJHPjbWBTZt_S35e-BN2LHUavVXa2vEljGM2TM", + }, + }, +}; + +// const [topicPopup, updateTopicPopup] = BUI.Component.create< +// HTMLDialogElement, +// { topic?: OBC.Topic } +// >((state: { topic?: OBC.Topic }) => { +// const { topic } = state; +// const dialog = createRef(); + +// const [form] = topicForm({ +// components, +// topic, +// styles: { users: topicsUIStyles.users }, +// onSubmit() { +// dialog.value?.close(); +// }, +// onCancel() { +// dialog.value?.close(); +// }, +// }); + +// return BUI.html`${form} `; +// }, {}); + +// document.body.append(topicPopup); + +// const [topicUI, updateTopicUI] = topicPanel({ +// components, +// styles: topicsUIStyles, +// world, +// onUpdateInformation(topic) { +// updateTopicPopup({ topic }); +// topicPopup.showModal(); +// }, +// }); + +viewportGrid.layouts = { + main: { + template: ` + "empty topicPanel" 1fr + /1fr 22rem + `, + elements: {}, + }, +}; + +// const [topicsList] = bcfTopicsList({ +// components, +// dataStyles: topicsUIStyles, +// onTopicEnter(topic) { +// updateTopicUI({ topic }); +// viewportGrid.layout = "main"; +// }, +// }); + +// Importing an external BCF (topics and viewpoints are going to be created) +const loadBCFs = async (urls: string[]) => { + const data: { viewpoints: OBC.Viewpoint[]; topics: OBC.Topic[] } = { + viewpoints: [], + topics: [], + }; + + for (const url of urls) { + const bcfFile = await fetch(url); + const bcfData = await bcfFile.arrayBuffer(); + const { viewpoints, topics } = await bcfTopics.load( + new Uint8Array(bcfData), + world, + ); + data.viewpoints.push(...viewpoints); + data.topics.push(...topics); + } + + return data; +}; + +await loadBCFs([ + // "/resources/topics.bcf", + // "/resources/MaximumInformation_2.1.bcf", + // "/resources/MaximumInformation_3.0.bcf", +]); + +const topic = bcfTopics.create({ + title: "Missing information", + description: "It seems these elements are badly defined.", + dueDate: new Date("08-01-2020"), + type: "Clash", + priority: "Major", + stage: "Design", + labels: new Set(["Architecture", "Cost Estimation"]), + assignedTo: "juan.hoyos4@gmail.com", +}); + +// const [topicAGuid] = [...bcfTopics.list][0]; +// topic.relatedTopics.add(topicAGuid); + +// Creating a custom viewpoint +const viewpoint = viewpoints.create(world, { title: "Custom Viewpoint" }); +viewpoint.addComponentsFromMap(model.getFragmentMap([186])); // You can provide a FragmentIdMap to the viewpoint selection +// viewpoint.selectionComponents.add("2idC0G3ezCdhA9WVjWemcy"); // You can provide a GlobalId to the viewpoint selection +// viewpoint.selection gives the fragmentIdMap to select elements with the highlighter from @thatopen/components-front +// you can also use the viewpoint.selection fragmentIdMap to query elements data using FragmentsGroup.getProperty() + +topic.viewpoints.add(viewpoint.guid); +const comment = topic.createComment("What if we talk about this next meeting?"); +comment.author = "juan.hoyos4@gmail.com"; +topic.createComment("Hi there! I agree."); +comment.viewpoint = viewpoint; + +// const [viewpointsListElement] = viewpointsList({ components }); + +const leftPanel = BUI.Component.create(() => { + return BUI.html` + + + + + + `; +}); + +const bottomPanel = BUI.Component.create(() => { + const onBcfDownload = async () => { + // const topics = [...topicsList.selection] + // .map(({ Guid }) => { + // if (typeof Guid !== "string") return null; + // return bcfTopics.list.get(Guid); + // }) + // .filter((topic) => topic) as OBC.Topic[]; + // const bcf = await bcfTopics.export( + // topics.length !== 0 ? topics : undefined, + // ); + // const bcfFile = new File([bcf], "topics.bcf"); + // const a = document.createElement("a"); + // a.href = URL.createObjectURL(bcfFile); + // a.download = bcfFile.name; + // a.click(); + // URL.revokeObjectURL(a.href); + }; + + return BUI.html` + + +
+ + +
+ + + + `; +}); + +const app = document.getElementById("app") as BUI.Grid; +app.layouts = { + main: { + template: ` + "leftPanel viewport" 2fr + "leftPanel bottomPanel" 1fr + / 25rem 1fr + `, + elements: { leftPanel, viewport, bottomPanel }, + }, +}; + +app.layout = "main"; diff --git a/packages/core/src/openbim/BCFTopics/index.ts b/packages/core/src/openbim/BCFTopics/index.ts new file mode 100644 index 000000000..6b8b687f7 --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/index.ts @@ -0,0 +1,661 @@ +import JSZip from "jszip"; +import * as THREE from "three"; +import { XMLParser } from "fast-xml-parser"; +import { + Component, + Configurable, + Disposable, + Event, + World, + DataMap, +} from "../../core/Types"; +import { + BCFTopic, + BCFTopicsConfig, + BCFVersion, + Topic, + extensionsImporter, +} from "./src"; +import { + BCFViewpoint, + Viewpoint, + ViewpointCamera, + Viewpoints, +} from "../../core/Viewpoints"; +import { Comment } from "./src/Comment"; +import { Clipper } from "../../core/Clipper"; + +// TODO: Extract import/export logic in its own class for better maintenance. + +export class BCFTopics + extends Component + implements Disposable, Configurable +{ + static uuid = "de977976-e4f6-4e4f-a01a-204727839802" as const; + enabled = false; + + static xmlParser = new XMLParser({ + allowBooleanAttributes: true, + attributeNamePrefix: "", + ignoreAttributes: false, + ignoreDeclaration: true, + ignorePiTags: true, + numberParseOptions: { leadingZeros: true, hex: true }, + parseAttributeValue: true, + preserveOrder: false, + processEntities: false, + removeNSPrefix: true, + trimValues: true, + }); + + config: Required = { + author: "jhon.doe@example.com", + version: "2.1", + types: new Set([ + "Clash", + "Failure", + "Fault", + "Inquiry", + "Issue", + "Remark", + "Request", + ]), + statuses: new Set(["Active", "In Progress", "Done", "In Review", "Closed"]), + priorities: new Set(["On hold", "Minor", "Normal", "Major", "Critical"]), + labels: new Set(), + stages: new Set(), + users: new Set(), + includeSelectionTag: false, + updateExtensionsOnImport: true, + strict: false, + includeAllExtensionsOnExport: true, + fallbackVersionOnImport: "2.1", + ignoreIncompleteTopicsOnImport: false, + }; + + readonly list = new DataMap(); + + readonly onSetup = new Event(); + isSetup = false; + setup(config?: Partial) { + if (this.isSetup) return; + this.config = { ...this.config, ...config }; + this.isSetup = true; + this.enabled = true; + this.onSetup.trigger(); + } + + readonly onBCFImported = new Event(); + + /** + * Creates a new BCFTopic instance and adds it to the list. + * + * @param data - Optional partial BCFTopic object to initialize the new topic with. + * If not provided, default values will be used. + * @returns The newly created BCFTopic instance. + */ + create(data?: Partial) { + const topic = new Topic(this.components); + if (data) { + topic.guid = data.guid ?? topic.guid; + topic.set(data); + } + this.list.set(topic.guid, topic); + return topic; + } + + readonly onDisposed = new Event(); + + /** + * Disposes of the BCFTopics component and triggers the onDisposed event. + * + * @remarks + * This method clears the list of topics and triggers the onDisposed event. + * It also resets the onDisposed event listener. + */ + dispose() { + this.list.dispose(); + this.onDisposed.trigger(); + this.onDisposed.reset(); + } + + /** + * Retrieves the unique set of topic types used across all topics. + * + * @returns A Set containing the unique topic types. + */ + get usedTypes() { + const types = [...this.list].map(([_, topic]) => topic.type); + return new Set(types); + } + + /** + * Retrieves the unique set of topic statuses used across all topics. + * + * @returns A Set containing the unique topic statuses. + */ + get usedStatuses() { + const statuses = [...this.list].map(([_, topic]) => topic.status); + return new Set(statuses); + } + + /** + * Retrieves the unique set of topic priorities used across all topics. + * + * @returns A Set containing the unique topic priorities. + * Note: This method filters out any null or undefined priorities. + */ + get usedPriorities() { + const priorities = [...this.list] + .map(([_, topic]) => topic.priority) + .filter((priority) => priority); + return new Set(priorities); + } + + /** + * Retrieves the unique set of topic stages used across all topics. + * + * @returns A Set containing the unique topic stages. + * Note: This method filters out any null or undefined stages. + */ + get usedStages() { + const stages = [...this.list] + .map(([_, topic]) => topic.stage) + .filter((stage) => stage); + return new Set(stages); + } + + /** + * Retrieves the unique set of users associated with topics. + * + * @returns A Set containing the unique users. + * Note: This method collects users from the creation author, assigned to, modified author, and comment authors. + */ + get usedUsers() { + const users: string[] = []; + for (const [_, topic] of this.list) { + users.push(topic.creationAuthor); + if (topic.assignedTo) users.push(topic.assignedTo); + if (topic.modifiedAuthor) users.push(topic.modifiedAuthor); + for (const [_, comment] of topic.comments) { + users.push(comment.author); + if (comment.modifiedAuthor) users.push(comment.modifiedAuthor); + } + } + return new Set(users); + } + + /** + * Retrieves the unique set of labels used across all topics. + * + * @returns A Set containing the unique labels. + */ + get usedLabels() { + const labels: string[] = []; + for (const [_, topic] of this.list) labels.push(...topic.labels); + return new Set(labels); + } + + /** + * Updates the set of extensions (types, statuses, priorities, labels, stages, users) based on the current topics. + * This method iterates through each topic in the list and adds its properties to the corresponding sets in the config. + */ + updateExtensions() { + for (const [_, topic] of this.list) { + for (const label of topic.labels) this.config.labels.add(label); + this.config.types.add(topic.type); + if (topic.priority) this.config.priorities.add(topic.priority); + if (topic.stage) this.config.stages.add(topic.stage); + this.config.statuses.add(topic.status); + this.config.users.add(topic.creationAuthor); + if (topic.assignedTo) this.config.users.add(topic.assignedTo); + if (topic.modifiedAuthor) this.config.users.add(topic.modifiedAuthor); + for (const [_, comment] of topic.comments) { + this.config.users.add(comment.author); + if (comment.modifiedAuthor) + this.config.users.add(comment.modifiedAuthor); + } + } + } + + /** + * Updates the references to viewpoints in the topics. + * This function iterates through each topic and checks if the viewpoints exist in the viewpoints list. + * If a viewpoint does not exist, it is removed from the topic's viewpoints. + */ + updateViewpointReferences() { + const viewpoints = this.components.get(Viewpoints); + for (const [_, topic] of this.list) { + for (const viewpointID of topic.viewpoints) { + const exists = viewpoints.list.has(viewpointID); + if (!exists) topic.viewpoints.delete(viewpointID); + } + } + } + + /** + * Exports the given topics to a BCF (Building Collaboration Format) zip file. + * + * @param topics - The topics to export. Defaults to all topics in the list. + * @returns A promise that resolves to a Blob containing the exported BCF zip file. + */ + async export(topics: Iterable = this.list.values()) { + const zip = new JSZip(); + zip.file( + "bcf.version", + ` + + `, + ); + zip.file("bcf.extensions", this.serializeExtensions()); + const image = await fetch( + "https://thatopen.github.io/engine_components/resources/favicon.ico", + ); + const imgBlob = await image.blob(); + const viewpoints = this.components.get(Viewpoints); + for (const topic of topics) { + const topicFolder = zip.folder(topic.guid) as JSZip; + topicFolder.file("markup.bcf", topic.serialize()); + for (const viewpointID of topic.viewpoints) { + const viewpoint = viewpoints.list.get(viewpointID); + if (!viewpoint) continue; + topicFolder.file(`${viewpointID}.jpeg`, imgBlob, { + binary: true, + }); + topicFolder.file(`${viewpointID}.bcfv`, await viewpoint.serialize()); + } + } + const content = await zip.generateAsync({ type: "blob" }); + return content; + } + + private serializeExtensions() { + const types = [...this.config.types] + .map((type) => `${type}`) + .join("\n"); + + const statuses = [...this.config.statuses] + .map((status) => `${status}`) + .join("\n"); + + const priorities = [...this.config.priorities] + .map((priority) => `${priority}`) + .join("\n"); + + const labels = [...this.config.labels] + .map((label) => `${label}`) + .join("\n"); + + const stages = [...this.config.stages] + .map((stage) => `${stage}`) + .join("\n"); + + const users = [...this.config.users] + .map((user) => `${user}`) + .join("\n"); + + return ` + + + ${types.length !== 0 ? `\n${types}\n` : ""} + ${statuses.length !== 0 ? `\n${statuses}\n` : ""} + ${priorities.length !== 0 ? `\n${priorities}\n` : ""} + ${labels.length !== 0 ? `\n${labels}\n` : ""} + ${stages.length !== 0 ? `\n${stages}\n` : ""} + ${users.length !== 0 ? `\n${users}\n` : ""} + + `; + } + + private processMarkupComment(markupComment: any) { + const { + Guid, + Date: CommentDate, + Author, + Comment: CommentText, + Viewpoint, + } = markupComment; + if (!(Guid && CommentDate && Author && (Comment || Viewpoint))) return null; + const viewpoints = this.components.get(Viewpoints); + const comment = new Comment(this.components, CommentText ?? "") as Comment; + comment.guid = Guid; + comment.date = new Date(CommentDate); + comment.author = Author; + comment.viewpoint = Viewpoint?.Guid + ? viewpoints.list.get(Viewpoint.Guid) + : undefined; + comment.modifiedAuthor = markupComment.ModifiedAuthor; + comment.modifiedDate = markupComment.ModifiedDate + ? new Date(markupComment.ModifiedDate) + : undefined; + return comment; + } + + private getMarkupComments(markup: any, version: BCFVersion) { + let data: any; + if (version === "2.1") data = markup.Comment; + if (version === "3") data = markup.Topic.Comments?.Comment; + if (!data) return []; + data = Array.isArray(data) ? data : [data]; + const comments = data + .map((comment: any) => this.processMarkupComment(comment)) + .filter((comment: any) => comment) as Comment[]; + const array = Array.isArray(comments) ? comments : [comments]; + return array; + } + + private getMarkupLabels(markup: any, version: BCFVersion) { + let data: any; + if (version === "2.1") data = markup.Topic.Labels; + if (version === "3") data = markup.Topic.Labels?.Label; + if (!data) return []; + const labels: string[] = Array.isArray(data) ? data : [data]; + return labels; + } + + private getMarkupViewpoints(markup: any, version: BCFVersion) { + let data: any; + if (version === "2.1") data = markup.Viewpoints; + if (version === "3") data = markup.Topic.Viewpoints?.ViewPoint; + if (!data) return []; + data = Array.isArray(data) ? data : [data]; + return data; + } + + private getMarkupRelatedTopics(markup: any, version: BCFVersion) { + let data: any; + if (version === "2.1") data = markup.Topic.RelatedTopic; + if (version === "3") data = markup.Topic.RelatedTopics?.RelatedTopic; + if (!data) return []; + const topics: { Guid: string }[] = Array.isArray(data) ? data : [data]; + return topics.map((topic) => topic.Guid); + } + + /** + * Loads BCF (Building Collaboration Format) data into the engine. + * + * @param world - The default world where the viewpoints are going to be created. + * @param data - The BCF data to load. + * + * @returns A promise that resolves to an object containing the created viewpoints and topics. + * + * @throws An error if the BCF version is not supported. + */ + async load(data: Uint8Array, world: World) { + const { + fallbackVersionOnImport, + ignoreIncompleteTopicsOnImport, + updateExtensionsOnImport, + } = this.config; + const zip = new JSZip(); + await zip.loadAsync(data); + + const files = Object.values(zip.files); + + // Get BCF Version from incomming data + let version = fallbackVersionOnImport; + const versionFile = files.find((file) => file.name.endsWith(".version")); + if (versionFile) { + const versionXML = await versionFile.async("string"); + const bcfVersion = + BCFTopics.xmlParser.parse(versionXML).Version.VersionId; + version = String(bcfVersion) as BCFVersion; + } + + if (!(version && (version === "2.1" || version === "3"))) { + throw new Error(`BCFTopics: ${version} is not supported.`); + } + + // Get BCF Extensions file + const extensionsFile = files.find((file) => + file.name.endsWith(".extensions"), + ); + + if (updateExtensionsOnImport && extensionsFile) { + const extensionsXML = await extensionsFile.async("string"); + extensionsImporter(this, extensionsXML); + } + + // Viewpoints must be processed first as they don't care about the topic, but the topic and comments care about them + const createdViewpoints: Viewpoint[] = []; + const viewpoints = this.components.get(Viewpoints); + const viewpointFiles = files.filter((file) => file.name.endsWith(".bcfv")); + for (const viewpointFile of viewpointFiles) { + const xml = await viewpointFile.async("string"); + const visualizationInfo = + BCFTopics.xmlParser.parse(xml).VisualizationInfo; + if (!visualizationInfo) { + console.warn("Missing VisualizationInfo in Viewpoint"); + continue; + } + + const bcfViewpoint: Partial = {}; + + const { + Guid, + ClippingPlanes, + Components, + OrthogonalCamera, + PerspectiveCamera, + } = visualizationInfo; + + if (Guid) bcfViewpoint.guid = Guid; + + if (Components) { + const { Selection, Visibility } = Components; + if (Selection && Selection.Component) { + const components = Array.isArray(Selection.Component) + ? Selection.Component + : [Selection.Component]; + bcfViewpoint.selectionComponents = components + .map((component: any) => component.IfcGuid) + .filter((guid: any) => guid); + } + if (Visibility && "DefaultVisibility" in Visibility) { + bcfViewpoint.defaultVisibility = Visibility.DefaultVisibility; + } + if ( + Visibility && + Visibility.Exceptions && + "Component" in Visibility.Exceptions + ) { + const { Component } = Visibility.Exceptions; + const components = Array.isArray(Component) ? Component : [Component]; + bcfViewpoint.exceptionComponents = components + .map((component: any) => component.IfcGuid) + .filter((guid: any) => guid); + } + let ViewSetupHints; + if (version === "2.1") { + ViewSetupHints = Components.ViewSetupHints; + } + if (version === "3") { + ViewSetupHints = Components.Visibility?.ViewSetupHints; + } + if (ViewSetupHints) { + if ("OpeningsVisible" in ViewSetupHints) { + bcfViewpoint.openingsVisible = ViewSetupHints.OpeningsVisible; + } + if ("SpacesVisible" in ViewSetupHints) { + bcfViewpoint.spacesVisible = ViewSetupHints.SpacesVisible; + } + if ("SpaceBoundariesVisible" in ViewSetupHints) { + bcfViewpoint.spaceBoundariesVisible = + ViewSetupHints.SpaceBoundariesVisible; + } + } + } + + if (OrthogonalCamera || PerspectiveCamera) { + const camera = + visualizationInfo.PerspectiveCamera ?? + visualizationInfo.OrthogonalCamera; + const { CameraViewPoint, CameraDirection } = camera; + + const position = new THREE.Vector3( + Number(CameraViewPoint.X), + Number(CameraViewPoint.Z), + Number(-CameraViewPoint.Y), + ); + + const direction = new THREE.Vector3( + Number(CameraDirection.X), + Number(CameraDirection.Z), + Number(-CameraDirection.Y), + ); + + const viewpointCamera: ViewpointCamera = { + position: { x: position.x, y: position.y, z: position.z }, + direction: { x: direction.x, y: direction.y, z: direction.z }, + aspectRatio: "AspectRatio" in camera ? camera.AspectRatio : 1, // Temporal simplification + }; + + if ("ViewToWorldScale" in camera) { + bcfViewpoint.camera = { + ...viewpointCamera, + viewToWorldScale: camera.ViewToWorldScale, + }; + } + + if ("FieldOfView" in camera) { + bcfViewpoint.camera = { + ...viewpointCamera, + fov: camera.FieldOfView, + }; + } + } + + const viewpoint = new Viewpoint(this.components, world, { + data: bcfViewpoint, + setCamera: false, + }); + + if (Components) { + const { Coloring } = Components; + if (Coloring && Coloring.Color) { + const colors = Array.isArray(Coloring.Color) + ? Coloring.Color + : [Coloring.Color]; + for (const colorData of colors) { + const { Color, Component } = colorData; + const components = Array.isArray(Component) + ? Component + : [Component]; + const guids = components.map((component) => component.IfcGuid); + viewpoint.componentColors.set(Color, guids); + } + } + } + + createdViewpoints.push(viewpoint); + + if (ClippingPlanes) { + const clipper = this.components.get(Clipper); + const planes = Array.isArray(ClippingPlanes.ClippingPlane) + ? ClippingPlanes.ClippingPlane + : [ClippingPlanes.ClippingPlane]; + for (const plane of planes) { + const { Location, Direction } = plane; + if (!(Location && Direction)) continue; + const location = new THREE.Vector3( + Location.X, + Location.Z, + -Location.Y, + ); + const direction = new THREE.Vector3( + Direction.X, + -Direction.Z, + Direction.Y, + ); + const clippingPlane = clipper.createFromNormalAndCoplanarPoint( + world, + direction, + location, + ); + clippingPlane.visible = false; + clippingPlane.enabled = false; + viewpoint.clippingPlanes.add(clippingPlane); + } + } + } + + // Process markup files + const topicRelations: { [guid: string]: Set } = {}; + const topics: Topic[] = []; + const markupFiles = files.filter((file) => file.name.endsWith(".bcf")); + for (const markupFile of markupFiles) { + const xml = await markupFile.async("string"); + const markup = BCFTopics.xmlParser.parse(xml).Markup; + const markupTopic = markup.Topic; + const { Guid, Type, Status, Title, CreationDate, CreationAuthor } = + markupTopic; + + // Required Data + if (ignoreIncompleteTopicsOnImport) { + if ( + !(Guid && Type && Status && Title && CreationDate && CreationAuthor) + ) + continue; + } + + const topic = new Topic(this.components); + topic.guid = Guid ?? topic.guid; + const relatedTopics = this.getMarkupRelatedTopics(markup, version); + topicRelations[topic.guid] = new Set(relatedTopics); + topic.type = Type ?? topic.type; + topic.status = Status ?? topic.status; + topic.title = Title ?? topic.title; + topic.creationDate = CreationDate + ? new Date(CreationDate) + : topic.creationDate; + topic.creationAuthor = CreationAuthor ?? topic.creationAuthor; + + // Optional Data + topic.serverAssignedId = markupTopic.ServerAssignedId; + topic.priority = markupTopic.Priority; + topic.index = markupTopic.Index; + topic.modifiedDate = markupTopic.ModifiedDate + ? new Date(markupTopic.ModifiedDate) + : undefined; + topic.modifiedAuthor = markupTopic.ModifiedAuthor; + topic.dueDate = markupTopic.DueDate + ? new Date(markupTopic.DueDate) + : undefined; + topic.assignedTo = markupTopic.AssignedTo; + topic.description = markupTopic.Description; + topic.stage = markupTopic.Stage; + const labels = this.getMarkupLabels(markup, version); + for (const label of labels) topic.labels.add(label); + + // Comments + const comments = this.getMarkupComments(markup, version); + for (const comment of comments) topic.comments.set(comment.guid, comment); + + // Viewpoints + const markupViewpoints = this.getMarkupViewpoints(markup, version); + for (const markupViewpoint of markupViewpoints) { + if (!(markupViewpoint && markupViewpoint.Guid)) continue; + const viewpoint = viewpoints.list.get(markupViewpoint.Guid); + if (viewpoint) topic.viewpoints.add(viewpoint.guid); + } + + this.list.set(topic.guid, topic); + topics.push(topic); + } + + for (const topicID in topicRelations) { + const topic = this.list.get(topicID); + if (!topic) continue; + const relations = topicRelations[topicID]; + for (const guid of relations) { + topic.relatedTopics.add(guid); + } + } + + this.onBCFImported.trigger(topics); + return { viewpoints: createdViewpoints, topics }; + } +} + +export * from "./src"; diff --git a/packages/core/src/openbim/BCFTopics/src/Comment.ts b/packages/core/src/openbim/BCFTopics/src/Comment.ts new file mode 100644 index 000000000..5b7631f9b --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/src/Comment.ts @@ -0,0 +1,86 @@ +import { BCFTopics, Topic } from ".."; +import { Viewpoint } from "../../../core/Viewpoints"; +import { Components } from "../../../core/Components"; +import { UUID } from "../../../utils"; + +/** + * Represents a comment in a BCF Topic. + */ +export class Comment { + date = new Date(); + author: string; + guid = UUID.create(); + viewpoint?: Viewpoint; + modifiedAuthor?: string; + modifiedDate?: Date; + topic?: Topic; + + private _components: Components; + private _comment: string = ""; + + /** + * Sets the comment text and updates the modified date and author. + * The author will be the one defined in BCFTopics.config.author + * @param value - The new comment text. + */ + set comment(value: string) { + const manager = this._components.get(BCFTopics); + this._comment = value; + this.modifiedDate = new Date(); + this.modifiedAuthor = manager.config.author; + this.topic?.comments.set(this.guid, this); + } + + /** + * Gets the comment text. + * @returns The comment text. + */ + get comment() { + return this._comment; + } + + /** + * Constructs a new BCF Topic Comment instance. + * @param components - The Components instance. + * @param text - The initial comment text. + */ + constructor(components: Components, text: string) { + this._components = components; + this._comment = text; // Set the comment to the private property to prevent setting a modifiedDate and author + const manager = this._components.get(BCFTopics); + this.author = manager.config.author; + } + + /** + * Serializes the Comment instance into a BCF compliant XML string. + * + * @returns A string representing the Comment in BCFv2 XML format. + */ + serialize() { + let viewpointTag: string | null = null; + if (this.viewpoint) { + viewpointTag = ``; + } + + let modifiedDateTag: string | null = null; + if (this.modifiedDate) { + modifiedDateTag = `${this.modifiedDate.toISOString()}`; + } + + let modifiedAuthorTag: string | null = null; + if (this.modifiedAuthor) { + modifiedAuthorTag = `${this.modifiedAuthor}`; + } + + return ` + + ${this.date.toISOString()} + ${this.author} + ${this.comment} + ${viewpointTag ?? ""} + ${modifiedAuthorTag ?? ""} + ${modifiedDateTag ?? ""} + + `; + } +} diff --git a/packages/core/src/openbim/BCFTopics/src/Topic.ts b/packages/core/src/openbim/BCFTopics/src/Topic.ts new file mode 100644 index 000000000..13058269c --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/src/Topic.ts @@ -0,0 +1,412 @@ +import { UUID } from "../../../utils"; +import { Components } from "../../../core/Components"; +import { Viewpoint, Viewpoints } from "../../../core/Viewpoints"; +import { Comment } from "./Comment"; +import { BCFTopics } from ".."; +import { BCFTopic } from "./types"; +import { DataMap, DataSet } from "../../../core/Types"; + +export class Topic implements BCFTopic { + /** + * Default values for a BCF Topic, excluding `guid`, `creationDate`, and `creationAuthor`. + */ + static default: Omit = { + title: "BCF Topic", + type: "Issue", + status: "Active", + labels: new Set(), + }; + + /** + * A unique identifier for the topic. + * + * @remarks + * The `guid` is automatically generated upon topic creation and by no means it should change. + */ + guid = UUID.create(); + title = Topic.default.title; + creationDate = new Date(); + creationAuthor = ""; + // Store viewpoint guids instead of the actual Viewpoint to prevent a possible memory leak + readonly viewpoints = new DataSet(); + // Store topic guids instead of the actual Topic to prevent a possible memory leak + readonly relatedTopics = new DataSet(); + // There is no problem to store the comment it-self as it is not referenced anywhere else + readonly comments = new DataMap(); + customData: Record = {}; + description?: string; + serverAssignedId?: string; + dueDate?: Date; + modifiedAuthor?: string; + modifiedDate?: Date; + index?: number; + + private _type = Topic.default.type; + + set type(value: string) { + const manager = this._components.get(BCFTopics); + const { strict, types } = manager.config; + const valid = strict ? types.has(value) : true; + if (!valid) return; + this._type = value; + } + + get type() { + return this._type; + } + + private _status = Topic.default.status; + + set status(value: string) { + const manager = this._components.get(BCFTopics); + const { strict, statuses } = manager.config; + const valid = strict ? statuses.has(value) : true; + if (!valid) return; + this._status = value; + } + + get status() { + return this._status; + } + + private _priority? = Topic.default.priority; + + set priority(value: string | undefined) { + const manager = this._components.get(BCFTopics); + if (value) { + const { strict, priorities } = manager.config; + const valid = strict ? priorities.has(value) : true; + if (!valid) return; + this._priority = value; + } else { + this._priority = value; + } + } + + get priority() { + return this._priority; + } + + private _stage? = Topic.default.priority; + + set stage(value: string | undefined) { + const manager = this._components.get(BCFTopics); + if (value) { + const { strict, stages } = manager.config; + const valid = strict ? stages.has(value) : true; + if (!valid) return; + this._stage = value; + } else { + this._stage = value; + } + } + + get stage() { + return this._stage; + } + + private _assignedTo? = Topic.default.assignedTo; + + set assignedTo(value: string | undefined) { + const manager = this._components.get(BCFTopics); + if (value) { + const { strict, users } = manager.config; + const valid = strict ? users.has(value) : true; + if (!valid) return; + this._assignedTo = value; + } else { + this._assignedTo = value; + } + } + + get assignedTo() { + return this._assignedTo; + } + + private _labels = Topic.default.labels; + + set labels(value: Set) { + const manager = this._components.get(BCFTopics); + const { strict, labels } = manager.config; + if (strict) { + const _value = new Set(); + for (const label of value) { + const valid = strict ? labels.has(label) : true; + if (!valid) continue; + _value.add(label); + } + this._labels = _value; + } else { + this._labels = value; + } + } + + get labels() { + return this._labels; + } + + private _components: Components; + + private get _managerVersion() { + const manager = this._components.get(BCFTopics); + return manager.config.version; + } + + /** + * Initializes a new instance of the `Topic` class representing a BCF (BIM Collaboration Format) topic. + * It provides methods and properties to manage and serialize BCF topics. + * + * @remarks + * The default creationUser is the one set in BCFTopics.config.author + * It should not be created manually. Better use BCFTopics.create(). + * + * @param components - The `Components` instance that provides access to other components and services. + */ + constructor(components: Components) { + this._components = components; + const manager = components.get(BCFTopics); + this.creationAuthor = manager.config.author; + // Prevent the topic to reference it-self + this.relatedTopics.guard = (guid) => guid !== this.guid; + } + + /** + * Sets properties of the BCF Topic based on the provided data. + * + * @remarks + * This method iterates over the provided `data` object and updates the corresponding properties of the BCF Topic. + * It skips the `guid` property as it should not be modified. + * + * @param data - An object containing the properties to be updated. + * @returns The topic + * + * @example + * ```typescript + * const topic = new Topic(components); + * topic.set({ + * title: "New BCF Topic Title", + * description: "This is a new description.", + * status: "Resolved", + * }); + * ``` + */ + set(data: Partial) { + const _data = data as any; + const _this = this as any; + for (const key in data) { + if (key === "guid") continue; + const value = _data[key]; + if (key in this) _this[key] = value; + } + const manager = this._components.get(BCFTopics); + manager.list.set(this.guid, this); + return this; + } + + /** + * Creates a new comment associated with the current topic. + * + * @param text - The text content of the comment. + * @param viewpoint - (Optional) The viewpoint associated with the comment. + * + * @returns The newly created comment. + * + * @example + * ```typescript + * const viewpoint = viewpoints.create(world); // Created with an instance of Viewpoints + * const topic = topics.create(); // Created with an instance of BCFTopics + * topic.viewpoints.add(viewpoint); + * const comment = topic.createComment("This is a new comment", viewpoint); + * ``` + */ + createComment(text: string, viewpoint?: Viewpoint) { + const comment = new Comment(this._components, text); + comment.viewpoint = viewpoint; + comment.topic = this; + this.comments.set(comment.guid, comment); + return comment; + } + + private createLabelTags(version = this._managerVersion) { + let tag = "Labels"; + if (version === "2.1") tag = "Labels"; + if (version === "3") tag = "Label"; + + let tags = [...this.labels] + .map((label) => `<${tag}>${label}`) + .join("\n"); + + for (const key in this.customData) { + const value = this.customData[key]; + if (typeof value !== "string") continue; + tags += `\n<${tag}>${value}`; + } + + if (version === "2.1") return tags; + if (version === "3") { + if (tags.length !== 0) return `\n${tags}\n`; + return ""; + } + + return tags; + } + + private createCommentTags(version = this._managerVersion) { + const tags = [...this.comments.values()] + .map((comment) => comment.serialize()) + .join("\n"); + + if (version === "2.1") return tags; + if (version === "3") { + if (tags.length !== 0) return `\n${tags}\n`; + return ""; + } + + return tags; + } + + private createViewpointTags(version = this._managerVersion) { + let tag = "Viewpoints"; + if (version === "2.1") tag = "Viewpoints"; + if (version === "3") tag = "ViewPoint"; + + // Make sure to only associate existing viewpoints + const manager = this._components.get(Viewpoints); + const viewpoints = [...this.viewpoints] + .map((viewpointID) => manager.list.get(viewpointID)) + .filter((viewpoint) => viewpoint) as Viewpoint[]; + + const tags = viewpoints + .map((viewpoint) => { + return `<${tag} Guid="${viewpoint.guid}"> + ${viewpoint.guid}.bcfv + ${viewpoint.guid}.jpeg + + `; + }) + .join("\n"); + + if (version === "2.1") return tags; + if (version === "3") { + if (tags.length !== 0) return `\n${tags}\n`; + return ""; + } + + return tags; + } + + private createRelatedTopicTags(version = this._managerVersion) { + const tags = [...this.relatedTopics] + .map( + (guid) => ` + `, + ) + .join("\n"); + + if (version === "2.1") return tags; + if (version === "3") { + if (tags.length !== 0) + return `\n${tags}\n`; + return ""; + } + + return tags; + } + + /** + * Serializes the BCF Topic instance into an XML string representation based on the official schema. + * + * @remarks + * This method constructs an XML string based on the properties of the BCF Topic instance. + * It includes the topic's guid, type, status, creation date, creation author, priority, index, + * modified date, modified author, due date, assigned to, description, stage, labels, related topics, + * comments, and viewpoints. + * + * @returns A string representing the XML serialization of the BCF Topic. + * + * @example + * ```typescript + * const topic = bcfTopics.create(); // Created with an instance of BCFTopics + * const xml = topic.serialize(); + * console.log(xml); + * ``` + */ + serialize() { + const version = this._managerVersion; + + let serverAssignedIdAttribute: string | null = null; + if (this.serverAssignedId) { + serverAssignedIdAttribute = `ServerAssignedId="${this.serverAssignedId}"`; + } + + let priorityTag: string | null = null; + if (this.priority) { + priorityTag = `${this.priority}`; + } + + let indexTag: string | null = null; + if (this.index && version === "2.1") { + indexTag = `${this.index}`; + } + + let modifiedDateTag: string | null = null; + if (this.modifiedDate) { + modifiedDateTag = `${this.modifiedDate.toISOString()}`; + } + + let modifiedAuthorTag: string | null = null; + if (this.modifiedAuthor) { + modifiedAuthorTag = `${this.modifiedAuthor}`; + } + + let dueDateTag: string | null = null; + if (this.dueDate) { + dueDateTag = `${this.dueDate.toISOString()}`; + } + + let assignedToTag: string | null = null; + if (this.assignedTo) { + assignedToTag = `${this.assignedTo}`; + } + + let descriptionTag: string | null = null; + if (this.description) { + descriptionTag = `${this.description}`; + } + + let stageTag: string | null = null; + if (this.stage) { + stageTag = `${this.stage}`; + } + + const commentTags = this.createCommentTags(version); + const viewpointTags = this.createViewpointTags(version); + const labelTags = this.createLabelTags(version); + const relatedTopicTags = this.createRelatedTopicTags(version); + + return ` + + + + ${this.title} + ${this.creationDate.toISOString()} + ${this.creationAuthor} + ${priorityTag ?? ""} + ${indexTag ?? ""} + ${modifiedDateTag ?? ""} + ${modifiedAuthorTag ?? ""} + ${dueDateTag ?? ""} + ${assignedToTag ?? ""} + ${descriptionTag ?? ""} + ${stageTag ?? ""} + ${labelTags} + ${relatedTopicTags} + ${version === "3" ? commentTags : ""} + ${version === "3" ? viewpointTags : ""} + + ${version === "2.1" ? commentTags : ""} + ${version === "2.1" ? viewpointTags : ""} + + `; + } +} diff --git a/packages/core/src/openbim/BCFTopics/src/importers/extensions.ts b/packages/core/src/openbim/BCFTopics/src/importers/extensions.ts new file mode 100644 index 000000000..8aedc606f --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/src/importers/extensions.ts @@ -0,0 +1,41 @@ +import { BCFTopics } from "../.."; + +export const extensionsImporter = ( + manager: BCFTopics, + extensionsXML: string, +) => { + if (extensionsXML.trim() === "") return; + const extensions = BCFTopics.xmlParser.parse(extensionsXML).Extensions; + if (!extensions) return; + const { Priorities, TopicStatuses, TopicTypes, Users } = extensions; + if (Priorities && Priorities.Priority) { + const priorities = Array.isArray(Priorities.Priority) + ? Priorities.Priority + : [Priorities.Priority]; + for (const priority of priorities) { + manager.config.priorities.add(priority); + } + } + if (TopicStatuses && TopicStatuses.TopicStatus) { + const statuses = Array.isArray(TopicStatuses.TopicStatus) + ? TopicStatuses.TopicStatus + : [TopicStatuses.TopicStatus]; + for (const status of statuses) { + manager.config.statuses.add(status); + } + } + if (TopicTypes && TopicTypes.TopicType) { + const types = Array.isArray(TopicTypes.TopicType) + ? TopicTypes.TopicType + : [TopicTypes.TopicType]; + for (const type of types) { + manager.config.types.add(type); + } + } + if (Users && Users.User) { + const users = Array.isArray(Users.User) ? Users.User : [Users.User]; + for (const user of users) { + manager.config.users.add(user); + } + } +}; diff --git a/packages/core/src/openbim/BCFTopics/src/importers/index.ts b/packages/core/src/openbim/BCFTopics/src/importers/index.ts new file mode 100644 index 000000000..e121e50b0 --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/src/importers/index.ts @@ -0,0 +1 @@ +export * from "./extensions"; diff --git a/packages/core/src/openbim/BCFTopics/src/index.ts b/packages/core/src/openbim/BCFTopics/src/index.ts new file mode 100644 index 000000000..973b81240 --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/src/index.ts @@ -0,0 +1,4 @@ +export * from "./Topic"; +export * from "./types"; +export * from "./Comment"; +export * from "./importers"; diff --git a/packages/core/src/openbim/BCFTopics/src/types.ts b/packages/core/src/openbim/BCFTopics/src/types.ts new file mode 100644 index 000000000..33f930cb9 --- /dev/null +++ b/packages/core/src/openbim/BCFTopics/src/types.ts @@ -0,0 +1,106 @@ +export type BCFVersion = "2.1" | "3"; + +export interface BCFTopic { + guid: string; + serverAssignedId?: string; + type: string; + status: string; + title: string; + priority?: string; + index?: number; + labels: Set; + creationDate: Date; + creationAuthor: string; + modifiedDate?: Date; + modifiedAuthor?: string; + dueDate?: Date; + assignedTo?: string; + description?: string; + stage?: string; +} + +/** + * Configuration settings for managing BCF topics. + * This interface defines the properties and their meanings used to control the behavior of exporting and importing BCF topics. + */ +export interface BCFTopicsConfig { + /** + * The BCF version used during export. + */ + version: BCFVersion; + + /** + * The email of the user creating topics using this component. + */ + author: string; + + /** + * The set of allowed topic types. This is exported inside the + * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure). + */ + types: Set; + + /** + * The set of allowed topic statuses. This is exported inside the + * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure). + */ + statuses: Set; + + /** + * The set of allowed topic priorities. This is exported inside the + * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure). + */ + priorities: Set; + + /** + * The set of allowed topic labels. This is exported inside the + * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure). + */ + labels: Set; + + /** + * The set of allowed topic stages. This is exported inside the + * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure). + */ + stages: Set; + + /** + * The set of allowed topic users. This is exported inside the + * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure). + */ + users: Set; + + /** + * Whether or not to include the AuthoringSoftwareId in the viewpoint components during export. + */ + includeSelectionTag: boolean; + + /** + * Updates the types, statuses, users, etc., after importing an external BCF. + */ + updateExtensionsOnImport: boolean; + + /** + * Only allow to use the extensions (types, statuses, etc.) defined in the config when setting the corresponding data in a topic. + */ + strict: boolean; + + /** + * If true, export the extensions (types, status, etc.) based on topics data. This doesn't update the extensions in the config. + * If false, only export the extensions defined in each collection of possibilities set in the config. + * In all cases, all the values from each collection of extensions defined in the config are going to be exported. + */ + includeAllExtensionsOnExport: boolean; + + /** + * Version to be used when importing if no bcf.version file is present in the incoming data. + * When null, the importer will throw an error if the version is missing or is not supported. + */ + fallbackVersionOnImport: BCFVersion | null; + + /** + * If true, do not import a topic with missing information (guid, type, status, title, creationDate or creationAuthor). + * If false, use default values for missing data. + */ + ignoreIncompleteTopicsOnImport: boolean; +} diff --git a/packages/core/src/openbim/index.ts b/packages/core/src/openbim/index.ts new file mode 100644 index 000000000..2c7d2bbf5 --- /dev/null +++ b/packages/core/src/openbim/index.ts @@ -0,0 +1 @@ +export * from "./BCFTopics"; diff --git a/resources/topics.bcf b/resources/topics.bcf new file mode 100644 index 000000000..d2dd107c0 Binary files /dev/null and b/resources/topics.bcf differ diff --git a/yarn.lock b/yarn.lock index f813bb4c7..c9f45caa1 100644 --- a/yarn.lock +++ b/yarn.lock @@ -641,7 +641,21 @@ __metadata: languageName: unknown linkType: soft -"@thatopen/components@workspace:packages/core, @thatopen/components@~2.1.0": +"@thatopen/components@npm:~2.1.0": + version: 2.1.27 + resolution: "@thatopen/components@npm:2.1.27" + dependencies: + camera-controls: 2.7.3 + three-mesh-bvh: 0.7.0 + peerDependencies: + "@thatopen/fragments": ~2.1.0 + three: ^0.160.1 + web-ifc: 0.0.57 + checksum: 8bcd18411046ba253253ff3716d078ff549e1e6bc7754772c475da4bcc99d0c5d57f4e129d2f71b36c82a97c8ac911fadfe96cddc3613b7706076fd48339e410 + languageName: node + linkType: hard + +"@thatopen/components@workspace:packages/core": version: 0.0.0-use.local resolution: "@thatopen/components@workspace:packages/core" dependencies: @@ -649,6 +663,8 @@ __metadata: "@thatopen/ui": ~2.1.0 "@types/three": 0.160.0 camera-controls: 2.7.3 + fast-xml-parser: 4.4.1 + jszip: 3.10.1 stats.js: ^0.17.0 three: ^0.160.1 three-mesh-bvh: 0.7.0 @@ -1347,6 +1363,13 @@ __metadata: languageName: node linkType: hard +"core-util-is@npm:~1.0.0": + version: 1.0.3 + resolution: "core-util-is@npm:1.0.3" + checksum: 9de8597363a8e9b9952491ebe18167e3b36e7707569eed0ebf14f8bba773611376466ae34575bca8cfe3c767890c859c74056084738f09d4e4a6f902b2ad7d99 + languageName: node + linkType: hard + "cross-spawn@npm:^7.0.0, cross-spawn@npm:^7.0.2": version: 7.0.3 resolution: "cross-spawn@npm:7.0.3" @@ -1996,6 +2019,17 @@ __metadata: languageName: node linkType: hard +"fast-xml-parser@npm:4.4.1": + version: 4.4.1 + resolution: "fast-xml-parser@npm:4.4.1" + dependencies: + strnum: ^1.0.5 + bin: + fxparser: src/cli/cli.js + checksum: f440c01cd141b98789ae777503bcb6727393296094cc82924ae9f88a5b971baa4eec7e65306c7e07746534caa661fc83694ff437d9012dc84dee39dfbfaab947 + languageName: node + linkType: hard + "fastq@npm:^1.6.0": version: 1.17.1 resolution: "fastq@npm:1.17.1" @@ -2425,6 +2459,13 @@ __metadata: languageName: node linkType: hard +"immediate@npm:~3.0.5": + version: 3.0.6 + resolution: "immediate@npm:3.0.6" + checksum: f9b3486477555997657f70318cc8d3416159f208bec4cca3ff3442fd266bc23f50f0c9bd8547e1371a6b5e82b821ec9a7044a4f7b944798b25aa3cc6d5e63e62 + languageName: node + linkType: hard + "import-fresh@npm:^3.2.1": version: 3.3.0 resolution: "import-fresh@npm:3.3.0" @@ -2466,7 +2507,7 @@ __metadata: languageName: node linkType: hard -"inherits@npm:2": +"inherits@npm:2, inherits@npm:~2.0.3": version: 2.0.4 resolution: "inherits@npm:2.0.4" checksum: 4a48a733847879d6cf6691860a6b1e3f0f4754176e4d71494c41f3475553768b10f84b5ce1d40fbd0e34e6bfbb864ee35858ad4dd2cf31e02fc4a154b724d7f1 @@ -2679,6 +2720,13 @@ __metadata: languageName: node linkType: hard +"isarray@npm:~1.0.0": + version: 1.0.0 + resolution: "isarray@npm:1.0.0" + checksum: f032df8e02dce8ec565cf2eb605ea939bdccea528dbcf565cdf92bfa2da9110461159d86a537388ef1acef8815a330642d7885b29010e8f7eac967c9993b65ab + languageName: node + linkType: hard + "isexe@npm:^2.0.0": version: 2.0.0 resolution: "isexe@npm:2.0.0" @@ -2788,6 +2836,18 @@ __metadata: languageName: node linkType: hard +"jszip@npm:3.10.1": + version: 3.10.1 + resolution: "jszip@npm:3.10.1" + dependencies: + lie: ~3.3.0 + pako: ~1.0.2 + readable-stream: ~2.3.6 + setimmediate: ^1.0.5 + checksum: abc77bfbe33e691d4d1ac9c74c8851b5761fba6a6986630864f98d876f3fcc2d36817dfc183779f32c00157b5d53a016796677298272a714ae096dfe6b1c8b60 + languageName: node + linkType: hard + "keyv@npm:^4.5.3": version: 4.5.4 resolution: "keyv@npm:4.5.4" @@ -2814,6 +2874,15 @@ __metadata: languageName: node linkType: hard +"lie@npm:~3.3.0": + version: 3.3.0 + resolution: "lie@npm:3.3.0" + dependencies: + immediate: ~3.0.5 + checksum: 33102302cf19766f97919a6a98d481e01393288b17a6aa1f030a3542031df42736edde8dab29ffdbf90bebeffc48c761eb1d064dc77592ca3ba3556f9fe6d2a8 + languageName: node + linkType: hard + "lit-element@npm:^4.0.4": version: 4.1.0 resolution: "lit-element@npm:4.1.0" @@ -3298,6 +3367,13 @@ __metadata: languageName: node linkType: hard +"pako@npm:~1.0.2": + version: 1.0.11 + resolution: "pako@npm:1.0.11" + checksum: 1be2bfa1f807608c7538afa15d6f25baa523c30ec870a3228a89579e474a4d992f4293859524e46d5d87fd30fa17c5edf34dbef0671251d9749820b488660b16 + languageName: node + linkType: hard + "parent-module@npm:^1.0.0": version: 1.0.1 resolution: "parent-module@npm:1.0.1" @@ -3442,6 +3518,13 @@ __metadata: languageName: node linkType: hard +"process-nextick-args@npm:~2.0.0": + version: 2.0.1 + resolution: "process-nextick-args@npm:2.0.1" + checksum: 1d38588e520dab7cea67cbbe2efdd86a10cc7a074c09657635e34f035277b59fbb57d09d8638346bf7090f8e8ebc070c96fa5fd183b777fff4f5edff5e9466cf + languageName: node + linkType: hard + "promise-retry@npm:^2.0.1": version: 2.0.1 resolution: "promise-retry@npm:2.0.1" @@ -3466,6 +3549,21 @@ __metadata: languageName: node linkType: hard +"readable-stream@npm:~2.3.6": + version: 2.3.8 + resolution: "readable-stream@npm:2.3.8" + dependencies: + core-util-is: ~1.0.0 + inherits: ~2.0.3 + isarray: ~1.0.0 + process-nextick-args: ~2.0.0 + safe-buffer: ~5.1.1 + string_decoder: ~1.1.1 + util-deprecate: ~1.0.1 + checksum: 65645467038704f0c8aaf026a72fbb588a9e2ef7a75cd57a01702ee9db1c4a1e4b03aaad36861a6a0926546a74d174149c8c207527963e0c2d3eee2f37678a42 + languageName: node + linkType: hard + "regexp.prototype.flags@npm:^1.5.2": version: 1.5.2 resolution: "regexp.prototype.flags@npm:1.5.2" @@ -3660,6 +3758,13 @@ __metadata: languageName: node linkType: hard +"safe-buffer@npm:~5.1.0, safe-buffer@npm:~5.1.1": + version: 5.1.2 + resolution: "safe-buffer@npm:5.1.2" + checksum: f2f1f7943ca44a594893a852894055cf619c1fbcb611237fc39e461ae751187e7baf4dc391a72125e0ac4fb2d8c5c0b3c71529622e6a58f46b960211e704903c + languageName: node + linkType: hard + "safe-regex-test@npm:^1.0.3": version: 1.0.3 resolution: "safe-regex-test@npm:1.0.3" @@ -3733,6 +3838,13 @@ __metadata: languageName: node linkType: hard +"setimmediate@npm:^1.0.5": + version: 1.0.5 + resolution: "setimmediate@npm:1.0.5" + checksum: c9a6f2c5b51a2dabdc0247db9c46460152ffc62ee139f3157440bd48e7c59425093f42719ac1d7931f054f153e2d26cf37dfeb8da17a794a58198a2705e527fd + languageName: node + linkType: hard + "shebang-command@npm:^2.0.0": version: 2.0.0 resolution: "shebang-command@npm:2.0.0" @@ -3910,6 +4022,15 @@ __metadata: languageName: node linkType: hard +"string_decoder@npm:~1.1.1": + version: 1.1.1 + resolution: "string_decoder@npm:1.1.1" + dependencies: + safe-buffer: ~5.1.0 + checksum: 9ab7e56f9d60a28f2be697419917c50cac19f3e8e6c28ef26ed5f4852289fe0de5d6997d29becf59028556f2c62983790c1d9ba1e2a3cc401768ca12d5183a5b + languageName: node + linkType: hard + "strip-ansi-cjs@npm:strip-ansi@^6.0.1, strip-ansi@npm:^6.0.0, strip-ansi@npm:^6.0.1": version: 6.0.1 resolution: "strip-ansi@npm:6.0.1" @@ -3942,6 +4063,13 @@ __metadata: languageName: node linkType: hard +"strnum@npm:^1.0.5": + version: 1.0.5 + resolution: "strnum@npm:1.0.5" + checksum: 651b2031db5da1bf4a77fdd2f116a8ac8055157c5420f5569f64879133825915ad461513e7202a16d7fec63c54fd822410d0962f8ca12385c4334891b9ae6dd2 + languageName: node + linkType: hard + "supports-color@npm:^7.1.0": version: 7.2.0 resolution: "supports-color@npm:7.2.0" @@ -4210,6 +4338,13 @@ __metadata: languageName: node linkType: hard +"util-deprecate@npm:~1.0.1": + version: 1.0.2 + resolution: "util-deprecate@npm:1.0.2" + checksum: 474acf1146cb2701fe3b074892217553dfcf9a031280919ba1b8d651a068c9b15d863b7303cb15bd00a862b498e6cf4ad7b4a08fb134edd5a6f7641681cb54a2 + languageName: node + linkType: hard + "validator@npm:^13.7.0": version: 13.12.0 resolution: "validator@npm:13.12.0"