@mappedin/mappedin-js 4.0.11 → 4.0.12

package/lib/esm/renderer/index.d.ts

@@ -911,6 +911,13 @@ declare module '@mappedin/mappedin-js/renderer/MapView.types' {
                 * The rank of the object used when comparing colliders to determine which should be shown.
                 */
             collisionRank?: COLLISION_RANKING_TIERS;
+            /**
+                * By default, we don't hide tooltips when they collide. This is
+                * so that for floor switching tooltips we don't lose where the elevator is
+                * This option will override that behavior
+                * @default true
+                */
+            alwaysVisible?: boolean;
     };
     export type TCreateTextTooltipOptions = TCreateTooltipCommonOptions & {
             /**
@@ -1310,7 +1317,6 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.Marker' {
         get strategies(): TColliderStrategy[];
         colliderDidMount(): void;
         setAction(action: any): void;
-        updateDimensions(): void;
         colliderDidGoOffscreen(): void;
         colliderDidUpdateVisiblity(): void;
     }
@@ -1678,7 +1684,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
             get strategies(): TColliderStrategy[];
             getCachedSymbol(orientation: any, textAlign: any, xCoordinate: any): any;
             colliderDidMount(): void;
-            colliderDidUpdatePosition(x: any, y: any): void;
+            colliderDidUpdatePosition(pos: any): void;
             setPriority(priority: any): void;
             colliderDidUpdateVisiblity(): void;
             colliderDidGoOutsideGrid(): void;
@@ -1871,6 +1877,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartTooltip' {
         selector?: string;
         map: string;
         padding?: number;
+        alwaysVisible?: boolean;
         collisionRank?: COLLISION_RANKING_TIERS;
         defaultAnchorType?: string;
         enabledAnchorTypes?: {
@@ -1892,6 +1899,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartTooltip' {
         bottomRight?: boolean;
     };
     class SmartTooltip extends HTMLCollider implements IHTMLCollider {
+        #private;
         className: string;
         _el: Element | null;
         style: TTooltipStyle;
@@ -1900,7 +1908,6 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartTooltip' {
         get strategies(): TColliderStrategy[];
         colliderDidMount(): void;
         setAction(action: any): void;
-        updateDimensions(): void;
         colliderDidNotFindAHome(): void;
         colliderDidGoOffscreen(): void;
         colliderDidUpdateVisiblity(): void;
@@ -3812,6 +3819,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.HTMLCollider' {
         contentEl: any;
     }
     class HTMLCollider extends BaseCollider {
+        #private;
         contentEl: any;
         containerEl: any;
         removeSelf(): void;
@@ -3819,7 +3827,12 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.HTMLCollider' {
         disable(): void;
         colliderDidGoOffscreen(): void;
         colliderDidNotFindAHome(): void;
-        colliderDidUpdatePosition(x: any, y: any): void;
+        colliderDidUpdatePosition(pos: any): void;
+        updateDimensions(): void;
+        /**
+          * @internal
+          */
+        updateDimensionsImmediately(): void;
         colliderDidMount(): void;
         colliderDidUpdateVisiblity(): void;
     }
@@ -3827,7 +3840,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.HTMLCollider' {
 }
 
 declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider' {
-    import { ISmartCollisionEngine } from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollisionEngine';
+    import SmartCollisionEngine from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollisionEngine';
     import { Vector3 } from 'three';
     export type TRange = [number, number, number, number];
     type TCustomCollider<T> = ICollider & T;
@@ -3864,7 +3877,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider'
         setAction: (action: EColliderAction) => void;
         action?: EColliderAction;
         position: Vector3;
-        __engine?: ISmartCollisionEngine;
+        __engine?: SmartCollisionEngine;
         enable: () => void;
         disable: () => void;
         enabled: boolean;
@@ -3878,7 +3891,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider'
         colliderDidGoOffscreen?: () => void;
         colliderDidGoOutsideGrid?: () => void;
         colliderDidUpdateVisiblity?: () => void;
-        colliderDidUpdatePosition?: (x: number, y: number) => void;
+        colliderDidUpdatePosition?: (prop: [x: number, y: number]) => void;
     }
     class BaseCollider implements ICollider {
         __engine: any;
@@ -3908,7 +3921,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider'
         removeSelf(): void;
         enable(): void;
         disable(): void;
-        colliderDidUpdatePosition(x: any, y: any): void;
+        colliderDidUpdatePosition(pos: any): void;
         colliderDidNotFindAHome(): void;
         colliderDidMount(): void;
         colliderDidUpdateVisiblity(): void;
@@ -4784,27 +4797,55 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.RenderTasks' {
 declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollisionEngine' {
     import { Vector3 } from 'three';
     import './Mappedin.SmartCollisionEngine.scss';
-    import { ICollider } from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider';
+    import { ICollider, TRange } from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider';
+    import { MappedinMap, MapView } from '@mappedin/mappedin-js/renderer';
     export const COLLIDER_STRATEGY_LOW_PRIORITY = "LOW_PRIORITY";
-    type TProjectFn = ({ position, mapId }: {
-        position: Vector3;
-        mapId: string;
-    }) => [number, number];
-    export interface ISmartCollisionEngine {
-        add: (colliderId: string, collider: ICollider) => void;
-        remove: (colliderId: string) => void;
-        init: (container: HTMLElement, projectFn: TProjectFn) => void;
-        resize: (container: HTMLElement) => void;
-        resort: () => void;
-        updatePosition: () => void;
-        updateVisibility: () => void;
-        makeCollidersDirty: () => void;
-        update: () => void;
-        destroy: () => void;
-        makeCollidersDirtyThrottled: (time: number) => void;
-        _makeCollidersDirtyThrottled?: [() => void, number];
+    class SmartCollisionEngine {
+            #private;
+            _makeCollidersDirtyThrottled: any;
+            colliderCanvas: HTMLCanvasElement;
+            debugCanvas: HTMLCanvasElement;
+            colliderCanvasContext: CanvasRenderingContext2D;
+            debugCanvasContext: CanvasRenderingContext2D;
+            collisionEngineContainerEl: HTMLDivElement;
+            stepsX: any;
+            stepsY: any;
+            totalWidth: any;
+            totalHeight: any;
+            project: any;
+            grid: Uint8Array;
+            colliders: Map<string, ICollider>;
+            offscreenRanges: TRange[];
+            get sortedColliders(): ICollider[];
+            initialized: boolean;
+            mapView: MapView;
+            constructor(mapView: any);
+            init: (container: HTMLDivElement, projectFn: ({ position, mapId }: {
+                    position: Vector3;
+                    mapId: MappedinMap['id'];
+            }) => {
+                    x: number;
+                    y: number;
+            }) => void;
+            updatePosition: () => void;
+            updateVisibility: () => void;
+            add: (colliderId: string, collider: ICollider) => void;
+            remove: (colliderId: string) => void;
+            /**
+                * When adding/removing new colliders, or when updating their priorty, we need to make all colliders around them as "dirty",
+                * so they can be reconcilded correctly
+                */
+            makeCollidersDirty: () => void;
+            /**
+                * Allow to throttle making collders dirty. This is useful for things like BlueDot follow mode,
+                * As we follow the BlueDot, colliders will overlap, but constantly updating their visiblity makes
+                * for a bad experience
+                */
+            makeCollidersDirtyThrottled: (time: any) => void;
+            resize: (container: any) => void;
+            update: () => void;
+            destroy: () => void;
     }
-    const SmartCollisionEngine: () => ISmartCollisionEngine;
     export default SmartCollisionEngine;
 }