@cyclomedia/streetsmart-api 23.14.4 → 23.14.6

package/src/types/PointCloudViewer.d.ts

@@ -0,0 +1,159 @@
+/// <reference path="shared.d.ts" />
+import React from 'react';
+declare module '@cyclomedia/streetsmart-api' {
+    type PointCloudViewerEventCallback<T extends PointCloudViewerEvents | SharedViewerEvents> = (
+        event: ViewerEvent<PointCloudViewerEventDetails[T]>,
+    ) => void;
+
+    class PointCloudViewer extends React.PureComponent {
+        /**
+         * Returns the ID of this viewer.
+         * @returns {String} The ID of this viewer.
+         */
+        getId(): string;
+
+        /**
+         * Returns the type of this viewer.
+         * @returns {ViewerType} The type of this viewer.
+         */
+        getType(): ViewerType;
+
+        /**
+         * Returns the visibility state of the navbar.
+         * @returns {Boolean} The visibility state of the navbar.
+         */
+        getNavbarVisible(): boolean;
+
+        /**
+         * Returns the expanded state of the navbar.
+         * @returns {Boolean} The expanded state of the navbar.
+         */
+        getNavbarExpanded(): boolean;
+
+        /**
+         * Toggles the visibility of the navbar in the PointCloudViewer.
+         * @param {Boolean} [visible] - If available, sets visibility to this value.
+         */
+        toggleNavbarVisible(visible?: boolean): void;
+
+        /**
+         * Modify the state of navbar expanded in the PointCloudViewer.
+         * @param {Boolean} [value] - If available, sets expanded to this value.
+         */
+        toggleNavbarExpanded(value?: boolean): void;
+
+        /**
+         * Get current style of points.
+         * @returns {ColorizationMode} The style of points.
+         */
+        getPointStyle(): ColorizationMode;
+
+        /**
+         * Set the style of points. See ColorizationMode Enum.
+         * @param {ColorizationMode} style - The new style of points.
+         */
+        setPointStyle(style: ColorizationMode): void;
+
+        /**
+         * Get current size of points, see PointSize enum.
+         * @returns {PointSize} The size of points.
+         */
+        getPointSize(): PointSize;
+
+        /**
+         * Set the size points are displayed on, see PointSize enum.
+         * @param {PointSize} size - The new size of points in the viewer.
+         */
+        setPointSize(size: PointSize): void;
+
+        /**
+         * Get the visibility of a button.
+         * @param buttonId - The ID of the button.
+         * @returns {Boolean} The visibility state of the button.
+         */
+        getButtonEnabled(buttonId: string): boolean;
+
+        /**
+         * Toggle the visibility of a button.
+         * @param {PointCloudViewerUi} buttonId - The ID of the button.
+         * @param {Boolean} [enabled] - If available, set enabled to this value.
+         */
+        toggleButtonEnabled(buttonId: PointCloudViewerUi | string, enabled?: boolean): void;
+
+        /**
+         * Get current visibility of edges around points.
+         * @returns {Boolean} The visibility state of edges around points.
+         */
+        getEdgesVisibility(): boolean;
+
+        /**
+         * Toggles or sets the visibility of edges around points.
+         * @param {Boolean} [visibility] - If available, set visibility to this value.
+         */
+        toggleEdges(visibility?: boolean): void;
+
+        /**
+         * Get the background of the pointcloud. See Background enum.
+         * @returns {Background} The background of the pointcloud.
+         */
+        getBackgroundPreset(): BackgroundPreset;
+
+        /**
+         * Set the background. See Background enum.
+         * @param {Background} backgroundPreset - The new background.
+         */
+        setBackgroundPreset(backgroundPreset: BackgroundPreset | string): void;
+
+        /**
+         * Toggles between aerial point cloud and street point cloud.
+         * @param {PointCloudType} [switchToPointCloudType] - If available, sets the type of point cloud.
+         */
+        togglePointCloudType(switchToPointCloudType?: PointCloudType): void;
+
+        /**
+         * Get current point amount, see Quality enum.
+         * @returns {Quality} The amount - can be 'low', 'medium', 'high', or 'ultra'.
+         */
+        getPointAmount(): Quality;
+
+        /**
+         * Set the maximum amount of point displayed in the viewer, see Quality enum.
+         * @param {Quality} amount - Can be set to 'low', 'medium', 'high', or 'ultra'.
+         */
+        setPointAmount(amount: Quality): void;
+
+        /**
+         * Get the minimal height colorization, these values are only used with the point style: Height.
+         * @returns {Number} The minimal height colorization can be between -10 and 50.
+         */
+        getMinHeightColorization(): number;
+
+        /**
+         * Get the maximal height colorization, these values are only used with the point style: Height.
+         * @returns {Number} The maximal height colorization can be between -10 and 50.
+         */
+        getMaxHeightColorization(): number;
+
+        /**
+         * Set the minimum height colorization, this function can only be used with the point style: Height.
+         * @param {Number} [heightColorization] - The minimum height colorization.
+         */
+        setMinHeightColorization(heightColorization?: number): void;
+
+        /**
+         * Set the maximum height colorization, this function can only be used with the point style: Height.
+         * @param {Number} [heightColorization] - The maximum height colorization.
+         */
+        setMaxHeightColorization(heightColorization?: number): void;
+
+        on<T extends PointCloudViewerEvents | SharedViewerEvents>(
+            type: T,
+            callback: PointCloudViewerEventCallback<T>,
+        ): this;
+
+        off<T extends PointCloudViewerEvents | SharedViewerEvents>(
+            type: T,
+            callback: PointCloudViewerEventCallback<T>,
+        ): this;
+    }
+}

package/src/types/shared.d.ts

@@ -0,0 +1,355 @@
+declare module '@cyclomedia/streetsmart-api' {
+    import { Style } from 'ol/style';
+    import { vec3 } from 'gl-matrix';
+
+    export enum ViewerType {
+        MAP = '@@ViewerType/MAP',
+        MESHVIEWER = '@@ViewerType/MESHVIEWER',
+        OBLIQUE = '@@ViewerType/OBLIQUE',
+        PANORAMA = '@@ViewerType/PANORAMA',
+        PANORAMA_ZOOM = '@@ViewerType/PANORAMA_ZOOM',
+        POINTCLOUD = '@@ViewerType/POINTCLOUD',
+    }
+
+    export type ViewerEvent<TDetail = null> = {
+        type: string;
+        detail: TDetail;
+    };
+
+    export enum GlobalViewerEvents {
+        VIEWER_ADDED = 'VIEWER_ADDED',
+        VIEWER_REMOVED = 'VIEWER_REMOVED',
+        VIEWER_UPDATED = 'VIEWER_UPDATED',
+    }
+
+    export enum SharedViewerEvents {
+        LAYER_VISIBILITY_CHANGE = 'LAYER_VISIBILITY_CHANGE',
+    }
+
+    export enum PanoramaViewerEvents {
+        PANORAMA_CREATED = 'PANORAMA_CREATED',
+        RECORDING_CLICK = 'RECORDING_CLICK',
+        FEATURE_CLICK = 'FEATURE_CLICK',
+        FEATURE_SELECTION_CHANGE = 'FEATURE_SELECTION_CHANGE',
+        IMAGE_CHANGE = 'IMAGE_CHANGE',
+        VIEW_CHANGE = 'VIEW_CHANGE',
+        VIEW_LOAD_END = 'VIEW_LOAD_END',
+        TILE_LOAD_ERROR = 'TILE_LOAD_ERROR',
+        TIME_TRAVEL_CHANGE = 'TIME_TRAVEL_CHANGE',
+        SURFACE_CURSOR_CHANGE = 'SURFACE_CURSOR_CHANGE',
+        ELEVATION_CHANGE = 'ELEVATION_CHANGE',
+    }
+
+    export enum MeasurementEvents {
+        MEASUREMENT_CHANGED = 'MEASUREMENT_CHANGED',
+        MEASUREMENT_STOPPED = 'MEASUREMENT_STOPPED',
+        MEASUREMENT_STARTED = 'MEASUREMENT_STARTED',
+        MEASUREMENT_SAVED = 'MEASUREMENT_SAVED',
+    }
+
+    type DefaultMeasurementEvent = {
+        // old GEOJson format
+        activeMeasurement: Measurement;
+        panoramaViewer: PanoramaViewer;
+    };
+
+    // Types for measurement event details
+    export type MeasurementEventDetails = {
+        [MeasurementEvents.MEASUREMENT_CHANGED]: DefaultMeasurementEvent;
+        [MeasurementEvents.MEASUREMENT_STOPPED]: DefaultMeasurementEvent;
+        [MeasurementEvents.MEASUREMENT_STARTED]: DefaultMeasurementEvent;
+        [MeasurementEvents.MEASUREMENT_SAVED]: DefaultMeasurementEvent;
+    };
+
+    export type PanoramaViewerEventDetails = {
+        [PanoramaViewerEvents.PANORAMA_CREATED]: {
+            panoramaId: string;
+            recording: Recording;
+            viewerData: {
+                hFov: number;
+                yaw: number;
+                srs: string;
+                xyz: [x: number, y: number, z: number];
+            };
+            colorStyle: { name: string; color: string; style: Style };
+        };
+        [PanoramaViewerEvents.RECORDING_CLICK]: {
+            eventData: {
+                altKey: boolean;
+                ctrlKey: boolean;
+                shiftKey: boolean;
+            };
+            recording: Recording;
+        };
+        [PanoramaViewerEvents.FEATURE_CLICK]: {
+            layerId: string;
+            layerName: string;
+            featureProperties: any;
+        };
+        [PanoramaViewerEvents.FEATURE_SELECTION_CHANGE]: {
+            layerId: string;
+            layerName: string;
+            featureProperties: any;
+        };
+        [PanoramaViewerEvents.IMAGE_CHANGE]: {};
+        [PanoramaViewerEvents.VIEW_CHANGE]: {
+            hFov: number;
+            pitch: number;
+            yaw: number;
+        };
+        [PanoramaViewerEvents.VIEW_LOAD_END]: {};
+        [PanoramaViewerEvents.TILE_LOAD_ERROR]: {
+            xhr: XMLHttpRequest;
+        };
+        [PanoramaViewerEvents.TIME_TRAVEL_CHANGE]: {
+            date: Date;
+        };
+        [PanoramaViewerEvents.SURFACE_CURSOR_CHANGE]: {
+            // depth in active units (m, ft, etc.)
+            depth: number;
+            depthInMeters: number;
+            srs: string;
+            xyz: [x: number, y: number, z: number];
+        };
+        [PanoramaViewerEvents.ELEVATION_CHANGE]: {
+            level: string;
+            heightUnit: string;
+            groundLevel: string;
+        };
+        [SharedViewerEvents.LAYER_VISIBILITY_CHANGE]: { layerId: string; visibility: boolean };
+    };
+
+    export enum ObliqueViewerEvents {
+        SWITCH_VIEWING_DIRECTION = 'SWITCH_VIEWING_DIRECTION',
+        FEATURE_CLICK = 'FEATURE_CLICK',
+        FEATURE_SELECTION_CHANGE = 'FEATURE_SELECTION_CHANGE',
+        IMAGE_CHANGE = 'IMAGE_CHANGE',
+        VIEW_CHANGE = 'VIEW_CHANGE',
+        VIEW_LOAD_END = 'VIEW_LOAD_END',
+        TIME_TRAVEL_CHANGE = 'TIME_TRAVEL_CHANGE',
+    }
+
+    // Types for event details
+    export type ObliqueViewerEventDetails = {
+        SWITCH_VIEWING_DIRECTION?: {
+            direction: string;
+        };
+        FEATURE_CLICK?: {
+            layerId: string;
+            layerName: string;
+            featureProperties: any;
+        };
+        FEATURE_SELECTION_CHANGE?: {
+            layerId: string;
+            layerName: string;
+            featureProperties: any;
+        };
+        IMAGE_CHANGE?: {
+            footprint: any;
+            footprintCentre: any;
+            rotation: number;
+            srs: string;
+        };
+        VIEW_CHANGE?: {
+            center: any;
+            resolution: any;
+            rotation: number;
+            srs: string;
+        };
+        VIEW_LOAD_END?: {};
+        TIME_TRAVEL_CHANGE?: {
+            date: Date;
+        };
+        [SharedViewerEvents.LAYER_VISIBILITY_CHANGE]: { layerId: string; visibility: boolean };
+    };
+
+    export enum PointCloudViewerEvents {
+        VIEW_CHANGE = 'VIEW_CHANGE',
+        EDGES_CHANGED = 'EDGES_CHANGED',
+        POINT_SIZE_CHANGED = 'POINT_SIZE_CHANGED',
+        POINT_STYLE_CHANGED = 'POINT_STYLE_CHANGED',
+        POINT_BUDGET_CHANGED = 'POINT_BUDGET_CHANGED',
+        BACKGROUND_CHANGED = 'BACKGROUND_CHANGED',
+    }
+
+    // Types for event details
+    export type PointCloudViewerEventDetails = {
+        VIEW_CHANGE?: {
+            cameraPosition: { x: number; y: number; z: number };
+            cameraTarget: { x: number; y: number; z: number };
+        };
+        EDGES_CHANGED?: {
+            edges: boolean;
+        };
+        POINT_SIZE_CHANGED?: {
+            pointSize: number;
+        };
+        POINT_STYLE_CHANGED?: {
+            pointStyle: any;
+        };
+        POINT_BUDGET_CHANGED?: {
+            pointBudget: number;
+        };
+        BACKGROUND_CHANGED?: {
+            background: any;
+        };
+        [SharedViewerEvents.LAYER_VISIBILITY_CHANGE]: { layerId: string; visibility: boolean };
+    };
+
+    export enum MeshViewerEvents {}
+
+    /**
+     * Enumeration for different UI elements in ObliqueViewer.
+     **/
+    export enum ObliqueViewerUi {
+        NAVBAR = 'NAVBAR',
+        SIDEBAR = 'SIDEBAR',
+        COMPASS = 'COMPASS',
+        TIME_TRAVEL = 'TIME_TRAVEL',
+    }
+
+    export enum PointCloudViewerUi {
+        OVERLAYS = 'pointcloudviewer.overlays',
+        DISPLAY = 'pointcloudviewer.display',
+        DOWNLOAD = 'pointcloudviewer.download',
+        MEASURE = 'pointcloudviewer.measure',
+        TOGGLE_AERIAL_STREET = 'pointcloudviewer.toggleAerialStreet',
+        SECTIONS = 'pointcloudviewer.sections',
+        NAVBAR = 'pointcloudviewer.navbar',
+        SIDEBAR = 'pointcloudviewer.sidebar',
+        SAVE_MEASUREMENT = 'pointcloudviewer.saveMeasurement',
+    }
+
+    export type Layer = {
+        /**
+         * ID of the layer.
+         */
+        id: string;
+
+        /**
+         * Visibility to toggle to.
+         */
+        visible: boolean;
+
+        /**
+         * Optional: Name of the layer.
+         */
+        name?: string;
+    };
+
+    /**
+     * Enumeration for different colorization modes.
+     * @enum {string}
+     */
+    export enum ColorizationMode {
+        RGB = 'RGB',
+        HEIGHT = 'Height',
+        INTENSITY = 'Intensity',
+        CLASSIFICATION = 'Classification', // (for aerial only)
+    }
+
+    /**
+     * Enumeration for different quality levels.
+     * @enum {string}
+     */
+    export enum Quality {
+        LOW = 'low',
+        MEDIUM = 'medium',
+        HIGH = 'high',
+        ULTRA = 'ultra',
+    }
+
+    /**
+     * Enumeration for different point sizes.
+     * @enum {string}
+     */
+    export enum PointSize {
+        SINGLE = 'single',
+        DOUBLE = 'double',
+        LARGE = 'large',
+    }
+
+    /**
+     * Enumeration for different background presets.
+     * @enum {string}
+     */
+    export enum BackgroundPreset {
+        SKYBOX = 'Skybox',
+        DARKBLUE = 'DarkBlue',
+        LIGHTBLUE = 'LightBlue',
+        BLACK = 'Black',
+        DARKGRAY = 'DarkGray',
+        GRAY = 'Gray',
+        LIGHTGRAY = 'LightGray',
+        WHITE = 'White',
+    }
+
+    /**
+     * Enumeration for height colorization limits.
+     * @enum {number}
+     */
+    export enum HeightColorization {
+        MIN = -10,
+        MAX = 50,
+    }
+
+    export enum PointCloudType {
+        AERIAL = 'aerial',
+        STREET = 'street',
+    }
+
+    export interface Recording {
+        id: string;
+        groundLevelOffset: number;
+        recorderDirection: number;
+        orientation: number;
+        recordedAt: Date | null;
+        expiredAt: Date | null;
+        year: number;
+        // The following two properties are urls that point to the blob storage location,
+        // which must first be presigned with a SAS token before use.
+        imageTilesUrlStructure: string | null;
+        depthTilesUrlStructure: string | null;
+        productType: string | null;
+
+        forwardTarget: boolean;
+        backwardTarget: boolean;
+
+        isPreloaded: boolean;
+        thumbs: Array<any>; // Replace "any" with the actual type of the array elements if known
+        thumbsLoaded: number;
+
+        relativeXyz: [number, number, number];
+        relativeYaw: number;
+        relativeDistance: number;
+
+        xyz: vec3;
+        srs: string;
+    }
+
+    interface MeasurementCollection {
+        type: 'FeatureCollection';
+        features: Measurement[];
+        crs:
+            | {
+                  type: 'EPSG';
+                  properties: {
+                      code: number;
+                  };
+              }
+            | {
+                  type: 'name';
+                  properties: {
+                      name: 'string';
+                  };
+              };
+    }
+
+    interface Measurement {
+        type: string;
+        properties: {
+            [k: string]: any;
+        };
+        geometry: any;
+    }
+}