@vcmap/core 5.0.3 → 5.1.0-rc.2

package/dist/src/util/flight/flightHelpers.d.ts

@@ -0,0 +1,29 @@
+import { CatmullRomSpline, LinearSpline, QuaternionSpline } from '@vcmap-cesium/engine';
+import type { FeatureCollection, Point as GeojsonPoint, LineString as GeojsonLineString } from 'geojson';
+import type { Coordinate } from 'ol/coordinate.js';
+import type { default as FlightInstance, FlightInstanceOptions } from './flightInstance.js';
+import { FlightAnchorGeojsonFeature } from './flightAnchor.js';
+/**
+ * exports a flight as GeoJson FeatureCollection
+ * {Object} vcsMeta.flightOptions: flight settings
+ * {Array} feature: viewpoints
+ *
+ * @param flightInstance
+ */
+export declare function exportFlightAsGeoJson(flightInstance: FlightInstance): FeatureCollection<GeojsonPoint>;
+export declare function getSplineAndTimesForInstance(flightInstance: FlightInstance): {
+    destinationSpline: CatmullRomSpline | LinearSpline;
+    quaternionSpline: QuaternionSpline;
+    times: number[];
+};
+export declare function getFlightPathCoordinatesFromInstance(flightInstance: FlightInstance): Coordinate[];
+export declare function exportFlightPathAsGeoJson(flightInstance: FlightInstance): FeatureCollection<GeojsonLineString>;
+/**
+ * parses source and creates a flight Object
+ * @param {Object} collection GeoJSON
+ * containing:
+ * {Object} vcsMeta containing flightOptions
+ * {Array} features anchors of flightInstance
+ * @returns
+ */
+export declare function parseFlightOptionsFromGeoJson(collection: FeatureCollection<GeojsonPoint, FlightAnchorGeojsonFeature['properties']>): FlightInstanceOptions;

package/dist/src/util/flight/flightHelpers.js

@@ -0,0 +1,134 @@
+import { HeadingPitchRoll, Cartesian3, Quaternion, CatmullRomSpline, LinearSpline, QuaternionSpline, Cartographic, Math as CesiumMath, } from '@vcmap-cesium/engine';
+import { vcsMetaVersion } from '../../layer/vectorProperties.js';
+/**
+ * exports a flight as GeoJson FeatureCollection
+ * {Object} vcsMeta.flightOptions: flight settings
+ * {Array} feature: viewpoints
+ *
+ * @param flightInstance
+ */
+export function exportFlightAsGeoJson(flightInstance) {
+    const options = flightInstance.toJSON();
+    const flightOptions = {};
+    if (options.loop != null) {
+        flightOptions.loop = options.loop;
+    }
+    if (options.interpolation != null) {
+        flightOptions.interpolation = options.interpolation;
+    }
+    if (options.multiplier != null) {
+        flightOptions.multiplier = options.multiplier;
+    }
+    return {
+        type: 'FeatureCollection',
+        features: options.anchors ?? [],
+        vcsMeta: {
+            version: vcsMetaVersion,
+            flightOptions: options,
+        },
+    };
+}
+export function getSplineAndTimesForInstance(flightInstance) {
+    const { loop, anchors } = flightInstance;
+    const anchorsArray = [...anchors];
+    const length = loop ? anchors.size + 1 : anchors.size;
+    const points = new Array(length);
+    const quaternions = new Array(length);
+    const times = new Array(length);
+    anchorsArray.forEach((anchor, index) => {
+        points[index] = Cartesian3.fromDegrees(anchor.coordinate[0], anchor.coordinate[1], anchor.coordinate[2]);
+        quaternions[index] = Quaternion.fromHeadingPitchRoll(HeadingPitchRoll.fromDegrees(anchor.heading, anchor.pitch, anchor.roll));
+        if (index > 0) {
+            let previousDuration = anchorsArray[index - 1].duration;
+            if (!previousDuration) {
+                previousDuration =
+                    Cartesian3.distance(points[index - 1], points[index]) / 300 || 1;
+            }
+            times[index] = times[index - 1] + previousDuration;
+        }
+        else {
+            times[index] = 0;
+        }
+    });
+    if (loop) {
+        points[length - 1] = Cartesian3.fromDegrees(anchorsArray[0].coordinate[0], anchorsArray[0].coordinate[1], anchorsArray[0].coordinate[2]);
+        quaternions[length - 1] = Quaternion.fromHeadingPitchRoll(HeadingPitchRoll.fromDegrees(anchorsArray[0].heading, anchorsArray[0].pitch, anchorsArray[0].roll));
+        let loopDuration = anchorsArray[length - 2].duration;
+        if (!loopDuration) {
+            loopDuration =
+                Cartesian3.distance(points[length - 2], points[length - 1]) / 300 || 1;
+        }
+        times[length - 1] = times[length - 2] + loopDuration;
+    }
+    const destinationSpline = flightInstance.interpolation === 'spline'
+        ? new CatmullRomSpline({ times, points })
+        : new LinearSpline({ times, points });
+    const quaternionSpline = new QuaternionSpline({ times, points: quaternions });
+    return {
+        destinationSpline,
+        quaternionSpline,
+        times,
+    };
+}
+export function getFlightPathCoordinatesFromInstance(flightInstance) {
+    const pathCoordinates = [];
+    if (flightInstance.interpolation === 'spline') {
+        const { destinationSpline, times } = getSplineAndTimesForInstance(flightInstance);
+        const scratchCartographic = new Cartographic();
+        const addCoordinateFromTime = (time) => {
+            Cartographic.fromCartesian(destinationSpline.evaluate(time), undefined, scratchCartographic);
+            pathCoordinates.push([
+                CesiumMath.toDegrees(scratchCartographic.longitude),
+                CesiumMath.toDegrees(scratchCartographic.latitude),
+                scratchCartographic.height,
+            ]);
+        };
+        const endTime = times[times.length - 1];
+        const step = endTime / 0.2 > 500 ? endTime / 500 : 0.2;
+        for (let i = 0; i < endTime; i += step) {
+            addCoordinateFromTime(i);
+        }
+        addCoordinateFromTime(endTime);
+    }
+    else {
+        for (const anchor of flightInstance.anchors) {
+            pathCoordinates.push(anchor.coordinate);
+        }
+        if (flightInstance.loop) {
+            pathCoordinates.push(pathCoordinates[0]);
+        }
+    }
+    return pathCoordinates;
+}
+export function exportFlightPathAsGeoJson(flightInstance) {
+    const coordinates = getFlightPathCoordinatesFromInstance(flightInstance);
+    return {
+        type: 'FeatureCollection',
+        features: [
+            {
+                type: 'Feature',
+                geometry: {
+                    type: 'LineString',
+                    coordinates,
+                },
+                properties: {},
+            },
+        ],
+    };
+}
+/**
+ * parses source and creates a flight Object
+ * @param {Object} collection GeoJSON
+ * containing:
+ * {Object} vcsMeta containing flightOptions
+ * {Array} features anchors of flightInstance
+ * @returns
+ */
+export function parseFlightOptionsFromGeoJson(collection) {
+    const flightOptions = collection.vcsMeta && collection.vcsMeta.flightOptions
+        ? collection.vcsMeta.flightOptions
+        : {};
+    flightOptions.anchors = collection.features;
+    return flightOptions;
+}
+//# sourceMappingURL=flightHelpers.js.map

package/dist/src/util/flight/flightHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flightHelpers.js","sourceRoot":"","sources":["../../../../src/util/flight/flightHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,IAAI,IAAI,UAAU,GACnB,MAAM,sBAAsB,CAAC;AAa9B,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAGjE;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,cAA8B;IAE9B,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;IACxC,MAAM,aAAa,GAAuB,EAAE,CAAC;IAC7C,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE;QACxB,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;KACnC;IACD,IAAI,OAAO,CAAC,aAAa,IAAI,IAAI,EAAE;QACjC,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;KACrD;IACD,IAAI,OAAO,CAAC,UAAU,IAAI,IAAI,EAAE;QAC9B,aAAa,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;KAC/C;IAED,OAAO;QACL,IAAI,EAAE,mBAAmB;QACzB,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;QAC/B,OAAO,EAAE;YACP,OAAO,EAAE,cAAc;YACvB,aAAa,EAAE,OAAO;SACvB;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,cAA8B;IAKzE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;IACzC,MAAM,YAAY,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACtD,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,CAAiB,CAAC;IACjD,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,MAAM,CAAiB,CAAC;IACtD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,CAAa,CAAC;IAE5C,YAAY,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACrC,MAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,WAAW,CACpC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EACpB,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EACpB,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CACrB,CAAC;QACF,WAAW,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,oBAAoB,CAClD,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CACxE,CAAC;QAEF,IAAI,KAAK,GAAG,CAAC,EAAE;YACb,IAAI,gBAAgB,GAAG,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;YACxD,IAAI,CAAC,gBAAgB,EAAE;gBACrB,gBAAgB;oBACd,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;aACpE;YACD,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,gBAAgB,CAAC;SACpD;aAAM;YACL,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SAClB;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,IAAI,EAAE;QACR,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CACzC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAC7B,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAC7B,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAC9B,CAAC;QACF,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,oBAAoB,CACvD,gBAAgB,CAAC,WAAW,CAC1B,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,EACvB,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,EACrB,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CACrB,CACF,CAAC;QAEF,IAAI,YAAY,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;QACrD,IAAI,CAAC,YAAY,EAAE;YACjB,YAAY;gBACV,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;SAC1E;QACD,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,YAAY,CAAC;KACtD;IAED,MAAM,iBAAiB,GACrB,cAAc,CAAC,aAAa,KAAK,QAAQ;QACvC,CAAC,CAAC,IAAI,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QACzC,CAAC,CAAC,IAAI,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IAE9E,OAAO;QACL,iBAAiB;QACjB,gBAAgB;QAChB,KAAK;KACN,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oCAAoC,CAClD,cAA8B;IAE9B,MAAM,eAAe,GAAiB,EAAE,CAAC;IAEzC,IAAI,cAAc,CAAC,aAAa,KAAK,QAAQ,EAAE;QAC7C,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,GAChC,4BAA4B,CAAC,cAAc,CAAC,CAAC;QAC/C,MAAM,mBAAmB,GAAG,IAAI,YAAY,EAAE,CAAC;QAC/C,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAQ,EAAE;YACnD,YAAY,CAAC,aAAa,CACxB,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAe,EAC9C,SAAS,EACT,mBAAmB,CACpB,CAAC;YACF,eAAe,CAAC,IAAI,CAAC;gBACnB,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC;gBACnD,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,QAAQ,CAAC;gBAClD,mBAAmB,CAAC,MAAM;aAC3B,CAAC,CAAC;QACL,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,OAAO,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,IAAI,IAAI,EAAE;YACtC,qBAAqB,CAAC,CAAC,CAAC,CAAC;SAC1B;QACD,qBAAqB,CAAC,OAAO,CAAC,CAAC;KAChC;SAAM;QACL,KAAK,MAAM,MAAM,IAAI,cAAc,CAAC,OAAO,EAAE;YAC3C,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;SACzC;QAED,IAAI,cAAc,CAAC,IAAI,EAAE;YACvB,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C;KACF;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,cAA8B;IAE9B,MAAM,WAAW,GAAG,oCAAoC,CAAC,cAAc,CAAC,CAAC;IAEzE,OAAO;QACL,IAAI,EAAE,mBAAmB;QACzB,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,YAAY;oBAClB,WAAW;iBACZ;gBACD,UAAU,EAAE,EAAE;aACf;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,6BAA6B,CAC3C,UAGC;IAED,MAAM,aAAa,GACjB,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,aAAa;QACpD,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,aAAa;QAClC,CAAC,CAAC,EAAE,CAAC;IAET,aAAa,CAAC,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC;IAC5C,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/dist/src/util/flight/flightInstance.d.ts

@@ -0,0 +1,57 @@
+import VcsObject, { VcsObjectOptions } from '../../vcsObject.js';
+import VcsEvent from '../../vcsEvent.js';
+import { FlightAnchor, FlightAnchorGeojsonFeature } from './flightAnchor.js';
+import IndexedCollection from '../indexedCollection.js';
+export type FlightInterpolation = 'spline' | 'linear';
+export type FlightInstanceMeta = VcsObjectOptions & {
+    multiplier?: number;
+    interpolation?: FlightInterpolation;
+    loop?: boolean;
+};
+export type FlightInstanceOptions = FlightInstanceMeta & {
+    anchors?: FlightAnchorGeojsonFeature[];
+    url?: string;
+};
+declare class FlightInstance extends VcsObject {
+    static get className(): string;
+    anchors: IndexedCollection<FlightAnchor>;
+    private _multiplier;
+    private _loop;
+    private _interpolation;
+    /**
+     * Raised when anchors are added, removed, moved or changed
+     */
+    anchorsChanged: VcsEvent<void>;
+    /**
+     * Raised when multiplier, loop or interpolation changes.
+     */
+    propertyChanged: VcsEvent<"multiplier" | "loop" | "interpolation">;
+    private readonly _url;
+    private _readyPromise;
+    private _anchorListeners;
+    static getDefaultOptions(): FlightInstanceOptions;
+    constructor(options: FlightInstanceOptions);
+    get initialized(): boolean;
+    get multiplier(): number;
+    set multiplier(value: number);
+    /**
+     * Whether this flight represents a circular flight path or not
+     */
+    get loop(): boolean;
+    set loop(value: boolean);
+    get interpolation(): FlightInterpolation;
+    set interpolation(value: FlightInterpolation);
+    initialize(): Promise<void>;
+    /**
+     * checks if this flightInstance is valid. To be valid, a flight must have at least 2 anchors.
+     * @returns
+     */
+    isValid(): boolean;
+    /**
+     * returns an options object for this flight. if this flight was configured via an URL, only the url will be configured.
+     * @returns
+     */
+    toJSON(): FlightInstanceOptions;
+    destroy(): void;
+}
+export default FlightInstance;

package/dist/src/util/flight/flightInstance.js

@@ -0,0 +1,166 @@
+import { parseBoolean, parseNumber } from '@vcsuite/parsers';
+import { check, oneOf } from '@vcsuite/check';
+import VcsObject from '../../vcsObject.js';
+import VcsEvent from '../../vcsEvent.js';
+import { parseFlightOptionsFromGeoJson } from './flightHelpers.js';
+import { requestJson } from '../fetch.js';
+import { anchorFromGeojsonFeature, anchorToGeojsonFeature, } from './flightAnchor.js';
+import IndexedCollection from '../indexedCollection.js';
+import { destroyCollection } from '../../vcsModuleHelpers.js';
+class FlightInstance extends VcsObject {
+    static get className() {
+        return 'FlightInstance';
+    }
+    anchors;
+    _multiplier;
+    _loop;
+    _interpolation;
+    /**
+     * Raised when anchors are added, removed, moved or changed
+     */
+    anchorsChanged = new VcsEvent();
+    /**
+     * Raised when multiplier, loop or interpolation changes.
+     */
+    propertyChanged = new VcsEvent();
+    _url;
+    _readyPromise = null;
+    _anchorListeners = new Map();
+    static getDefaultOptions() {
+        return {
+            multiplier: 1,
+            loop: false,
+            interpolation: 'spline',
+            anchors: [],
+        };
+    }
+    constructor(options) {
+        super(options);
+        const defaultOptions = FlightInstance.getDefaultOptions();
+        const anchorsArray = (options.anchors ?? defaultOptions.anchors)
+            .map(anchorFromGeojsonFeature)
+            .filter((a) => !!a);
+        this.anchors = IndexedCollection.from(anchorsArray);
+        this._multiplier = parseNumber(options.multiplier, defaultOptions.multiplier);
+        this._loop = parseBoolean(options.loop, defaultOptions.loop);
+        this._interpolation =
+            options.interpolation || defaultOptions.interpolation;
+        this.anchorsChanged = new VcsEvent();
+        this._url = options.url;
+    }
+    get initialized() {
+        return !!this._readyPromise;
+    }
+    get multiplier() {
+        return this._multiplier;
+    }
+    set multiplier(value) {
+        check(value, Number);
+        if (this._multiplier !== value) {
+            this._multiplier = value;
+            this.propertyChanged.raiseEvent('multiplier');
+        }
+    }
+    /**
+     * Whether this flight represents a circular flight path or not
+     */
+    get loop() {
+        return this._loop;
+    }
+    set loop(value) {
+        check(value, Boolean);
+        if (this._loop !== value) {
+            this._loop = value;
+            this.propertyChanged.raiseEvent('loop');
+        }
+    }
+    get interpolation() {
+        return this._interpolation;
+    }
+    set interpolation(value) {
+        check(value, oneOf('linear', 'spline'));
+        if (this._interpolation !== value) {
+            this._interpolation = value;
+            this.propertyChanged.raiseEvent('interpolation');
+        }
+    }
+    initialize() {
+        if (!this._readyPromise) {
+            if (this._url) {
+                this._readyPromise = requestJson(this._url).then((collection) => {
+                    const instance = parseFlightOptionsFromGeoJson(collection);
+                    (instance.anchors ?? [])
+                        .map(anchorFromGeojsonFeature)
+                        .filter((a) => !!a)
+                        .forEach((anchor) => this.anchors.add(anchor));
+                    this._multiplier = instance.multiplier ?? this._multiplier;
+                    this._loop = instance.loop ?? this._loop;
+                    this._interpolation = instance.interpolation ?? this._interpolation;
+                });
+            }
+            else {
+                this._readyPromise = Promise.resolve();
+            }
+            for (const anchor of this.anchors) {
+                this._anchorListeners.set(anchor.name, anchor.changed.addEventListener(() => {
+                    this.anchorsChanged.raiseEvent();
+                }));
+            }
+            this.anchors.added.addEventListener((anchor) => {
+                this._anchorListeners.set(anchor.name, anchor.changed.addEventListener(() => {
+                    this.anchorsChanged.raiseEvent();
+                }));
+                this.anchorsChanged.raiseEvent();
+            });
+            this.anchors.removed.addEventListener((anchor) => {
+                this._anchorListeners.get(anchor.name)?.();
+                this._anchorListeners.delete(anchor.name);
+                this.anchorsChanged.raiseEvent();
+            });
+            this.anchors.moved.addEventListener(() => {
+                this.anchorsChanged.raiseEvent();
+            });
+        }
+        return this._readyPromise;
+    }
+    /**
+     * checks if this flightInstance is valid. To be valid, a flight must have at least 2 anchors.
+     * @returns
+     */
+    isValid() {
+        return this.anchors.size >= 2;
+    }
+    /**
+     * returns an options object for this flight. if this flight was configured via an URL, only the url will be configured.
+     * @returns
+     */
+    toJSON() {
+        const config = super.toJSON();
+        if (this._url) {
+            config.url = this._url;
+            return config;
+        }
+        const defaultOptions = FlightInstance.getDefaultOptions();
+        if (this._multiplier !== defaultOptions.multiplier) {
+            config.multiplier = this._multiplier;
+        }
+        if (this._loop !== defaultOptions.loop) {
+            config.loop = this._loop;
+        }
+        if (this._interpolation !== defaultOptions.interpolation) {
+            config.interpolation = this._interpolation;
+        }
+        if (this.anchors.size > 0) {
+            config.anchors = [...this.anchors].map(anchorToGeojsonFeature);
+        }
+        return config;
+    }
+    destroy() {
+        this.anchorsChanged.destroy();
+        destroyCollection(this.anchors);
+        this._anchorListeners.clear();
+        super.destroy();
+    }
+}
+export default FlightInstance;
+//# sourceMappingURL=flightInstance.js.map

package/dist/src/util/flight/flightInstance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flightInstance.js","sourceRoot":"","sources":["../../../../src/util/flight/flightInstance.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,SAA+B,MAAM,oBAAoB,CAAC;AACjE,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAEL,wBAAwB,EACxB,sBAAsB,GAEvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,iBAAiB,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAe9D,MAAM,cAAe,SAAQ,SAAS;IACpC,MAAM,KAAK,SAAS;QAClB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,OAAO,CAAkC;IAEjC,WAAW,CAAS;IAEpB,KAAK,CAAU;IAEf,cAAc,CAAsB;IAE5C;;OAEG;IACH,cAAc,GAAG,IAAI,QAAQ,EAAQ,CAAC;IAEtC;;OAEG;IACH,eAAe,GAAG,IAAI,QAAQ,EAA2C,CAAC;IAEzD,IAAI,CAAqB;IAElC,aAAa,GAAyB,IAAI,CAAC;IAE3C,gBAAgB,GAA4B,IAAI,GAAG,EAAE,CAAC;IAE9D,MAAM,CAAC,iBAAiB;QACtB,OAAO;YACL,UAAU,EAAE,CAAC;YACb,IAAI,EAAE,KAAK;YACX,aAAa,EAAE,QAAQ;YACvB,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED,YAAY,OAA8B;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,MAAM,cAAc,GAAG,cAAc,CAAC,iBAAiB,EAAE,CAAC;QAC1D,MAAM,YAAY,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,cAAc,CAAC,OAAQ,CAAC;aAC9D,GAAG,CAAC,wBAAwB,CAAC;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAqB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEzC,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEpD,IAAI,CAAC,WAAW,GAAG,WAAW,CAC5B,OAAO,CAAC,UAAU,EAClB,cAAc,CAAC,UAAU,CAC1B,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7D,IAAI,CAAC,cAAc;YACjB,OAAO,CAAC,aAAa,IAAI,cAAc,CAAC,aAAc,CAAC;QAEzD,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,EAAE,CAAC;QAErC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC;IAC1B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,UAAU,CAAC,KAAa;QAC1B,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAErB,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;YACzB,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;SAC/C;IACH,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,KAAc;QACrB,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAEtB,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,EAAE;YACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SACzC;IACH,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAI,aAAa,CAAC,KAA0B;QAC1C,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QAExC,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,EAAE;YACjC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;YAC5B,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;SAClD;IACH,CAAC;IAED,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,EAAE;gBACb,IAAI,CAAC,aAAa,GAAG,WAAW,CAK9B,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE;oBAC/B,MAAM,QAAQ,GAAG,6BAA6B,CAAC,UAAU,CAAC,CAAC;oBAC3D,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC;yBACrB,GAAG,CAAC,wBAAwB,CAAC;yBAC7B,MAAM,CAAC,CAAC,CAAC,EAAqB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;yBACrC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;oBACjD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW,CAAC;oBAC3D,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC;oBACzC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc,CAAC;gBACtE,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;aACxC;YACD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;gBACjC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CACvB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE;oBACnC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;gBACnC,CAAC,CAAC,CACH,CAAC;aACH;YAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,EAAE;gBAC7C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CACvB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE;oBACnC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;gBACnC,CAAC,CAAC,CACH,CAAC;gBACF,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;YACnC,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,EAAE;gBAC/C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;gBAC3C,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC1C,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;YACnC,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,EAAE;gBACvC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;YACnC,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAA2B,CAAC;QAEvD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;YACvB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,cAAc,GAAG,cAAc,CAAC,iBAAiB,EAAE,CAAC;QAC1D,IAAI,IAAI,CAAC,WAAW,KAAK,cAAc,CAAC,UAAU,EAAE;YAClD,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;SACtC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,cAAc,CAAC,IAAI,EAAE;YACtC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;SAC1B;QAED,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,aAAa,EAAE;YACxD,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC;SAC5C;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;YACzB,MAAM,CAAC,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;SAChE;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO;QACL,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAC9B,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC9B,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;CACF;AAED,eAAe,cAAc,CAAC"}

package/dist/src/util/flight/flightPlayer.d.ts

@@ -0,0 +1,30 @@
+import FlightInstance from './flightInstance.js';
+import VcsEvent from '../../vcsEvent.js';
+import VcsApp from '../../vcsApp.js';
+export type FlightPlayerClock = {
+    startTime: number;
+    endTime: number;
+    currentTime: number;
+    times: number[];
+    currentSystemTime?: number;
+};
+export type FlightPlayerState = 'playing' | 'paused' | 'stopped';
+export type FlightPlayer = {
+    readonly flightInstanceName: string;
+    readonly state: FlightPlayerState;
+    readonly stateChanged: VcsEvent<FlightPlayerState>;
+    readonly destroyed: VcsEvent<void>;
+    clock: FlightPlayerClock;
+    play(): void;
+    stop(): void;
+    pause(): void;
+    /**
+     * jumps to the given time
+     * @param time time in seconds
+     */
+    goToTime(time: number): void;
+    forward(): void;
+    backward(): void;
+    destroy(): void;
+};
+export declare function createFlightPlayer(instance: FlightInstance, app: VcsApp): Promise<FlightPlayer>;

package/dist/src/util/flight/flightPlayer.js

@@ -0,0 +1,247 @@
+import { HeadingPitchRoll, } from '@vcmap-cesium/engine';
+import { getLogger } from '@vcsuite/logger';
+import { check } from '@vcsuite/check';
+import CesiumMap from '../../map/cesiumMap.js';
+import { getSplineAndTimesForInstance } from './flightHelpers.js';
+import FlightInstance from './flightInstance.js';
+import VcsEvent from '../../vcsEvent.js';
+import VcsApp from '../../vcsApp.js';
+function getDefaultFlightPlayerClock() {
+    return {
+        startTime: 0,
+        endTime: 0,
+        currentTime: 0,
+        times: [],
+    };
+}
+export async function createFlightPlayer(instance, app) {
+    check(instance, FlightInstance);
+    check(app, VcsApp);
+    let cesiumMap = app.maps.activeMap instanceof CesiumMap
+        ? app.maps.activeMap
+        : app.maps.getByType(CesiumMap.className)[0];
+    if (!cesiumMap) {
+        throw new Error('Cannot start a flight player without a cesium map');
+    }
+    await instance.initialize();
+    const clock = getDefaultFlightPlayerClock();
+    let playerState = 'stopped';
+    const stateChanged = new VcsEvent();
+    const setState = (state) => {
+        playerState = state;
+        stateChanged.raiseEvent(playerState);
+    };
+    let destinationSpline;
+    let quaternionSpline;
+    let postRenderListener;
+    let backedBeforeTimeout;
+    let screenSpaceCameraController;
+    const stop = () => {
+        if (playerState !== 'stopped') {
+            if (postRenderListener) {
+                postRenderListener();
+                postRenderListener = undefined;
+            }
+            if (screenSpaceCameraController) {
+                screenSpaceCameraController.enableInputs = true;
+            }
+            setState('stopped');
+            clock.currentTime = 0;
+            clock.currentSystemTime = undefined;
+        }
+    };
+    const updateSplines = () => {
+        if (!instance.isValid()) {
+            stop();
+            Object.assign(clock, getDefaultFlightPlayerClock());
+        }
+        else {
+            const splines = getSplineAndTimesForInstance(instance);
+            ({ destinationSpline, quaternionSpline } = splines);
+            const { times } = splines;
+            clock.endTime = times[times.length - 1];
+            clock.times = times;
+        }
+    };
+    updateSplines();
+    const listeners = [
+        instance.anchorsChanged.addEventListener(updateSplines),
+        instance.propertyChanged.addEventListener((property) => {
+            if (property === 'interpolation' || property === 'loop') {
+                updateSplines();
+            }
+        }),
+        app.maps.mapActivated.addEventListener(() => {
+            stop();
+            if (app.maps.activeMap instanceof CesiumMap) {
+                cesiumMap = app.maps.activeMap;
+            }
+        }),
+    ];
+    const cesiumPostRender = (scene) => {
+        const time = Date.now() / 1000;
+        if (!clock.currentSystemTime) {
+            clock.currentSystemTime = time;
+        }
+        const seconds = time - clock.currentSystemTime;
+        clock.currentSystemTime = time;
+        if (playerState === 'paused') {
+            if (screenSpaceCameraController) {
+                screenSpaceCameraController.enableInputs = true;
+            }
+            return;
+        }
+        clock.currentTime += seconds * instance.multiplier;
+        if (clock.currentTime > clock.endTime) {
+            if (instance.loop && clock.endTime > 0) {
+                while (clock.currentTime > clock.endTime) {
+                    clock.currentTime -= clock.endTime;
+                }
+            }
+            else {
+                stop();
+            }
+        }
+        else if (clock.currentTime < clock.startTime) {
+            if (instance.loop) {
+                clock.currentTime = clock.endTime + clock.currentTime;
+            }
+            else {
+                clock.currentTime = clock.startTime;
+                return;
+            }
+        }
+        const view = {
+            destination: destinationSpline.evaluate(clock.currentTime),
+            orientation: HeadingPitchRoll.fromQuaternion(quaternionSpline.evaluate(clock.currentTime)),
+        };
+        scene.camera.setView(view);
+        if (playerState === 'playing') {
+            if (screenSpaceCameraController) {
+                screenSpaceCameraController.enableInputs = false;
+            }
+        }
+    };
+    const play = () => {
+        if (playerState === 'playing') {
+            return;
+        }
+        if (!(app.maps.activeMap instanceof CesiumMap)) {
+            getLogger('FlightPlayer').warning('cannot play without a cesium map active');
+            return;
+        }
+        if (playerState === 'paused') {
+            setState('playing');
+            return;
+        }
+        if (postRenderListener) {
+            postRenderListener();
+            postRenderListener = undefined;
+        }
+        const scene = cesiumMap.getScene();
+        if (!scene) {
+            return;
+        }
+        ({ screenSpaceCameraController } = scene);
+        postRenderListener = scene.postRender.addEventListener(cesiumPostRender);
+        clock.currentSystemTime = undefined;
+        setState('playing');
+    };
+    const goToTime = (time) => {
+        if (time > clock.endTime) {
+            getLogger('FlightPlayer').warning(`time: ${time} out of range`);
+            return;
+        }
+        clock.currentTime = time;
+        clock.currentSystemTime = undefined;
+        if (playerState !== 'playing') {
+            const view = {
+                destination: destinationSpline.evaluate(clock.currentTime),
+                orientation: HeadingPitchRoll.fromQuaternion(quaternionSpline.evaluate(clock.currentTime)),
+            };
+            cesiumMap.getScene()?.camera.setView(view);
+        }
+    };
+    const destroyed = new VcsEvent();
+    const destroy = () => {
+        if (postRenderListener) {
+            postRenderListener();
+            postRenderListener = undefined;
+        }
+        if (screenSpaceCameraController) {
+            screenSpaceCameraController.enableInputs = true;
+            screenSpaceCameraController = undefined;
+        }
+        if (backedBeforeTimeout != null) {
+            clearTimeout(backedBeforeTimeout);
+        }
+        listeners.forEach((cb) => {
+            cb();
+        });
+        stateChanged.destroy();
+        destroyed.raiseEvent();
+        destroyed.destroy();
+    };
+    listeners.push(app.flights.removed.addEventListener((flight) => {
+        if (flight === instance) {
+            destroy();
+        }
+    }), app.flights.added.addEventListener((flight) => {
+        if (flight.name === instance.name) {
+            destroy();
+        }
+    }));
+    return {
+        clock,
+        get flightInstanceName() {
+            return instance.name;
+        },
+        get state() {
+            return playerState;
+        },
+        get stateChanged() {
+            return stateChanged;
+        },
+        get destroyed() {
+            return destroyed;
+        },
+        play,
+        stop,
+        pause() {
+            if (playerState === 'playing') {
+                setState('paused');
+            }
+        },
+        goToTime,
+        /**
+         * forwards the currentTime to the next anchor
+         */
+        forward() {
+            const seconds = clock.currentTime;
+            const newTime = clock.times.find((t) => t > seconds) ||
+                clock.times[clock.times.length - 1];
+            goToTime(newTime);
+        },
+        /**
+         * resets the currentTime to the previous anchor
+         */
+        backward() {
+            const seconds = clock.currentTime;
+            let index = clock.times.findIndex((t) => t >= seconds) - 1;
+            if (backedBeforeTimeout != null) {
+                index -= 1;
+                clearTimeout(backedBeforeTimeout);
+            }
+            if (index < 0) {
+                index = 0;
+            }
+            const newTime = clock.times[index];
+            goToTime(newTime);
+            backedBeforeTimeout = window.setTimeout(() => {
+                backedBeforeTimeout = undefined;
+            }, 700);
+        },
+        destroy,
+    };
+}
+//# sourceMappingURL=flightPlayer.js.map