@archilogic/floor-plan-sdk 5.0.0-rc.2 → 5.0.0-rc.3

package/dist/fpe.d.ts

@@ -45,7 +45,7 @@ declare interface ArcCurve extends CurveBase {
 
 declare interface ArcCurve_2 extends BaseShape {
     type: 'curve:arc';
-    position: Vector2_2;
+    position: Vector2_3;
     radius: number;
     startAngle: number;
     endAngle: number;
@@ -78,8 +78,8 @@ declare interface BezierCurve extends BaseShape {
 }
 
 declare type BoundingBox2d = {
-    min: Vector2_2;
-    max: Vector2_2;
+    min: Vector2_3;
+    max: Vector2_3;
 };
 
 declare type BoundingBox3d = {
@@ -94,7 +94,7 @@ declare interface CircleCurve extends CurveBase {
 
 declare interface CircleCurve_2 extends BaseShape {
     type: 'curve:circle';
-    position: Vector2_2;
+    position: Vector2_3;
     radius: number;
 }
 
@@ -337,7 +337,7 @@ declare class FloorPlanCore {
      * @param {*} position - plan position
      * @returns {Object} - list of spaces and assets
      */
-    getResourcesFromPosition(position: Vector2_2): {
+    getResourcesFromPosition(position: Vector2_3): {
         spaces: LayoutSpace[];
         assets: LayoutAsset[];
     };
@@ -453,11 +453,11 @@ export declare class FloorPlanEngine extends FloorPlanCore {
     /**
      * Convert screen coordinates to plan coordinates
      */
-    getPlanPosition(point: Vector2_2): Vector2_2;
+    getPlanPosition(point: Vector2_3): Vector2_3;
     /**
      * Convert plan coordinates to screen coordinates
      */
-    getScreenPosition(point: Vector2_2): Vector2_2;
+    getScreenPosition(point: Vector2_3): Vector2_3;
     /**
      * create plan layer or return existing by id
      */
@@ -546,7 +546,7 @@ declare type FloorPlanTheme = {
 
 declare type FpeComputed = {
     wallContours: PolygonWithHoles[];
-    snapPoints: Vector2_2[];
+    snapPoints: Vector2_3[];
     snapMargin: number;
 };
 
@@ -573,14 +573,14 @@ declare type FpeCoreEventMap = {
 };
 
 export declare type FpeDragEvent = {
-    position: Vector2_2;
-    screenPos: Vector2_2;
+    position: Vector2_3;
+    screenPos: Vector2_3;
     sourceEvent: FpeInteractionEvent;
 };
 
 export declare type FpeDropEvent = {
-    position: Vector2_2;
-    screenPos: Vector2_2;
+    position: Vector2_3;
+    screenPos: Vector2_3;
     verticalPos: number;
     sourceEvent: DragEvent;
 };
@@ -615,8 +615,8 @@ export declare type FpeEventMap = FpeCoreEventMap & {
 };
 
 declare interface FpeInteraction {
-    lastSceneClick: Vector2_2;
-    cursor: Vector2_2;
+    lastSceneClick: Vector2_3;
+    cursor: Vector2_3;
     cursorTarget: LayoutElement | LayoutSpace;
     isDragging: boolean;
     isPanning: boolean;
@@ -628,13 +628,18 @@ declare interface FpeInteraction {
     ctrlKey: boolean;
     altKey: boolean;
     shiftKey: boolean;
-    dragOffset: Vector2_2;
+    dragOffset: Vector2_3;
     cursorAction: 'split-wall' | 'duplicate' | 'move' | 'select' | 'none';
     _dragStart: ScreenPosition;
     preventFocusoutOnAltKeyup: boolean;
 }
 
-export declare type FpeInteractionEvent = InteractionEventType[keyof InteractionEventType];
+export declare type FpeInteractionEvent = FpeInteractionEventType[keyof FpeInteractionEventType];
+
+export declare type FpeInteractionEventType = {
+    /* Excluded from this release type: pixi */
+    dom: MouseEvent;
+};
 
 export declare type FpeKeyEvent = {
     key: string;
@@ -677,7 +682,7 @@ declare type FpeLoader_2 = FloorPlanCore['loader'];
 
 export declare type FpePointerEvent = {
     nodeId?: string;
-    position: Vector2_2;
+    position: Vector2_3;
     isDoubleClick?: boolean;
     sourceEvent: FpeInteractionEvent;
 };
@@ -848,7 +853,7 @@ declare class Graph {
 
 export declare interface GraphicArgs {
     shapes: Shape[];
-    position?: Vector2_2;
+    position?: Vector2_3;
     alpha?: number;
     clearLayer?: boolean;
     scale?: number;
@@ -860,7 +865,7 @@ export declare interface GraphicArgs {
 }
 
 declare type GraphicUpdate = {
-    position?: Vector2_2;
+    position?: Vector2_3;
     style?: ShapeStyle;
     shapes?: Shape[];
 };
@@ -885,7 +890,7 @@ declare const GroupRelationTypeValue = "relation:group";
 
 declare interface GroupShape extends BaseShape {
     type: 'group';
-    position?: Vector2_2;
+    position?: Vector2_3;
     rotation?: number;
     children: Shape[];
 }
@@ -908,9 +913,9 @@ declare type HideableElement = LayoutElement['type'] | LayoutSpace['type'] | Spa
 declare type HingeSide = 'left' | 'right';
 
 declare class HtmlMarker {
-    position: Vector2_2;
-    size: Vector2_2;
-    offset: Vector2_2;
+    position: Vector2_3;
+    size: Vector2_3;
+    offset: Vector2_3;
     isHidden: boolean;
     id: string;
     el: HTMLElement;
@@ -925,8 +930,8 @@ declare class HtmlMarker {
 
 declare interface HtmlMarkerArgs {
     /** coordinates of the window in meters */
-    position?: Vector2_2;
-    offset?: Vector2_2;
+    position?: Vector2_3;
+    offset?: Vector2_3;
     /** html string as content of the info window */
     el?: HTMLElement;
     /** If true , a close button will appear in the top right corner of the info window. */
@@ -945,7 +950,7 @@ declare type IndexRange = {
 
 declare class InfoWindow {
     private _floorPlan;
-    position: Vector2_2;
+    position: Vector2_3;
     height: number;
     width: number;
     closeButton: any;
@@ -973,7 +978,7 @@ declare interface InfoWindowArgs {
     /** pixel height of the window - default 80 */
     height?: number;
     /** coordinates of the window in meters */
-    position?: Vector2_2;
+    position?: Vector2_3;
     /** html string as content of the info window */
     html?: string;
     /** If true , a close button will appear in the top right corner of the info window. */
@@ -984,10 +989,6 @@ declare interface InfoWindowState extends InfoWindowArgs {
     floorPlan?: FloorPlanEngine;
 }
 
-declare type InteractionEventType = {
-    dom: MouseEvent;
-};
-
 declare class Layout2dView extends LayoutViewBase {
     type: Layout2dViewType;
     parameters: Layout2dViewParameters;
@@ -2039,8 +2040,8 @@ declare interface LineCurve extends CurveBase {
 
 declare interface LineCurve_2 extends BaseShape {
     type: 'curve:line';
-    start: Vector2_2;
-    end: Vector2_2;
+    start: Vector2_3;
+    end: Vector2_3;
 }
 
 declare type LineCurveType = typeof LineCurveTypeValue;
@@ -2051,7 +2052,7 @@ declare type LoadingEvent = 'loading-done' | 'loading-status' | 'resource-loaded
 
 declare interface MarkerArgs {
     /** coordinates of the marker in meters */
-    position?: Vector2_2;
+    position?: Vector2_3;
     /** color of the marker, hex code */
     color?: string;
     /** size in pixels */
@@ -2060,7 +2061,7 @@ declare interface MarkerArgs {
 }
 
 declare class MarkerPin {
-    position: Vector2_2;
+    position: Vector2_3;
     color: string;
     size: number;
     id: string;
@@ -2189,7 +2190,9 @@ declare const PlaneGeometryTypeValue = "geometry:plane";
 
 declare class PlanGraphic {
     shapes: Shape[];
+    /* Excluded from this release type: gfx */
     scaleOnZoom: boolean;
+    /* Excluded from this release type: container */
     gfxScale: number;
     private floorPlan;
     constructor({ shapes, position, alpha, scale, clearLayer, interactive, id, isHandler, scaleOnZoom, updatePositionOnDrag, baseLayer, container, floorPlan }: PlanGraphicArgs);
@@ -2204,10 +2207,13 @@ declare class PlanGraphic {
 
 declare interface PlanGraphicArgs extends GraphicArgs {
     floorPlan: FloorPlanEngine;
+    /* Excluded from this release type: baseLayer */
+    /* Excluded from this release type: container */
     [key: string]: any;
 }
 
 declare class PlanLayer {
+    /* Excluded from this release type: container */
     graphics: Set<PlanGraphic>;
     id: string;
     private baseLayer;
@@ -2225,7 +2231,7 @@ declare class PlanLayer {
     destroy(): void;
 }
 
-declare type Polygon = Vector2_2[];
+declare type Polygon = Vector2_3[];
 
 declare interface PolygonCurve extends CurveBase {
     type: PolygonCurveType;
@@ -2274,7 +2280,7 @@ declare interface RectangleCurve extends CurveBase {
 
 declare interface RectangleCurve_2 extends BaseShape {
     type: 'curve:rectangle';
-    position: Vector2_2;
+    position: Vector2_3;
     dimensions: [number, number];
 }
 
@@ -2927,7 +2933,7 @@ declare type TemporaryAccessTokenFunction = (args: CreateTemporaryAccessToken) =
 
 declare interface TextShape extends BaseShape {
     type: 'text';
-    position: Vector2_2;
+    position: Vector2_3;
     text: string;
     rotation?: number;
     alignV?: 'center' | 'bottom' | 'top';
@@ -3064,6 +3070,8 @@ declare type Vector2 = [number, number];
 
 declare type Vector2_2 = [number, number];
 
+declare type Vector2_3 = [number, number];
+
 declare type Vector3 = [number, number, number];
 
 declare interface Vector3List extends SpaceGraphTypedValueJson {
@@ -3083,9 +3091,9 @@ declare interface Vector3Range extends SpaceGraphTypedValueJson {
 declare type ViewEvent = 'pan' | 'zoom' | 'viewbox' | 'resize-canvas' | 'scene-rendered' | 'focus';
 
 declare class WebGlView extends TinyEmitter {
-    windowPos: Vector2_2;
+    windowPos: Vector2_3;
     zoom: number;
-    client: Vector2_2;
+    client: Vector2_3;
     layers: Map<string, PlanLayer>;
     viewbox: BoundingBox2d;
     viewportNeedsUpdate: boolean;
@@ -3095,8 +3103,15 @@ declare class WebGlView extends TinyEmitter {
     wallNodeUpdateInProgress: boolean;
     parentEl: HTMLElement;
     _settings: FpeConfig;
+    /* Excluded from this release type: gfxLayers */
     redrawScene: () => void;
+    /* Excluded from this release type: gfxNodes */
+    /* Excluded from this release type: _viewport */
+    /* Excluded from this release type: _canvasMargin */
+    /* Excluded from this release type: _renderer */
+    /* Excluded from this release type: _stage */
     _dummyTexture: any;
+    /* Excluded from this release type: _zoomTarget */
     _oldTime: number;
     ticker?: Ticker;
     on: (event: ViewEvent, callback: Function, ctx?: any) => this;