@archilogic/floor-plan-sdk 5.1.1 → 5.1.4

package/dist/fpe.d.ts

@@ -158,6 +158,11 @@ declare interface CommonParameters {
     materials: LayoutWindowMaterials;
 }
 
+declare type CommonStairsParameters = {
+    railing: 'none' | 'left' | 'right' | 'both';
+    materials: LayoutStairsMaterials;
+};
+
 export declare interface CompositeCurve extends BaseShape {
     type: 'curve:composite';
     segments: OpenCurves[];
@@ -202,35 +207,68 @@ declare interface CurveBase {
 
 declare type CurveType = ClosedCurveType | OpenCurveType;
 
+declare type CustomAttributeInputType = 'Text' | 'Number' | 'Boolean' | 'Integer' | 'Select';
+
 declare type CustomAttributeResourceType = 'building' | 'element' | 'floor' | 'layout' | 'product' | 'space';
 
-declare type CustomAttributeValueType = 'Text' | 'Number' | 'Boolean';
+declare type CustomAttributeSchema = CustomAttributeSchemaText | CustomAttributeSchemaSelect | CustomAttributeSchemaNumber | CustomAttributeSchemaInteger | CustomAttributeSchemaBoolean;
+
+declare type CustomAttributeSchemaBoolean = {
+    type: 'boolean';
+};
+
+declare type CustomAttributeSchemaInteger = {
+    type: 'integer';
+};
+
+declare type CustomAttributeSchemaNumber = {
+    type: 'number';
+};
+
+declare type CustomAttributeSchemaSelect = {
+    type: 'string';
+    enum: string[];
+};
+
+declare type CustomAttributeSchemaText = {
+    type: 'string';
+};
+
+/** @deprecated */
+declare type CustomAttributeValueType = 'Text' | 'Number' | 'Boolean' | 'Schema';
 
-declare interface CustomStairsParameters {
+declare type CustomStairsParameters = {
     stairsType: CustomStairsType;
+    /** @minimum 0.01 */
     height: number;
+    /** @minimum 0.01 */
     stepWidth: number;
-    railing: 'none' | 'left' | 'right' | 'both';
-    materials: LayoutStairsMaterials;
-}
+} & CommonStairsParameters;
 
 declare type CustomStairsParametersJson = Partial<CustomStairsParameters>;
 
 declare type CustomStairsType = 'custom';
 
 declare interface DimensionParameters$1 {
+    /** @minimum 0.01 */
     length: number;
+    /** @minimum 0.01 */
     height: number;
 }
 
 declare interface DimensionParameters$2 {
+    /** @minimum 0.01 */
     length: number;
+    /** @minimum 0.01 */
     height: number;
 }
 
 declare type DimensionParameters = {
+    /** @minimum 0.01 */
     length: number;
+    /** @minimum 0.01 */
     width: number;
+    /** @minimum 0.01 */
     height: number;
 };
 
@@ -238,6 +276,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;
 }
@@ -360,6 +411,7 @@ declare class FloorPlanCore {
  * The main Floor plan engine SDK class
  */
 export declare class FloorPlanEngine extends FloorPlanCore {
+    #private;
     fpeNode?: HTMLElement;
     view: WebGlView;
     interaction: FpeInteraction;
@@ -1317,6 +1369,7 @@ declare interface LayoutColumnMaterials {
 
 declare interface LayoutColumnParameters {
     profile: LayoutColumnProfile;
+    /** @minimum 0.01 */
     height: number;
     materials: LayoutColumnMaterials;
 }
@@ -1435,7 +1488,12 @@ 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;
@@ -1474,6 +1532,7 @@ declare interface LayoutFloorPlanDxfAnnotationJson extends LayoutAnnotationBaseJ
 declare interface LayoutFloorPlanDxfParameters {
     uri: string;
     drawingOrigin: Vector2_2;
+    drawingUnits: DxfUnitsString;
     hiddenLayers: string[];
 }
 
@@ -1774,6 +1833,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;
@@ -2028,7 +2089,9 @@ declare interface LayoutWallMaterials {
 }
 
 declare interface LayoutWallParameters {
+    /** @minimum 0.01 */
     width: number;
+    /** @minimum 0.01 */
     height: number;
     offset: number;
     elevation: number;
@@ -2166,16 +2229,12 @@ declare type OpenCurves = LineCurve | ArcCurve | PolylineCurve | BezierCurve;
 
 declare type OpenCurveType = LineCurveType | PolylineCurveType | ArcCurveType;
 
-declare interface OrthogonalStairsParameters {
+declare type OrthogonalStairsParameters = {
     stairsType: OrthogonalStairsType;
-    length: number;
-    width: number;
-    height: number;
+    /** @minimum 0.01 */
     stepWidth: number;
     circulation: 'left' | 'right';
-    railing: 'none' | 'left' | 'right' | 'both';
-    materials: LayoutStairsMaterials;
-}
+} & DimensionParameters & CommonStairsParameters;
 
 declare type OrthogonalStairsParametersJson = Partial<OrthogonalStairsParameters>;
 
@@ -2597,6 +2656,7 @@ declare class SpaceGraphCustomAttribute extends SpaceGraphNodeBase {
     type: SpaceGraphCustomAttributeType;
     attributes: SpaceGraphCustomAttributeAttributes;
     constructor(id: string, attributesJson?: SpaceGraphCustomAttributeAttributesJson);
+    getInputType(): CustomAttributeInputType;
     setAttributes(attributesJson: SpaceGraphCustomAttributeAttributesJson): void;
     copyForClone(customAttribute: SpaceGraphCustomAttribute): void;
     toJSON(): SpaceGraphCustomAttributeJson;
@@ -2604,14 +2664,15 @@ declare class SpaceGraphCustomAttribute extends SpaceGraphNodeBase {
 
 declare type SpaceGraphCustomAttributeAttributes = {
     resourceType: CustomAttributeResourceType;
-    valueType: CustomAttributeValueType;
+    schema: CustomAttributeSchema;
     updatedAt?: string;
     description?: string;
 };
 
 declare type SpaceGraphCustomAttributeAttributesJson = {
     resourceType: CustomAttributeResourceType;
-    valueType: CustomAttributeValueType;
+    valueType?: CustomAttributeValueType;
+    schema?: CustomAttributeSchema;
     updatedAt?: string;
     /** @minLength 3 @maxLength 200 @type string */
     description?: string;
@@ -2630,9 +2691,9 @@ declare type SpaceGraphCustomAttributeType = typeof SpaceGraphCustomAttributeTyp
 
 declare const SpaceGraphCustomAttributeTypeValue = "customAttribute:definition";
 
-declare type SpaceGraphCustomAttributeValue = Record<string, string>;
+declare type SpaceGraphCustomAttributeValue = Record<string, string | boolean | number>;
 
-declare type SpaceGraphCustomAttributeValueJson = Record<string, string | null>;
+declare type SpaceGraphCustomAttributeValueJson = Record<string, string | boolean | number | null>;
 
 declare class SpaceGraphEmbeddedMaterial extends SpaceGraphNodeBase {
     type: SpaceGraphEmbeddedMaterialType;
@@ -3059,7 +3120,9 @@ declare interface SpiralStairFlightParameters {
     stairFlightType: 'spiral';
     angle: number;
     radius: number;
+    /** @minimum 0.01 */
     width: number;
+    /** @minimum 0.01 */
     height: number;
     circulation: 'left' | 'right';
     materials: LayoutStairFlightMaterials;
@@ -3067,16 +3130,16 @@ declare interface SpiralStairFlightParameters {
 
 declare type SpiralStairFlightParametersJson = Partial<SpiralStairFlightParameters>;
 
-declare interface SpiralStairsParameters {
+declare type SpiralStairsParameters = {
     stairsType: SpiralStairsType;
     radius: number;
     angle: number;
+    /** @minimum 0.01 */
     height: number;
+    /** @minimum 0.01 */
     stepWidth: number;
     circulation: 'left' | 'right';
-    railing: 'none' | 'left' | 'right' | 'both';
-    materials: LayoutStairsMaterials;
-}
+} & CommonStairsParameters;
 
 declare type SpiralStairsParametersJson = Partial<SpiralStairsParameters>;
 
@@ -3106,24 +3169,16 @@ declare interface StartupOptions {
     zoomRange?: [number, number];
 }
 
-declare interface StraightStairFlightParameters {
+declare type StraightStairFlightParameters = {
     stairFlightType: 'straight';
-    length: number;
-    width: number;
-    height: number;
     materials: LayoutStairFlightMaterials;
-}
+} & DimensionParameters;
 
 declare type StraightStairFlightParametersJson = Partial<StraightStairFlightParameters>;
 
-declare interface StraightStairsParameters {
+declare type StraightStairsParameters = {
     stairsType: StraightStairsType;
-    length: number;
-    width: number;
-    height: number;
-    railing: 'none' | 'left' | 'right' | 'both';
-    materials: LayoutStairsMaterials;
-}
+} & DimensionParameters & CommonStairsParameters;
 
 declare type StraightStairsParametersJson = Partial<StraightStairsParameters>;