@mappedin/react-native-sdk 5.3.0 → 5.4.0

package/dist/index.d.ts

@@ -305,6 +305,10 @@ declare module '@mappedin/react-native-sdk/wrappers/react-native-sdk/src/MiMapVi
                 * Get all polygons that intersect with a specific coordinate.
                 */
             getPolygonsAtCoordinate(coordinate: MappedinCoordinate, options?: TGetPolygonsAtCoordinateOptions): Promise<MappedinPolygon[]>;
+            /**
+                * Get all polygons that intersect with a specific screen coordinate.
+                */
+            getPolygonsAtScreenCoordinate(x: number, y: number, options?: TGetPolygonsAtCoordinateOptions): Promise<MappedinPolygon[]>;
             /**
              Camera controls interface
              */
@@ -1867,6 +1871,7 @@ declare module '@mappedin/react-native-sdk/wrappers/common/events' {
             ADD_SEARCH_QUERY = "ADD_SEARCH_QUERY",
             CLICK = "CLICK",
             GET_POLYGONS_AT_COORDINATE = "GET_POLYGONS_AT_COORDINATE",
+            GET_POLYGONS_AT_SCREEN_COORDINATE = "GET_POLYGONS_AT_SCREEN_COORDINATE",
             CREATE_TOOLTIP = "CREATE_TOOLTIP",
             CREATE_CUSTOM_TOOLTIP = "CREATE_CUSTOM_TOOLTIP",
             REMOVE_TOOLTIP = "REMOVE_TOOLTIP"
@@ -2204,6 +2209,11 @@ declare module '@mappedin/react-native-sdk/wrappers/common/payloads' {
                     coordinate: TSerializedCoordinate;
                     options?: TGetPolygonsAtCoordinateOptions;
             };
+            [EVENT.GET_POLYGONS_AT_SCREEN_COORDINATE]: {
+                    x: number;
+                    y: number;
+                    options?: TGetPolygonsAtCoordinateOptions;
+            };
             [EVENT.CREATE_TOOLTIP]: {
                     nodeOrCoordinate: TSerializedNode | TSerializedCoordinate;
                     contentHtml: string;
@@ -2309,7 +2319,7 @@ declare module '@mappedin/react-native-sdk/wrappers/common/pub-sub' {
 declare module '@mappedin/react-native-sdk/core/packages/renderer/Core.interface' {
     import { MappedinMap, Mappedin, MappedinCoordinate, MappedinPolygon, MappedinNode } from '@mappedin/react-native-sdk/core/packages/get-venue';
     import { Vector2, Vector3 } from 'three';
-    import { changeListenerFn, TMapViewOptions } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
+    import { changeListenerFn, TGetPolygonsAtCoordinateOptions, TMapViewOptions } from '@mappedin/react-native-sdk/core/packages/renderer/MapView.types';
     import RENDER from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.RenderTasks';
     import { INTERNAL_EVENT_PAYLOAD } from '@mappedin/react-native-sdk/core/packages/renderer/MapView';
     import { TPadding } from '@mappedin/react-native-sdk/core/packages/renderer';
@@ -2461,6 +2471,22 @@ declare module '@mappedin/react-native-sdk/core/packages/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;
@@ -3072,6 +3098,14 @@ declare module '@mappedin/react-native-sdk/wrappers/common/controller' {
                                     options?: import("../../core/packages/renderer").TGetPolygonsAtCoordinateOptions | undefined;
                             };
                     };
+                    GET_POLYGONS_AT_SCREEN_COORDINATE: {
+                            msgID?: string | undefined;
+                            data: {
+                                    x: number;
+                                    y: number;
+                                    options?: import("../../core/packages/renderer").TGetPolygonsAtCoordinateOptions | undefined;
+                            };
+                    };
                     CREATE_TOOLTIP: {
                             msgID?: string | undefined;
                             data: {
@@ -3176,7 +3210,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
     }
     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;
@@ -3234,6 +3268,10 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
                                 */
                             inactive?: string;
                     };
+                    /**
+                        * Size of bounding box of SVG icon
+                        */
+                    iconSize?: number;
                     /**
                         * SVG of icon to place inside Floating Label
                         */
@@ -3267,6 +3305,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
                             active: string;
                             inactive: string;
                     };
+                    iconSize?: number;
                     icon?: string;
                     iconVisibilityThreshold?: number;
             };
@@ -3331,6 +3370,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
             static imagePromiseCache: {
                     [key in number]?: Promise<HTMLImageElement>;
             };
+            get pinCanvasSize(): number;
             draw(context: CanvasRenderingContext2D): void;
     }
     export default FloatingLabel;
@@ -3597,8 +3637,10 @@ declare module '@mappedin/react-native-sdk/core/packages/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}
                 */
@@ -4785,7 +4827,7 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/MappedinNavig
     import type { MappedinPolygon } from '@mappedin/react-native-sdk/core/packages/get-venue/MappedinPolygon';
     import type { MappedinNode } from '@mappedin/react-native-sdk/core/packages/get-venue/MappedinNode';
     import { MappedinDestinationSet } from '@mappedin/react-native-sdk/core/packages/get-venue/MappedinDestinationSet';
-    import type { Mappedin } from '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin';
+    import { Mappedin } from '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin';
     import { MappedinDirections } from '@mappedin/react-native-sdk/core/packages/get-venue/MappedinDirections';
     export type TDirectionToOptions = {
             accessible?: boolean;
@@ -4808,7 +4850,7 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/MappedinNavig
 }
 
 declare module '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin.CustomerAnalytics' {
-    import { MappedinCategory, MappedinLocation } from '@mappedin/react-native-sdk/core/packages/get-venue';
+    import { MappedinCategory, MappedinLocation, MappedinNavigatable } from '@mappedin/react-native-sdk/core/packages/get-venue';
     type AnalyticsOptions = {
             clientId?: string;
             clientSecret?: string;
@@ -4822,7 +4864,12 @@ declare module '@mappedin/react-native-sdk/core/packages/get-venue/Mappedin.Cust
     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;
@@ -5985,6 +6032,19 @@ declare module '@mappedin/react-native-sdk/core/packages/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
@@ -6560,8 +6620,8 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/MapView.SceneM
 
 declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollider' {
     import SmartCollisionEngine from '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappedin.SmartCollisionEngine';
-    import { Vector3 } from 'three';
     import { Rectangle } from '@mappedin/react-native-sdk/core/packages/renderer/internal/quad-tree';
+    import { MappedinCoordinate, MappedinNode } from '@mappedin/react-native-sdk/core/packages/renderer/index.rn';
     export type TRange = [number, number, number, number];
     type TCustomCollider<T> = ICollider & T;
     export type TColliderStrategyProps = {
@@ -6588,6 +6648,10 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         'show' = 1,
         'hide' = 2
     }
+    export type TColliderPosition = {
+        nodeOrCoordinate: MappedinNode | MappedinCoordinate;
+        height?: number;
+    };
     export interface ICollider {
         dimensions: TDimensions;
         screenPosition: [number, number];
@@ -6606,7 +6670,7 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
         offscreen?: boolean;
         setAction: (action: EColliderAction) => void;
         action?: EColliderAction;
-        position: Vector3;
+        position: TColliderPosition;
         __engine?: SmartCollisionEngine;
         enable: () => void;
         disable: () => void;
@@ -7710,7 +7774,24 @@ declare module '@mappedin/react-native-sdk/core/packages/renderer/internal/Mappe
             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;