@archilogic/floor-plan-sdk 5.1.0 → 5.1.3

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;
@@ -234,6 +238,19 @@ declare type DoorSide = 'side1' | 'side2';
 
 declare type DoorType = 'singleSwing' | 'doubleSwing' | 'slidingDoor' | 'opening' | 'elevatorDoor' | 'garageDoor';
 
+declare enum DxfUnits {
+    unitLess = 0,
+    inches = 1,
+    feet = 2,
+    miles = 3,
+    millimeters = 4,
+    centimeters = 5,
+    meters = 6,
+    kilometers = 7
+}
+
+declare type DxfUnitsString = keyof typeof DxfUnits;
+
 declare interface EdgeCanSplitOptions {
     minimumLength?: number;
 }
@@ -336,6 +353,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
@@ -355,6 +373,7 @@ declare class FloorPlanCore {
  * The main Floor plan engine SDK class
  */
 export declare class FloorPlanEngine extends FloorPlanCore {
+    #private;
     fpeNode?: HTMLElement;
     view: WebGlView;
     interaction: FpeInteraction;
@@ -399,7 +418,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.
@@ -866,6 +884,7 @@ export declare interface GraphicArgs {
 
 declare type GraphicUpdate = {
     position?: Vector2;
+    rotation?: number;
     style?: ShapeStyle;
     shapes?: Shape[];
 };
@@ -1402,6 +1421,7 @@ declare class LayoutEdgeElementBase extends LayoutElementBase {
     getAdjacentSpacesBySide(): [LayoutSpace[], LayoutSpace[]];
     getSpaces(): LayoutSpace[];
     getElementsAtLinearPosition(u: number): LayoutElement[];
+    get isExternal(): boolean;
 }
 
 declare interface LayoutEdgeElementBaseJson extends LayoutElementBaseJson {
@@ -1429,7 +1449,13 @@ declare class LayoutElementBase extends LayoutNodeBase {
     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;
     removeElement(element: LayoutElement): void;
     copyForClone(element: LayoutElement): void;
     setParameters(parameters: RecursivePartial<LayoutElementParameters>): void;
@@ -1467,6 +1493,7 @@ declare interface LayoutFloorPlanDxfAnnotationJson extends LayoutAnnotationBaseJ
 declare interface LayoutFloorPlanDxfParameters {
     uri: string;
     drawingOrigin: Vector2_2;
+    drawingUnits: DxfUnitsString;
     hiddenLayers: string[];
 }
 
@@ -1590,6 +1617,7 @@ declare class LayoutOpening extends LayoutOpeningElementBase {
         transform: Transform3d;
     };
     getSpaces(): LayoutSpace[];
+    get isExternal(): boolean;
 }
 
 declare type LayoutOpeningElement = LayoutOpening;
@@ -1751,6 +1779,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;
@@ -1765,6 +1794,8 @@ declare class LayoutSpace extends LayoutNodeBase {
         edgeIndex: number;
     };
     getBoundingBox(): TransformBoundingBox3d;
+    getAxisAlignedBoundingBox(): BoundingBox3d;
+    getBoundingBoxContour(): Vector2_2[];
     attachSlab(slab: LayoutBoundarySlab): void;
     detachSlab(slab: LayoutBoundarySlab): void;
     toJSON(): LayoutSpaceJson;
@@ -2227,7 +2258,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;
@@ -2251,6 +2282,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
@@ -2667,7 +2699,7 @@ 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];
@@ -2979,6 +3011,8 @@ 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;