@mapvx/web-js 1.0.0

package/dist/es/controllers/routeController.d.ts

@@ -0,0 +1,161 @@
+import { type InternalMapVXMap } from "../map/map";
+import { type InternalAnimationConfig, type InternalAnimationDrawingConfig } from "../domain/models/animation";
+import { type LatLng } from "../domain/models/latLng";
+import { type MVXRoute } from "../domain/models/route";
+import { type InternalDrawRouteConfiguration } from "../domain/models/routeConfiguration";
+/**
+ * Represents the controller for routes on the map.
+ * Supports multiple simultaneous routes with independent customizations,
+ * animations, and lifecycle management.
+ * @group Routes
+ */
+export declare class RouteController {
+    private readonly mapvxMap;
+    private readonly routes;
+    private lastAddedRouteId?;
+    constructor(map: InternalMapVXMap);
+    private get map();
+    /**
+     * Resolve a route instance by ID, or fall back to the last added route.
+     */
+    private resolveInstance;
+    /**
+     * Add MapLibre sources and layers for a single route instance.
+     */
+    private addSourcesAndLayersForRoute;
+    /**
+     * Remove MapLibre sources and layers for a single route instance.
+     */
+    private removeSourcesAndLayersForRoute;
+    /**
+     * Re-add sources and layers for all active routes.
+     * Should be called when the map style is reloaded.
+     */
+    addSourcesAndLayers(): void;
+    /**
+     * Add a route to the map.
+     * @param route The route to add.
+     * @param drawConfig The draw configuration for the route.
+     */
+    addRoute(route: MVXRoute, drawConfig: InternalDrawRouteConfiguration): void;
+    /**
+     * Update the visual progress of a route based on an external user position.
+     * Splits the route into behind (already traveled) and ahead (remaining) sections
+     * at the point on the route closest to the given position.
+     *
+     * @param routeId The ID of the route to update.
+     * @param position The current user position (will be projected onto the route).
+     * @param behindDrawConfig The draw configuration for the behind (traveled) portion.
+     */
+    updateRouteProgress(routeId: string, position: LatLng, behindDrawConfig: InternalDrawRouteConfiguration): void;
+    /**
+     * Project a point onto a line segment and return the clamped fraction and squared distance.
+     */
+    private projectPointToSegment;
+    private setSourceData;
+    private setCurrentSourceData;
+    private setLayerPaint;
+    private preparePaintForLayer;
+    /**
+     * Update the filter of the layer referenced with a ID.
+     *
+     * @see {@link https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#setfilter}
+     * @param layerId The ID for the layer.
+     */
+    private updateLayerFilter;
+    /**
+     * Determines the correct floor_key for a route step.
+     * Outdoor steps (without startInsideFloor) should use the outdoor floor key,
+     * not the current floor which might be indoor.
+     * Elevator steps are always drawn on startInsideFloor; floor is updated to endInsideFloor
+     * only when the step completes (see prepareForNextStep / animateStep).
+     * @param step The route step to determine the floor_key for
+     * @returns The floor_key string to use for the step
+     */
+    private getFloorKeyForStep;
+    private createFeaturesFrom;
+    /**
+     * Update the layers for all active routes.
+     * @param floorId The floor ID to update the layers for.
+     */
+    updateRouteLayers(floorId: string): void;
+    /**
+     * Update the visibility of route markers for all active routes.
+     * @param floorId The floor ID to update the visibility for.
+     */
+    updateRouteMarkerVisibility(floorId: string): void;
+    private updatePlaceFloorForRouting;
+    /**
+     * Start the animation of a route.
+     * @param route The route to animate.
+     * @param drawConfig The draw configuration for the route.
+     * @param animationConfig The animation configuration for the route.
+     */
+    startAnimating(route: MVXRoute, drawConfig: InternalAnimationDrawingConfig, animationConfig: InternalAnimationConfig): void;
+    private clearRouteInstance;
+    /**
+     * Remove a route from the map.
+     * @param routeId The ID of the route to remove. If not provided, removes the last added route.
+     */
+    removeRoute(routeId?: string): void;
+    /**
+     * Remove all routes from the map.
+     */
+    removeAllRoutes(): void;
+    /**
+     * Get the IDs of all active routes on the map.
+     * @returns Array of route IDs.
+     */
+    getRouteIds(): string[];
+    private internalPause;
+    /**
+     * Pause the animation of a route.
+     * @param routeId The ID of the route. If not provided, pauses the last added route.
+     */
+    pauseAnimation(routeId?: string): void;
+    private internalResume;
+    /**
+     * Resume the animation of a route.
+     * @param routeId The ID of the route. If not provided, resumes the last added route.
+     */
+    resumeAnimation(routeId?: string): void;
+    /**
+     * Restart the animation of a route.
+     * @param routeId The ID of the route. If not provided, restarts the last added route.
+     */
+    restartAnimation(routeId?: string): void;
+    /**
+     * Stop the animation of a route.
+     * @param routeId The ID of the route. If not provided, stops the last added route.
+     */
+    stopAnimation(routeId?: string): void;
+    /**
+     * Add a step animation to a route.
+     * @param route The route to animate.
+     * @param drawConfig The draw configuration for the route.
+     * @param animationConfig The animation configuration for the route.
+     */
+    addStepAnimation(route: MVXRoute, drawConfig: InternalAnimationDrawingConfig, animationConfig: InternalAnimationConfig): void;
+    /**
+     * Animate the next step of a route.
+     * @param routeId The ID of the route. If not provided, uses the last added route.
+     */
+    nextStepAnimation(routeId?: string): void;
+    /**
+     * Go to the previous step of a route.
+     * @param routeId The ID of the route. If not provided, uses the last added route.
+     */
+    previousStepAnimation(routeId?: string): void;
+    /**
+     * Center on the current step of a route.
+     * @param routeId The ID of the route. If not provided, uses the last added route.
+     */
+    centerOnCurrentStep(routeId?: string): void;
+    private prepareForNextStep;
+    private animateStep;
+    private setMarkerLngLat;
+    private setMarkerRotation;
+    setMarkerFloor(floorId?: string, routeId?: string): void;
+    private cameraFollow;
+}
+//# sourceMappingURL=routeController.d.ts.map

package/dist/es/controllers/routeController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeController.d.ts","sourceRoot":"","sources":["../../../src/controllers/routeController.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACpC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAErD,OAAO,EAAE,KAAK,QAAQ,EAAqB,MAAM,wBAAwB,CAAA;AACzE,OAAO,EAAE,KAAK,8BAA8B,EAAE,MAAM,qCAAqC,CAAA;AAiBzF;;;;;GAKG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwC;IAC/D,OAAO,CAAC,gBAAgB,CAAC,CAAQ;gBAErB,GAAG,EAAE,gBAAgB;IAIjC,OAAO,KAAK,GAAG,GAEd;IAED;;OAEG;IACH,OAAO,CAAC,eAAe;IAKvB;;OAEG;IACH,OAAO,CAAC,2BAA2B;IA0CnC;;OAEG;IACH,OAAO,CAAC,8BAA8B;IAgBtC;;;OAGG;IACH,mBAAmB,IAAI,IAAI;IAM3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,8BAA8B,GAAG,IAAI;IAU3E;;;;;;;;OAQG;IACH,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,gBAAgB,EAAE,8BAA8B,GAC/C,IAAI;IAuGP;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAsB7B,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,oBAAoB;IAsC5B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IA+B1B,OAAO,CAAC,kBAAkB;IAc1B;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQxC;;;OAGG;IACH,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAQlD,OAAO,CAAC,0BAA0B;IASlC;;;;;OAKG;IACH,cAAc,CACZ,KAAK,EAAE,QAAQ,EACf,UAAU,EAAE,8BAA8B,EAC1C,eAAe,EAAE,uBAAuB,GACvC,IAAI;IAiEP,OAAO,CAAC,kBAAkB;IAqB1B;;;OAGG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAYnC;;OAEG;IACH,eAAe,IAAI,IAAI;IASvB;;;OAGG;IACH,WAAW,IAAI,MAAM,EAAE;IAIvB,OAAO,CAAC,aAAa;IAOrB;;;OAGG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAMtC,OAAO,CAAC,cAAc;IAUtB;;;OAGG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAMvC;;;OAGG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAuExC;;;OAGG;IACH,aAAa,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAUrC;;;;;OAKG;IACH,gBAAgB,CACd,KAAK,EAAE,QAAQ,EACf,UAAU,EAAE,8BAA8B,EAC1C,eAAe,EAAE,uBAAuB;IA0G1C;;;OAGG;IACH,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAiCzC;;;OAGG;IACH,qBAAqB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAwE7C;;;OAGG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAuB3C,OAAO,CAAC,kBAAkB;IA4D1B,OAAO,CAAC,WAAW;IAoJnB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,iBAAiB;IAYzB,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAKxD,OAAO,CAAC,YAAY;CAQrB"}