@archilogic/floor-plan-sdk 5.0.2 → 5.1.1

package/dist/fpe.d.ts

@@ -77,7 +77,7 @@ export declare interface BezierCurve extends BaseShape {
     points: Polygon;
 }
 
-declare type BoundingBox2d = {
+export declare type BoundingBox2d = {
     min: Vector2;
     max: Vector2;
 };
@@ -127,7 +127,9 @@ declare interface CommonParameters$3 {
 }
 
 declare interface CommonParameters$4 {
+    /** thickness of the frame in x direction */
     frameThickness: number;
+    /** depth of the frame in z direction */
     frameDepth: number;
     doorType: DoorType;
     doorAngle: number;
@@ -147,7 +149,9 @@ declare interface CommonParameters$6 {
 }
 
 declare interface CommonParameters {
+    /** thickness of the frame in x direction */
     frameThickness: number;
+    /** depth of the frame in z direction */
     frameDepth: number;
     panelLength: number;
     panelCount: number;
@@ -198,6 +202,10 @@ declare interface CurveBase {
 
 declare type CurveType = ClosedCurveType | OpenCurveType;
 
+declare type CustomAttributeResourceType = 'building' | 'element' | 'floor' | 'layout' | 'product' | 'space';
+
+declare type CustomAttributeValueType = 'Text' | 'Number' | 'Boolean';
+
 declare interface CustomStairsParameters {
     stairsType: CustomStairsType;
     height: number;
@@ -332,6 +340,7 @@ declare class FloorPlanCore {
      * Change options after the floor plan engine instance has been created
      */
     set(args?: FpeConfig): void;
+    getBoundingBox(margin?: number): BoundingBox2d;
     /**
      * Get a list of spaces and assets for a specific plan position
      * @param {*} position - plan position
@@ -395,7 +404,6 @@ export declare class FloorPlanEngine extends FloorPlanCore {
     initDrawingEvents(): void;
     freeDrawingEvents(): void;
     generateUi(): void;
-    getBoundingBox(margin?: number): BoundingBox2d;
     /**
      * Get a bounding box containing the layout, with some padding
      * @param layoutBoundingBox - bounding box of the layout, in meters.
@@ -507,12 +515,8 @@ declare type FloorPlanTheme = {
             grayscale: boolean;
         };
         roomStamp?: {
-            /** @deprecated show the usage information in room stamps */
-            showUsage?: boolean;
-            /** @deprecated show the area information in room stamps */
-            showArea?: boolean;
             /** show the area information in room stamps */
-            roomStampDisplay?: ('usage' | 'area' | 'customId' | 'name' | 'id')[];
+            roomStampDisplay?: ('usage' | 'area' | 'customId' | 'name' | 'id' | ['customAttribute', string])[];
             /** text color for room stamps */
             text?: Rgb;
             /** whether the room stamp text should have an outline to assist with contrast issues */
@@ -866,6 +870,7 @@ export declare interface GraphicArgs {
 
 declare type GraphicUpdate = {
     position?: Vector2;
+    rotation?: number;
     style?: ShapeStyle;
     shapes?: Shape[];
 };
@@ -877,6 +882,7 @@ declare class GroupRelation extends SpaceGraphNodeBase {
     insertElements(elements: LayoutElement[]): void;
     removeElements(elements: LayoutElement[]): void;
     copyForClone(product: GroupRelation): void;
+    toJSON(): GroupRelationJson;
 }
 
 declare interface GroupRelationJson extends SpaceGraphNodeBaseJson {
@@ -1083,6 +1089,7 @@ declare class LayoutAnnotationBase extends LayoutNodeBase {
     copyForClone(annotation: LayoutAnnotation): void;
     setTransform(position: Vector3, rotation: number): void;
     setParameters(parameters: RecursivePartial<LayoutAnnotationParameters>): void;
+    toJSON(): LayoutAnnotationJson;
 }
 
 declare interface LayoutAnnotationBaseJson extends LayoutNodeBaseJson {
@@ -1160,6 +1167,7 @@ declare class LayoutBoundary {
     vertices: SpatialGraphVertex[];
     edges: SpatialGraphEdge[];
     geometryProfile: Vector2_2[];
+    toJSON(): LayoutBoundaryJson;
 }
 
 declare type LayoutBoundaryElement = LayoutBoundarySlab | LayoutBoundaryWall;
@@ -1399,6 +1407,7 @@ declare class LayoutEdgeElementBase extends LayoutElementBase {
     getAdjacentSpacesBySide(): [LayoutSpace[], LayoutSpace[]];
     getSpaces(): LayoutSpace[];
     getElementsAtLinearPosition(u: number): LayoutElement[];
+    get isExternal(): boolean;
 }
 
 declare interface LayoutEdgeElementBaseJson extends LayoutElementBaseJson {
@@ -1427,10 +1436,12 @@ declare class LayoutElementBase extends LayoutNodeBase {
     getTransform(): Transform3d;
     getWorldTransform(): Transform3d;
     getBoundingBox(localTransform?: boolean): TransformBoundingBox3d;
+    get isExternal(): boolean;
     removeElement(element: LayoutElement): void;
     copyForClone(element: LayoutElement): void;
     setParameters(parameters: RecursivePartial<LayoutElementParameters>): void;
     getSpaces(): LayoutSpace[];
+    toJSON(): LayoutElementJson;
 }
 
 declare interface LayoutElementBaseJson extends LayoutNodeBaseJson {
@@ -1560,13 +1571,13 @@ declare const LayoutKitchenTypeValue = "element:kitchen";
 
 declare type LayoutNode = SpatialGraphNode | LayoutSpace | LayoutElement | LayoutAnnotation | LayoutView;
 
-declare class LayoutNodeBase extends SpaceGraphNodeBase {
+declare class LayoutNodeBase extends SpaceGraphNodeWithCustomAttributesBase {
     type: LayoutNodeType;
     layout: SpaceGraphLayout;
     constructor(id: string, type: LayoutNodeType);
 }
 
-declare interface LayoutNodeBaseJson extends SpaceGraphNodeBaseJson {
+declare interface LayoutNodeBaseJson extends SpaceGraphNodeWithCustomAttributesBaseJson {
     type: LayoutNodeType;
 }
 
@@ -1586,6 +1597,7 @@ declare class LayoutOpening extends LayoutOpeningElementBase {
         transform: Transform3d;
     };
     getSpaces(): LayoutSpace[];
+    get isExternal(): boolean;
 }
 
 declare type LayoutOpeningElement = LayoutOpening;
@@ -1747,6 +1759,7 @@ declare class LayoutSpace extends LayoutNodeBase {
     copyForClone(space: LayoutSpace): void;
     setId(id: string): void;
     setAttributes(attributes: LayoutSpaceAttributesJson): void;
+    get isExternal(): boolean;
     getArea(): number;
     getAdjacentSpaces(graph: Graph, { connectivity }?: {
         connectivity?: number;
@@ -1763,6 +1776,7 @@ declare class LayoutSpace extends LayoutNodeBase {
     getBoundingBox(): TransformBoundingBox3d;
     attachSlab(slab: LayoutBoundarySlab): void;
     detachSlab(slab: LayoutBoundarySlab): void;
+    toJSON(): LayoutSpaceJson;
 }
 
 declare interface LayoutSpaceAttributes {
@@ -1843,6 +1857,7 @@ declare class LayoutSpatialGraph {
     createVertex(id: string, x: number, y: number): SpatialGraphVertex;
     createEdge(id: string, vertex1: SpatialGraphVertex, vertex2: SpatialGraphVertex, splitSpace?: boolean): SpatialGraphEdge;
     createEdgeByVertexIds(id: string, vertexId1: string, vertexId2: string, splitSpace?: boolean): SpatialGraphEdge;
+    toJSON(): LayoutSpatialGraphJson;
 }
 
 declare interface LayoutSpatialGraphJson {
@@ -1957,6 +1972,7 @@ declare class LayoutViewBase extends LayoutNodeBase {
     parameters: LayoutViewParameters;
     copyForClone(view: LayoutView): void;
     setParameters(parameters: RecursivePartial<LayoutViewParameters>): void;
+    toJSON(): LayoutViewJson;
 }
 
 declare interface LayoutViewBaseJson extends LayoutNodeBaseJson {
@@ -2220,7 +2236,7 @@ declare class PlanGraphic {
     gfxScale: number;
     private floorPlan;
     constructor({ shapes, position, alpha, scale, clearLayer, interactive, id, isHandler, scaleOnZoom, updatePositionOnDrag, baseLayer, container, floorPlan }: PlanGraphicArgs);
-    set({ position, style, shapes }?: GraphicUpdate): void;
+    set({ position, rotation, style, shapes }?: GraphicUpdate): void;
     private doUpdatePositionOnDrag;
     on(event: string, callback: any, context?: any): this;
     off(event: string, callback?: any): this;
@@ -2244,6 +2260,7 @@ declare class PlanLayer {
     private floorPlan;
     constructor(floorPlan: FloorPlanEngine, baseLayer?: BaseLayers, id?: string);
     addGraphic(args: GraphicArgs): PlanGraphic;
+    /* Excluded from this release type: findGraphic */
     deleteGraphic(graphic: PlanGraphic): void;
     /**
      * clear all shapes from the layer
@@ -2390,6 +2407,7 @@ declare interface ShapeStyle {
     fill?: string | number | number[] | false;
     fillOpacity?: number;
     dash?: boolean;
+    alignment?: 0 | 0.5 | 1;
 }
 
 declare class SpaceGraph {
@@ -2399,6 +2417,11 @@ declare class SpaceGraph {
     productsByType: NodesByType<{
         readonly 'product:static': typeof SpaceGraphProduct;
     }>;
+    customAttributes: SpaceGraphCustomAttribute[];
+    customAttributesById: Record<string, SpaceGraphCustomAttribute>;
+    customAttributesByType: NodesByType<{
+        readonly 'customAttribute:definition': typeof SpaceGraphCustomAttribute;
+    }>;
     geometries: SpaceGraphGeometryJson[];
     geometriesById: Record<string, SpaceGraphGeometryJson>;
     geometriesByType: NodesByType<{
@@ -2498,11 +2521,14 @@ declare class SpaceGraph {
     insertRelation(relation: SpaceGraphRelation): void;
     removeRelation(relation: SpaceGraphRelation): void;
     createRelation(type: SpaceGraphRelationType, id: string): SpaceGraphRelation;
+    insertCustomAttribute(customAttribute: SpaceGraphCustomAttribute): void;
+    removeCustomAttribute(customAttribute: SpaceGraphCustomAttribute): void;
     getId(): string;
     emit<EventType extends keyof SpaceGraphEventMap>(event: EventType, ...args: SpaceGraphEventMap[EventType]): void;
     on<EventType extends keyof SpaceGraphEventMap>(event: EventType, handler: (...args: SpaceGraphEventMap[EventType]) => void, context?: any): void;
     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;
 }
 
 declare class SpaceGraphBasicMaterial extends SpaceGraphNodeBase {
@@ -2513,6 +2539,7 @@ declare class SpaceGraphBasicMaterial extends SpaceGraphNodeBase {
     opacity: number;
     constructor(id: string);
     copyForClone(material: SpaceGraphBasicMaterial): void;
+    toJSON(): SpaceGraphMaterialResourceJson;
 }
 
 declare interface SpaceGraphBasicMaterialJson extends SpaceGraphMaterialBaseJson {
@@ -2536,6 +2563,7 @@ declare class SpaceGraphBuilding extends SpaceGraphSpatialStructureBase {
     insertFloor(floor: SpaceGraphFloor): void;
     removeFloor(floor: SpaceGraphFloor): void;
     createFloor(id: string): SpaceGraphFloor;
+    toJSON(): SpaceGraphBuildingJson;
 }
 
 declare interface SpaceGraphBuildingJson extends SpaceGraphSpatialStructureBaseJson {
@@ -2553,6 +2581,7 @@ declare class SpaceGraphColorMaterial extends SpaceGraphNodeBase {
     color: Rgb;
     opacity: number;
     constructor(id: string, color?: Rgb, opacity?: number);
+    toJSON(): SpaceGraphMaterialResourceJson;
 }
 
 declare interface SpaceGraphColorMaterialJson extends SpaceGraphMaterialBaseJson {
@@ -2564,11 +2593,53 @@ declare type SpaceGraphColorMaterialType = typeof SpaceGraphColorMaterialTypeVal
 
 declare const SpaceGraphColorMaterialTypeValue = "material:color";
 
+declare class SpaceGraphCustomAttribute extends SpaceGraphNodeBase {
+    type: SpaceGraphCustomAttributeType;
+    attributes: SpaceGraphCustomAttributeAttributes;
+    constructor(id: string, attributesJson?: SpaceGraphCustomAttributeAttributesJson);
+    setAttributes(attributesJson: SpaceGraphCustomAttributeAttributesJson): void;
+    copyForClone(customAttribute: SpaceGraphCustomAttribute): void;
+    toJSON(): SpaceGraphCustomAttributeJson;
+}
+
+declare type SpaceGraphCustomAttributeAttributes = {
+    resourceType: CustomAttributeResourceType;
+    valueType: CustomAttributeValueType;
+    updatedAt?: string;
+    description?: string;
+};
+
+declare type SpaceGraphCustomAttributeAttributesJson = {
+    resourceType: CustomAttributeResourceType;
+    valueType: CustomAttributeValueType;
+    updatedAt?: string;
+    /** @minLength 3 @maxLength 200 @type string */
+    description?: string;
+};
+
+declare interface SpaceGraphCustomAttributeJson extends SpaceGraphNodeBaseJson {
+    /** @type string @minLength 3 @maxLength 50 @pattern ^(?![_-])[A-Za-z0-9_-]*$ */
+    id: string;
+    /** @minLength 3 @maxLength 30 @type string */
+    name: string;
+    type: SpaceGraphCustomAttributeType;
+    attributes: SpaceGraphCustomAttributeAttributesJson;
+}
+
+declare type SpaceGraphCustomAttributeType = typeof SpaceGraphCustomAttributeTypeValue;
+
+declare const SpaceGraphCustomAttributeTypeValue = "customAttribute:definition";
+
+declare type SpaceGraphCustomAttributeValue = Record<string, string>;
+
+declare type SpaceGraphCustomAttributeValueJson = Record<string, string | null>;
+
 declare class SpaceGraphEmbeddedMaterial extends SpaceGraphNodeBase {
     type: SpaceGraphEmbeddedMaterialType;
     reference: string;
     format: SpaceGraphEmbeddedMaterialFormat;
     constructor(id: string, reference: string, format: SpaceGraphEmbeddedMaterialFormat);
+    toJSON(): SpaceGraphMaterialResourceJson;
 }
 
 declare type SpaceGraphEmbeddedMaterialFormat = 'data3d';
@@ -2586,8 +2657,11 @@ declare interface SpaceGraphEventMap {
     'material-delete': [SpaceGraphMaterial];
     'relation-create': [SpaceGraphRelation];
     'relation-delete': [SpaceGraphRelation];
+    'custom-attribute-create': [SpaceGraphCustomAttribute];
+    'custom-attribute-delete': [SpaceGraphCustomAttribute];
     'node-id-change': [SpaceGraphNodeBase, string];
     'node-property-change': [SpaceGraphNodeBase, string];
+    'node-custom-attributes-change': [SpaceGraphNodeBase];
     'vertex-create': [SpatialGraphVertex];
     'vertex-delete': [SpatialGraphVertex];
     'vertex-add-edge': [SpatialGraphVertex, SpatialGraphEdge];
@@ -2603,9 +2677,10 @@ declare interface SpaceGraphEventMap {
     'space-split': [LayoutSpace, [LayoutSpace, LayoutSpace]];
     'space-attributes-change': [LayoutSpace];
     'element-create': [LayoutElement];
-    'element-delete': [LayoutElement];
+    'element-delete': [LayoutElement, LayoutElement | null];
     'element-parameters-change': [LayoutElementBase];
     'element-transform-change': [LayoutTransformElementBase];
+    'element-edges-change': [LayoutEdgeElementBase];
     'annotation-create': [LayoutAnnotation];
     'annotation-delete': [LayoutAnnotation];
     'annotation-transform-change': [LayoutAnnotationBase];
@@ -2628,6 +2703,7 @@ declare class SpaceGraphFloor extends SpaceGraphSpatialStructureBase {
     insertLayout(layout: SpaceGraphLayout): void;
     removeLayout(layout: SpaceGraphLayout): void;
     createLayout(id: string): SpaceGraphLayout;
+    toJSON(): SpaceGraphFloorJson;
 }
 
 declare interface SpaceGraphFloorJson extends SpaceGraphSpatialStructureBaseJson {
@@ -2731,6 +2807,7 @@ declare class SpaceGraphLayout extends SpaceGraphSpatialStructureBase {
     getSpaceId(prefix?: string): string;
     getElementId(element: LayoutElement, prefix?: string): string;
     getBoundingBox(): TransformBoundingBox3d;
+    toJSON(): SpaceGraphLayoutJson;
 }
 
 declare interface SpaceGraphLayoutJson extends SpaceGraphSpatialStructureBaseJson {
@@ -2757,7 +2834,7 @@ declare type SpaceGraphMaterialJson = Rgb | RgbA | string | SpaceGraphMaterialRe
 
 declare type SpaceGraphMaterialResourceJson = SpaceGraphColorMaterialJson | SpaceGraphStandardMaterialJson | SpaceGraphBasicMaterialJson;
 
-declare type SpaceGraphNode = SpaceGraphProduct | SpaceGraphGeometry | SpaceGraphMaterial | SpaceGraphRelation | SpaceGraphBuilding | SpaceGraphFloor | LayoutNode | SpaceGraphLayout | LayoutAnnotation;
+declare type SpaceGraphNode = SpaceGraphProduct | SpaceGraphGeometry | SpaceGraphMaterial | SpaceGraphRelation | SpaceGraphCustomAttribute | SpaceGraphBuilding | SpaceGraphFloor | LayoutNode | SpaceGraphLayout | LayoutAnnotation;
 
 declare class SpaceGraphNodeBase extends SpaceGraphTypedValue {
     id: string;
@@ -2768,6 +2845,7 @@ declare class SpaceGraphNodeBase extends SpaceGraphTypedValue {
     setName(name: string): void;
     setCustomId(customId: string): void;
     emit<EventType extends keyof SpaceGraphEventMap>(event: EventType, ...args: SpaceGraphEventMap[EventType]): void;
+    toJSON(): SpaceGraphNodeBaseJson;
 }
 
 declare interface SpaceGraphNodeBaseJson extends SpaceGraphTypedValueJson {
@@ -2777,13 +2855,28 @@ declare interface SpaceGraphNodeBaseJson extends SpaceGraphTypedValueJson {
     customId?: string;
 }
 
-declare class SpaceGraphProduct extends SpaceGraphNodeBase {
+declare type SpaceGraphNodeWithCustomAttributes = LayoutNode | SpaceGraphSpatialStructure | SpaceGraphProduct;
+
+declare class SpaceGraphNodeWithCustomAttributesBase extends SpaceGraphNodeBase {
+    customAttributes: SpaceGraphCustomAttributeValue;
+    constructor(id: string, type: string);
+    setCustomAttributes(customAttributes?: SpaceGraphCustomAttributeValueJson | null, customAttributesById?: Record<string, SpaceGraphCustomAttribute>): void;
+    toJSON(): SpaceGraphNodeWithCustomAttributesBaseJson;
+    copyForClone(node: SpaceGraphNodeWithCustomAttributes): void;
+}
+
+declare interface SpaceGraphNodeWithCustomAttributesBaseJson extends SpaceGraphNodeBaseJson {
+    customAttributes?: SpaceGraphCustomAttributeValueJson | null;
+}
+
+declare class SpaceGraphProduct extends SpaceGraphNodeWithCustomAttributesBase {
     type: SpaceGraphProductType;
     attributes: SpaceGraphProductAttributes;
     geometries: GeometryOperationJson[];
     constructor(id: string);
     copyForClone(product: SpaceGraphProduct): void;
     setAttributes(attributesJson: SpaceGraphProductAttributesJson): void;
+    toJSON(): SpaceGraphProductJson;
 }
 
 declare type SpaceGraphProductAttributes = {
@@ -2806,7 +2899,7 @@ declare type SpaceGraphProductAttributesJson = {
     updatedAt?: string;
 };
 
-declare interface SpaceGraphProductJson extends SpaceGraphNodeBaseJson {
+declare interface SpaceGraphProductJson extends SpaceGraphNodeWithCustomAttributesBaseJson {
     type: SpaceGraphProductType;
     attributes?: SpaceGraphProductAttributesJson;
     geometries: GeometryOperationJson[];
@@ -2827,16 +2920,17 @@ declare interface SpaceGraphSharedResourcesJson {
     geometries: SpaceGraphGeometryJson[];
     materials: SpaceGraphMaterialResourceJson[];
     relations: SpaceGraphRelationJson[];
+    customAttributes?: SpaceGraphCustomAttributeJson[];
 }
 
 declare type SpaceGraphSpatialStructure = SpaceGraphBuilding | SpaceGraphFloor | SpaceGraphLayout;
 
-declare class SpaceGraphSpatialStructureBase extends SpaceGraphNodeBase {
+declare class SpaceGraphSpatialStructureBase extends SpaceGraphNodeWithCustomAttributesBase {
     type: SpaceGraphSpatialStructureType;
     constructor(id: string, type: SpaceGraphSpatialStructureType);
 }
 
-declare interface SpaceGraphSpatialStructureBaseJson extends SpaceGraphNodeBaseJson {
+declare interface SpaceGraphSpatialStructureBaseJson extends SpaceGraphNodeWithCustomAttributesBaseJson {
     type: SpaceGraphSpatialStructureType;
 }
 
@@ -2848,6 +2942,7 @@ declare class SpaceGraphStandardMaterial extends SpaceGraphNodeBase {
     type: SpaceGraphStandardMaterialType;
     reference: string;
     constructor(id: string, reference: string);
+    toJSON(): SpaceGraphMaterialResourceJson;
 }
 
 declare interface SpaceGraphStandardMaterialJson extends SpaceGraphMaterialBaseJson {
@@ -2894,12 +2989,15 @@ declare class SpatialGraphEdge extends SpatialGraphNodeBase {
     element: LayoutEdgeElement | null;
     constructor(id: string, vertex1: SpatialGraphVertex, vertex2: SpatialGraphVertex);
     getPoints(): [Vector2, Vector2];
+    getLength(): number;
+    get isExternal(): boolean;
     setVertices(vertex1: SpatialGraphVertex, vertex2: SpatialGraphVertex): void;
     setVerticesByIds(vertexId1: string, vertexId2: string): void;
     canSplit(u: number, options?: EdgeCanSplitOptions): boolean;
     split(u: number, options?: EdgeSplitOptions, updateSpaceBoundaries?: boolean): EdgeSplitReturnValue;
     canMerge(edge: SpatialGraphEdge): boolean;
     merge(edge: SpatialGraphEdge, updateSpaceBoundaries?: boolean): void;
+    toJSON(): SpatialGraphEdgeJson;
 }
 
 declare interface SpatialGraphEdgeJson extends SpatialGraphNodeBaseJson {
@@ -2930,6 +3028,7 @@ declare class SpatialGraphVertex extends SpatialGraphNodeBase {
     addEdge(edge: SpatialGraphEdge): void;
     removeEdge(edge: SpatialGraphEdge): void;
     setPosition(x: number, y: number): void;
+    toJSON(): SpatialGraphVertexJson;
 }
 
 declare interface SpatialGraphVertexJson extends SpatialGraphNodeBaseJson {