@poor-knight/cesium-utils 0.5.3 → 0.5.5

package/dist/cesium-utils.d.ts

@@ -0,0 +1,353 @@
+import { Cartesian3 } from 'cesium';
+import * as Cesium from 'cesium';
+import { default as default_2 } from 'eventemitter3';
+import { EventEmitter } from 'eventemitter3';
+import { Feature } from 'geojson';
+import { FeatureCollection } from 'geojson';
+import { ImageryLayer } from 'cesium';
+import { ImageryLayerFeatureInfo } from 'cesium';
+import { Point } from 'geojson';
+import { Popup } from 'cesium-extends';
+import { Viewer } from 'cesium';
+import { WebMapServiceImageryProvider } from 'cesium';
+
+declare type Cartesian3Like = Cesium.Cartesian3 | {
+    x: number;
+    y: number;
+    z: number;
+};
+
+/**创建天地图图层 */
+export declare function createTdtProvider(key: 'img' | 'vec' | 'cia' | 'cva', opt: {
+    token: string;
+} & Partial<CustomWebMapTileServiceImageryProviderConstructorOptions>): CustomWebMapTileServiceImageryProvider;
+
+/**创建天地图地形 */
+export declare function createTdtTerrain(opt: {
+    token: string;
+}): Cesium.TerrainProvider;
+
+declare class CustomWebMapTileServiceImageryProvider extends Cesium.WebMapTileServiceImageryProvider {
+    private options;
+    constructor(options: CustomWebMapTileServiceImageryProviderConstructorOptions);
+    requestImage(x: number, y: number, level: number, request?: Cesium.Request | undefined): Promise<HTMLImageElement | ImageBitmap | HTMLCanvasElement> | undefined;
+    private pickSubdomain;
+}
+
+declare type CustomWebMapTileServiceImageryProviderConstructorOptions = Cesium.WebMapTileServiceImageryProvider.ConstructorOptions & {
+    requestInterceptor?: (image: HTMLImageElement | ImageBitmap | HTMLCanvasElement) => HTMLImageElement | ImageBitmap | HTMLCanvasElement;
+    subdomains?: string[];
+};
+
+/**根据视角参数，调整摄像头 */
+export declare function flyToCameraParams(viewer: Cesium.Viewer, params: {
+    position: Cartesian3Like;
+    direction: Cartesian3Like;
+    up: Cartesian3Like;
+    right: Cartesian3Like;
+    transform: Matrix4Like;
+}, duration?: number): void;
+
+export declare function invertToCanvas(image: HTMLImageElement | ImageBitmap | HTMLCanvasElement): HTMLCanvasElement;
+
+/**图层 */
+export declare interface Layer {
+    key: string;
+    zIndex: number;
+    show(viewer: Viewer): void;
+    hide(viewer: Viewer): void;
+}
+
+/**获取左键点击事件监听器，基于viewer唯一 */
+export declare function ListenLeftClick(viewer: Cesium.Viewer): default_2<{
+    click: (payload: Cesium.ScreenSpaceEventHandler.PositionedEvent) => void;
+}, any>;
+
+declare type Matrix4Like = Cesium.Matrix4 | Record<string, number> | number[];
+
+export declare class PolygonDrawer {
+    private options?;
+    private _viewer;
+    private _callBack;
+    private _posChange;
+    private _pointGeometry;
+    private _activePoint;
+    private _polygon;
+    private _positions;
+    private _status;
+    private _mouseDelta;
+    private _lastClickPosition;
+    private _options;
+    private _subscriber;
+    private _events;
+    private _labels;
+    private _tips;
+    private _hoveredPoint;
+    get status(): "INIT" | "START" | "END" | "EDITING" | "DESTROY";
+    get isDestroy(): boolean;
+    /**
+     * Create a PolygonDrawer Class
+     * @param viewer cesium viewer
+     * @param [options.accuracy] lonlat number accuracy.
+     * @param [options.once] If continue to draw the next polygon.
+     * @param [options.retainGeo] If retain polygon geo after drawing complete.
+     * @param [options.positions] The object onto which to store the position Array.
+     * @param [options.callback] callback funciton after drawing complete.
+     * @param [options.posChange] callback funciton after position array changed.
+     * @param [options.tips] tip labels text config.
+     * @example
+     * const DrawTool = new PolygonDrawer(viewer, {
+     callback: (result) => {
+     console.log(result);
+     },
+     posChange: (coors) => {
+     console.log(coors)
+     },
+     tips: {
+     leftClick: intl.formatMessage({ id: 'drawer.leftClick' }),
+     rightClick: intl.formatMessage({ id: 'drawer.rightClick' }),
+     doubleClick: intl.formatMessage({ id: 'drawer.doubleClick' }),
+     edit: intl.formatMessage({ id: 'drawer.edit' }),
+     }
+     })
+     */
+    constructor(viewer: Viewer, options?: PolygonDrawerOptions | undefined);
+    /**
+     * 根据传入的positions初始化图形并进入编辑状态
+     */
+    private initializeFromPositions;
+    /**
+     * 更新标签信息
+     * @param options 标签位置、标签文字， 不填则按照默认逻辑更新
+     */
+    private updateLabel;
+    /**
+     * positions数组改变后调用回调函数
+     */
+    private handlePosChange;
+    protected drawPoint(position: Cartesian3): Cesium.Entity;
+    private updatePointSize;
+    /**
+     * 点Entity的左键点击事件
+     */
+    private onMouseClickPoint;
+    /**
+     * 绘制多边形
+     */
+    private drawShape;
+    /**
+     * 鼠标移动时改变活动点的位置和position坐标串
+     */
+    private handleMouseMove;
+    /**
+     * 鼠标左键监听事件,点击添加点和坐标,并设置新的活动点
+     */
+    private handleMouseLeftClick;
+    /**
+     * 添加一个点
+     * @param index 点的下标
+     * @param pos 点的经纬度
+     */
+    addOnePosition: (index: number, pos: number[]) => boolean;
+    /**
+     * 改变一个点的坐标信息
+     * @param index 点下标
+     * @param pos 位置[经纬度]
+     * @returns boolean
+     */
+    changeOnePosition: (index: number, pos: number[]) => boolean;
+    /**
+     * 移除一个点
+     * @param index 点的下标
+     * @returns {boolean} 是否移除成功
+     */
+    removeOnePosition: (index: number) => boolean;
+    /**
+     * 将一个点设置为活动点
+     * @param index 点的下标
+     */
+    activeOnePosition: (index: number) => void;
+    private handleMouseRightClick;
+    /**
+     * 开始绘制多边形
+     */
+    start(): void;
+    private removePolygon;
+    /**
+     * 停止绘制多边形
+     * @param removePoint 是否移除控制点,默认true
+     */
+    private stop;
+    /**
+     * cesium坐标转经纬度
+     * @param cartesian
+     * @returns [lon, lat]
+     */
+    cartesian2lonlat: (cartesian: Cartesian3) => number[];
+    /**
+     * 结束绘制
+     * @returns boolean
+     */
+    private endDraw;
+    clear(): void;
+    destroy(): void;
+}
+
+declare type PolygonDrawerOptions = {
+    accuracy?: number;
+    once?: boolean;
+    retainGeo?: boolean;
+    positions?: Cartesian3[];
+    callback?: (coors: number[][]) => void;
+    posChange?: (coors: number[][]) => void;
+    tips?: {
+        leftClick?: string;
+        rightClick?: string;
+        doubleClick?: string;
+        edit?: string;
+    };
+    polygon?: Omit<Cesium.PolygonGraphics.ConstructorOptions, 'hierarchy' | 'show'>;
+};
+
+/** 弹窗控制器 */
+export declare class PopupCtrl extends default_2<{
+    onMount: (id: string | number) => void;
+    onUnmount: (id: string | number) => void;
+}> {
+    private static instance;
+    private constructor();
+    static getInstance(): PopupCtrl;
+    popupMap: Map<string | number, {
+        popup: Popup;
+        destroy(): void;
+    }>;
+    popup(payload: {
+        viewer: Cesium.Viewer;
+        id: string | number;
+        position: number[];
+        offset?: [number, number];
+        element: HTMLElement;
+    }): void;
+    close(id: string | number): void;
+    closeAll(): void;
+}
+
+/**保持当前的视角参数到对象 */
+export declare function saveCameraParams(viewer: Cesium.Viewer): {
+    position: Cesium.Cartesian3;
+    direction: Cesium.Cartesian3;
+    up: Cesium.Cartesian3;
+    right: Cesium.Cartesian3;
+    transform: Cesium.Matrix4;
+};
+
+/**船只图层
+ *
+ *
+ */
+export declare class ShipLayer extends default_2<{
+    createEntity: (entity: Cesium.Entity) => void;
+}> implements Layer {
+    key: string;
+    zIndex: number;
+    private opt?;
+    db: Cesium.CustomDataSource;
+    private labelDataSource;
+    private IS_MOVING_THRESHOLD;
+    private shipDisplayOptions;
+    /**
+     * 构造函数
+     * @param key 图层唯一标识
+     * @param zIndex 图层渲染顺序
+     * @param opt 配置项
+     *   - clustering: label的聚合相关配置
+     *     - enabled 是否启用聚合
+     *     - pixelRange 聚合像素范围
+     *     - minimumClusterSize 最小聚合数量
+     *   - distanceDisplayConditions: 距离显示条件
+     *     - near 最近显示距离
+     *     - far 最远显示距离
+     *   - defaultValue: 输入信息的默认值
+     *     - designBeam 默认船宽
+     *     - designLength 默认船长
+     *   - IS_MOVING_THRESHOLD 判定移动的速度阈值（米/秒），默认1
+     *   - shipDisplayOptions 船只显示配置
+     *     - startFadeMinutes 船只开始淡出时间（分钟）默认1分钟
+     *     - endFadeMinutes 船只达到最淡的时间（分钟）默认5分钟
+     *     - hideMinutes 船只隐藏时间（分钟）默认60分钟
+     */
+    constructor(key: string, zIndex: number, opt?: {
+        clustering?: {
+            enabled?: boolean;
+            pixelRange?: number;
+            minimumClusterSize?: number;
+        };
+        distanceDisplayConditions?: {
+            near?: number;
+            far?: number;
+        };
+        defaultValue: {
+            designBeam: number;
+            designLength: number;
+        };
+        IS_MOVING_THRESHOLD?: number;
+        shipDisplayOptions?: {
+            startFadeMinutes?: number;
+            endFadeMinutes?: number;
+            hideMinutes?: number;
+        };
+    } | undefined);
+    private isMounted;
+    private _viewer;
+    show(viewer: Cesium.Viewer): void;
+    hide(): void;
+    entityMap: Map<string, Cesium.Entity>;
+    contain(e: Cesium.Entity): boolean;
+    /**生成entity, geojson的id优先和mmsi保持一致，没有mmsi的情况下，使用nanoid生成 */
+    render(geojson: FeatureCollection<Point>): void;
+    /**获取id */
+    private getIdByFeature;
+    /**渲染feature */
+    renderFeature(feature: Feature<Point>): void;
+    /**更新or新增feature */
+    update(feature: Feature<Point>): void;
+    private renderEntity;
+    private renderLabelEntity;
+    private shadowEntityMap;
+    private createShipPlane;
+    /**显隐entity，回调返回显示隐藏的状态,不传Fn时默认显示所有 */
+    private hookFilterEntityFn?;
+    hideEntityByCondition(validateFn?: (entity: Cesium.Entity) => boolean): void;
+    private getHideAfterSomeMinutesAndByDistance;
+}
+
+export declare class WmsLayer implements Layer {
+    private ctrl;
+    key: string;
+    layer: string;
+    zIndex: number;
+    constructor(ctrl: WmsLayerController, key: string, layer: string, zIndex?: number);
+    show(viewer: Viewer): void;
+    hide(viewer: Viewer): void;
+}
+
+/**wms图层控制器 */
+export declare class WmsLayerController extends EventEmitter<{
+    click: (payload: ImageryLayerFeatureInfo[] | undefined) => void;
+}> {
+    private args;
+    constructor(args: Omit<WebMapServiceImageryProvider.ConstructorOptions, 'layers'>);
+    private layerMap;
+    registerLayer(layer: WmsLayer): void;
+    private showLayers;
+    showLayer(viewer: Viewer, key: string): void;
+    hideLayer(viewer: Viewer, key: string): void;
+    imgLayer?: ImageryLayer;
+    /**更新底图，加了个的防抖 */
+    private update;
+    private handler?;
+    private hookClickEvent;
+    private destroyHandler;
+}
+
+export { }