csk-gis-frame-work 4.0.0

package/mapgis/js/datalayer/igs-layer/IGSImageryLayer.js

@@ -0,0 +1,460 @@
+import DataUtils from '../../../../mapboxgl/js/utils/DataUtils';
+import mapConfig from '../../../../baseSetting/config/mapConfig'
+import {removeLayerFromManager} from "../";
+
+/**
+ * 定义 MapGIS Common API IGS影像服务图层类
+ *
+ * @alias IGSImageryLayer
+ *
+ * @summary <用于加载和管理IGS影像服务图层，支持IGS1.0和2.0两个服务版本>
+ * @description 该类负责具体的图层操作逻辑，包括图层的加载、显示/隐藏、移除等。
+ *              底层通过 LayerProvider 与 Mapbox GL JS 进行交互。
+ */
+export default class IGSImageryLayer {
+    /**
+     * 构造函数
+     * @param {Object} options - 图层配置选项
+     * @param {Object} options.map - 地图对象（mapboxgl.Map 实例）
+     * @param {String} options.url - 服务基地址
+     * @param {String} [options.id] - 图层ID（可选，不传则自动生成）
+     * @param {String} [options.title=''] - 图层标题
+     * @param {String} [options.description=''] - 图层描述
+     * @param {Number} [options.opacity=1] - 图层透明度 (0-1)
+     * @param {Boolean} [options.visible=true] - 图层可见性
+     * @param {Array<Number>} [options.bandIds] - 波段号
+     * @param {String} [options.format='PNG'] - 返回图片格式 (PNG/JPG/MIXED)
+     * @param {Number} [options.imageMaxHeight=0] - 图像最大高度
+     * @param {Number} [options.imageMaxWidth=0] - 图像最大宽度
+     * @param {String} [options.interpolation=''] - 重采样方式
+     * @param {Object} [options.rasterFunction=null] - 栅格数据处理渲染规则
+     * @param {Object} [options.serviceRasterInfo=null] - 栅格信息
+     * @param {Object} [options.clippingArea=null] - 图层空间裁剪范围
+     * @param {String} [options.renderMode='image'] - 影像展现形式 ('tile'/'image')
+     * @param {Number} [options.imageWidth=512] - 影像宽度（renderMode为'tile'时生效）
+     * @param {Number} [options.imageHeight=512] - 影像高度（renderMode为'tile'时生效）
+     * @param {Number} [options.minScale=0] - 最小显示比例尺
+     * @param {Number} [options.maxScale=0] - 最大显示比例尺
+     * @param {String} [options.tokenKey='token'] - Token键名
+     * @param {String} [options.tokenValue=''] - Token值
+     * @param {Object} [options.spatialReference] - 坐标系
+     */
+    constructor(options) {
+        /**
+         * 地图对象
+         * @type {Object}
+         */
+        this._map = options.map;
+
+        this._layer = null
+
+        /**
+         * 服务基地址
+         * 格式：http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageServer
+         * @type {String}
+         */
+        this._url = options.url;
+
+        /**
+         * 图层ID
+         * @type {String}
+         */
+        this._layerId = DataUtils.default(options.id + '_source', 'igs_imagery_layer_' + new Date().getTime());
+
+        /**
+         * 数据源ID
+         * @type {String}
+         */
+        this._sourceId = this._layerId;
+
+        /**
+         * 图层标题
+         * @type {String}
+         */
+        this._title = DataUtils.default(options.title, '');
+
+        /**
+         * 图层描述
+         * @type {String}
+         */
+        this._description = DataUtils.default(options.description, '');
+
+        /**
+         * 图层透明度 (0-1),0为完全透明,1为不透明
+         * @type {Number}
+         */
+        this._opacity = DataUtils.default(options.opacity, 1);
+
+        /**
+         * 图层可见性,true则显示,false则隐藏
+         * @type {Boolean}
+         */
+        this._visible = DataUtils.default(options.visible, true);
+
+        /**
+         * 波段号
+         * 如果有多个波段，可以指定要导出的单个波段，也可以通过指定波段编号来更改波段组合
+         * 例如 [0,1,2]
+         * @type {Array<Number>|null}
+         */
+        this._bandIds = DataUtils.default(options.bandIds, null);
+
+        /**
+         * 描述服务支持的能力
+         * 例如是否支持直方图、是否支持统计等
+         * @type {Object}
+         */
+        this._capabilities = DataUtils.default(options.capabilities, {});
+
+        /**
+         * 返回图片格式
+         * 支持 PNG/JPG/MIXED，默认 PNG
+         * @type {String}
+         */
+        this._format = DataUtils.default(options.format, 'PNG');
+
+        /**
+         * 表示服务导出的图像的最大高度
+         * @type {Number}
+         */
+        this._imageMaxHeight = DataUtils.default(options.imageMaxHeight, 0);
+
+        /**
+         * 表示服务导出的图像的最大宽度
+         * @type {Number}
+         */
+        this._imageMaxWidth = DataUtils.default(options.imageMaxWidth, 0);
+
+        /**
+         * 重采样方式
+         * 支持 NearestNeighbor/BilinearInterpolation，默认数据本身的重采样方式
+         * @type {String}
+         */
+        this._interpolation = DataUtils.default(options.interpolation, '');
+
+        /**
+         * 栅格数据处理渲染规则
+         * 支持 ndvi、hillshade
+         * NDVI应用于多光谱影像数据，HILLSHADE应用于DEM高程数据
+         * @type {Object|null}
+         */
+        this._rasterFunction = DataUtils.default(options.rasterFunction, null);
+
+        /**
+         * 栅格信息
+         * @type {Object|null}
+         */
+        this._serviceRasterInfo = DataUtils.default(options.serviceRasterInfo, null);
+
+        /**
+         * 图层空间裁剪范围
+         * 仅支持多多边形裁剪、多边形裁剪、矩形裁剪、圆形裁剪
+         * @type {Object|null}
+         */
+        this._clippingArea = DataUtils.default(options.clippingArea, null);
+
+        /**
+         * 影像的展现形式
+         * 可选 'tile'（瓦片方式平铺）、'image'（请求一张覆盖当前屏幕的图像）
+         * 默认为 'image'
+         * 当选项为 'image' 时，加载影像会请求一张覆盖当前屏幕的图像
+         * 当选项为 'tile' 时，加载影像时以瓦片的方式平铺
+         * @type {String}
+         */
+        this._renderMode = DataUtils.default(options.renderMode, 'image');
+
+        /**
+         * 影像的宽度
+         * 仅在 renderMode 为 'tile' 时生效
+         * @type {Number}
+         */
+        this._imageWidth = DataUtils.default(options.imageWidth, 512);
+
+        /**
+         * 影像的高度
+         * 仅在 renderMode 为 'tile' 时生效
+         * @type {Number}
+         */
+        this._imageHeight = DataUtils.default(options.imageHeight, 512);
+
+        /**
+         * 最小显示比例尺，图层在视图中可见的最小比例尺
+         * @type {Number}
+         */
+        this._minScale = DataUtils.default(options.minScale, 0);
+
+        /**
+         * 最大显示比例尺，图层在视图中可见的最大比例尺
+         * @type {Number}
+         */
+        this._maxScale = DataUtils.default(options.maxScale, 0);
+
+        /**
+         * Token键名
+         * @type {String}
+         */
+        this._tokenKey = DataUtils.default(options.tokenKey, 'token');
+
+        /**
+         * Token值,只有当tokenValue存在时,才会绑定token
+         * @type {String}
+         */
+        this._tokenValue = DataUtils.default(options.tokenValue, '');
+
+        /**
+         * 图层类型
+         * @type {String}
+         */
+        this._type = DataUtils.default(options.type, 'igs-imagery');
+
+        /**
+         * 图层加载状态: 'unloaded' | 'loading' | 'loaded' | 'error'
+         * @type {String}
+         */
+        this._loadStatus = 'unloaded';
+
+        /**
+         * 事件监听器集合
+         * @type {Object}
+         */
+        this._eventListeners = {};
+
+        /**
+         * 坐标系
+         * 支持4326(包含4490,4214以及4610)、3857以及EPSG上的自定义坐标系
+         * 坐标系默认从元信息中获取,也可指定坐标系
+         * @type {Object|null}
+         */
+        this._spatialReference = DataUtils.default(options.spatialReference, new zondy.SpatialReference({
+            wkid: mapConfig.map_srid_code
+        }))
+
+        this._isFlyTo = DataUtils.default(options.isFlyTo, true);
+    }
+
+    _buildOptions() {
+        return {
+            url: this._url,
+            id: this._layerId,
+            visible: this._visible,
+            bandIds: this._bandIds,
+            capabilities: this._capabilities,
+            format: this._format,
+            imageMaxHeight: this._imageMaxHeight,
+            imageMaxWidth: this._imageMaxWidth,
+            interpolation: this._interpolation,
+            rasterFunction: this._rasterFunction,
+            serviceRasterInfo: this._serviceRasterInfo,
+            clippingArea: this._clippingArea,
+            renderMode: this._renderMode,
+            imageWidth: this._imageWidth,
+            imageHeight: this._imageHeight,
+            minScale: this._minScale,
+            maxScale: this._maxScale,
+            tokenKey: this._tokenKey,
+            tokenValue: this._tokenValue,
+            opacity: this._opacity,
+            spatialReference: this._spatialReference
+        }
+    }
+
+    /** ==================== Core Methods ==================== */
+
+    /**
+     * 加载图层资源
+     * @description 不加载图层到地图，仅获取图层信息
+     * @returns {Promise<IGSImageryLayer>} 返回图层实例的 Promise
+     *
+     * @example
+     * const layer = new IGSImageryLayer({
+     *     url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/ImageServer'
+     * });
+     * layer.load().then((result) => {
+     *     console.log(result); // 获取完图层信息
+     * });
+     */
+    load() {
+        return new Promise((resolve, reject) => {
+            try {
+                if (!this._layer) {
+                    const opts = this._buildOptions();
+                    this._layer = new zondy.layer.IGSImageryLayer(opts);
+                }
+
+                // 监听图层加载完成事件
+                const handler = (result) => {
+                    // 移除事件监听器
+                    this._layer.off('layerview-created', handler);
+                    resolve(this);
+                };
+
+                this._layer.on('layerview-created', handler);
+
+                // 如果已经加载完成，直接返回
+                if (this._layer.loadStatus === 'loaded') {
+                    resolve(this);
+                }
+            } catch (error) {
+                reject(error);
+            }
+        });
+    }
+
+    /**
+     * 加载图层到地图
+     * @description 调用 zondy.layer.IGSImageryLayer 加载图层数据，并添加到 Mapbox GL 地图中
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const layer = createLayer({
+     *     type: 'igs-imagery',
+     *     map: mapboxMap,
+     *     url: 'http://xxx/igs/rest/services/Map/图层/ImageServer'
+     * });
+     * await layer.loadLayer();
+     */
+    loadLayer() {
+        if (this.hasLayer()) return;
+
+        const layer = new zondy.layer.IGSImageryLayer(this._buildOptions())
+        this._layer = layer;
+        // 将图层添加到 MapGIS 地图对象
+        this.addToMapGisMap()
+        // 监听图层加载完成事件
+        layer.on('layerview-created',(result) => {
+            //视点跳转
+            this._isFlyTo && gisView.goTo({
+                layer: result.layer
+            })
+        });
+    }
+
+    addToMapGisMap() {
+        this._map.add(this._layer)
+    }
+
+    /**
+     * 显示/隐藏图层
+     * @param {Boolean} isShow - 是否显示图层（true: 显示，false: 隐藏）
+     */
+    showLayer(isShow) {
+        this._layer.visible = isShow
+    }
+
+    /**
+     * 判断图层是否已加载
+     *
+     * @returns {Boolean}
+     */
+    hasLayer() {
+        // 优先检查底层 zondy.layer.IGSImageryLayer 的加载状态
+        if (this._layer && this._layer.isLoaded) {
+            return true;
+        }
+    }
+
+    /**
+     * 移除图层
+     */
+    removeLayer() {
+        // 移除底层 zondy.layer.IGSImageryLayer
+        if (this._layer) {
+            this._layer.remove();
+            this._layer = null;
+        }
+
+        // 从管理器中移除
+        removeLayerFromManager(this._layer);
+    }
+
+    /**
+     * 转换为 JSON 对象
+     * @returns {Object} JSON 对象
+     *
+     * @example
+     * const json = layer.toJSON();
+     * console.log(json);
+     */
+    toJSON() {
+        return {
+            url: this._url,
+            id: this._layerId,
+            title: this._title,
+            description: this._description,
+            opacity: this._opacity,
+            visible: this._visible,
+            bandIds: this._bandIds,
+            format: this._format,
+            imageMaxHeight: this._imageMaxHeight,
+            imageMaxWidth: this._imageMaxWidth,
+            interpolation: this._interpolation,
+            rasterFunction: this._rasterFunction,
+            serviceRasterInfo: this._serviceRasterInfo,
+            clippingArea: this._clippingArea,
+            renderMode: this._renderMode,
+            imageWidth: this._imageWidth,
+            imageHeight: this._imageHeight,
+            minScale: this._minScale,
+            maxScale: this._maxScale,
+            tokenKey: this._tokenKey,
+            tokenValue: this._tokenValue,
+            spatialReference: this._spatialReference ? this._spatialReference.toJSON ? this._spatialReference.toJSON() : this._spatialReference : null,
+            type: this._type
+        };
+    }
+
+    /**
+     * 克隆 IGSImageryLayer 对象
+     * @returns {IGSImageryLayer} 克隆后的 IGSImageryLayer 实例
+     *
+     * @example
+     * const clonedLayer = layer.clone();
+     */
+    clone() {
+        const json = this.toJSON();
+        return IGSImageryLayer.fromJSON(json);
+    }
+
+    /**
+     * 通过传入的 JSON 构造并返回一个新的 IGSImageryLayer 实例
+     * @static
+     * @param {Object} json - JSON 对象
+     * @returns {IGSImageryLayer} 新的 IGSImageryLayer 实例
+     *
+     * @example
+     * const json = {
+     *     url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/ImageServer'
+     * };
+     * const layer = IGSImageryLayer.fromJSON(json);
+     */
+    static fromJSON(json) {
+        if (!json || !json.url) {
+            throw new Error('JSON 对象必须包含 url 属性');
+        }
+
+        return new IGSImageryLayer({
+            url: json.url,
+            id: json.id,
+            title: json.title,
+            description: json.description,
+            opacity: json.opacity,
+            visible: json.visible,
+            bandIds: json.bandIds,
+            format: json.format,
+            imageMaxHeight: json.imageMaxHeight,
+            imageMaxWidth: json.imageMaxWidth,
+            interpolation: json.interpolation,
+            rasterFunction: json.rasterFunction,
+            serviceRasterInfo: json.serviceRasterInfo,
+            clippingArea: json.clippingArea,
+            renderMode: json.renderMode,
+            imageWidth: json.imageWidth,
+            imageHeight: json.imageHeight,
+            minScale: json.minScale,
+            maxScale: json.maxScale,
+            tokenKey: json.tokenKey,
+            tokenValue: json.tokenValue,
+            spatialReference: json.spatialReference
+        });
+    }
+}