@baidumap/mapv-three 1.0.1 → 1.2.0

package/dist/types/threejs/materials/natural/WaterMaterial.d.ts

@@ -1,8 +1,51 @@
 /**
- * ![](media://water_material.png)
+ * 水体材质，用于模拟真实的水面效果。
+ *
+ * 支持水下折射、岸边泡沫、菲涅耳反射、水体深度渐变、焦散等复杂水面光照效果。
+ *
+ * @category Materials
+ * @example
+ * ```javascript
+ * const waterMaterial = new mapvthree.WaterMaterial({
+ *     waterColor: [0.1, 0.3, 0.8],
+ *     foamSpeed: 0.05,
+ *     depthSoftness: 5,
+ * });
+ * ```
  */
 export class WaterMaterial extends CommonShaderMaterial {
-    constructor(parameters?: {});
+    /**
+     * 构造函数
+     * @param {Object} parameters 材质参数
+     * @param {Array<number>} [parameters.waterColor] 水体的主颜色（深水区域颜色），默认为[1/255, 46/255, 120/255]
+     * @param {number} [parameters.foamSpeed] 泡沫流动速度，默认为0.050
+     * @param {number} [parameters.offsetScale] 波浪扰动高度偏移，默认为1
+     * @param {number} [parameters.depthSoftness] 水深渐变过渡，默认为5
+     * @param {number} [parameters.foamDepthSoftness] 泡沫在水深维度上的衰减程度，默认为1
+     * @param {number} [parameters.foamSoftness] 泡沫边缘模糊程度，默认为3
+     * @param {number} [parameters.foamScale] 泡沫贴图缩放比例，默认为100
+     * @param {number} [parameters.crestFoam] 波峰泡沫判断阈值，范围0-1，默认为0.70
+     * @param {Array<number>} [parameters.crestFoamColor] 波峰泡沫颜色，默认为[0.3, 0.3, 0.6]
+     * @param {number} [parameters.specularStrength] 高光闪耀强度，默认为1.5
+     * @param {number} [parameters.uvScale] UV缩放比例，默认为1000.0
+     * @param {boolean} [parameters.useEnvMap] 是否使用环境贴图，默认为true
+     * @param {number} [parameters.timeScaleFactor] 时间缩放因子，默认为0.001
+     */
+    constructor(parameters?: {
+        waterColor?: number[] | undefined;
+        foamSpeed?: number | undefined;
+        offsetScale?: number | undefined;
+        depthSoftness?: number | undefined;
+        foamDepthSoftness?: number | undefined;
+        foamSoftness?: number | undefined;
+        foamScale?: number | undefined;
+        crestFoam?: number | undefined;
+        crestFoamColor?: number[] | undefined;
+        specularStrength?: number | undefined;
+        uvScale?: number | undefined;
+        useEnvMap?: boolean | undefined;
+        timeScaleFactor?: number | undefined;
+    });
     /** @private */ private _timeScaleFactor;
     /** @private */ private _style;
     /** @private */ private _useEnvMap;
@@ -16,6 +59,7 @@ export class WaterMaterial extends CommonShaderMaterial {
     /** @private */ private _crestFoam;
     /** @private */ private _crestFoamColor;
     /** @private */ private _specularStrength;
+    /** @private */ private _uvScale;
     type: string;
     vertexShader: any;
     fragmentShader: any;
@@ -23,75 +67,165 @@ export class WaterMaterial extends CommonShaderMaterial {
     lights: boolean;
     transparent: boolean;
     fog: boolean;
-    set waterColor(value: number[]);
+    /**
+     * 设置水系样式，默认为lake
+     * @param {'river'|'lake'|'ocean'} style 样式名称，只接受'river', 'lake', 'ocean'
+     */
+    set style(style: "river" | "lake" | "ocean");
+    /**
+     * 水体样式
+     * @type {string}
+     */
+    get style(): string;
+    /**
+     * 设置水体的主颜色（深水区域颜色）
+     * @param {Array<number>} value RGB颜色数组，范围0-1
+     */
+    set waterColor(value: Array<number>);
     /**
      * 水体的主颜色（深水区域颜色）
+     * @type {Array<number>}
+     */
+    get waterColor(): Array<number>;
+    /**
+     * 设置泡沫的流动速度
+     * @param {number} value 泡沫流动速度
      */
-    get waterColor(): number[];
     set foamSpeed(value: number);
     /**
      * 控制泡沫的流动速度（用于 `tFoamNoise` 采样偏移）
+     * @type {number}
      */
     get foamSpeed(): number;
+    /**
+     * 设置波浪扰动高度偏移
+     * @param {number} value 波浪扰动高度偏移
+     */
     set offsetScale(value: number);
     /**
-     * 控制波浪扰动高度偏移, 默认为1
+     * 控制波浪扰动高度偏移，默认为1
+     * @type {number}
      */
     get offsetScale(): number;
+    /**
+     * 设置水深渐变过渡
+     * @param {number} value 水深渐变过渡值
+     */
     set depthSoftness(value: number);
     /**
-     * 控制水深渐变过渡, 默认为5
+     * 控制水深渐变过渡，默认为5
+     * @type {number}
      */
     get depthSoftness(): number;
+    /**
+     * 设置泡沫在水深维度上的衰减程度
+     * @param {number} value 泡沫深度衰减值
+     */
     set foamDepthSoftness(value: number);
     /**
-     * 控制泡沫在水深维度上的衰减程度, 泡沫从深度为0到foamDepthSoftness范围衰减, 默认为1
+     * 控制泡沫在水深维度上的衰减程度，泡沫从深度为0到foamDepthSoftness范围衰减，默认为1
+     * @type {number}
      */
     get foamDepthSoftness(): number;
+    /**
+     * 设置泡沫边缘模糊的程度
+     * @param {number} value 泡沫边缘模糊值
+     */
     set foamSoftness(value: number);
     /**
      * 控制泡沫边缘模糊的程度
+     * @type {number}
      */
     get foamSoftness(): number;
+    /**
+     * 设置泡沫贴图缩放比例
+     * @param {number} value 泡沫贴图缩放比例
+     */
     set foamScale(value: number);
     /**
      * 控制泡沫贴图缩放比例，默认为100
+     * @type {number}
      */
     get foamScale(): number;
+    /**
+     * 设置波峰泡沫的判断阈值
+     * @param {number} value 波峰泡沫阈值，范围0-1
+     */
     set crestFoam(value: number);
     /**
-     * 控制波峰泡沫的判断阈值，1最大, 默认0.7
+     * 控制波峰泡沫的判断阈值，1最大，默认0.7
+     * @type {number}
      */
     get crestFoam(): number;
-    set crestFoamColor(value: number[]);
     /**
      * 设置波峰泡沫颜色
+     * @param {Array<number>} value RGB颜色数组，范围0-1
      */
-    get crestFoamColor(): number[];
-    set specularStrength(value: number);
+    set crestFoamColor(value: Array<number>);
+    /**
+     * 波峰泡沫颜色
+     * @type {Array<number>}
+     */
+    get crestFoamColor(): Array<number>;
     /**
      * 设置高光闪耀强度
+     * @param {number} value 高光强度值
+     */
+    set specularStrength(value: number);
+    /**
+     * 高光闪耀强度
+     * @type {number}
      */
     get specularStrength(): number;
+    /**
+     * 设置UV缩放比例
+     * @param {number} value UV缩放比例
+     */
+    set uvScale(value: number);
+    /**
+     * UV缩放比例
+     * @type {number}
+     */
+    get uvScale(): number;
     defines: {
         CUBEUV_TEXEL_WIDTH: number;
         CUBEUV_TEXEL_HEIGHT: number;
         CUBEUV_MAX_MIP: string;
     };
     /**
-     * 设置水系样式，默认为lake
-     * @param {'river'|'lake'|'ocean'} style 样式名称，只接受'river', 'lake', 'ocean'
+     * 渲染前的处理函数，更新相机和渲染状态相关的uniforms
+     * @param {Engine} engine 引擎实例
+     * @param {Scene} scene 场景对象
+     * @param {Camera} camera 相机对象
+     * @param {Object} renderState 渲染状态
+     * @protected
+     */
+    protected onBeforeSceneRender(engine: Engine, scene: Scene, camera: Camera, renderState: Object): void;
+    /**
+     * 设置是否使用环境贴图
+     * @param {boolean} value 是否启用环境贴图
      */
-    set style(style: "river" | "lake" | "ocean");
-    get style(): "river" | "lake" | "ocean";
-    /** @protected */
-    protected onBeforeSceneRender(engine: any, scene: any, camera: any, renderState: any): void;
     set useEnvMap(value: boolean);
+    /**
+     * 是否使用环境贴图
+     * @type {boolean}
+     */
     get useEnvMap(): boolean;
+    /**
+     * 设置时间缩放因子
+     * @param {number} value 时间缩放因子
+     */
     set timeScaleFactor(value: number);
+    /**
+     * 时间缩放因子
+     * @type {number}
+     */
     get timeScaleFactor(): number;
     normalMap: any;
-    waterBedMap: any;
+    /**
+     * 释放资源
+     * 清理所有纹理和缓存
+     */
     dispose(): void;
 }
 import { CommonShaderMaterial } from '../CommonShaderMaterial';

package/dist/types/threejs/materials/point/Ballon.d.ts

@@ -3,6 +3,7 @@ export class InstancedBallonMaterial extends InstancedEffectPointMaterial {
     isInstancedBallonMaterial: boolean;
     vertexShader: any;
     fragmentShader: any;
+    side: any;
     textureLoader: any;
     dispose(): void;
 }

package/dist/types/threejs/materials/point/Effect.d.ts

@@ -0,0 +1,13 @@
+export class InstancedEffectMaterial extends InstancedEffectPointMaterial {
+    constructor(parameters?: {});
+    name: string;
+    depthTest: boolean;
+    depthWrite: boolean;
+    transparent: boolean;
+    vertexShader: any;
+    fragmentShader: any;
+    isBreath: boolean;
+    noAnimation: boolean;
+    animationRotate: boolean;
+}
+import { InstancedEffectPointMaterial } from './EffectPoint';

package/dist/types/threejs/materials/point/Icon.d.ts

@@ -3,6 +3,10 @@ export class IconMaterial extends CommonShaderMaterial {
     vertexShader: any;
     fragmentShader: any;
     isIconMaterial: boolean;
+    transparent: boolean;
+    _fallback: string;
+    set fallback(value: string);
+    get fallback(): string;
     dispose(): void;
 }
 import { CommonShaderMaterial } from '../CommonShaderMaterial';

package/dist/types/threejs/materials/polygon/PolygonMaterial.d.ts

@@ -8,6 +8,8 @@ export class PolygonMaterial extends CommonShaderMaterial {
     mapSrc: any;
     emissiveEnabled: boolean;
     emissive: number[];
+    set backgroundColor(value: any);
+    get backgroundColor(): any;
     dispose(): void;
 }
 import { CommonShaderMaterial } from '../CommonShaderMaterial';

package/dist/types/threejs/materials/sphere/GridMaterial.d.ts

@@ -1,9 +1,14 @@
 export class GridMaterial extends InstancedEffectPointMaterial {
     name: string;
     isGridMaterial: boolean;
+    createGradientMap(): void;
+    _cachedGradientMap: any;
+    updateGradientMap(): void;
     vertexShader: any;
     fragmentShader: any;
-    side: any;
     transparent: boolean;
+    _multiColor: any[];
+    set multiColor(value: any[]);
+    get multiColor(): any[];
 }
 import { InstancedEffectPointMaterial } from '../point/EffectPoint';

package/dist/types/threejs/materials/sphere/PillarMaterial.d.ts

@@ -3,12 +3,16 @@ export class PillarMaterial extends InstancedEffectPointMaterial {
     isPillarMaterial: boolean;
     vertexShader: any;
     fragmentShader: any;
-    side: any;
     transparent: boolean;
     _cachedGradient: any;
+    _cachedBandColors: any;
+    _colorMode: any;
     createGradientMap(): void;
     _cachedGradientMap: any;
+    createBandMap(): void;
+    _cachedBandMap: any;
     updateGradientMap(): void;
+    updateBandMap(): void;
     dispose(): void;
 }
 import { InstancedEffectPointMaterial } from '../point/EffectPoint';

package/dist/types/threejs/objects/FadeData.d.ts

@@ -2,6 +2,7 @@
  * fadeOpacity: 0-1 淡入  3-2淡出，通过值可判断fade方向
  */
 export class FadeData {
+    constructor(options?: {});
     /** @private */
     private _fadeDuration;
     /** @private */

package/dist/types/threejs/objects/GeoInstancedMesh.d.ts

@@ -18,7 +18,7 @@ export class GeoInstancedMesh extends GeoObject {
      * @param {BufferGeometry} geometry 一个BufferGeometry实例
      * @param {Material} material 一个Material实例
      */
-    constructor(geometry: BufferGeometry, material: Material);
+    constructor(geometry: BufferGeometry, material: Material, parameters: any);
     /** @protected */ protected type: string;
     /** @protected */ protected isMesh: boolean;
     /** @protected */ protected isInstancedMesh: boolean;
@@ -35,7 +35,6 @@ export class GeoInstancedMesh extends GeoObject {
     isEventEntitySupported: boolean;
     boundingBox: null;
     boundingSphere: null;
-    parameters: {};
     geometry: BufferGeometry;
     material: Material;
     set enableInstanceColor(value: boolean);

package/dist/types/threejs/objects/GeoObject.d.ts

@@ -18,6 +18,7 @@ export class GeoObject extends ThreeObject {
     /** @private */ private _zooms;
     /** @private */ private _zoomVisibleCache;
     /** @protected */ protected engine: any;
+    _attributeRenameMap: {};
     /** @protected */
     set parameters(value: any);
     /**
@@ -31,6 +32,8 @@ export class GeoObject extends ThreeObject {
     set dataSource(dataSource: DataSource);
     /** object连接的数据源[[DataSource]]类 */
     get dataSource(): DataSource;
+    _proxyDataSource: any;
+    _proxyDataSourceNeedsUpdate: boolean | undefined;
     /**
      * 设置object是否在下一帧更新
      * @param {boolean} value 设置为true，则下一帧渲染前更新该object
@@ -56,6 +59,27 @@ export class GeoObject extends ThreeObject {
      * @internal
      */
     get inZoomsRange(): boolean;
+    /** @private */
+    private _createProxyDataSource;
+    /** @private */
+    private _createMappedObjectProxy;
+    /** @private */
+    private _createLazyMappedArrayProxy;
+    /**
+     * 添加属性重命名
+     * @param {string} key 原始属性名，该组件的属性名
+     * @param {string} value 重命名后的属性名，数据源的属性名
+     */
+    addAttributeRename(key: string, value: string): void;
+    /**
+     * 移除属性重命名
+     * @param {string} key 原始属性名
+     */
+    removeAttributeRename(key: string): void;
+    /**
+     * 清空属性重命名
+     */
+    clearAttributeRename(): void;
     /** @protected */
     protected afterAddToEngine(engine: any): void;
     /**

package/dist/types/threejs/objects/ThreeObject.d.ts

@@ -10,12 +10,14 @@ export class ThreeObject {
     /**
     * @internal
     * @param {*} geometry 要偏移坐标的geometry
+    * @param {*} positions 要偏移的position数组
+    * @param {*} offsetLength 偏移数据长度
     */
-    makeGeometryOffsetPosition: (geometry: any, positions: any) => void;
+    makeGeometryOffsetPosition: (geometry: any, positions: any, offsetLength: any) => void;
     /**
      * @internal
      */
-    makePostionArrayOffset: (positions: any, x: any, y: any, z: any, origin: any) => void;
+    makePostionArrayOffset: (positions: any, x: any, y: any, z: any, origin: any, offsetLength: any) => void;
     /**
      * @internal
      */

package/dist/types/threejs/objects/element/OctahedralImpostor.d.ts

@@ -1,32 +1,27 @@
-/**
- * 八面体替代渲染类
- */
-export class OctahedralImpostor extends GeoInstancedPointMesh {
-    static textureLoader: any;
+export class OctahedralImpostor extends GeoInstancedMesh {
+    static imageBitmapLoader: any;
     static defaultTextures: {
         diffuse: null;
         normalDepth: null;
         orm: null;
     };
-    /**
-     * 初始化默认纹理（如果尚未加载）
-     */
-    static initDefaultTextures(): void;
-    /**
-     * 构造函数
-     * @param {Object} parameters - 配置参数
-     */
-    constructor(parameters?: Object);
-    parameters: Object;
-    offsetY: any;
+    static initDefaultTextures(): Promise<void>;
+    static createTextures(diffuseUrl: any, normalDepthUrl: any, ormUrl: any): Promise<{
+        diffuseTexture: any;
+        normalDepthTexture: any;
+        ormTexture: any;
+    }>;
+    constructor(parameters?: {});
+    parameters: {};
+    offsetZ: any;
     modelDistance: any;
     imposterScale: any;
     hasLastResult: boolean;
     lastCameraPosition: any;
-    /**
-     * 初始化纹理
-     */
-    initTextures(): void;
+    _texturesInitialized: boolean;
+    _geometryInitialized: boolean;
+    initialize(): Promise<void>;
+    initTextures(): Promise<void>;
     diffuseTexture: any;
     normalDepthTexture: any;
     ormTexture: any;
@@ -92,6 +87,5 @@ export class OctahedralImpostor extends GeoInstancedPointMesh {
      */
     private _createScaleMatrix;
 }
-import { GeoInstancedPointMesh } from '../point/GeoInstancedPointMesh';
 import { GeoInstancedMesh } from '../GeoInstancedMesh';
 import { GeoJSONDataSource } from '../../../threemap/dataSource/GeoJSONDataSource';

package/dist/types/threejs/objects/heatmap/Heatmap3D.d.ts

@@ -1,9 +1,21 @@
 /**
- * 3D热力图，立体热力图，平面热力图见[[Heatmap]]
+ * 3D热力图，立体热力图，平面热力图见 {@link Heatmap}
  *
  * **注意：3D热力图目前只适用于小面积覆盖范围（区、乡镇级别以下），在大面积覆盖场景下（省、市级别以上）会有明显性能问题**
- * ```js
- * const heatmap = engine.add(new mapvthree.Heatmap3D());
+ *
+ * @category Objects
+ * @example
+ * ```javascript
+ * const heatmap = engine.add(new mapvthree.Heatmap3D({
+ *     gradient: {
+ *         0.4: 'rgba(0,0,255,1)',
+ *         0.6: 'rgba(0,255,0,1)',
+ *         0.8: 'rgba(255,255,0,1)',
+ *         1: 'rgba(255,0,0,1)'
+ *     },
+ *     radius: 100,
+ *     maxValue: 1
+ * }));
  * let data = mapvthree.GeoJSONDataSource.fromGeoJSON(data);
  * heatmap.dataSource = data;
  * ```
@@ -12,21 +24,19 @@
 export class Heatmap3D extends GeoMesh {
     /**
      * 构造函数
-     * @param {{
-     * gradient?: object, opacity?: number, heightRatio?: number, maxValue?: number, radius?: number
-     * }} parameters 传入参数对象
-     * @param {object} parameters.gradient 热力渐变颜色配置，格式为{stop: 'color'}，例如{0.4: 'blue', 0.65: 'lime', 1: 'red'}
-     * @param {number} parameters.opacity 透明度整体系数，默认1
-     * @param {number} parameters.heightRatio 高度系数，默认100
-     * @param {number} parameters.maxValue 最大热力值，默认1
-     * @param {number} parameters.radius 热力绘制半径，默认100
+     * @param {Object} parameters 传入参数对象
+     * @param {Object} [parameters.gradient] 热力渐变颜色配置，格式为{stop: 'color'}，例如{0.4: 'blue', 0.65: 'lime', 1: 'red'}
+     * @param {number} [parameters.opacity=1] 透明度整体系数
+     * @param {number} [parameters.heightRatio=100] 高度系数
+     * @param {number} [parameters.maxValue=1] 最大热力值
+     * @param {number} [parameters.radius=100] 热力绘制半径
      */
     constructor(parameters: {
-        gradient?: object;
-        opacity?: number;
-        heightRatio?: number;
-        maxValue?: number;
-        radius?: number;
+        gradient?: Object | undefined;
+        opacity?: number | undefined;
+        heightRatio?: number | undefined;
+        maxValue?: number | undefined;
+        radius?: number | undefined;
     });
     /** @private */ private _gradient;
     /** @private */ private _radius;
@@ -38,16 +48,26 @@ export class Heatmap3D extends GeoMesh {
     /** 透明度整体系数 */ opacity: any;
     /** 高度系数 */ heightRatio: any;
     parameters: {
-        gradient?: object;
-        opacity?: number;
-        heightRatio?: number;
-        maxValue?: number;
-        radius?: number;
+        gradient?: Object | undefined;
+        opacity?: number | undefined;
+        heightRatio?: number | undefined;
+        maxValue?: number | undefined;
+        radius?: number | undefined;
     };
     texture: any;
-    set gradient(value: object);
+    set gradient(value: Object | {
+        0.4: string;
+        0.6: string;
+        0.8: string;
+        1: string;
+    });
     /** 热力渐变颜色配置，格式为{stop: 'color'}，例如{0.4: 'blue', 0.65: 'lime', 1: 'red'} */
-    get gradient(): object;
+    get gradient(): Object | {
+        0.4: string;
+        0.6: string;
+        0.8: string;
+        1: string;
+    };
     set radius(value: number);
     /** 热力绘制半径 */
     get radius(): number;

package/dist/types/threejs/objects/instance/InstancedModel.d.ts

@@ -7,6 +7,8 @@ export class InstancedModel {
      * 是否支持返回的事件参数中携带entity实体数据
      */
     isEventEntitySupported: boolean;
+    /** @readonly */
+    readonly isInstancedModel: true;
     /**
      * @private
      * mesh,这里的mesh需要材质数量尽可能少