@soonspacejs/plugin-heat-cloud 2.16.8 → 3.0.0-alpha.0

package/dist/index.d.ts

@@ -1,24 +1,2499 @@
-import { ColorGradient, CreateImageData3DTextureFromGradientOptions, GradientVolumeMaterialOptions, HeatData3DOptions, HeatParticleVolumeFeaturePoint, ParticleVolumeFeaturePoint, SliceMaterialOptions, VolumeMaterial } from '@three3d/volume';
-import { default as SoonSpace } from 'soonspacejs';
-import { CreatLineHeatOptions, CreateHeatCloudOptions, CreateHeatOptions, CreateImageExtrusionOptions } from './types';
-export * from '@three3d/volume';
-export declare class HeatMapPlugin {
-    readonly ssp: SoonSpace;
-    constructor(ssp: SoonSpace);
-    defaultColorGradient: ColorGradient;
-    defaultGradientVolumeMaterialOptions: GradientVolumeMaterialOptions;
-    protected _createTexture(points: HeatData3DOptions['points'], options: CreateHeatOptions, isLine?: boolean): any;
-    /**
-     * 创建热力云
-     * return material
-     */
-    createHeatCloud(points: HeatParticleVolumeFeaturePoint[], options?: CreateHeatCloudOptions): any;
-    createLineHeat(points: ParticleVolumeFeaturePoint[], options: CreatLineHeatOptions): any;
-    createImageExtrusion(imageUrl: string, options?: CreateImageExtrusionOptions & {
-        depth?: number;
-    }): Promise<any>;
-    createSliceMesh(material: VolumeMaterial, options?: SliceMaterialOptions & CreateImageData3DTextureFromGradientOptions): any;
-    createImageSlice(material: VolumeMaterial, options?: CreateImageData3DTextureFromGradientOptions): any;
-}
-export * from './types';
-export default HeatMapPlugin;
+import { BufferGeometry } from 'three';
+import { Color } from 'three';
+import { Data3DTexture } from 'three';
+import type { DataArrayTexture } from 'three';
+import { default as default_2 } from 'soonspacejs';
+import { IUniform } from 'three';
+import type { Matrix3 } from 'three';
+import { Matrix4 } from 'three';
+import { Mesh } from 'three';
+import { NormalBufferAttributes } from 'three';
+import { Points } from 'three';
+import { PointsMaterialParameters } from 'three';
+import { RawShaderMaterial } from 'three';
+import { ShaderLib } from 'three';
+import { ShaderMaterial } from 'three';
+import { ShaderMaterialParameters } from 'three';
+import type { Side } from 'three';
+import { Texture } from 'three';
+import { TextureDataType } from 'three';
+import { Vector2 } from 'three';
+import { Vector3 } from 'three';
+
+/**
+ * 轴
+ */
+declare enum Axis {
+    	x = 0,
+    	y = 1,
+    	z = 2
+}
+
+/**
+ * 轴的方法
+ */
+declare namespace Axis {
+    	/**
+     	 * 将轴索引转为轴名字
+     	 * @param index - 索引
+     	 * @returns
+     	 */
+    	function toKey(index: Axis): AxisName;
+    	/**
+     	 * 将轴名字转为轴索引
+     	 * @param name
+     	 * @returns
+     	 */
+    	function toIndex(name: AxisName): Axis;
+    	/**
+     	 * 获取剩余的另外两个轴
+     	 * @remarks
+     	 * 获取除 axis 之外的另外两个轴，且这两轴的顺序符合叉乘得 axis 轴的顺序
+     	 * @param axis
+     	 * @returns
+     	 */
+    	function getCrossAxiss(axis: Axis): [
+    		Axis,
+    		Axis
+    	];
+}
+
+/**
+ * 轴名
+ */
+declare type AxisName = "x" | "y" | "z";
+
+export declare type ColorFogPoint = ColorFogPointFeature & IVector3;
+
+declare interface ColorFogPointFeature extends Omit<VolumeFeature, "value"> {
+    /**
+     * 颜色 RGBA
+     * @remarks
+     * 其中 RGB 取值是 0 - 255，A 的取值是 0 - 1
+     */
+    color?: [number, number, number, number];
+}
+
+export declare class ColorFogPointsMaterial extends FogPointsMaterial<ColorFogPointsMaterialUniforms> {
+    readonly isColorFogPointsMaterial = true;
+    constructor(options?: ColorFogPointsMaterialOptions);
+    /**
+     * 雾点的颜色
+     * @remarks
+     * 当开启顶点颜色 {@link SphereFogMaterial.vertexColors} 时，此设置将无论；
+     */
+    get color(): Color;
+    set color(value: Color);
+    get alphaMap(): Texture | null;
+    set alphaMap(value: Texture | null);
+    get uvTransform(): Matrix3;
+    set uvTransform(value: Matrix3);
+}
+
+/**
+ * 雾点材质的选项
+ */
+export declare interface ColorFogPointsMaterialOptions extends PointsMaterialParameters, FogPointsMaterialOptions {
+    uvTransform?: Matrix3;
+}
+
+/**
+ * 雾点材质的 uniforms
+ */
+export declare type ColorFogPointsMaterialUniforms = PointsUniforms & FogPointsMaterialUniforms;
+
+export declare interface ColorFogPointsOptions extends ColorFogPointFeature {
+    points: ColorFogPoint[];
+}
+
+/**
+ * 颜色梯度，颜色断点列表
+ * @remarks
+ * 颜色断点可以不按顺序排列
+ */
+export declare type ColorGradient = ColorStop[];
+
+/**
+ * 颜色断点
+ * @remarks
+ * number 的范围是 0-1，表示断点的位置；
+ *
+ * string 表示颜色，支持 css 所支持的所有颜色格式；
+ */
+export declare type ColorStop = [number, string];
+
+/**
+ * 根据热力点来计算并生成相关的3D数据
+ * @param pointInfo - 点信息
+ * @param extraInfo - 额外的信息
+ * @param intersects - 相交的点列表
+ * @returns
+ */
+export declare function computeHeatData3DForPoint(pointInfo: HeatParticleVolumeFeaturePointInfo, extraInfo: Data3DPointExtraInfo, intersects: HeatParticleVolumeFeaturePointInfo[]): {
+    particles: Vector3[];
+    values: number[];
+};
+
+/**
+ * 创建颜色雾点
+ * @param options
+ * @returns
+ */
+export declare function createColorFogPoints(options: CreateColorFogPointsOptions): Points<BufferGeometry<NormalBufferAttributes>, ColorFogPointsMaterial>;
+
+export declare type CreateColorFogPointsOptions = ColorFogPointsOptions & ColorFogPointsMaterialOptions;
+
+/**
+ * 创建梯度 Data3DTexture
+ * @param data3D - 3D数据
+ * @param options - 选项
+ * @returns
+ */
+export declare function createGradientData3DTexture(data3D: IData3D, options?: CreateGradientData3DTextureOptions): GradientData3DTexture;
+
+export declare interface CreateGradientData3DTextureOptions {
+    /**
+     * 表示为空的值
+     * @remarks
+     * 在转换时 IData3D 时，当遇到值为 undefined 或 null 的值时，就会使 voidValue 来替换；
+     *
+     * IData3D 中，可以通过 undefined 或 null 来表示空，但在将 IData3D 转为 Data3DTexture 时，所有的item都必须是数字，所以这时就需要为空约定一个数字；
+     *
+     * @defaultValue 0
+     */
+    voidValue?: number;
+    /**
+     * 3D数据中包含的数值是否是 uint8 类型的
+     * @defaultValue false
+     */
+    uint8?: boolean;
+}
+
+/**
+ * 创建梯度雾点
+ * @param options
+ * @returns
+ */
+export declare function createGradientFogPoints(options: CreateGradientFogPointsOptions): Points<BufferGeometry<NormalBufferAttributes>, GradientFogPointsMaterial>;
+
+export declare type CreateGradientFogPointsOptions = GradientFogPointsOptions & GradientFogPointsMaterialOptions;
+
+export declare type CreateHeatCloudOptions = HeatDataOptions & GradientOptions;
+
+/**
+ * 创建热力3D数据
+ * @param options
+ * @returns
+ */
+export declare function createHeatData3D(options: HeatData3DOptions): {
+    data: number[];
+    size: Vector3;
+};
+
+export declare type CreateHeatOptions = CreatLineHeatOptions & CreateHeatCloudOptions;
+
+/**
+ * 通过挤出Image来创建 ImageData3DTexture
+ * @remarks
+ * 没 z 轴挤出
+ * @param image - 图像
+ * @param depth - 挤出的深度
+ * @param options - 选项
+ * @returns
+ */
+export declare function createImageData3DTextureByExtrudeImage(image: CanvasImageSource, depth: number, options?: ExtrudeImageOptions | null): ImageData3DTexture;
+
+/**
+ * 从梯度数据 创建梯度图像 ImageData3DTexture
+ * @param gradientData3D - 梯度数据
+ * @param options - 选项
+ * @returns
+ */
+export declare function createImageData3DTextureFromGradient(gradientData3D: IData3D | IImageData3, options: CreateImageData3DTextureFromGradientOptions): ImageData3DTexture;
+
+export declare type CreateImageData3DTextureFromGradientOptions = GradientData3DToImageData3DOptions & {
+    gradient: TexImageSource | ColorGradient;
+};
+
+export declare type CreateImageExtrusionOptions = VolumeMaterialOptions<ImageData3DTexture> & ExtrudeImageOptions;
+
+/**
+ * 创建线性渐变 ImageData
+ * @param colorGradient
+ * @param width - 宽度
+ * @param height - 高度
+ * @returns
+ */
+export declare function createLinearGradientImageData(colorGradient: ColorGradient, width: number, height: number, colorSpace?: PredefinedColorSpace): ImageData;
+
+/**
+ * 创建线性Data3D数据
+ * @param options
+ * @returns
+ */
+export declare function createLineData3D(options: LineData3DOptions): {
+    particles: Vector3[];
+    values: number[];
+    size: Vector3;
+    data: number[];
+};
+
+export declare type CreatLineHeatOptions = LineDataOptions & GradientOptions;
+
+/**
+ * 将 Data2D 的坐标转成 索引
+ * @param coord - 坐标
+ * @param size - Data2D 的尺寸
+ * @returns 索引
+ */
+export declare function data2DCoordToIndex(coord: IVector2, size: IVector2): number;
+
+/**
+ * 将 Data2D 的坐标转成 索引
+ * @param coord - 坐标
+ * @param size - Data2D 的尺寸
+ * @returns 索引
+ */
+export declare function data2DIndexToCoord(index: number, size: IVector2): {
+    x: number;
+    y: number;
+};
+
+/**
+ * 将 Data3D 的坐标转成 索引
+ * @param coord - 坐标
+ * @param size - Data3D 的尺寸
+ * @returns 索引
+ */
+export declare function data3DCoordToIndex(coord: IVector3, size: IVector3): number;
+
+/**
+ * 将 Data3D 的坐标转成 索引
+ * @param coord - 坐标
+ * @param size - Data3D 的尺寸
+ * @returns 索引
+ */
+export declare function data3DIndexToCoord(index: number, size: IVector3): {
+    x: number;
+    y: number;
+    z: number;
+};
+
+/**
+ * 计算 Data3D 点所需要的额外信息
+ */
+export declare type Data3DPointExtraInfo = {
+    /**
+     * 存放 Data3D 的数组
+     * @remarks
+     * 长度应该是 `size.x * size.y * size.z`
+     */
+    data3D: number[];
+    /**
+     * Data3D的尺寸
+     */
+    size: IVector3;
+    /**
+     * 计算标记数组
+     * @remarks
+     * 与 data3D 一样长，用于记录哪些像素已经被计算过了
+     */
+    tags: (undefined | true)[];
+};
+
+export declare interface DataAccumulateValue<D> {
+    value: D;
+    data3D: IData3D<D>;
+    index: number;
+    coord: IVector3;
+}
+
+/**
+ * 值累积函数
+ */
+export declare type DataValuesAccumulate<D> = (values: DataAccumulateValue<D>[]) => D;
+
+/**
+ * 体积材质
+ */
+export declare class ExampleVolumeMaterial_1 extends ShaderMaterial {
+    readonly isExampleVolumeMaterial_1 = true;
+    constructor(options?: ExampleVolumeMaterial_1Options);
+    uniforms: ExampleVolumeMaterial_1Uniforms;
+    /**
+     * 三维纹理
+     */
+    get map(): Data3DTexture | null;
+    set map(value: Data3DTexture | null);
+    /**
+     * 颜色映射纹理
+     * @remarks
+     * 会将垂直居中的那条水平像素从左到右映射到 clim 表示的限制区间，
+     * 即 clim.x 对应最左边的像素，clim.y 对应最右边的像素
+     */
+    get gradientMap(): Texture | null;
+    protected _gradient?: null | GradientTextureOptions;
+    /**
+     * 颜色映射选项
+     */
+    get gradient(): GradientTextureOptions | null | undefined;
+    set gradient(value: GradientTextureOptions | null | undefined);
+    /**
+     * 三维纹理的尺寸
+     * @remarks
+     * 三维纹理的尺寸 要 和 Geometry 的尺寸是一样的，不但比列一样，大小也是一样的
+     * 但 mesh 本身可以进行几何变换；
+     * Geometry 左下角的坐标要从 (0,0,0) 开始；
+     */
+    get size(): Vector3;
+    set size(value: Vector3);
+    /**
+     * 渲染样式
+     */
+    get style(): VolumeRenderStyle;
+    set style(value: VolumeRenderStyle);
+    /**
+     * 映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     */
+    get clim(): Vector2;
+    set clim(value: Vector2);
+    /**
+     * 渲染最低阈值
+     * @remarks
+     * 只对 ISO 样式有效；
+     *
+     * 当三维纹理中的值低于该值时，不会被渲染，即视为空
+     */
+    get threshold(): number;
+    set threshold(value: number);
+}
+
+/**
+ * 体积材质选项
+ */
+export declare interface ExampleVolumeMaterial_1Options {
+    /**
+     * 渲染样式
+     */
+    style?: VolumeRenderStyle | null;
+    /**
+     * 渲染最低阈值
+     * @remarks
+     * 只对 ISO 样式有效；
+     *
+     * 当三维纹理中的值低于该值时，不会被渲染，即视为空
+     */
+    threshold?: number | null;
+    /**
+     * 映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     */
+    clim?: Vector2 | null;
+    /**
+     * 三维纹理
+     */
+    map?: Data3DTexture | null;
+    /**
+     * 颜色映射纹理
+     */
+    gradient?: GradientTextureOptions | null;
+}
+
+export declare interface ExampleVolumeMaterial_1Uniforms {
+    u_size: IUniform<Vector3>;
+    u_renderstyle: IUniform<VolumeRenderStyle>;
+    u_renderthreshold: IUniform<number>;
+    u_clim: IUniform<Vector2>;
+    u_data: IUniform<null | Data3DTexture>;
+    u_cmdata: IUniform<null | Texture>;
+
+    [uniform: string]: IUniform<unknown>;
+}
+
+/**
+ * 示例体积材质-云
+ */
+export declare class ExampleVolumeMaterial_Cloud extends RawShaderMaterial {
+    readonly isExampleVolumeMaterial_Cloud = true;
+    constructor(options?: ExampleVolumeMaterial_CloudOptions);
+    uniforms: ExampleVolumeMaterial_CloudUniforms;
+    /**
+     * 三维纹理
+     */
+    get map(): GradientData3DTexture | null;
+    set map(value: GradientData3DTexture | null);
+    /**
+     * 颜色
+     */
+    get color(): Color;
+    set color(value: Color);
+    /**
+     * 透明度
+     */
+    get opacity(): number;
+    set opacity(value: number);
+    /**
+     * 渲染最低阈值
+     */
+    get threshold(): number;
+    set threshold(value: number);
+    /**
+     * 范围
+     */
+    get range(): number;
+    set range(value: number);
+    /**
+     * 体积材质渲染的采样数
+     */
+    get steps(): number;
+    set steps(value: number);
+    /**
+     * 渲染帧次
+     */
+    get frame(): number;
+    set frame(value: number);
+    /**
+     * 相机的位置
+     */
+    get cameraPos(): Vector3;
+    set cameraPos(value: Vector3);
+}
+
+/**
+ * 示例体积材质-云 的选项
+ */
+export declare interface ExampleVolumeMaterial_CloudOptions {
+    /**
+     * 颜色
+     */
+    color?: Color | null;
+    /**
+     * 三维纹理
+     */
+    map?: GradientData3DTexture | null;
+    /**
+     * 渲染最低阈值
+     */
+    threshold?: number | null;
+    /**
+     * 透明度
+     */
+    opacity?: number | null;
+    /**
+     * 范围
+     */
+    range?: number | null;
+    /**
+     * 体积材质渲染的采样数
+     */
+    steps?: number | null;
+    /**
+     * 渲染帧次
+     */
+    frame?: number | null;
+    /**
+     * 相机的位置
+     */
+    cameraPos?: Vector3 | null;
+}
+
+/**
+ * 示例体积材质-云 的 uniforms
+ */
+export declare interface ExampleVolumeMaterial_CloudUniforms {
+    base: IUniform<Color>;
+    map: IUniform<null | GradientData3DTexture>;
+    threshold: IUniform<number>;
+    opacity: IUniform<number>;
+    range: IUniform<number>;
+    steps: IUniform<number>;
+    frame: IUniform<number>;
+    cameraPos: IUniform<Vector3>;
+
+    [uniform: string]: IUniform<unknown>;
+}
+
+/**
+ * 示例体积材质-花边
+ */
+export declare class ExampleVolumeMaterial_Perlin extends RawShaderMaterial {
+    readonly isExampleVolumeMaterial_Perlin = true;
+    constructor(options?: ExampleVolumeMaterial_PerlinOptions);
+    uniforms: ExampleVolumeMaterial_PerlinUniforms;
+    /**
+     * 三维纹理
+     */
+    get map(): GradientData3DTexture | null;
+    set map(value: GradientData3DTexture | null);
+    /**
+     * 渲染最低阈值
+     */
+    get threshold(): number;
+    set threshold(value: number);
+    /**
+     * 体积材质渲染的采样数
+     */
+    get steps(): number;
+    set steps(value: number);
+    /**
+     * 相机的位置
+     */
+    get cameraPos(): Vector3;
+    set cameraPos(value: Vector3);
+}
+
+/**
+ * 体积切片材质选项
+ */
+export declare interface ExampleVolumeMaterial_PerlinOptions {
+    /**
+     * 三维纹理
+     */
+    map?: GradientData3DTexture | null;
+    /**
+     * 渲染最低阈值
+     */
+    threshold?: number | null;
+    /**
+     * 体积材质渲染的采样数
+     */
+    steps?: number | null;
+    /**
+     * 相机的位置
+     */
+    cameraPos?: Vector3 | null;
+}
+
+/**
+ * 示例体积材质-花边 的 uniforms
+ */
+export declare interface ExampleVolumeMaterial_PerlinUniforms {
+    map: IUniform<null | GradientData3DTexture>;
+    threshold: IUniform<number>;
+    steps: IUniform<number>;
+    cameraPos: IUniform<Vector3>;
+
+    [uniform: string]: IUniform<unknown>;
+}
+
+/**
+ * 挤出图像
+ * @param image
+ * @param depth
+ * @param colorSpace
+ * @returns
+ */
+export declare function extrudeImage(image: CanvasImageSource, depth: number, options?: ExtrudeImageOptions | null): {
+    data: Uint8ClampedArray;
+    width: number;
+    height: number;
+    depth: number;
+    colorSpace: PredefinedColorSpace;
+};
+
+/**
+ * 挤压ImageData
+ * @param imageData
+ * @param depth
+ * @param colorSpace
+ * @returns
+ */
+export declare function extrudeImageData(imageData: ImageData, depth: number, reverseY?: boolean | null): {
+    data: Uint8ClampedArray;
+    width: number;
+    height: number;
+    depth: number;
+    colorSpace: PredefinedColorSpace;
+};
+
+/**
+ * 在指定轴上挤压ImageData
+ * @param imageData
+ * @param axisName
+ * @param depth
+ * @param reverseY
+ * @returns
+ */
+export declare function extrudeImageDataOnAxis(imageData: ImageData, axis: Axis, depth: number, reverseY?: boolean | null): {
+    data: Uint8ClampedArray;
+    width: number;
+    height: number;
+    depth: number;
+    colorSpace: PredefinedColorSpace;
+};
+
+/**
+ * extrudeImage 的选项
+ */
+export declare interface ExtrudeImageOptions {
+    reverseY?: boolean | null;
+    axis?: Axis | null;
+    colorSpace?: PredefinedColorSpace | null;
+}
+
+export declare class FogPointsMaterial<FogPointsUniforms extends FogPointsMaterialUniforms> extends ShaderMaterial {
+    readonly isFogPointsMaterial = true;
+    constructor(options?: FogPointsMaterialOptions, shaderMaterialParameters?: ShaderMaterialParameters | null);
+    uniforms: FogPointsUniforms;
+    /**
+     * 使用来自Texture的数据设置点的颜色
+     * @remarks
+     * 可以选择包括一个alpha通道，通常与 .transparent或.alphaTest。
+     */
+    get map(): Texture | null;
+    set map(value: Texture | null);
+    /**
+     * 是否渲染成星星的样式
+     * @remarks
+     * 否则，将被渲染成球形
+     */
+    get star(): boolean;
+    set star(value: boolean);
+    /**
+     * 点的大小
+     * @defaultValue 1.0
+     */
+    get size(): number;
+    set size(value: number);
+    /**
+     * 透明度
+     * @remarks
+     * 决定整体的透明度
+     * @defaultValue 1
+     */
+    get opacity(): number;
+    set opacity(value: number);
+    /**
+     * 实心因子
+     * @remarks
+     * 在实心范围内，雾点不会衰减
+     * @defaultValue 0
+     */
+    get solid(): number;
+    set solid(value: number);
+    /**
+     * 雾的衰减指数
+     * @defaultValue 1
+     */
+    get exp(): number;
+    set exp(value: number);
+    get scale(): number;
+    set scale(value: number);
+    get fogDensity(): number;
+    set fogDensity(value: number);
+    get fogNear(): number;
+    set fogNear(value: number);
+    get fogFar(): number;
+    set fogFar(value: number);
+    get fogColor(): Color;
+    set fogColor(value: Color);
+    /**
+     * 点的大小是否因相机深度而衰减
+     * @remarks
+     * 仅限透视摄像头
+     *
+     * @defaultValue true
+     */
+    sizeAttenuation: boolean;
+}
+
+/**
+ * 雾点材质的选项
+ */
+export declare interface FogPointsMaterialOptions extends Omit<PointsMaterialParameters, "color" | "uvTransform" | "alphaMap"> {
+    /**
+     * 是否渲染成星星的样式
+     * @remarks
+     * 否则，将被渲染成球形
+     */
+    star?: boolean;
+    /**
+     * 实心因子
+     * @remarks
+     * 在实心范围内，雾点不会衰减
+     * @defaultValue 0
+     */
+    solid?: number;
+    /**
+     * 雾的衰减指数
+     * @defaultValue 1
+     */
+    exp?: number;
+    /**
+     * 是否使用 geometry 中的 radius 属性
+     * @remarks
+     * 如果为 true，geometry 中需要定义 radius 属性；
+     */
+    useRadius?: boolean;
+    /**
+     * 点的大小是否因相机深度而衰减
+     * @remarks
+     * 仅限透视摄像头
+     *
+     * @defaultValue true
+     */
+    sizeAttenuation?: boolean;
+}
+
+/**
+ * 雾点材质的 uniforms
+ */
+export declare interface FogPointsMaterialUniforms extends Omit<PointsUniforms, "diffuse" | "uvTransform" | "alphaMap"> {
+    solid: IUniform<number>;
+    exp: IUniform<number>;
+    star: IUniform<boolean>;
+}
+
+/**
+ * 获取 Data2D 对应坐标处的Item和对应的索引
+ * @remarks
+ * 不会验证坐标是否超出 data2D 的尺寸范围
+ * @param data2D
+ * @param coord
+ * @returns
+ */
+export declare function getData2DItem<D>(data2D: IData2D<D>, coord: IVector2, itemSize?: number): {
+    index: number;
+    value: D[];
+};
+
+/**
+ * 安全地获取 Data2D 对应坐标处的Item和对应的索引
+ * @param data2D
+ * @param coord -坐标会被钳在 data2D 的尺寸范围中
+ * @returns 当坐标超出 data2D 的尺寸范围时，会返回 null
+ */
+export declare function getData2DItemSafe<D>(data2D: IData2D<D>, coord: IVector2, itemSize?: number): {
+    index: number;
+    value: D[];
+};
+
+/**
+ * 获取指定的行，即：y
+ * @param data2D
+ * @param row
+ * @param itemSize
+ * @returns
+ */
+export declare function getData2DRow<D>(data2D: IData2D<D>, row: number, itemSize?: number): any;
+
+/**
+ * 获取 D苌3D 对应坐标处的值和对应的索引
+ * @remarks
+ * 不会验证坐标是否超出 data2D 的尺寸范围
+ * @param data2D
+ * @param coord
+ * @returns
+ */
+export declare function getData2DValue<D>(data2D: IData2D<D>, coord: IVector2): {
+    index: number;
+    value: D;
+};
+
+/**
+ * 安全地获取 IData2D 对应坐标处的值和对应的索引
+ * @param data2D
+ * @param coord
+ * @returns 当坐标超出 data2D 的尺寸范围时，会返回 null
+ */
+export declare function getData2DValueSafe<D>(data2D: IData2D<D>, coord: IVector2): {
+    index: number;
+    value: D;
+};
+
+/**
+ * 获取 Data3D 对应坐标处的Item和对应的索引
+ * @remarks
+ * 不会验证坐标是否超出 data3D 的尺寸范围
+ * @param data3D
+ * @param coord
+ * @returns
+ */
+export declare function getData3DItem<D>(data3D: IData3D<D>, coord: IVector3, itemSize?: number): {
+    index: number;
+    value: D[];
+};
+
+/**
+ * 安全地获取 Data3D 对应坐标处的Item和对应的索引
+ * @param data3D
+ * @param coord - 坐标会被钳在 data3D 的尺寸范围中
+ * @returns
+ */
+export declare function getData3DItemSafe<D>(data3D: IData3D<D>, coord: IVector3, itemSize?: number): {
+    index: number;
+    value: D[];
+};
+
+/**
+ * 获取 data3D 在某个轴上指定位置的切片
+ * @remarks
+ * 对于超出范围的深度，会被钳在 [0,轴长-1] 区间
+ * @param data3D
+ * @param axis
+ * @param depth
+ * @param itemSize
+ * @returns
+ */
+export declare function getData3DSlice<D>(data3D: IData3D<D>, axis: Axis, depth: number, itemSize?: number): IData2D<D>;
+
+/**
+ * 获取 D苌3D 对应坐标处的值和对应的索引
+ * @remarks
+ * 不会验证坐标是否超出 data3D 的尺寸范围
+ * @param data3D
+ * @param coord
+ * @returns
+ */
+export declare function getData3DValue<D>(data3D: IData3D<D>, coord: IVector3): {
+    index: number;
+    value: D;
+};
+
+/**
+ * 安全地获取 D苌3D 对应坐标处的值和对应的索引
+ * @param data3D
+ * @param coord - 坐标会被钳在 data3D 的尺寸范围中
+ * @returns
+ */
+export declare function getData3DValueSafe<D>(data3D: IData3D<D>, coord: IVector3): {
+    index: number;
+    value: D;
+};
+
+/**
+ * 值梯度函数
+ * @remarks
+ * 会通过该函数来获取在中心点及其半径范围内各点处的值
+ * @param params - 梯度参数；包含了当前点处的相关信息
+ * @returns 返回最终的值
+ */
+export declare type GetGradientValue = (params: GradientParams) => number;
+
+/**
+ * 获取 ImageData 的指定位置的像素
+ * @param imageData
+ * @param row - 行索引
+ * @param col - 列索引
+ * @returns 返回有4个元素的 Uint8ClampedArray 对象，依次存放 RGBA 的值
+ */
+export declare function getImageDateColor(imageData: ImageData, row: number, col: number): Uint8ClampedArray;
+
+/**
+ * 获取图像的 ImageData
+ * @remarks
+ * 对于 SVGImageElement 类型的 image，需要指定 `area.width` 和 `area.height`
+ * @param image
+ * @param options
+ * @returns
+ */
+export declare function getImageDateOfImage(image: CanvasImageSource, options?: GetImageDateOfImageOptions): ImageData;
+
+export declare interface GetImageDateOfImageOptions {
+    /**
+     * 需要获取图像哪部分区域的数据
+     * @defaultValue 图像的完整区域
+     */
+    area?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    } | null;
+    /**
+     * ImageDate 的宽度
+     * @remarks
+     * 如果与 area 的宽度不一样，则会对图像进行缩放处理
+     */
+    width?: number | null;
+    /**
+     * ImageDate 的高度
+     * @remarks
+     * 如果与 area 的高度不一样，则会对图像进行缩放处理
+     */
+    height?: number | null;
+    colorSpace?: PredefinedColorSpace | null;
+}
+
+/**
+ * 获取 ImageData 的指定行
+ * @param imageData
+ * @param row - 行索引
+ * @returns 返回 Uint8ClampedArray 类型的对象
+ */
+export declare function getImageDateRow(imageData: ImageData, row: number): Uint8ClampedArray;
+
+/**
+ * 轴线值梯度函数
+ * @remarks
+ * 会通过该函数来获取从轴线的起始点到终点之间轴线上各点处的值
+ * @param params - 梯度参数；包含了当前点处的相关信息
+ * @returns 返回最终的值
+ */
+export declare type GetLineGradientValue = (params: LineGradientParams) => number;
+
+/**
+ * 获取 ImageSource 资源的固有尺寸
+ * @remarks
+ * 不是显示的尺寸，而是资源本身的固有尺寸
+ * @param image
+ * @returns
+ */
+export declare function getNaturalSizeOfImageSource(image: TexImageSource): {
+    width: number;
+    height: number;
+};
+
+/**
+ * 梯度 Data3D 选项
+ */
+export declare interface GradientData3DOptions {
+    /**
+     * 数值的映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     *
+     * @defaultValue {x:0,y:100}
+     */
+    range?: IVector2 | null;
+    /**
+     * 是否丢弃超出映射范围的数值
+     * @remarks
+     * 当数值超出映射区间 {@link GradientData3DOptions.range}  时，是否丢弃；
+     *
+     * 包含左右边界值
+     * @defaultValue true
+     */
+    discardOut?: boolean | null;
+    /**
+     * 空值的范围
+     * @remarks
+     * 当数值在此范围中时，会被认为是空的值，渲染时会被丢弃
+     *
+     * 包含左右边界值
+     *
+     * @defaultValue {x:-100,y:-1}
+     */
+    voidRange?: IVector2 | null;
+}
+
+/**
+ * 3D数据纹理
+ * @remarks
+ * 专门用于 {@link ./GradientVolumeMaterial#GradientVolumeMaterial} 的纹理对象
+ * 提供了一些与 {@link ./GradientVolumeMaterial#GradientVolumeMaterial} 约定的设置 和 一些便利方法
+ */
+export declare class GradientData3DTexture extends Data3DTexture {
+    readonly isGradientData3DTexture = true;
+    constructor(data: BufferSource, width: number, height: number, depth: number, type?: TextureDataType);
+    /**
+     * 获取3D数据的切片
+     * @remarks
+     * 切片就是指定轴的指定位置的垂直截面
+     * @param axis - 轴
+     * @param depth - 在轴上的坐标值
+     * @returns
+     */
+    getData3DSlice(axis: Axis, depth: number): IData2D<number>;
+    /**
+     * 获取3D数据中指定坐标处的数据项目
+     * @remarks
+     * 在 ImageData3DTexture 中，与 {@link ImageData3DTexture.getColor} 返回的值一样；
+     * @param coord
+     * @returns
+     */
+    getItem(coord: IVector3): number[];
+    /**
+     * 获取3D数据中指定坐标处的值
+     * @param coord - 坐标
+     * @returns
+     */
+    getValue(coord: IVector3): number;
+}
+
+/**
+ * 梯度 Data3D 转 ImageData3D
+ * @param data3D
+ * @param gradient
+ * @param options
+ * @returns
+ */
+export declare function gradientData3DToImageData3D(data3D: IData3D, gradient: ImageData, options: GradientData3DToImageData3DOptions): {
+    data: number[];
+    size: IVector3;
+};
+
+/**
+ * 梯度 Data3D 转 ImageData3D 的选项
+ */
+export declare interface GradientData3DToImageData3DOptions extends GradientData3DOptions {
+    voidColor?: [number, number, number, number];
+}
+
+export declare type GradientFogPoint = VolumeFeature & IVector3;
+
+export declare interface GradientFogPointsGeometryOptions extends VolumeFeature {
+    points: GradientFogPoint[];
+}
+
+/**
+ * 梯度雾点材质
+ * @remarks
+ * 需要 geoometry 有以下属性
+ * - value : 每个顶点都有一个数字类型的值 value
+ * - radius : 仅当 useRadius 为 true 时必须；每个顶点都有一个数字类型的半径
+ *
+ * 材质的 map 属性存储的是梯度图像，用于映射 value 的；
+ */
+export declare class GradientFogPointsMaterial extends FogPointsMaterial<GradientFogPointsMaterialUniforms> {
+    readonly isColorFogPointsMaterial = true;
+    constructor(options?: GradientFogPointsMaterialOptions);
+    /**
+     * 数值的映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     *
+     * @defaultValue {x:0,y:100}
+     */
+    get range(): Vector2;
+    set range(value: Vector2);
+}
+
+/**
+ * 梯度雾点材质的选项
+ */
+export declare interface GradientFogPointsMaterialOptions extends PointsMaterialParameters, FogPointsMaterialOptions {
+    /**
+     * 数值的映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     *
+     * @defaultValue {x:0,y:100}
+     */
+    range?: IVector2 | null;
+}
+
+/**
+ * 梯度雾点材质的 uniforms
+ */
+export declare interface GradientFogPointsMaterialUniforms extends PointsUniforms, FogPointsMaterialUniforms {
+    range: IUniform<Vector2>;
+}
+
+export declare interface GradientFogPointsOptions extends GradientFogPointsGeometryOptions {
+    /**
+     * 数值的梯度映射纹理
+     */
+    gradient?: GradientTextureOptions | null;
+}
+
+export declare type GradientOptions = GradientOptionsOptimizeOptions & CreateGradientData3DTextureOptions & GradientVolumeMaterialOptions;
+
+/**
+ * 优化选项
+ */
+export declare interface GradientOptionsOptimizeOptions {
+    /**
+     * 指定优化后的梯度选项的所能达到的最大尺寸
+     * @remarks
+     * 会对原来的梯度选项进行等比缩放以达到该尺寸；
+     *
+     * 如果同时指定 maxSize 和 {@link GradientOptionsOptimizeOptions.scale} ，则优先使用 {@link GradientOptionsOptimizeOptions.scale}
+     * @defaultValue 100
+     */
+    maxSize?: number;
+    /**
+     * 缩放系数
+     * @remarks
+     * 对原梯度选项进行缩放；
+     *
+     * 优先级高于 {@link GradientOptionsOptimizeOptions.maxSize}
+     */
+    scale?: number;
+}
+
+/**
+ * 梯度函数的参数
+ */
+export declare interface GradientParams {
+    /**
+     * 梯度的变化比率
+     * @remarks
+     * 一般是当前点与其所属中心点的距离和中心点半径的比率
+     */
+    ratio: number;
+    /**
+     * 当前中心点的半径
+     */
+    radius: number;
+    /**
+     * 当前中心点空心比率
+     */
+    hollow: number;
+    /**
+     * 根据空间比率计算的空心半径
+     */
+    hollowRadius: number;
+    /**
+     * 当前点与其所属中心点的距离
+     */
+    distance: number;
+    /**
+     * 值
+     */
+    value: number;
+    /**
+     * 值的范围
+     */
+    clim: IVector2;
+    /**
+     * 当前点的坐标
+     */
+    point: Vector3;
+}
+
+declare type GradientTextureOptions = Texture | TexImageSource | string | ColorGradient;
+
+/**
+ * 梯度体积材质
+ */
+export declare class GradientVolumeMaterial extends VolumeMaterial<GradientData3DTexture, GradientVolumeMaterialUniforms> {
+    readonly isGradientVolumeMaterial = true;
+    constructor(options?: GradientVolumeMaterialOptions);
+    /**
+     * 数值的梯度映射纹理
+     */
+    get gradient(): Texture | null;
+    set gradient(value: Texture | null);
+    /**
+     * 数值的映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     *
+     * @defaultValue {x:0,y:100}
+     */
+    get range(): Vector2;
+    set range(value: Vector2);
+    /**
+     * 是否丢弃超出映射范围的数值
+     * @remarks
+     * 当数值超出映射区间 {@link GradientVolumeMaterial.range}  时，是否丢弃；
+     *
+     * 包含左右边界值
+     * @defaultValue true
+     */
+    get discardOut(): boolean;
+    set discardOut(value: boolean);
+    /**
+     * 空值的范围
+     * @remarks
+     * 当数值在此范围中时，会被认为是空的值，渲染时会被丢弃
+     *
+     * 包含左右边界值
+     *
+     * @defaultValue {x:-100,y:-1}
+     */
+    get voidRange(): Vector2;
+    set voidRange(value: Vector2);
+}
+
+/**
+ * 梯度体积材质选项
+ */
+export declare interface GradientVolumeMaterialOptions extends VolumeMaterialOptions<GradientData3DTexture>, GradientData3DOptions {
+    /**
+     * 数值的梯度映射纹理
+     */
+    gradient?: GradientTextureOptions | null;
+}
+
+/**
+ * GradientVolumeMaterial 的 uniforms 类型
+ */
+export declare interface GradientVolumeMaterialUniforms extends VolumeMaterialUniforms<GradientData3DTexture> {
+    gradient: IUniform<null | Texture>;
+    range: IUniform<Vector2>;
+    discardOut: IUniform<boolean>;
+    voidRange: IUniform<Vector2>;
+}
+
+/**
+ * 热力值及其相关信息
+ */
+export declare type HeatAccumulateValue = Required<Omit<SphereParticleVolumeFeature, "valueGradient">> & GradientParams;
+
+/**
+ * 创建热力3D数据的选项
+ */
+export declare interface HeatData3DOptions extends HeatParticleVolumeFeature {
+    /**
+     * 热力点列表
+     */
+    points: HeatParticleVolumeFeaturePoint[];
+    /**
+     * Data3D 的尺寸
+     * @defaultValue 从原点到  points 的AABB包围盒最大点的空间尺寸
+     */
+    size?: IVector3 | null;
+}
+
+export declare type HeatDataOptions = Omit<HeatData3DOptions, 'points'>;
+
+declare class HeatMapPlugin {
+    readonly ssp: default_2;
+    constructor(ssp: default_2);
+    defaultColorGradient: ColorGradient;
+    defaultGradientVolumeMaterialOptions: GradientVolumeMaterialOptions;
+    protected _createTexture(points: HeatData3DOptions['points'], options: CreateHeatOptions, isLine?: boolean): any;
+    /**
+     * 创建热力云
+     * return material
+     */
+    createHeatCloud(points: HeatParticleVolumeFeaturePoint[], options?: CreateHeatCloudOptions): any;
+    createLineHeat(points: ParticleVolumeFeaturePoint[], options: CreatLineHeatOptions): any;
+    createImageExtrusion(imageUrl: string, options?: CreateImageExtrusionOptions & {
+        depth?: number;
+    }): Promise<any>;
+    createSliceMesh(material: VolumeMaterial, options?: SliceMaterialOptions & CreateImageData3DTextureFromGradientOptions): any;
+    createImageSlice(material: VolumeMaterial, options?: CreateImageData3DTextureFromGradientOptions): any;
+}
+export { HeatMapPlugin }
+export default HeatMapPlugin;
+
+/**
+ * 热力粒子体积特性
+ */
+export declare interface HeatParticleVolumeFeature extends SphereParticleVolumeFeature {
+    /**
+     * 值累积函数
+     * @remarks
+     * 当某一个点处理多个热力球区域内时，需要考虑多个热力球在该点的累积效果，通过该函数来获取最终的累积结果
+     * @defaultValue valuesAccumulate_Default
+     */
+    valuesAccumulate?: HeatValuesAccumulate;
+}
+
+/**
+ * 热力点
+ */
+export declare type HeatParticleVolumeFeaturePoint = HeatParticleVolumeFeature & IVector3;
+
+/**
+ * 热力点信息
+ */
+export declare type HeatParticleVolumeFeaturePointInfo = Required<HeatParticleVolumeFeaturePoint>;
+
+/**
+ * 热力向量信息
+ */
+export declare type HeatParticleVolumeFeatureVectorInfo = Required<HeatParticleVolumeFeature> & Vector3;
+
+/**
+ * 热力值累积函数
+ * @remarks
+ * 当某一个点处理多个热力球区域内时，需要考虑多个热力球在该点的累积效果，通过该函数来获取最终的累积结果
+ * @param values - 值的信息列表
+ * @param clim - 默认的映射区间
+ * @returns 累积后的最终值
+ */
+export declare type HeatValuesAccumulate = (values: HeatAccumulateValue[], clim: IVector2) => number;
+
+/**
+ * 默认的空心比率梯度函数
+ * @param param0
+ * @returns
+ */
+export declare function hollowGradient_Default({ startHollow, addedHollow, ratio }: LineGradientParams): number;
+
+/**
+ * Data2D 类型
+ */
+export declare interface IData2D<D = number> {
+    data: ArrayLike<D>;
+    size: IVector2;
+}
+
+/**
+ * Data3D 类型
+ */
+export declare interface IData3D<D = number> {
+    data: ArrayLike<D>;
+    size: IVector3;
+}
+
+/**
+ * IImageData2 的类型
+ */
+export declare interface IImageData2 {
+    data: ArrayBufferView;
+    height: number;
+    width: number;
+    colorSpace?: PredefinedColorSpace;
+}
+
+/**
+ * IImageData3 类型的数据
+ * @remarks
+ * 比 IImageData2 多了个深度
+ */
+export declare interface IImageData3 extends IImageData2 {
+    depth: number;
+}
+
+/**
+ * 获取3D图像切片的工具
+ * @remarks
+ * 提供了用于呈现切片的 canvas 元素；
+ * 生成切片图像的url；
+ * 获取指定坐标的颜色等等；
+ */
+export declare class ImageData3DSlice {
+    readonly isImageData3DSlice = true;
+    constructor(image3D: IImageData3);
+    /**
+     * 3D图像数据
+     */
+    get image3D(): IImageData3;
+    set image3D(value: IImageData3);
+    protected _image3D: IImageData3;
+    /**
+     * 呈现切片的 canvas 元素
+     * @remarks
+     * 当 {@link ImageData3DSlice.axis} 或 {@link ImageData3DSlice.depth} 变更时，它会自动更新切片
+     */
+    get canvas(): HTMLCanvasElement;
+    protected _canvas?: HTMLCanvasElement | null;
+    /**
+     * canvas 的 2d 上下文对象
+     */
+    get context(): CanvasRenderingContext2D;
+    protected _context?: CanvasRenderingContext2D;
+    /**
+     * 轴
+     * @remarks
+     * 会沿该轴的垂直截面生成切片
+     *
+     * @defaultValue Axis.z
+     */
+    get axis(): Axis;
+    set axis(value: Axis);
+    protected _axis: Axis;
+    /**
+     * 轴上的坐标值
+     * @remarks
+     * 会在轴的该位置处获取切片
+     * @defaultValue 0
+     */
+    get depth(): number;
+    set depth(value: number);
+    protected _depth: number;
+    /**
+     * 切片的尺寸
+     * @remarks
+     * 不同轴上的切片的尺寸一般不一样
+     */
+    get sliceSize(): IVector2;
+    protected _sliceSize?: IVector2 | null;
+    /**
+     * 获取切片数据
+     * @remarks
+     * 总是获取当前轴和深度处的切片
+     */
+    get slice(): ImageData;
+    protected _slice?: ImageData | null;
+    /**
+     * 获取切片数据
+     * @remarks
+     * 可以指定轴和深度；该方法不会更新  {@link ImageData3DSlice.axis} 和 {@link ImageData3DSlice.depth} 属性
+     * @param axis - 轴
+     * @param depth - 深度
+     * @returns
+     */
+    getSlice(axis: Axis, depth: number): ImageData;
+    /**
+     * 获取切片图像的 url
+     * @returns
+     */
+    getDataURL(): string;
+    /**
+     * 获取切片上指定坐标处的颜色
+     * @param coord - 坐标
+     * @returns
+     */
+    getColor(coord: IVector2): Uint8ClampedArray;
+    /**
+     * 更新切片尺寸相关的信息
+     */
+    updateSize(): void;
+    /**
+     * 更新切片相关的信息
+     */
+    updateSlice(): void;
+}
+
+/**
+ * 3D图像纹理
+ * @remarks
+ * 专门用于 {@link ./ImageVolumeMaterial#ImageVolumeMaterial} 的纹理对象
+ * 提供了一些与 {@link ./ImageVolumeMaterial#ImageVolumeMaterial} 约定的设置 和 一些便利方法
+ */
+export declare class ImageData3DTexture extends Data3DTexture {
+    readonly isImageData3DTexture = true;
+    constructor(data: BufferSource, width: number, height: number, depth: number);
+    /**
+     * 获取3D数据的切片
+     * @remarks
+     * 切片就是指定轴的指定位置的垂直截面
+     * @param axis - 轴
+     * @param depth - 在轴上的坐标值
+     * @returns
+     */
+    getData3DSlice(axis: Axis, depth: number): IData2D<number>;
+    /**
+     * 获取3D数据中指定坐标处的数据项目
+     * @remarks
+     * 在 ImageData3DTexture 中，与 {@link ImageData3DTexture.getColor} 返回的值一样；
+     * @param coord
+     * @returns
+     */
+    getItem(coord: IVector3): number[];
+    /**
+     * 获取3D图像中指定坐标处的颜色
+     * @param coord - 坐标
+     * @returns
+     */
+    getColor(coord: IVector3): number[];
+}
+
+/**
+ * 获取3D图像切片的工具
+ * @remarks
+ * 提供了用于呈现切片的 canvas 元素；
+ * 生成切片图像的url；
+ * 获取指定坐标的颜色等等；
+ */
+export declare class ImageData3DTextureSlice extends ImageData3DSlice {
+    readonly isImageData3DTextureSlice = true;
+    constructor(texture: IImageData3 | Texture3D);
+    /**
+     * 设置材质或 IImageData3 类数据
+     */
+    set texture(texture: IImageData3 | Texture3D);
+}
+
+/**
+ * imageData转Canvas
+ * @param imageData
+ * @returns
+ */
+export declare function imageDataToCanvas(imageData: ImageData): HTMLCanvasElement;
+
+/**
+ * 将 imageData 转成 url
+ * @param imageData
+ * @returns
+ */
+export declare function imageDataToUrl(imageData: ImageData): string;
+
+/**
+ * 图像体积材质
+ * @remarks
+ * 用于渲染3D图像的材质
+ */
+export declare class ImageVolumeMaterial extends VolumeMaterial<ImageData3DTexture> {
+    readonly isImageVolumeMaterial = true;
+    constructor(options?: VolumeMaterialOptions<ImageData3DTexture>);
+}
+
+/**
+ * 判断是否是 IImageData2 类型的数据
+ * @remarks
+ * IImageData3 类型的数据也会被验证通过
+ * @param target
+ * @returns
+ */
+export declare function isIImageData2(target: any): target is IImageData2;
+
+/**
+ * 判断是否是 IImageData3 类型的数据
+ * @param target
+ * @returns
+ */
+export declare function isIImageData3(target: any): target is IImageData3;
+
+/**
+ * 坐标是否超出尺寸范围
+ * @param coord
+ * @param size
+ * @returns
+ */
+export declare function isOutOfSize<Ivec extends IVector>(coord: Ivec, size: Ivec): boolean;
+
+/**
+ * 向量
+ */
+declare type IVector = IVector2 | IVector3 | IVector4;
+
+/**
+ * 二维向量
+ */
+declare interface IVector2 {
+    	x: number;
+    	y: number;
+}
+
+/**
+ * 三维向量
+ */
+declare interface IVector3 extends IVector2 {
+    	z: number;
+}
+
+/**
+ * 四维向量
+ */
+declare interface IVector4 extends IVector3 {
+    	w: number;
+}
+
+/**
+ * 创建线性3D数据的选项
+ */
+export declare interface LineData3DOptions extends SphereParticleVolumeFeature {
+    /**
+     * 体积粒子列表
+     */
+    points: ParticleVolumeFeaturePoint[];
+    /**
+     * Data3D 的尺寸
+     * @defaultValue 从原点到  points 的AABB包围盒最大点的空间尺寸
+     */
+    size?: IVector3 | null;
+    /**
+     * 半径梯度函数
+     * @defaultValue radiusGradient_Default
+     */
+    radiusGradient?: GetLineGradientValue;
+    /**
+     * 空心比梯度函数
+     * @defaultValue hollowGradient_Default
+     */
+    hollowGradient?: GetLineGradientValue;
+    /**
+     * 轴线值梯度函数
+     * @defaultValue lineValueGradient_Default
+     */
+    lineValueGradient?: GetLineGradientValue;
+    /**
+     * 值累积函数
+     * @defaultValue numberValuesAccumulate_Default
+     */
+    valuesAccumulate?: NumberValuesAccumulate;
+}
+
+export declare type LineDataOptions = Omit<LineData3DOptions, 'points'>;
+
+/**
+ * 轴线梯度函数的参数
+ */
+export declare interface LineGradientParams {
+    /**
+     * 梯度的变化比率
+     * @remarks
+     * 一般是当前轴线位置到轴线开始处距离 与 轴线的长度的比率
+     */
+    ratio: number;
+    /**
+     * 轴线的长度
+     */
+    length: number;
+    /**
+     * 当前点的坐标
+     */
+    point: Vector3;
+    /**
+     * 轴线起始点处的半径
+     */
+    startRadius: number;
+    /**
+     * 轴线终点处的半径
+     */
+    endRadius: number;
+    /**
+     * 轴线终点处的半径相对起始点处的半径的增加量；即 `endRadius - startRadius`
+     */
+    addedRadius: number;
+    /**
+     * 选项中默认的半径
+     */
+    defaultRadius: number;
+    /**
+     * 当前中心点的半径
+     * @remarks
+     * 注意：在 `radiusGradient` 中，该值就是 `defaultRadius`；
+     */
+    radius: number;
+    /**
+     * 轴线起始点处的值
+     */
+    startValue: number;
+    /**
+     * 轴线终点处的值
+     */
+    endValue: number;
+    /**
+     * 轴线终点处的值相对起始点处的值的增加量；即 `endValue - startValue`
+     */
+    addedValue: number;
+    /**
+     * 选项中默认的值
+     */
+    defaultValue: number;
+    /**
+     * 轴线起始点处的空心比率
+     */
+    startHollow: number;
+    /**
+     * 轴线终点处的空心比率
+     */
+    endHollow: number;
+    /**
+     * 轴线终点处的空心比率相对起始点处的空心比率的增加量；即 `endHollow - startHollow`
+     */
+    addedHollow: number;
+    /**
+     * 选项中默认的空心比率
+     */
+    defaultHollow: number;
+}
+
+/**
+ * 默认的轴线值梯度函数
+ * @param param0
+ * @returns
+ */
+export declare function lineValueGradient_Default({ startValue, addedValue, ratio }: LineGradientParams): number;
+
+/**
+ * 将几何体的原点移动包围盒的最小点处
+ * @param geometry
+ */
+export declare function makeOriginOnBoundingBoxMinOfGeometry(geometry: BufferGeometry): BufferGeometry<NormalBufferAttributes>;
+
+/**
+ * 将多 Data3D 合并成一个
+ * @param data3Ds
+ * @param valuesAccumulate
+ * @param options
+ * @returns
+ */
+export declare function mergeData3Ds<D>(data3Ds: IData3D<D>[], options: MergeData3DsOptions<D>): {
+    data: D[];
+    size: {
+        x: number;
+        y: number;
+        z: number;
+    };
+};
+
+/**
+ * 合并选项
+ */
+export declare interface MergeData3DsOptions<D> {
+    valuesAccumulate: DataValuesAccumulate<D>;
+    verifyVoid?: VerifyVoidValue<D>;
+    voidValue: D;
+}
+
+/**
+ * 数值累积函数
+ * @remarks
+ * 当某一个点处理多个区域数据内时，需要考虑多个数据区域在该点的累积效果，通过该函数来获取最终的累积结果
+ * @param values - 值的列表
+ * @param clim - 默认的映射区间
+ * @returns 累积后的最终值
+ */
+export declare type NumberValuesAccumulate = (values: number[], clim: IVector2) => number;
+
+/**
+ * 默认的数值累积函数
+ * @param values
+ * @param clim
+ * @returns
+ */
+export declare function numberValuesAccumulate_Default(values: number[], clim: IVector2): number;
+
+/**
+ * 对梯度选项进行优化
+ * @param gradientOptions
+ * @param options
+ * @returns
+ */
+export declare function optimizeGradientOptions<Opts extends TransferableGradientOptions>(gradientOptions: Opts, options?: GradientOptionsOptimizeOptions | null): {
+    options: Opts;
+    position: Vector3;
+    scale: number;
+};
+
+/**
+ * 粒子体积特征
+ */
+export declare interface ParticleVolumeFeature extends VolumeFeature {
+    /**
+     * 空心因子
+     *
+     * @defaultValue 0
+     */
+    hollow?: number;
+}
+
+export declare type ParticleVolumeFeaturePoint = ParticleVolumeFeature & IVector3;
+
+export declare type ParticleVolumeFeaturePointInfo = Required<ParticleVolumeFeaturePoint>;
+
+export declare type ParticleVolumeFeatureVectorInfo = Required<ParticleVolumeFeature> & Vector3;
+
+export declare type PointsUniforms = typeof ShaderLib.points.uniforms;
+
+/**
+ * 默认的半径梯度函数
+ * @param param0
+ * @returns
+ */
+export declare function radiusGradient_Default({ startRadius, addedRadius, ratio }: LineGradientParams): number;
+
+/**
+ * 将 imageData 沿 Y 轴反转
+ * @param imageData
+ * @returns
+ */
+export declare function reverseImageDateY(imageData: ImageData): ImageData;
+
+/**
+ * 切片材质
+ * @remarks
+ * 用于呈现3D图像的在指定轴上指定位置处的截面
+ */
+export declare class SliceMaterial extends ShaderMaterial {
+    readonly isSliceMaterial = true;
+    constructor(options?: SliceMaterialOptions);
+    uniforms: SliceMaterialUniforms;
+    /**
+     * 三维的纹理
+     */
+    get map(): Texture3D | null;
+    set map(value: Texture3D | null);
+    /**
+     * 透明度
+     * @remarks
+     * 决定整体的透明度
+     * @defaultValue 1
+     */
+    get opacity(): number;
+    set opacity(value: number);
+    /**
+     * 轴
+     * @remarks
+     * 切片就是垂直于该轴的截面
+     *
+     * @defaultValue Axis.z
+     */
+    get axis(): Axis;
+    set axis(value: Axis);
+    /**
+     * 轴上的坐标值
+     * @remarks
+     * 会在轴的该位置处获取切片
+     * @defaultValue 0
+     */
+    get depth(): number;
+    set depth(value: number);
+    /**
+     * 切片的尺寸
+     * @remarks
+     * 不同轴上的切片的尺寸一般不一样
+     */
+    get sliceSize(): Vector2;
+    protected _sliceSize?: Vector2 | null;
+}
+
+/**
+ * 切片材质的选项
+ */
+export declare interface SliceMaterialOptions extends Omit<ShaderMaterialParameters, "opacity"> {
+    /**
+     * 三维的纹理
+     */
+    map?: Texture3D | null;
+    /**
+     * 透明度
+     * @remarks
+     * 决定整体的透明度
+     * @defaultValue 1
+     */
+    opacity?: number | null;
+    /**
+     * 轴
+     * @remarks
+     * 切片就是垂直于该轴的截面
+     *
+     * @defaultValue Axis.z
+     */
+    axis?: Axis | null;
+    /**
+     * 轴上的坐标值
+     * @remarks
+     * 会在轴的该位置处获取切片
+     * @defaultValue 0
+     */
+    depth?: number | null;
+}
+
+/**
+ * 切片材质的 uniforms
+ */
+export declare interface SliceMaterialUniforms {
+    map: IUniform<Texture3D | null>;
+    opacity: IUniform<number>;
+    axis: IUniform<Axis>;
+    depth: IUniform<number>;
+
+    [uniform: string]: IUniform<unknown>;
+}
+
+/**
+ * 呈现3D图像切片的Mesh
+ * @remarks
+ * 专用于 {@link ./SliceMaterial#SliceMaterial}
+ *
+ * 虽然 {@link ./SliceMaterial#SliceMaterial} 也可以用于普通的 Mesh；但如果使用 SliceMesh ，则可以减少很多切片材质 和 geometry 同步操作；
+ */
+export declare class SliceMesh extends Mesh {
+    readonly isSliceMesh = true;
+    constructor(options: SliceMaterialOptions);
+    protected _geometry: BufferGeometry;
+    material: SliceMaterial;
+    protected _material: SliceMaterial;
+    /**
+     * 是否自动更新几何体
+     * @remarks
+     * 当启动该选项后，在 SliceMesh 监测到切片尺寸相关的变更时，会自动更新 geometry 的尺寸，以适应切片的尺寸
+     * @defaultValue true
+     */
+    autoUpdateGeometry: boolean;
+    /**
+     * 更新几何体
+     */
+    updateGeometry(): false | undefined;
+    /**
+     * 三维的纹理
+     */
+    get map(): Texture3D | null;
+    set map(value: Texture3D | null);
+    /**
+     * 轴
+     * @remarks
+     * 切片就是垂直于该轴的截面
+     *
+     * @defaultValue Axis.z
+     */
+    get axis(): Axis;
+    set axis(value: Axis);
+    /**
+     * 轴上的坐标值
+     * @remarks
+     * 会在轴的该位置处获取切片
+     * @defaultValue 0
+     */
+    get depth(): number;
+    set depth(value: number);
+    /**
+     * 切片的尺寸
+     * @remarks
+     * 不同轴上的切片的尺寸一般不一样
+     */
+    get sliceSize(): Vector2;
+}
+
+/**
+ * 体积雾材质
+ */
+export declare class SphereFogMaterial extends ShaderMaterial {
+    readonly isSphereFogMaterial = true;
+    constructor(options?: SphereFogMaterialOptions);
+    uniforms: SphereFogMaterialUniforms;
+    /**
+     * Mesh三角形的渲染面
+     * @remarks
+     * 可设置为前面、后面、或者两面都渲染
+     * 如果只渲染前面，进入体积材质内部，体积材质就会消失
+     * 如果只渲染后面，体积初遮挡，就会消失
+     * 如果两面都渲染，则会隐藏看到容器的面
+     */
+    get side(): Side;
+    set side(value: Side);
+    protected _side: Side;
+    /**
+     * 球形雾的颜色
+     * @remarks
+     * 当开启顶点颜色 {@link SphereFogMaterial.vertexColors} 时，此设置将无论；
+     */
+    get color(): Color;
+    set color(value: Color);
+    /**
+     * 透明度
+     * @remarks
+     * 决定整体的透明度
+     * @defaultValue 1
+     */
+    get opacity(): number;
+    set opacity(value: number);
+    /**
+     * 实心因子
+     * @remarks
+     * 在实心范围内，球形雾不会衰减
+     * @defaultValue 0
+     */
+    get solid(): number;
+    set solid(value: number);
+    /**
+     * 雾的衰减指数
+     * @defaultValue 1
+     */
+    get exp(): number;
+    set exp(value: number);
+}
+
+/**
+ * 球形雾材质选项
+ */
+export declare interface SphereFogMaterialOptions {
+    /**
+     * 球形雾的颜色
+     * @remarks
+     * 当开启顶点颜色 {@link SphereFogMaterial.vertexColors} 时，此设置将无论；
+     */
+    color?: Color | null;
+    /**
+     * 实心因子
+     * @remarks
+     * 在实心范围内，球形雾不会衰减
+     * @defaultValue 0
+     */
+    solid?: number | null;
+    /**
+     * 雾的衰减指数
+     * @defaultValue 1
+     */
+    exp?: number | null;
+    /**
+     * 透明度
+     * @remarks
+     * 决定整体的透明度
+     * @defaultValue 1
+     */
+    opacity?: number | null;
+    /**
+     * Mesh三角形的渲染面
+     * @remarks
+     * 可设置为前面、后面、或者两面都渲染
+     * 如果只渲染前面，进入体积材质内部，体积材质就会消失
+     * 如果只渲染后面，体积初遮挡，就会消失
+     * 如果两面都渲染，则会隐藏看到容器的面
+     */
+    side?: Side | undefined;
+}
+
+/**
+ * 球形雾的 uniforms
+ */
+export declare interface SphereFogMaterialUniforms {
+    color: IUniform<Color>;
+    solid: IUniform<number>;
+    exp: IUniform<number>;
+    opacity: IUniform<number>;
+    isDoubleSide: IUniform<boolean>;
+
+    [uniform: string]: IUniform<unknown>;
+}
+
+export declare interface SphereParticleVolumeFeature extends ParticleVolumeFeature {
+    /**
+     * 映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     *
+     * @defaultValue {x:0,y:100}
+     */
+    clim?: IVector2;
+    /**
+     * 值梯度函数
+     */
+    valueGradient?: GetGradientValue;
+}
+
+/**
+ * 3D的纹理
+ * @remarks
+ * 包含三维数据的纹理
+ */
+declare type Texture3D = Data3DTexture | DataArrayTexture;
+
+/**
+ * 梯度特性
+ */
+export declare interface TransferableGradientFeature {
+    /**
+     * 半径
+     *
+     * @defaultValue 10
+     */
+    radius?: number | null;
+}
+
+/**
+ * 可变换的梯度选项
+ */
+export declare interface TransferableGradientOptions extends TransferableGradientFeature {
+    /**
+     * 热力点列表
+     */
+    points?: (TransferableGradientFeature & IVector3)[] | null;
+    /**
+     * Data3D 的尺寸
+     */
+    size?: IVector3 | null;
+}
+
+/**
+ * 对梯度选项应用矩阵变换
+ * @param options
+ * @param matrix
+ * @returns
+ */
+export declare function transformGradientOptions<Opts extends TransferableGradientOptions>(options: Opts, matrix: Matrix4): Opts;
+
+/**
+ * 对梯度选项进行平移后再缩放
+ * @param options
+ * @param translate
+ * @param scale
+ * @returns
+ */
+export declare function translateScaleGradientOptions<Opts extends TransferableGradientOptions>(options: Opts, translate: Vector3, scale?: number): Opts;
+
+/**
+ * 默认的值梯度函数
+ */
+export declare function valueGradient_Default({ ratio, value }: GradientParams): number;
+
+/**
+ * 默认的值累积函数
+ * @param values
+ * @param clim
+ * @returns
+ */
+export declare function valuesAccumulate_Default(values: HeatAccumulateValue[], clim: IVector2): number;
+
+/**
+ * 空值验证函数
+ */
+export declare type VerifyVoidValue<D> = (value: D, data3D: IData3D<D>, index: number) => boolean | null | undefined;
+
+/**
+ * 体积特征
+ */
+export declare interface VolumeFeature {
+    /**
+     * 半径
+     *
+     * @defaultValue 10
+     */
+    radius?: number;
+    /**
+     * 值
+     *
+     * @defaultValue 100
+     */
+    value?: number;
+}
+
+/**
+ * 体积材质填充模式
+ */
+export declare enum VolumeFit {
+    /**
+     * 填充
+     * @remarks
+     * 材质会充满容器
+     */
+    Fill = 0,
+    /**
+     * 对齐
+     * @remarks
+     * 材质会从容器的最小点开始绘制，但不会充满容器
+     */
+    Align = 1,
+    /**
+     * 原始
+     * @remarks
+     * 材质会从容器空间中的坐标原点开始绘制，也不会充满容器
+     */
+    Raw = 2
+}
+
+/**
+ * 体积材质
+ */
+export declare abstract class VolumeMaterial<Data3M extends Data3DTexture = Data3DTexture, VolumeUniforms extends VolumeMaterialUniforms<Data3M> = VolumeMaterialUniforms<Data3M>> extends ShaderMaterial {
+    readonly isVolumeMaterial = true;
+    constructor(options?: VolumeMaterialOptions<Data3M>);
+    /**
+     * uniforms
+     */
+    uniforms: VolumeUniforms;
+    /**
+     * 三维的纹理
+     */
+    get map(): Data3M | null;
+    set map(value: Data3M | null);
+    /**
+     * 渲染体积材质的容器的最小点
+     * @remarks
+     * 容器的最小点和最大点一般是被设置成 geometry 的AABB包围盒；但也可以不是
+     * 总之，体积材质的渲染依托于 geometry 的形状，它不会超出 geometry 的尺寸；
+     * 但可以控制容器的最小点和最大点来控制体积材质的渲染尺寸；
+     */
+    get containerMin(): Vector3;
+    set containerMin(value: Vector3);
+    /**
+     * 渲染体积材质的容器的最大点
+     * @remarks
+     * 容器的最小点和最大点一般是被设置成 geometry 的AABB包围盒；但也可以不是
+     * 总之，体积材质的渲染依托于 geometry 的形状，它不会超出 geometry 的尺寸；
+     * 但可以控制容器的最小点和最大点来控制体积材质的渲染尺寸；
+     */
+    get containerMax(): Vector3;
+    set containerMax(value: Vector3);
+    /**
+     * 渲染体积材质容器的尺寸
+     * @remarks
+     * 每次调用都会重新计算
+     */
+    get containerSize(): Vector3;
+    /**
+     * 体积材质在容器内的填充模式
+     * @defaultValue VolumeFit.Fill
+     */
+    get fit(): VolumeFit;
+    set fit(value: VolumeFit);
+    /**
+     * 获取当前填模式下对 map 的应用的平移
+     * @returns
+     */
+    getFitTranslate(): Vector3;
+    /**
+     * 获取当前填模式下对 map 的应用的缩放
+     * @returns
+     */
+    getFitScale(): Vector3;
+    /**
+     * 获取当前填模式下对 map 的应用的变换矩阵
+     * @returns
+     */
+    getFitMatrix(): Matrix4;
+    /**
+     * 获取当前填模式下对 map 的应用的变换矩阵的逆矩阵
+     * @returns
+     */
+    getFitMatrixInvert(): Matrix4;
+    /**
+     * Mesh三角形的渲染面
+     * @remarks
+     * 可设置为前面、后面、或者两面都渲染
+     * 如果只渲染前面，进入体积材质内部，体积材质就会消失
+     * 如果只渲染后面，体积初遮挡，就会消失
+     * 如果两面都渲染，则会隐藏看到容器的面
+     */
+    get side(): Side;
+    set side(value: Side);
+    protected _side: Side;
+    /**
+     * 透明度
+     * @remarks
+     * 决定整体的透明度
+     */
+    get opacity(): number;
+    set opacity(value: number);
+    /**
+     * 有效透明度的取值范围
+     * @remarks
+     * 如果最终颜色的透明度小于或等于 alphaRange.x ，则被认为是完全透明
+     * 如果最终颜色的透明度在于或等于 alphaRange.y ，则被认为是完全不透明
+     * 取值范围应当在 0 - 1
+     * @defaultValue {x:0,y:0.95}
+     */
+    get alphaRange(): Vector2;
+    set alphaRange(value: Vector2);
+    /**
+     * 是否开启雾化的效果
+     * @remarks
+     * 开启后的渲染效果会更像雾
+     * @defaultValue true
+     */
+    get atomize(): boolean;
+    set atomize(value: boolean);
+    /**
+     * 体积材质渲染的采样数
+     * @remarks
+     * 采样数越高，占用的GPU资源就越大；所以该数据设置的适宜最好；
+     * @defaultValue 100
+     */
+    get steps(): number;
+    set steps(value: number);
+    /**
+     * 颜色累积系数
+     * @remarks
+     * 它是对体积材质进行积分时使用的系数；只在开启雾化效果{@link VolumeMaterial.atomize}时才有效；
+     * 值越小，最终呈现出的效果就越雾化；
+     * @defaultValue 1
+     */
+    get accFactor(): number;
+    set accFactor(value: number);
+    /**
+     * 将材质空间下的坐标转为 map 空间下的坐标
+     * @param coord - 材质空间下的坐标
+     * @returns
+     */
+    toMapPosition(coord: IVector3): Vector3;
+    /**
+     * 将材质空间下的深度转为 map 空间下的深度
+     * @param axis - map坐标系下的坐标轴
+     * @param depth - 材质空间下的深度
+     * @returns
+     */
+    toMapDepth(axis: Axis, depth: number): number;
+    /**
+     * 获取3D数据的切片
+     * @remarks
+     * 切片就是指定轴的指定位置的垂直截面
+     * @param axis - map坐标系下的坐标轴
+     * @param depth - 材质空间下，在轴方向的坐标值
+     * @returns
+     */
+    getData3DSlice(axis: Axis, depth: number): IData2D<number> | null;
+    /**
+     * 获取3D数据中指定坐标处的数据项目
+     * @param coord
+     * @returns
+     */
+    getItem(coord: IVector3): number[] | null;
+}
+
+/**
+ * 体积材质的选项
+ */
+export declare interface VolumeMaterialOptions<Data3M extends Data3DTexture = Data3DTexture> extends Omit<ShaderMaterialParameters, "map" | "opacity"> {
+    /**
+     * 三维的纹理
+     */
+    map?: Data3M | null;
+    /**
+     * 渲染体积材质的容器的最小点
+     * @remarks
+     * 容器的最小点和最大点一般是被设置成 geometry 的AABB包围盒；但也可以不是
+     * 总之，体积材质的渲染依托于 geometry 的形状，它不会超出 geometry 的尺寸；
+     * 但可以控制容器的最小点和最大点来控制体积材质的渲染尺寸；
+     * @defaultValue {x:0,y:0,z:0}
+     */
+    containerMin?: IVector3 | null;
+    /**
+     * 渲染体积材质的容器的最大点
+     * @remarks
+     * 容器的最小点和最大点一般是被设置成 geometry 的AABB包围盒；但也可以不是
+     * 总之，体积材质的渲染依托于 geometry 的形状，它不会超出 geometry 的尺寸；
+     * 但可以控制容器的最小点和最大点来控制体积材质的渲染尺寸；
+     * @defaultValue map尺寸中的最大点
+     */
+    containerMax?: IVector3 | null;
+    /**
+     * 体积材质在容器内的填充模式
+     * @defaultValue VolumeFit.Fill
+     */
+    fit?: VolumeFit | null;
+    /**
+     * Mesh三角形的渲染面
+     * @remarks
+     * 可设置为前面、后面、或者两面都渲染
+     * 如果只渲染前面，进入体积材质内部，体积材质就会消失
+     * 如果只渲染后面，体积初遮挡，就会消失
+     * 如果两面都渲染，则会隐藏看到容器的面
+     */
+    side?: Side | undefined;
+    /**
+     * 透明度
+     * @remarks
+     * 决定整体的透明度
+     * @defaultValue 1
+     */
+    opacity?: number | null;
+    /**
+     * 有效透明度的取值范围
+     * @remarks
+     * 如果最终颜色的透明度小于或等于 alphaRange.x ，则被认为是完全透明
+     * 如果最终颜色的透明度在于或等于 alphaRange.y ，则被认为是完全不透明
+     * 取值范围应当在 0 - 1
+     * @defaultValue {x:0,y:0.95}
+     */
+    alphaRange?: IVector2 | null;
+    /**
+     * 是否开启雾化的效果
+     * @remarks
+     * 开启后的渲染效果会更像雾
+     * @defaultValue true
+     */
+    atomize?: boolean | null;
+    /**
+     * 体积材质渲染的采样数
+     * @remarks
+     * 采样数越高，占用的GPU资源就越大；所以该数据设置的适宜最好；
+     * @defaultValue 100
+     */
+    steps?: number | null;
+    /**
+     * 颜色累积系数
+     * @remarks
+     * 它是对体积材质进行积分时使用的系数；只在开启雾化效果{@link VolumeMaterial.atomize}时才有效；
+     * 值越小，最终呈现出的效果就越雾化；
+     * @defaultValue 1
+     */
+    accFactor?: number | null;
+}
+
+/**
+ * 体积材质的 Uniforms 类型
+ */
+export declare interface VolumeMaterialUniforms<Data3M extends Texture3D = Data3DTexture> {
+    map: IUniform<Data3M | null>;
+    containerMin: IUniform<Vector3>;
+    containerMax: IUniform<Vector3>;
+    fit: IUniform<VolumeFit>;
+    opacity: IUniform<number>;
+    alphaRange: IUniform<Vector2>;
+    atomize: IUniform<boolean>;
+    steps: IUniform<number>;
+    accFactor: IUniform<number>;
+    isDoubleSide: IUniform<boolean>;
+
+    [uniform: string]: IUniform<unknown>;
+}
+
+/**
+ * 体积Mesh
+ * @remarks
+ * 专用用于体积材质；
+ *
+ * 体积材质也可以用于普通的 Mesh；但如果使用 VolumeMesh ，则可以减少很多体积材质 和 geometry 同步操作；
+ */
+export declare class VolumeMesh extends Mesh {
+    readonly isVolumeMesh = true;
+    constructor(material: VolumeMaterial);
+    protected _geometry: BufferGeometry;
+    /**
+     * 是否自动更新材质
+     * @remarks
+     * 当启动该选项后，在 VolumeMesh 监测到 geometry 变更时，会自动更新体积材质的相关选项，以适应新的 geometry
+     * @defaultValue true
+     */
+    autoUpdateMaterial: boolean;
+    material: VolumeMaterial;
+    protected _material: VolumeMaterial;
+    /**
+     * 是否自动更新几何体
+     * @remarks
+     * 当启动该选项后，在 VolumeMesh 监测到 material 变更时，会自动更新 geometry 的相关选项，以适应新的 体积材质
+     * @defaultValue true
+     */
+    autoUpdateGeometry: boolean;
+    /**
+     * 更新材质
+     * @remarks
+     * 更新体积材质的相关选项以使其匹配 geometry
+     */
+    updateMaterial(): false | undefined;
+    /**
+     * 更新几何体
+     * @remarks
+     * 更新 geometry 的相关选项以使其匹配体积材质
+     */
+    updateGeometry(): false | undefined;
+    /**
+     * 自动规范化
+     * @remarks
+     * 开启该选项，设置新的 geometry 时，对 geometry 自动执行规范化操作
+     */
+    autoNormalize: boolean;
+    /**
+     * 规范化
+     * @remarks
+     * 将 geometry 的原点移动到包围盒的最小点处
+     */
+    normalize(): void;
+    /**
+     * 将材质空间下的坐标转为 map 空间下的坐标
+     * @param coord - 材质空间下的坐标
+     * @returns
+     */
+    toMapPosition(coord: IVector3): Vector3;
+    /**
+     * 将世界坐标系下的深度转为 material 空间下的深度
+     * @param axis - 材质空间下的坐标轴
+     * @param depth - 深度
+     * @returns
+     */
+    toMaterialDepth(axis: Axis, depth: number): number;
+    /**
+     * 将世界坐标系下的深度转为 map 空间下的深度
+     * @param axis - map空间下的坐标轴
+     * @param depth - 深度
+     * @returns
+     */
+    toMapDepth(axis: Axis, depth: number): number;
+    /**
+     * 获取3D数据的切片
+     * @remarks
+     * 切片就是指定轴的指定位置的垂直截面；
+     * 轴和深度都是局部坐标系下的
+     * @param axis - map空间下的坐标轴
+     * @param depth - 世界空间下在轴方向上的坐标值
+     * @returns
+     */
+    getData3DSlice(axis: Axis, depth: number): IData2D<number> | null;
+    /**
+     * 获取3D数据中指定坐标处的数据项目
+     * @param coord - 世界坐标系下的坐标
+     * @returns
+     */
+    getItem(coord: IVector3): number[] | null;
+}
+
+/**
+ * 体积渲染样式
+ */
+export declare enum VolumeRenderStyle {
+    /**
+     * 密度投影
+     * @remarks
+     * 会显示出几何体的外面
+     */
+    MIP = 0,
+    /**
+     * 标准的样式
+     */
+    ISO = 1
+}
+
+export { }