@splnlss/3d-story-viewer 0.5.7 → 0.7.0

package/build/types/src/geospatial.d.ts

@@ -0,0 +1,40 @@
+export function requireFiniteNumber(value: any, field: any): any;
+export function validateLongitudeLatitude(longitude: any, latitude: any, field?: string): void;
+export function validateGeodeticPosition(longitude: any, latitude: any, altitude: any, field?: string): {
+    longitude: any;
+    latitude: any;
+    altitude: any;
+};
+export function validateRotation(pitch: any, yaw: any, roll: any, field?: string): {
+    pitch: any;
+    yaw: any;
+    roll: any;
+};
+export function validateTuple(value: any, field: any): any[];
+export function validateScale(value: any, field?: string): any;
+export function normalizeLayerOffset(offset: any, field?: string): {
+    lon: any;
+    lat: any;
+    alt: any;
+};
+export function validateEcefPosition(x: any, y: any, z: any): any[];
+export function geodeticToEcefPosition(longitude: any, latitude: any, altitude: any): number[];
+export function ecefToGeodeticPosition(x: any, y: any, z: any): {
+    lon: number;
+    lat: number;
+    alt: number;
+};
+export function getEnuBasis(longitude: any, latitude: any): {
+    east: number[];
+    north: number[];
+    up: number[];
+};
+export function enuToEcefDelta(translation: any, longitude: any, latitude: any): number[];
+export function geodeticOffsetToEcefDelta(position: any, offset: any): [number, number, number];
+export const WGS84_SEMI_MAJOR_AXIS_METERS: 6378137;
+export const WGS84_INVERSE_FLATTENING: 298.257223563;
+export const WGS84_FLATTENING: number;
+export const WGS84_SEMI_MINOR_AXIS_METERS: number;
+export const WGS84_FIRST_ECCENTRICITY_SQUARED: number;
+export const MIN_ELLIPSOIDAL_HEIGHT_METERS: -12000;
+export const MAX_ELLIPSOIDAL_HEIGHT_METERS: 100000;

package/build/types/src/main.d.ts

@@ -1,4 +1,23 @@
 export type Vector3Tuple = [number, number, number];
+export type LabelOptions = {
+    /**
+     * WGS84 longitude in decimal degrees.
+     */
+    lon: number;
+    /**
+     * WGS84 latitude in decimal degrees.
+     */
+    lat: number;
+    /**
+     * WGS84 ellipsoidal height in meters.
+     */
+    alt: number;
+    text?: string;
+    element?: HTMLElement;
+    visible?: boolean;
+    hovered?: boolean;
+    selected?: boolean;
+};
 export type ViewerOptions = {
     cesiumToken?: string;
     googleMapsToken?: string;
@@ -38,6 +57,9 @@ export type TilesLayerDefinition = {
     data: {
         url: string;
     };
+    /**
+     * Offset longitude/latitude are WGS84 decimal degrees; altitude is ellipsoidal meters.
+     */
     options?: {
         renderOrder?: number;
         implicit?: boolean;
@@ -58,6 +80,9 @@ export type MeshLayerDefinition = {
     data: {
         url: string;
     };
+    /**
+     * Nonzero offsets require an explicit WGS84 offsetOrigin. Longitude/latitude are decimal degrees; altitude is ellipsoidal meters. The offset translates existing geometry in ECEF; it does not georeference a local model.
+     */
     options?: {
         renderOrder?: number;
         offset?: {
@@ -65,6 +90,11 @@ export type MeshLayerDefinition = {
             lat?: number;
             alt?: number;
         };
+        offsetOrigin?: {
+            longitude: number;
+            latitude: number;
+            altitude: number;
+        };
     };
 };
 export type GeojsonLayerDefinition = {

package/build/types/src/viewer/ContentLayer/GeojsonLayer.d.ts

@@ -1,5 +1,5 @@
 export class GeojsonLayer extends ContentLayer {
-    constructor(data: any, options?: {});
+    constructor(data: any, options?: {}, callbacks?: {});
     isGeojsonLayer: boolean;
     setTimeFrame(start: any, end: any): void;
 }

package/build/types/src/viewer/ContentLayer/MeshLayer.d.ts

@@ -1,5 +1,5 @@
 export class MeshLayer extends ContentLayer {
-    constructor(url: any, options?: {});
+    constructor(url: any, options?: {}, callbacks?: {});
     isMeshLayer: boolean;
     mesh: any;
 }

package/build/types/src/viewer/ContentLayer/TilesLayer.d.ts

@@ -1,5 +1,5 @@
 export class TilesLayer extends ContentLayer {
-    constructor(url: any, options?: {});
+    constructor(url: any, options?: {}, callbacks?: {});
     isTilesLayer: boolean;
     firstSet: any;
     camera: any;

package/build/types/src/viewer/index.d.ts

@@ -50,7 +50,11 @@ declare class Viewer extends EventDispatcher {
     pointerCoords: ViewerCoords;
     pointerXYZ: any;
     keysDown: {};
-    keysEnabled: boolean;
+    _keysEnabled: boolean;
+    /** Camera-relative translation speed in WGS84 ECEF metres/second. */
+    movementSpeed: number;
+    /** Dimensionless multiplier while BOOST is held. */
+    boostMultiplier: number;
     movementKeys: {
         BOOST: string[];
         FRONT: string[];
@@ -75,13 +79,24 @@ declare class Viewer extends EventDispatcher {
     sky: Sky;
     pointerRaycaster: any;
     _onPointerMove: (event: any) => void;
+    set keysEnabled(enabled: boolean);
+    get keysEnabled(): boolean;
     updateMovementState(): void;
-    getElevation(lon: any, lat: any): {
+    /**
+     * @param {number} lon
+     * @param {number} lat
+     * @returns {{ lon: number, lat: number, alt: number }}
+     */
+    getElevation(lon: number, lat: number): {
         lon: number;
         lat: number;
         alt: number;
     };
-    updateCoordsElevation(coords: any): any;
+    /**
+     * @param {[number, number, number?][]} coords
+     * @returns {[number, number, number?][]}
+     */
+    updateCoordsElevation(coords: [number, number, number?][]): [number, number, number?][];
     setBackgroundColor(color: any): void;
     appendTo(container: any): void;
     container: any;
@@ -100,12 +115,48 @@ declare class Viewer extends EventDispatcher {
     setTimeFrame(start: any, end: any): void;
     timeFrameStart: Date;
     timeFrameEnd: Date;
-    updateLabel(id: any, params?: {}): any;
+    /**
+     * @param {string} id
+     * @param {{ lon: number, lat: number, alt: number, text?: string, element?: HTMLElement, visible?: boolean, hovered?: boolean, selected?: boolean }} params
+     * @returns {HTMLElement}
+     */
+    updateLabel(id: string, params: {
+        lon: number;
+        lat: number;
+        alt: number;
+        text?: string;
+        element?: HTMLElement;
+        visible?: boolean;
+        hovered?: boolean;
+        selected?: boolean;
+    }): HTMLElement;
     animate(time: any): void;
     render(): void;
     getCameraPivot(): any;
-    alignCamera(lon: any, lat: any, alt: any, pitch?: number, yaw?: number, roll?: number, duration?: number): Promise<void>;
-    focusCamera(lon: any, lat: any, alt: any, distance?: number, pitch?: number, duration?: number): Promise<void>;
+    /**
+     * @param {number} lon
+     * @param {number} lat
+     * @param {number} alt
+     * @param {number} [pitch]
+     * @param {number} [yaw]
+     * @param {number} [roll]
+     * @param {number} [duration]
+     */
+    alignCamera(lon: number, lat: number, alt: number, pitch?: number, yaw?: number, roll?: number, duration?: number): Promise<void>;
+    /**
+     * @param {number} lon
+     * @param {number} lat
+     * @param {number} alt
+     * @param {number} [distance]
+     * @param {number} [pitch]
+     * @param {number} [duration]
+     */
+    focusCamera(lon: number, lat: number, alt: number, distance?: number, pitch?: number, duration?: number): Promise<void>;
+    /**
+     * @param {number} [pitch]
+     * @param {number} [yaw]
+     * @param {number} [duration]
+     */
     angleCamera(pitch?: number, yaw?: number, duration?: number): Promise<void>;
     setViewMode(mode?: string): Promise<void>;
     exportScene(): void;

package/build/types/src/viewer/keyboardMovement.d.ts

@@ -0,0 +1,4 @@
+/** Apply camera-relative translation to a WGS84 ECEF position (metres).
+ * Speed is metres/second; deltaTime is seconds; boost is dimensionless.
+ */
+export function applyKeyboardMovement(position: any, forward: any, right: any, up: any, state: any, deltaTime: any, movementSpeed: any, boostMultiplier: any): void;

package/build/types/src/viewer/utils.d.ts

@@ -1,9 +1,3 @@
-export function ecefToGeodeticPosition(x: any, y: any, z: any): {
-    lon: number;
-    lat: number;
-    alt: number;
-};
-export function geodeticToEcefPosition(lon: any, lat: any, alt: any): number[];
 export function ecefToGeodeticRotation(x: any, y: any, z: any, quaternion: any): {
     lon: number;
     lat: number;
@@ -15,3 +9,4 @@ export function ecefToGeodeticRotation(x: any, y: any, z: any, quaternion: any):
 export function geodeticToEcefUpVector(lon: any, lat: any): any;
 export function geodeticToEcefRotation(lon: any, lat: any, pitch: any, yaw: any, roll: any): any;
 export function exportScene(root: any): void;
+export { ecefToGeodeticPosition, geodeticToEcefPosition } from "../geospatial.js";

package/build/types/src/workers/geojson.worker.d.ts

@@ -1,2 +1,15 @@
+export function createArrowGeometry(data: any): {
+    origin: any;
+    meshVertexBuffer: Float32Array<any>;
+};
+export function createPerimeterGeometry(data: any, color: any): {
+    origin: any;
+    lineVertexBuffer: Float32Array<any>;
+    lineVertexRGBBuffer: Uint8Array<ArrayBuffer>;
+    meshVertexBuffer: Float32Array<any>;
+    meshVertexRGBBuffer: Uint8Array<ArrayBuffer>;
+    meshIndexBuffer: Uint16Array<any>;
+};
+export const MAX_FEATURE_EXTENT_METERS: 50000;
 declare const self: Window & typeof globalThis;
 export default self;

package/build/types/utils/elevation/index.d.ts

@@ -1,6 +1,15 @@
 export default computeElevation;
-declare function computeElevation(lon: any, lat: any, options: any): Promise<{
+/**
+ * @param {number} lon WGS84 longitude in decimal degrees.
+ * @param {number} lat WGS84 latitude in decimal degrees.
+ * @param {{ apiKey?: string, maxDepth?: number }} [options]
+ * @returns {Promise<{ lon: number, lat: number, alt: number } | null | undefined>}
+ */
+declare function computeElevation(lon: number, lat: number, options?: {
+    apiKey?: string;
+    maxDepth?: number;
+}): Promise<{
     lon: number;
     lat: number;
     alt: number;
-}>;
+} | null | undefined>;

package/build/types/utils/elevation/tiles.d.ts

@@ -1,9 +1,3 @@
-export function ecefToGeodeticPosition(x: any, y: any, z: any): {
-    lon: number;
-    lat: number;
-    alt: number;
-};
-export function geodeticToEcefPosition(lon: any, lat: any, alt: any): number[];
 export function buildTileUrl(path: any, apiKey: any): URL;
 export function fetchTileset(url: any, apiKey: any): Promise<any>;
 export function obbToBox(obb: any): {
@@ -41,3 +35,4 @@ export namespace logColors {
     let bgWhite: string;
 }
 export let sessionKeyCache: any;
+export { ecefToGeodeticPosition, geodeticToEcefPosition } from "../../src/geospatial.js";