@mappedin/mappedin-js 5.3.0 → 5.4.0

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

@@ -390,6 +390,19 @@ declare module '@mappedin/mappedin-js/renderer/MapView' {
                 * @returns MappedinPolygon[]
                 */
             getPolygonsAtCoordinate(coordinate: MappedinCoordinate, options?: TGetPolygonsAtCoordinateOptions): MappedinPolygon[];
+            /**
+                * Finds all the polygons on a screen coordinate x and y. If multiple
+                * polygons are stacked on top of each other, the array of polygons returned will be
+                * in the order of farthest to closest.
+                *
+                * By default, this only considers interactive polygons.
+                *
+                * @param x
+                * @param y
+                * @param options {@link TGetPolygonsAtCoordinateOptions}
+                * @returns MappedinPolygon[]
+                */
+            getPolygonsAtScreenCoordinate(x: number, y: number, options?: TGetPolygonsAtCoordinateOptions): MappedinPolygon[];
             /**
                 * Destroy instance and reclaim memory. Note: this does not destroy the instance of {@link Mappedin}
                 * that was passed in. For applications that require destroying and re-creating the mapView, it is
@@ -2028,8 +2041,10 @@ declare module '@mappedin/mappedin-js/renderer/layers/BlueDot' {
                 * @private
                 */
             constructor(mapView: MapView, core: ICore, eventsLayer: EventSystemLayer);
-            on(eventName: any, fn: any): void;
-            off(eventName: any, fn: any): void;
+            on<EVENT_NAME extends E_BLUEDOT_EVENT>(eventName: EVENT_NAME, fn: (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME] extends {
+                    data: null;
+            } ? E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]['data'] : E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]) => void): void;
+            off<EVENT_NAME extends E_BLUEDOT_EVENT>(eventName: EVENT_NAME, fn: (payload: E_BLUEDOT_EVENT_PAYLOAD[EVENT_NAME]) => void): void;
             /**
                 * Enables Blue Dot. BlueDot then emits {@link TBlueDotStateChange} and {@link TBlueDotPositionUpdate} events via {@link E_BLUEDOT_EVENT}
                 */
@@ -3230,7 +3245,7 @@ declare module '@mappedin/mappedin-js/get-venue/MappedinNavigatable' {
     import type { MappedinPolygon } from '@mappedin/mappedin-js/get-venue/MappedinPolygon';
     import type { MappedinNode } from '@mappedin/mappedin-js/get-venue/MappedinNode';
     import { MappedinDestinationSet } from '@mappedin/mappedin-js/get-venue/MappedinDestinationSet';
-    import type { Mappedin } from '@mappedin/mappedin-js/get-venue/Mappedin';
+    import { Mappedin } from '@mappedin/mappedin-js/get-venue/Mappedin';
     import { MappedinDirections } from '@mappedin/mappedin-js/get-venue/MappedinDirections';
     export type TDirectionToOptions = {
             accessible?: boolean;
@@ -3253,7 +3268,7 @@ declare module '@mappedin/mappedin-js/get-venue/MappedinNavigatable' {
 }
 
 declare module '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics' {
-    import { MappedinCategory, MappedinLocation } from '@mappedin/mappedin-js/get-venue';
+    import { MappedinCategory, MappedinLocation, MappedinNavigatable } from '@mappedin/mappedin-js/get-venue';
     type AnalyticsOptions = {
             clientId?: string;
             clientSecret?: string;
@@ -3267,7 +3282,12 @@ declare module '@mappedin/mappedin-js/get-venue/Mappedin.CustomerAnalytics' {
     interface IAnalytics {
             locationSelected(location: MappedinLocation): void;
             categorySelected(category: MappedinCategory): void;
-            getDirections(start: MappedinLocation, end: MappedinLocation): void;
+            /**
+                * @hidden
+                * @internal
+                * @deprecated
+                */
+            getDirections(start: MappedinNavigatable, end: MappedinNavigatable): void;
     }
     interface IInternalAnalytics extends IAnalytics {
             track(target: string, query: any): void;
@@ -3886,7 +3906,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/pub-sub' {
 declare module '@mappedin/mappedin-js/renderer/Core.interface' {
     import { MappedinMap, Mappedin, MappedinCoordinate, MappedinPolygon, MappedinNode } from '@mappedin/mappedin-js/get-venue';
     import { Vector2, Vector3 } from 'three';
-    import { changeListenerFn, TMapViewOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
+    import { changeListenerFn, TGetPolygonsAtCoordinateOptions, TMapViewOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
     import RENDER from '@mappedin/mappedin-js/renderer/internal/Mappedin.RenderTasks';
     import { INTERNAL_EVENT_PAYLOAD } from '@mappedin/mappedin-js/renderer/MapView';
     import { TPadding } from '@mappedin/mappedin-js/renderer';
@@ -4038,6 +4058,22 @@ declare module '@mappedin/mappedin-js/renderer/Core.interface' {
                 * @param element The node to stop rotating. It won't reset the transform, just leave it as is.
                 */
             unlockNorth(element: HTMLElement): void;
+            /**
+                * Returns all polygons that contain the specified MappedinCoordinate.
+                *
+                * @param coordinate The MappedinCoordinate to check
+                * @param hoverableMeshChildren
+                * @param options {@link TGetPolygonsAtCoordinateOptions}
+                */
+            getPolygonsAtScreenCoordinate(coordinate: Vector2, hoverableMeshChildren: any[], options?: TGetPolygonsAtCoordinateOptions): MappedinPolygon[];
+            /**
+                * Returns all polygons at the specified screen coordinate.
+                *
+                * @param coordinate The Vector2 coordinate to check
+                * @param hoverableMeshChildren
+                * @param options {@link TGetPolygonsAtCoordinateOptions}
+                */
+            getPolygonsAtCoordinate(coordinate: MappedinCoordinate, hoverableMeshChildren: any[], options?: TGetPolygonsAtCoordinateOptions): MappedinPolygon[];
             currentInteractionEvent: string;
             interactivePolygons: any;
             highlightedPolygons: any;
@@ -4261,7 +4297,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
     }
     export type TFloatingLabelAppearance = {
             /**
-                * Margin around the label and marker. This will affect label density
+                * Margin around the label and marker. This will affect label density, with a mininum of 7px around
                 * @default 6
                 */
             margin?: number;
@@ -4319,6 +4355,10 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
                                 */
                             inactive?: string;
                     };
+                    /**
+                        * Size of bounding box of SVG icon
+                        */
+                    iconSize?: number;
                     /**
                         * SVG of icon to place inside Floating Label
                         */
@@ -4352,6 +4392,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
                             active: string;
                             inactive: string;
                     };
+                    iconSize?: number;
                     icon?: string;
                     iconVisibilityThreshold?: number;
             };
@@ -4416,6 +4457,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.FloatingLabel'
             static imagePromiseCache: {
                     [key in number]?: Promise<HTMLImageElement>;
             };
+            get pinCanvasSize(): number;
             draw(context: CanvasRenderingContext2D): void;
     }
     export default FloatingLabel;
@@ -4455,8 +4497,8 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.HTMLCollider' {
 
 declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider' {
     import SmartCollisionEngine from '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollisionEngine';
-    import { Vector3 } from 'three';
     import { Rectangle } from '@mappedin/mappedin-js/renderer/internal/quad-tree';
+    import { MappedinCoordinate, MappedinNode } from '@mappedin/mappedin-js/renderer/index.rn';
     export type TRange = [number, number, number, number];
     type TCustomCollider<T> = ICollider & T;
     export type TColliderStrategyProps = {
@@ -4483,6 +4525,10 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider'
         'show' = 1,
         'hide' = 2
     }
+    export type TColliderPosition = {
+        nodeOrCoordinate: MappedinNode | MappedinCoordinate;
+        height?: number;
+    };
     export interface ICollider {
         dimensions: TDimensions;
         screenPosition: [number, number];
@@ -4501,7 +4547,7 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.SmartCollider'
         offscreen?: boolean;
         setAction: (action: EColliderAction) => void;
         action?: EColliderAction;
-        position: Vector3;
+        position: TColliderPosition;
         __engine?: SmartCollisionEngine;
         enable: () => void;
         disable: () => void;
@@ -5818,6 +5864,27 @@ declare module '@mappedin/mappedin-js/renderer/internal/quad-tree' {
     export { QuadTree, Rectangle };
 }
 
+declare module '@mappedin/mappedin-js/renderer/index.rn' {
+    import { getVenue, getVenueBundle, Mappedin, MappedinDestinationSet } from '@mappedin/mappedin-js/get-venue';
+    import { randomId } from '@mappedin/mappedin-js/--/common/random-id';
+    export * from '@mappedin/mappedin-js/renderer/MapView.enums';
+    export { getVenue, 
+    /**
+      * @deprecated
+      */
+    getVenueBundle, MappedinDestinationSet, Mappedin, randomId };
+    export { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, E_BLUEDOT_STATE_REASON, E_BLUEDOT_STATE, E_BLUEDOT_MARKER_STATE, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, E_CAMERA_DIRECTION, SAFE_AREA_INSET_TYPE, ANIMATION_TWEENS, CAMERA_EASING_MODE } from '@mappedin/mappedin-js/renderer/MapView.enums';
+    export { labelThemes } from '@mappedin/mappedin-js/renderer/MapView.types';
+    export type { IFlatLabels } from '@mappedin/mappedin-js/renderer/MapView.FlatLabels';
+    export type { IFloatingLabels } from '@mappedin/mappedin-js/renderer/MapView.FloatingLabels';
+    export type { TBlueDotPositionUpdate, TBlueDotStateChange, TJourneyOptions, TMapViewOptions, TCreateMarkerOptions, TGeolocationObject, TPathOptions, TFlatLabelOptions, TAddFloatingLabelOptions, TAddFlatLabelOptions, TLabelAllLocationCommonOptions, TFloatingLabelAllLocationsOptions, TFlatLabelAllLocationsOptions, TLabelAllLocationFlatLabelOptions, TLabelAllLocationFloatingLabelOptions, TEnableBlueDotOptions, TFloatingLabelAppearance, TFlatLabelAppearance, CAMERA_EVENT_PAYLOAD, TMapClickEvent, TGetPolygonsAtCoordinateOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
+    export { BEARING_TYPE, ACTION_TYPE } from '@mappedin/mappedin-js/navigator';
+    export type { IDirectionsResult, E_MESSAGES as E_GET_DIRECTIONS_MESSAGES } from '@mappedin/mappedin-js/navigator';
+    export type { TGetVenueBundleOptions, TGetVenueOptions, TMappedinDirective, TShowVenueOptions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineSearchAllOptions, TMappedinOfflineAllSearchMatch } from '@mappedin/mappedin-js/get-venue';
+    export { MappedinLocation, MappedinPolygon, MappedinNode, MappedinCategory, MappedinMap, MappedinEvent, MappedinMapGroup, MappedinVenue, MappedinVortex, MappedinDirections, MappedinNavigatable, MappedinCoordinate, MappedinRankings, MAP_RENDER_MODE, OfflineSearch, MappedinCollectionType } from '@mappedin/mappedin-js/get-venue';
+    export type { TSafeAreaInsets, TCameraTargets, TFocusOnCameraOptions, TCameraTransform, TCameraAnimationOptions } from '@mappedin/mappedin-js/renderer/Camera';
+}
+
 declare module '@mappedin/mappedin-js/navigator/Edge' {
     import INode from '@mappedin/mappedin-js/navigator/interfaces/INode';
     import IVortex from '@mappedin/mappedin-js/navigator/interfaces/IVortex';
@@ -5969,27 +6036,6 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.LabelAtlas' {
     export {};
 }
 
-declare module '@mappedin/mappedin-js/renderer/index.rn' {
-    import { getVenue, getVenueBundle, Mappedin, MappedinDestinationSet } from '@mappedin/mappedin-js/get-venue';
-    import { randomId } from '@mappedin/mappedin-js/--/common/random-id';
-    export * from '@mappedin/mappedin-js/renderer/MapView.enums';
-    export { getVenue, 
-    /**
-      * @deprecated
-      */
-    getVenueBundle, MappedinDestinationSet, Mappedin, randomId };
-    export { GEOLOCATION_STATUS, COLLISION_RANKING_TIERS, E_BLUEDOT_STATE_REASON, E_BLUEDOT_STATE, E_BLUEDOT_MARKER_STATE, STATE, MARKER_ANCHOR, E_SDK_EVENT, E_BLUEDOT_EVENT, E_CAMERA_EVENT, E_CAMERA_DIRECTION, SAFE_AREA_INSET_TYPE, ANIMATION_TWEENS, CAMERA_EASING_MODE } from '@mappedin/mappedin-js/renderer/MapView.enums';
-    export { labelThemes } from '@mappedin/mappedin-js/renderer/MapView.types';
-    export type { IFlatLabels } from '@mappedin/mappedin-js/renderer/MapView.FlatLabels';
-    export type { IFloatingLabels } from '@mappedin/mappedin-js/renderer/MapView.FloatingLabels';
-    export type { TBlueDotPositionUpdate, TBlueDotStateChange, TJourneyOptions, TMapViewOptions, TCreateMarkerOptions, TGeolocationObject, TPathOptions, TFlatLabelOptions, TAddFloatingLabelOptions, TAddFlatLabelOptions, TLabelAllLocationCommonOptions, TFloatingLabelAllLocationsOptions, TFlatLabelAllLocationsOptions, TLabelAllLocationFlatLabelOptions, TLabelAllLocationFloatingLabelOptions, TEnableBlueDotOptions, TFloatingLabelAppearance, TFlatLabelAppearance, CAMERA_EVENT_PAYLOAD, TMapClickEvent, TGetPolygonsAtCoordinateOptions } from '@mappedin/mappedin-js/renderer/MapView.types';
-    export { BEARING_TYPE, ACTION_TYPE } from '@mappedin/mappedin-js/navigator';
-    export type { IDirectionsResult, E_MESSAGES as E_GET_DIRECTIONS_MESSAGES } from '@mappedin/mappedin-js/navigator';
-    export type { TGetVenueBundleOptions, TGetVenueOptions, TMappedinDirective, TShowVenueOptions, TMappedinOfflineSearchOptions, TMappedinOfflineSearchResult, TMappedinOfflineSearchSuggestions, TMappedinOfflineSearchAllOptions, TMappedinOfflineAllSearchMatch } from '@mappedin/mappedin-js/get-venue';
-    export { MappedinLocation, MappedinPolygon, MappedinNode, MappedinCategory, MappedinMap, MappedinEvent, MappedinMapGroup, MappedinVenue, MappedinVortex, MappedinDirections, MappedinNavigatable, MappedinCoordinate, MappedinRankings, MAP_RENDER_MODE, OfflineSearch, MappedinCollectionType } from '@mappedin/mappedin-js/get-venue';
-    export type { TSafeAreaInsets, TCameraTargets, TFocusOnCameraOptions, TCameraTransform, TCameraAnimationOptions } from '@mappedin/mappedin-js/renderer/Camera';
-}
-
 declare module '@mappedin/mappedin-js/renderer/MapView.Scene' {
     import { MappedinMap } from '@mappedin/mappedin-js/get-venue';
     import { ICore } from '@mappedin/mappedin-js/renderer/Core.interface';
@@ -6105,7 +6151,24 @@ declare module '@mappedin/mappedin-js/renderer/internal/Mappedin.MapObject' {
             loadMethodUsed: string | undefined;
             _dispose(objectToDispose: any): void;
             add(childObjectToAdd: any): void;
+            /**
+                * Convert lat/lon to local map position vector
+                */
             getPositionLatLon(lat: any, lon: any): any;
+            /**
+                * Previously, each map was centered around 0,0,0 and scaled to fit the map.
+                * With scene manager, each map is positioned and scaled relative to the base map/world
+                * Since most 3D objects (like blue dot) are added to the map via `getPositionLatLon`, they already
+                * have the map's matrix applied, on top of being affected as a child of the map's own transform
+                * This method inverts the map's matrix to resolve the double matrix application issue.
+                * TODO: investigate a better way to handle this
+                */
+            addToObject(child: any): void;
+            /**
+                * Translates objects that are added to the map (such as blue dot), assuming they are added via `getPositionLatLon`,
+                * or `convertTo3DMapPosition`, where the map's matrix has already been applied.
+                */
+            translateChild(child: any, position: any): void;
             getMapScale(): null;
             getNorth(): null;
             disableAllImageFlipping(): void;