@archilogic/floor-plan-sdk 5.1.12 → 5.1.14

package/dist/fpe.d.ts

@@ -1,3 +1,5 @@
+import { default as default_2 } from 'rbush';
+
 /**
  * This interface was referenced by `AuthJson`'s JSON-Schema
  * via the `definition` "actionScope".
@@ -1013,6 +1015,15 @@ declare interface HtmlMarkerState extends HtmlMarkerArgs {
     floorPlan: FloorPlanEngine;
 }
 
+declare type IndexedNodeReference = {
+    id: string;
+    type: LayoutBoundingBoxNode['type'];
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+};
+
 declare type IndexRange = {
     type: 'index:range';
     start: number;
@@ -1183,10 +1194,9 @@ declare class LayoutAsset extends LayoutTransformElementBase {
     get isComponentInstanceChild(): boolean;
     setParameters(parameters: RecursivePartial<LayoutAssetParameters>): void;
     setProduct(product: SpaceGraphProduct): void;
-    getBoundingBox(localTransform?: boolean): {
+    calculateBoundingBox(): {
         min: Vector3;
         max: Vector3;
-        transform: Transform3d;
     };
 }
 
@@ -1246,10 +1256,9 @@ declare class LayoutBoundaryElementBase extends LayoutElementBase {
     parameters: LayoutBoundaryElementParameters;
     boundaries: LayoutBoundary[];
     constructor(id: string, type: LayoutBoundaryElementType, boundaries: LayoutBoundary[]);
-    getBoundingBox(): {
+    calculateBoundingBox(): {
         min: Vector3;
         max: Vector3;
-        transform: Transform3d;
     };
 }
 
@@ -1336,6 +1345,32 @@ declare type LayoutBoundaryWallType = typeof LayoutBoundaryWallTypeValue;
 
 declare const LayoutBoundaryWallTypeValue = "element:boundaryWall";
 
+declare class LayoutBoundingBoxNode extends LayoutNodeBase {
+    protected axisAlignedBoundingBox: BoundingBox3d | null;
+    protected objectAlignedBoundingBox: BoundingBox3d | null;
+    protected boundingBoxContour: Vector2_2[] | null;
+    protected transform: Transform3d | null;
+    protected worldTransform: Transform3d | null;
+    calculateTransform(): Transform3d;
+    getTransform(): Transform3d;
+    calculateWorldTransform(): Transform3d;
+    getWorldTransform(): Transform3d;
+    resetTransform(resetIndex?: boolean): void;
+    resetBoundingBox(resetIndex?: boolean): void;
+    resetSpatialIndexing(): void;
+    calculateBoundingBox(): BoundingBox3d;
+    /**
+     * returns the node's object aligned bounding box with transform
+     */
+    getBoundingBox(localTransform?: boolean): TransformBoundingBox3d;
+    /**
+     * returns the node's axis aligned bounding box with transform applied
+     */
+    getAxisAlignedBoundingBox(): BoundingBox3d;
+    calculateBoundingBoxContour(localTransform?: boolean): Vector2_2[];
+    getBoundingBoxContour(): Vector2_2[];
+}
+
 declare class LayoutCasework extends LayoutTransformElementBase {
     type: LayoutCaseworkType;
     parameters: LayoutCaseworkParameters;
@@ -1425,10 +1460,9 @@ declare class LayoutDoor extends LayoutTransformElementBase {
     parameters: LayoutDoorParameters;
     constructor(id: string);
     setParameters(parameters: RecursivePartial<LayoutDoorParameters>): void;
-    getBoundingBox(localTransform?: boolean): {
+    calculateBoundingBox(): {
         min: Vector3;
         max: Vector3;
-        transform: Transform3d;
     };
 }
 
@@ -1453,14 +1487,15 @@ declare const LayoutDoorTypeValue = "element:door";
 declare type LayoutEdgeElement = LayoutCurtainWall | LayoutSpaceDivider | LayoutWall;
 
 declare class LayoutEdgeElementBase extends LayoutElementBase {
+    #private;
     type: LayoutEdgeElementType;
     parameters: LayoutEdgeElementParameters;
     private edges;
     private vertices;
+    private boundingBoxTransform;
     edgesChanged: boolean;
     constructor(id: string, type: LayoutEdgeElementType, edges: SpatialGraphEdge[]);
     setEdges(edges: SpatialGraphEdge[]): void;
-    private verifyEdges;
     getEdges(): SpatialGraphEdge[];
     getVertices(): SpatialGraphVertex[];
     getStartVertex(): SpatialGraphVertex | undefined;
@@ -1469,6 +1504,9 @@ declare class LayoutEdgeElementBase extends LayoutElementBase {
     getAxisLength(): number;
     getEdgeAtLinearPosition(u: number): SpatialGraphEdge | undefined;
     getEdgesAtLinearSegment(u: number, v: number): SpatialGraphEdge[];
+    resetTransform(): void;
+    getBoundingBox(): TransformBoundingBox3d;
+    calculateBoundingBoxTransform(): Transform3d;
     /**
      * @deprecated Use getEdges() instead of edge
      */
@@ -1496,22 +1534,16 @@ declare type LayoutEdgeElementType = LayoutCurtainWallType | LayoutSpaceDividerT
 
 declare type LayoutElement = LayoutBoundaryElement | LayoutEdgeElement | LayoutOpeningElement | LayoutTransformElement;
 
-declare class LayoutElementBase extends LayoutNodeBase {
+declare class LayoutElementBase extends LayoutBoundingBoxNode {
     type: LayoutElementType;
     parameters: LayoutElementParameters;
     parent: LayoutElement | null;
     elements: LayoutElement[];
     geometries: GeometryOperationJson[];
     insertElement(element: LayoutElement): void;
-    getTransform(): Transform3d;
-    getWorldTransform(): Transform3d;
-    /**
-     * returns the element's object aligned bounding box with transform
-     */
-    getBoundingBox(localTransform?: boolean): TransformBoundingBox3d;
-    getAxisAlignedBoundingBox(localTransform?: boolean): BoundingBox3d;
-    getBoundingBoxContour(localTransform?: boolean): Vector2_2[];
     get isExternal(): boolean;
+    resetTransform(resetIndex?: boolean): void;
+    resetBoundingBox(resetIndex?: boolean): void;
     removeElement(element: LayoutElement): void;
     copyForClone(element: LayoutElement): void;
     setParameters(parameters: RecursivePartial<LayoutElementParameters>): void;
@@ -1825,7 +1857,8 @@ declare type LayoutSlabType = typeof LayoutSlabTypeValue;
 
 declare const LayoutSlabTypeValue = "element:slab";
 
-declare class LayoutSpace extends LayoutNodeBase {
+declare class LayoutSpace extends LayoutBoundingBoxNode {
+    #private;
     type: LayoutSpaceType;
     attributes: LayoutSpaceAttributes;
     boundaries: LayoutBoundary[];
@@ -1836,6 +1869,7 @@ declare class LayoutSpace extends LayoutNodeBase {
     setId(id: string): void;
     setAttributes(attributes: LayoutSpaceAttributesJson): void;
     get isExternal(): boolean;
+    calculateArea(): number;
     getArea(): number;
     getAdjacentSpaces(graph: Graph, { connectivity }?: {
         connectivity?: number;
@@ -1849,9 +1883,10 @@ declare class LayoutSpace extends LayoutNodeBase {
         boundary: LayoutBoundary | undefined;
         edgeIndex: number;
     };
-    getBoundingBox(): TransformBoundingBox3d;
+    calculateBoundingBox(): BoundingBox3d;
     getAxisAlignedBoundingBox(): BoundingBox3d;
-    getBoundingBoxContour(): Vector2_2[];
+    resetBoundingBox(resetIndex?: boolean): void;
+    resetSpatialIndexing(): void;
     attachSlab(slab: LayoutBoundarySlab): void;
     detachSlab(slab: LayoutBoundarySlab): void;
     toJSON(): LayoutSpaceJson;
@@ -1872,7 +1907,7 @@ declare class LayoutSpaceDivider extends LayoutEdgeElementBase {
     parameters: LayoutSpaceDividerParameters;
     constructor(id: string, edges: SpatialGraphEdge[]);
     setParameters(parameters: RecursivePartial<LayoutSpaceDividerParameters>): void;
-    getBoundingBox(): TransformBoundingBox3d;
+    calculateBoundingBox(): BoundingBox3d;
 }
 
 declare interface LayoutSpaceDividerJson extends LayoutEdgeElementBaseJson {
@@ -1969,10 +2004,9 @@ declare class LayoutStairs extends LayoutTransformElementBase {
     parameters: LayoutStairsParameters;
     constructor(id: string);
     setParameters(parameters: RecursivePartial<LayoutStairsParameters>, skipElementCreation?: boolean): void;
-    getBoundingBox(localTransform?: boolean): {
+    calculateBoundingBox(): {
         min: Vector3;
         max: Vector3;
-        transform: Transform3d;
     };
 }
 
@@ -2009,12 +2043,11 @@ declare class LayoutTransformElementBase extends LayoutElementBase {
     setRotation(rotation: number, rotationAxis?: Vector3): void;
     setTransform(position: Vector3, rotation: number, rotationAxis?: Vector3): void;
     getSpaces(): LayoutSpace[];
-    getTransform(): Transform3d;
-    getWorldTransform(): Transform3d;
-    getBoundingBox(localTransform?: boolean): {
+    calculateTransform(): Transform3d;
+    calculateWorldTransform(): Transform3d;
+    calculateBoundingBox(): {
         min: Vector3;
         max: Vector3;
-        transform: Transform3d;
     };
     setParameters(parameters: RecursivePartial<LayoutTransformElementParameters>): void;
 }
@@ -2069,7 +2102,7 @@ declare class LayoutWall extends LayoutEdgeElementBase {
     constructor(id: string, edges: SpatialGraphEdge[]);
     copyForClone(wall: LayoutWall): void;
     setParameters(parameters: RecursivePartial<LayoutWallParameters>): void;
-    getBoundingBox(): TransformBoundingBox3d;
+    calculateBoundingBox(): BoundingBox3d;
 }
 
 declare interface LayoutWallGeometryProfile {
@@ -2518,9 +2551,9 @@ declare class SpaceGraph {
     nodes: SpaceGraphNode[];
     nodesById: Record<string, SpaceGraphNode>;
     nodesByType: NodesByType<{
-        readonly 'spatialStructure:building': typeof SpaceGraphBuilding;
-        readonly 'spatialStructure:floor': typeof SpaceGraphFloor;
-        readonly 'spatialStructure:layout': typeof SpaceGraphLayout;
+        readonly 'spatialStructure:building': SpaceGraphBuilding;
+        readonly 'spatialStructure:floor': SpaceGraphFloor;
+        readonly 'spatialStructure:layout': SpaceGraphLayout;
         readonly 'relation:group': typeof GroupRelation;
         readonly 'product:static': typeof SpaceGraphProductStatic;
         readonly 'product:component': typeof SpaceGraphProductComponent;
@@ -2575,10 +2608,6 @@ declare class SpaceGraph {
     unregisterNode(node: SpaceGraphNode): void;
     insertSpatialStructure(spatialStructure: SpaceGraphSpatialStructure): void;
     removeSpatialStructure(): SpaceGraphSpatialStructure | undefined;
-    createSpatialStructure(type: SpaceGraphBuildingType, id: string): SpaceGraphBuilding;
-    createSpatialStructure(type: SpaceGraphFloorType, id: string): SpaceGraphFloor;
-    createSpatialStructure(type: LayoutType, id: string): SpaceGraphLayout;
-    createSpatialStructure(type: SpaceGraphSpatialStructureType, id: string): SpaceGraphSpatialStructure;
     insertProduct(product: SpaceGraphProduct): void;
     removeProduct(product: SpaceGraphProduct): void;
     createProduct(id: string, type: SpaceGraphProductType): SpaceGraphProduct;
@@ -2601,6 +2630,7 @@ declare class SpaceGraph {
     once<EventType extends keyof SpaceGraphEventMap>(event: EventType, handler: (...args: SpaceGraphEventMap[EventType]) => void, context?: any): void;
     off<EventType extends keyof SpaceGraphEventMap>(event: EventType, handler?: (...args: SpaceGraphEventMap[EventType]) => void): void;
     toJSON(): SpaceGraphJson;
+    static fromJSON(spaceGraphJson: SpaceGraphJson): SpaceGraph;
 }
 
 declare class SpaceGraphBasicMaterial extends SpaceGraphNodeBase {
@@ -2636,6 +2666,10 @@ declare class SpaceGraphBuilding extends SpaceGraphSpatialStructureBase {
     removeFloor(floor: SpaceGraphFloor): void;
     createFloor(id: string): SpaceGraphFloor;
     toJSON(): SpaceGraphBuildingJson;
+    static fromJSON(buildingJson: SpaceGraphBuildingJson, options: {
+        spaceGraph: SpaceGraph;
+        skipInsert?: boolean;
+    }): SpaceGraphBuilding;
 }
 
 declare interface SpaceGraphBuildingJson extends SpaceGraphSpatialStructureBaseJson {
@@ -2778,6 +2812,10 @@ declare class SpaceGraphFloor extends SpaceGraphSpatialStructureBase {
     removeLayout(layout: SpaceGraphLayout): void;
     createLayout(id: string): SpaceGraphLayout;
     toJSON(): SpaceGraphFloorJson;
+    static fromJSON(floorJson: SpaceGraphFloorJson, options?: {
+        spaceGraph: SpaceGraph;
+        skipInsert?: boolean;
+    }): SpaceGraphFloor;
 }
 
 declare interface SpaceGraphFloorJson extends SpaceGraphSpatialStructureBaseJson {
@@ -2846,6 +2884,7 @@ declare class SpaceGraphLayout extends SpaceGraphSpatialStructureBase {
         readonly 'view:2d': Layout2dView;
         readonly 'view:3d': Layout3dView;
     }>;
+    spatialIndex: SpatialIndex;
     debugIds: boolean;
     suggestedIds: Record<string, boolean>;
     constructor(id: string);
@@ -2882,6 +2921,10 @@ declare class SpaceGraphLayout extends SpaceGraphSpatialStructureBase {
     getElementId(element: LayoutElement, prefix?: string): string;
     getBoundingBox(): TransformBoundingBox3d;
     toJSON(): SpaceGraphLayoutJson;
+    static fromJSON(layoutJson: SpaceGraphLayoutJson, options?: {
+        spaceGraph?: SpaceGraph;
+        skipInsert?: boolean;
+    }): SpaceGraphLayout;
 }
 
 declare interface SpaceGraphLayoutJson extends SpaceGraphSpatialStructureBaseJson {
@@ -2973,6 +3016,7 @@ declare class SpaceGraphProductBase extends SpaceGraphNodeWithCustomAttributesBa
     constructor(id: string, type: SpaceGraphProductType);
     copyForClone(product: SpaceGraphProductStatic | SpaceGraphProductComponent): void;
     setAttributes(attributesJson: SpaceGraphProductAttributesJson): void;
+    getBoundingBox(): BoundingBox3d;
     toJSON(): SpaceGraphProductJson;
 }
 
@@ -3116,6 +3160,8 @@ declare class SpatialGraphEdge extends SpatialGraphNodeBase {
     getLength(): number;
     get isExternal(): boolean;
     setVertices(vertex1: SpatialGraphVertex, vertex2: SpatialGraphVertex): void;
+    resetSpatialIndexing(): void;
+    calculateBoundingBox(): BoundingBox3d;
     setVerticesByIds(vertexId1: string, vertexId2: string): void;
     canSplit(u: number, options?: EdgeCanSplitOptions): boolean;
     split(u: number, options?: EdgeSplitOptions, updateSpaceBoundaries?: boolean): EdgeSplitReturnValue;
@@ -3125,6 +3171,7 @@ declare class SpatialGraphEdge extends SpatialGraphNodeBase {
 }
 
 declare interface SpatialGraphEdgeJson extends SpatialGraphNodeBaseJson {
+    id: string;
     type: SpatialGraphEdgeType;
     vertices: [string, string];
 }
@@ -3135,7 +3182,7 @@ declare const SpatialGraphEdgeTypeValue = "spatialGraph:edge";
 
 declare type SpatialGraphNode_2 = SpatialGraphVertex | SpatialGraphEdge;
 
-declare class SpatialGraphNodeBase extends LayoutNodeBase {
+declare class SpatialGraphNodeBase extends LayoutBoundingBoxNode {
 }
 
 declare interface SpatialGraphNodeBaseJson extends LayoutNodeBaseJson {
@@ -3149,13 +3196,16 @@ declare class SpatialGraphVertex extends SpatialGraphNodeBase {
     edges: SpatialGraphEdge[];
     constructor(id: string, x: number, y: number);
     sortVertexEdges(): void;
+    calculateTransform(): Transform3d;
     addEdge(edge: SpatialGraphEdge): void;
     removeEdge(edge: SpatialGraphEdge): void;
     setPosition(x: number, y: number): void;
+    resetSpatialIndexing(): void;
     toJSON(): SpatialGraphVertexJson;
 }
 
 declare interface SpatialGraphVertexJson extends SpatialGraphNodeBaseJson {
+    id: string;
     type: SpatialGraphVertexType;
     position: Vector2_2;
 }
@@ -3164,6 +3214,43 @@ declare type SpatialGraphVertexType = typeof SpatialGraphVertexTypeValue;
 
 declare const SpatialGraphVertexTypeValue = "spatialGraph:vertex";
 
+/**
+ * A spatial index for efficiently querying nodes within a 2D bounding box.
+ *
+ * @example
+ * ```typescript
+ * const spatialIndex = new SpatialIndex(layout);
+ * spatialIndex.addNode(node);
+ * const foundNodes = spatialIndex.find({
+ *   min: [-10, -10],
+ *   max: [10, 10],
+ *   margin: 0.1,
+ *   types: ['element:wall', 'element:door']
+ * });
+ * ```
+ */
+declare class SpatialIndex extends default_2<IndexedNodeReference> {
+    nodeIds: Set<string>;
+    layout: SpaceGraphLayout;
+    constructor(layout: SpaceGraphLayout);
+    /**
+     * Find nodes by 2d bounding, margin and types selection
+     *
+     * `max` will fallback to `min` if not provided
+     */
+    find<T = LayoutBoundingBoxNode>({ min, max, margin, types }: SpatialIndexFind): T[];
+    addNode(node: LayoutBoundingBoxNode): void;
+    removeNode(node: LayoutBoundingBoxNode): void;
+    remove(node: IndexedNodeReference): this;
+}
+
+declare type SpatialIndexFind = {
+    min: Vector2_2;
+    max?: Vector2_2;
+    margin?: number;
+    types?: LayoutNodeType[];
+};
+
 declare class SphereGeometry extends ParametricGeometryBase {
     type: SphereGeometryType;
     radius: number;