@soonspacejs/plugin-effect 2.16.8 → 3.0.0-alpha.0

package/dist/index.d.ts

@@ -1,195 +1,784 @@
-import { Blending } from 'three';
-import { default as SoonSpace, IVector3, IColor, PluginObject, PluginObjectInfo } from 'soonspacejs';
-import { ParticleClusterOptions } from '@three3d/particle';
-import { InnerCircleWaveOptions } from './circle-wave';
-import { InnerCylinderWaveOptions } from './cylinder-wave';
-import { WaterOptions } from './water';
-export * from '@three3d/particle';
-export interface FlameOptions extends PluginObjectInfo {
-    magnitude?: number;
-    gain?: number;
-    imgUrl?: string;
-}
-export interface SmokeOptions extends PluginObjectInfo {
-    imgUrl?: string;
-    count?: number;
-    maxAge?: number;
-    size?: number;
-    acceleration?: number;
-    velocity?: IVector3;
-    color?: IColor[];
-}
-export interface Smoke2Options extends PluginObjectInfo {
-    imgUrl?: string;
-    radius?: number;
-    maxLife?: number;
-    maxSize?: number;
-    rate?: number;
-    colors?: IColor[];
-    blending?: Blending;
-}
-export interface SparklesOptions extends PluginObjectInfo {
-    count?: number;
-    speed?: number | Float32Array;
-    opacity?: number | Float32Array;
-    color?: IColor | Float32Array;
-    size?: number | Float32Array;
-    scalar?: number | [number, number, number] | IVector3;
-    noise?: number | [number, number, number] | IVector3 | Float32Array;
-}
-export interface CreateWaterOptions extends PluginObjectInfo, Omit<WaterOptions, 'userData'> {
-    /**
-     * 是否开启水的动画
-     * @remarks
-     * 如果开启，则会一直触发场景渲染
-     * 如果关闭，则不会主动触发场景渲染，但在渲染渲染时仍会有动画效果，只是不会主动触发场景渲染
-     */
-    animation?: boolean;
-}
-export interface ContactShadowsOptions extends Omit<PluginObjectInfo, 'scale'> {
-    opacity?: number;
-    width?: number;
-    height?: number;
-    blur?: number;
-    far?: number;
-    resolution?: number;
-    frames?: number;
-    scale?: number | [x: number, y: number];
-    darkness?: number;
-}
-export interface WeatherOptions {
-    /**
-     * 粒子贴图
-     */
-    imgUrl?: string;
-    /**
-     * 颜色
-     */
-    color?: IColor;
-    /**
-     * 大小
-     */
-    size?: number;
-    /**
-     * 不透明度
-     */
-    opacity?: number;
-    /**
-     * 粒子数量
-     */
-    count?: number;
-    /**
-     * 粒子范围
-     */
-    range?: number;
-    /**
-     * 粒子左右速度的随机范围
-     */
-    velocityX?: [number, number];
-    /**
-     * 粒子上下速度的随机范围
-     */
-    velocityY?: [number, number];
-}
-export type CircleWaveOptions = InnerCircleWaveOptions & PluginObjectInfo;
-export type CylinderWaveOptions = InnerCylinderWaveOptions & PluginObjectInfo;
-export interface PointsWaveOptions extends PluginObjectInfo {
-    xAxisCount?: number;
-    zAxisCount?: number;
-    showDistance?: number;
-    separation?: number;
-    size?: number;
-    maxFluctua?: number;
-    color?: IColor;
-    opacity?: number;
-}
-export interface BuildsOptions extends PluginObjectInfo {
-    buildWidth?: number;
-    buildHeigh?: number;
-    buildDepth?: number;
-    count?: number;
-    gapX?: number;
-    gapZ?: number;
-    showDistance?: number;
-    randShift?: number;
-    color?: IColor;
-}
-declare class EffectPlugin {
-    readonly ssp: SoonSpace;
-    [x: string]: any;
-    /**
-     * 天气预设图片
-     */
-    readonly weatherPresetImgs: {
-        rain: string;
-        snow: string;
-    };
-    private _weatherId;
-    constructor(ssp: SoonSpace);
-    /**
-     * 创建火焰
-     * @params params
-     * @returns
-     */
-    createFlame(params: FlameOptions): PluginObject;
-    /**
-     * 创建烟雾
-     * @param params
-     * @returns
-     */
-    createSmoke(params: SmokeOptions): PluginObject;
-    createSmoke2(params: Smoke2Options): PluginObject;
-    /**
-     * 创建星星
-     * @param params
-     * @returns
-     */
-    createSparkles(params: SparklesOptions): PluginObject;
-    /**
-     * 创建接触阴影
-     * @params params
-     */
-    createContactShadows({ scale, frames, opacity, width, height, blur, darkness, far, resolution, ...props }: ContactShadowsOptions): PluginObject;
-    /**
-     * 开启天气
-     * @param param0
-     */
-    openWeather(params?: WeatherOptions): void;
-    /**
-     * 关闭天气
-     */
-    closeWeather(): void;
-    /**
-     * 创建粒子簇
-     * @param options
-     * @returns
-     */
-    createParticleCluster(options: ParticleClusterOptions): any;
-    /**
-     * 创建圆形光波
-     * @param options
-     * @returns
-     */
-    createCircleWave(options: CircleWaveOptions): PluginObject;
-    /**
-     * 创建立柱光波
-     * @param options
-     * @returns
-     */
-    createCylinderWave(options: CylinderWaveOptions): PluginObject;
-    /**
-     * 创建粒子波浪
-     * @param options
-     * @returns
-     */
-    createPointsWave(options: PointsWaveOptions): PluginObject;
-    /**
-     * 创建建筑
-     * @param options
-     * @returns
-     */
-    createBuilds(options: BuildsOptions): PluginObject;
-    createWater(options: CreateWaterOptions): PluginObject;
-    removeEffect(id: PluginObjectInfo['id']): boolean;
-}
-export default EffectPlugin;
+import { Blending } from 'three';
+import { BufferGeometry } from 'three';
+import { ColorRepresentation } from 'three';
+import { default as default_2 } from 'soonspacejs';
+import { IColor } from 'soonspacejs';
+import { IVector3 } from 'soonspacejs';
+import { Matrix4 } from 'three';
+import { PluginObject } from 'soonspacejs';
+import { PluginObjectInfo } from 'soonspacejs';
+import { Points } from 'three';
+import { PointsMaterialParameters } from 'three';
+import { ShaderMaterialParameters } from 'three';
+import { Texture } from 'three';
+import { Vector2 } from 'three';
+import { Vector3 } from 'three';
+import { Vector4 } from 'three';
+
+/**
+ * 累积值的类型
+ */
+export declare type AccumulateValue = Required<Omit<ParticleClusterFeature, "densityGradient" | "valueGradient">> & GradientParams;
+
+export declare interface BuildsOptions extends PluginObjectInfo {
+    buildWidth?: number;
+    buildHeigh?: number;
+    buildDepth?: number;
+    count?: number;
+    gapX?: number;
+    gapZ?: number;
+    showDistance?: number;
+    randShift?: number;
+    color?: IColor;
+}
+
+export declare type CircleWaveOptions = InnerCircleWaveOptions & PluginObjectInfo;
+
+/**
+ * 簇几何体
+ */
+export declare class ClusterGeometry extends BufferGeometry {
+    readonly isClusterGeometry = true;
+    constructor(options?: ClusterGeometryOptions);
+    protected _options?: Partial<ClusterGeometryOptions> | null;
+    /**
+     * 选项
+     */
+    get options(): Partial<ClusterGeometryOptions>;
+    set options(options: Partial<ClusterGeometryOptions>);
+    /**
+     * 梯度
+     */
+    get gradient(): ColorGradient | ImageData | null | undefined;
+    set gradient(value: ColorGradient | ImageData | null | undefined);
+    protected _colorGradient?: ImageData | null;
+    get colorGradient(): ImageData | null;
+    set colorGradient(value: ImageData | null);
+    /**
+     * 创建颜色梯度
+     * @param gradient
+     * @returns
+     */
+    createColorGradient(gradient?: ColorGradient | ImageData | null): ImageData | null;
+    /**
+     * 更新顶点颜色
+     * @returns
+     */
+    updateVertexColors(): false | undefined;
+    get clim(): IVector2;
+    set clim(value: IVector2);
+    /**
+     * 簇列表
+     */
+    get clusters(): ParticleClusterData<IVector3_2>[] | undefined;
+    set clusters(value: ParticleClusterData<IVector3_2>[] | undefined);
+    /**
+     * 更新顶点
+     * @returns
+     */
+    updateVertices(): void;
+    protected _values?: number[] | null;
+    /**
+     * 顶点对应的值列表
+     */
+    get values(): number[];
+    set values(val: number[]);
+    /**
+     * 添加簇
+     * @param cluster
+     * @returns
+     */
+    addCluster(cluster: ParticleClusterData<IVector3_2>[] | ParticleClusterData<IVector3_2>): void;
+    /**
+     * 添加值和顶点颜色
+     * @param values
+     * @returns
+     */
+    addValueColors(values: number[]): false | undefined;
+}
+
+/**
+ * 簇几何体的选项
+ */
+export declare interface ClusterGeometryOptions {
+    /**
+     * 颜色映射纹理
+     */
+    gradient?: ColorGradient | ImageData | null;
+    /**
+     * 簇数据
+     */
+    clusters: ParticleClusterData<IVector3_2>[];
+    /**
+     * 映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     *
+     * @defaultValue {x:0,y:100}
+     */
+    clim?: IVector2;
+}
+
+/**
+ * 簇类型
+ */
+export declare enum ClusterType {
+    Point = 0,
+    Line = 1,
+    Heat = 2
+}
+
+/**
+ * 颜色梯度，颜色断点列表
+ * @remarks
+ * 颜色断点可以不按顺序排列
+ */
+declare type ColorGradient = ColorStop[];
+
+/**
+ * 颜色断点
+ * @remarks
+ * number 的范围是 0-1，表示断点的位置；
+ *
+ * string 表示颜色，支持 css 所支持的所有颜色格式；
+ */
+declare type ColorStop = [number, string];
+
+export declare interface ContactShadowsOptions extends Omit<PluginObjectInfo, 'scale'> {
+    opacity?: number;
+    width?: number;
+    height?: number;
+    blur?: number;
+    far?: number;
+    resolution?: number;
+    frames?: number;
+    scale?: number | [x: number, y: number];
+    darkness?: number;
+}
+
+/**
+ * 生成点云
+ * @param pointInfo - 点信息
+ * @param intersects - 相交的点列表
+ * @returns
+ */
+export declare function createHeatParticleClusterData<IVec extends IVector>(pointInfo: Required<HeatParticleClusterFeaturePoint<IVec>>, intersects: Required<HeatParticleClusterFeaturePoint<IVec>>[]): ParticleClusterData<IVec>;
+
+/**
+ * 为很多点创建点粒子族列
+ * @param options
+ * @returns
+ */
+export declare function createHeatParticleClusterDataArr<IVec extends IVector>(options: CreateHeatParticleClusterDataArrOptions<IVec>): ParticleClusterData<IVec>[];
+
+/**
+ * 很多热力点粒子族
+ */
+export declare interface CreateHeatParticleClusterDataArrOptions<IVec extends IVector> extends HeatParticleClusterFeature {
+    points: HeatParticleClusterFeaturePoint<IVec>[];
+}
+
+declare interface CreateLineParticleClusterDataArrOptions<IVec extends IVector> extends CreatePointParticleClusterDataArrOptions<IVec> {
+    radiusGradient?: GetLineGradientValue;
+    lineDensityGradient?: GetLineGradientValue;
+    lineValueGradient?: GetLineGradientValue;
+    /**
+     * 对折线进行插件时步长
+     * @defaultValue 与 `step` 相同
+     */
+    lineStep?: number;
+}
+
+/**
+ * 生成点云
+ * @param options
+ * @returns
+ */
+export declare function createPointParticleClusterData<IVec extends IVector>(pointInfo: PointParticleClusterInfo<IVec>, lineOptions?: LinePointInfo): ParticleClusterData<IVec>;
+
+/**
+ * 为很多点创建点粒子族列
+ * @param options
+ * @returns
+ */
+export declare function createPointParticleClusterDataArr<IVec extends IVector>(options: CreatePointParticleClusterDataArrOptions<IVec>): ParticleClusterData<IVec>[];
+
+/**
+ * 很多点粒子族
+ */
+export declare interface CreatePointParticleClusterDataArrOptions<IVec extends IVector> extends ParticleClusterFeature {
+    points: ParticleClusterFeaturePoint<IVec>[];
+}
+
+export declare interface CreateWaterOptions extends PluginObjectInfo, Omit<WaterOptions, 'userData'> {
+    /**
+     * 是否开启水的动画
+     * @remarks
+     * 如果开启，则会一直触发场景渲染
+     * 如果关闭，则不会主动触发场景渲染，但在渲染渲染时仍会有动画效果，只是不会主动触发场景渲染
+     */
+    animation?: boolean;
+}
+
+export declare type CylinderWaveOptions = InnerCylinderWaveOptions & PluginObjectInfo;
+
+/**
+ * 默认的密度梯度函数
+ * @param param0
+ * @returns
+ */
+export declare function densityGradient_Default({ ratio, density }: GradientParams): number;
+
+declare class EffectPlugin {
+    readonly ssp: default_2;
+    [x: string]: any;
+    /**
+     * 天气预设图片
+     */
+    readonly weatherPresetImgs: {
+        rain: string;
+        snow: string;
+    };
+    private _weatherId;
+    constructor(ssp: default_2);
+    /**
+     * 创建火焰
+     * @params params
+     * @returns
+     */
+    createFlame(params: FlameOptions): PluginObject;
+    /**
+     * 创建烟雾
+     * @param params
+     * @returns
+     */
+    createSmoke(params: SmokeOptions): PluginObject;
+    createSmoke2(params: Smoke2Options): PluginObject;
+    /**
+     * 创建星星
+     * @param params
+     * @returns
+     */
+    createSparkles(params: SparklesOptions): PluginObject;
+    /**
+     * 创建接触阴影
+     * @params params
+     */
+    createContactShadows(options: ContactShadowsOptions): PluginObject;
+    /**
+     * 开启天气
+     * @param param0
+     */
+    openWeather(params?: WeatherOptions): void;
+    /**
+     * 关闭天气
+     */
+    closeWeather(): void;
+    /**
+     * 创建粒子簇
+     * @param options
+     * @returns
+     */
+    createParticleCluster(options: ParticleClusterOptions): any;
+    /**
+     * 创建圆形光波
+     * @param options
+     * @returns
+     */
+    createCircleWave(options: CircleWaveOptions): PluginObject;
+    /**
+     * 创建立柱光波
+     * @param options
+     * @returns
+     */
+    createCylinderWave(options: CylinderWaveOptions): PluginObject;
+    /**
+     * 创建粒子波浪
+     * @param options
+     * @returns
+     */
+    createPointsWave(options: PointsWaveOptions): PluginObject;
+    /**
+     * 创建建筑
+     * @param options
+     * @returns
+     */
+    createBuilds(options: BuildsOptions): PluginObject;
+    createWater(options: CreateWaterOptions): PluginObject;
+    removeEffect(id: PluginObjectInfo['id']): boolean;
+}
+export default EffectPlugin;
+
+export declare interface FlameOptions extends PluginObjectInfo {
+    magnitude?: number;
+    gain?: number;
+    imgUrl?: string;
+}
+
+/**
+ * 密度梯度函数
+ */
+export declare type GetGradientValue = (params: GradientParams) => number;
+
+declare type GetLineGradientValue = (params: LineGradientParams) => number;
+
+/**
+ * 在圆形区域内生成随机向量
+ * @param axisNum - 向量的轴数
+ * @returns
+ */
+export declare function getRandomVector_Circle(axisNum: number): number[];
+
+/**
+ * 在环形区域内生成随机向量
+ * @remarks
+ * 随机生成的向量长度在 start 到 start+space 之间
+ * @param axisNum - 向量的轴数
+ * @param start - 向量的起始长度
+ * @param space - 随机空间的长度
+ * @returns
+ */
+export declare function getRandomVector_CircleAnnular(axisNum: number, start: number, space: number): number[];
+
+/**
+ * 在圆柱区域内生成随机向量
+ * @param axisNum - 向量的轴数
+ * @param height - 方轴的高度
+ * @returns 包含向量各个分量的轴列表
+ */
+export declare function getRandomVector_CircleCylinder(axisNum: number, height: number): number[];
+
+/**
+ * 在圆环柱区域内生成随机向量
+ * @param axisNum - 向量的轴数
+ * @param start - 向量的起始长度
+ * @param space - 随机空间的长度
+ * @param height - 方轴的高度
+ * @returns 包含向量各个分量的轴列表
+ */
+export declare function getRandomVector_CircleCylinderAnnular(axisNum: number, start: number, space: number, height: number): number[];
+
+/**
+ * 在方式区域内生成随机向量
+ * @param axisNum - 向量的轴数
+ * @returns
+ */
+export declare function getRandomVector_Square(axisNum: number): number[];
+
+/**
+ * 在方环形区域内生成随机向量
+ * @remarks
+ * 随机生成的向量长度在 start 到 start+space 之间
+ * @param axisNum - 向量的轴数
+ * @param start - 向量的起始长度
+ * @param space - 随机空间的长度
+ * @returns
+ */
+export declare function getRandomVector_SquareAnnular(axisNum: number, start: number, space: number): number[];
+
+/**
+ * 在方柱区域内生成随机向量
+ * @param axisNum - 向量的轴数
+ * @param height - 方轴的高度
+ * @returns 包含向量各个分量的轴列表
+ */
+export declare function getRandomVector_SquareCylinder(axisNum: number, height: number): number[];
+
+/**
+ * 在方环柱区域内生成随机向量
+ * @param axisNum - 向量的轴数
+ * @param height - 方轴的高度
+ * @param start - 向量的起始长度
+ * @param space - 随机空间的长度
+ * @returns 包含向量各个分量的轴列表
+ */
+export declare function getRandomVector_SquareCylinderAnnular(axisNum: number, start: number, space: number, height: number): number[];
+
+/**
+ * 梯度函数的参数
+ */
+export declare interface GradientParams {
+    /**
+     * 梯度的变化比率
+     * @remarks
+     * 当作为 DensityGradient 的参数时，表示
+     * - 在 solidRadius 半径处为 0
+     * - 在 radius 处为 1
+     * 当作为 ValueGradient 的参数时，表示
+     * - 在 0 半径处为 0
+     * - 在 radius 处为 1
+     */
+    ratio: number;
+    radius: number;
+    solid: number;
+    solidRadius: number;
+    gradientRadius: number;
+    hollow: number;
+    hollowRadius: number;
+    distance: number;
+    density: number;
+    value: number;
+    clim: IVector2;
+}
+
+export declare interface HeatParticleClusterFeature extends ParticleClusterFeature {
+    valuesAccumulate?: ValuesAccumulate;
+}
+
+export declare type HeatParticleClusterFeaturePoint<IVec extends IVector> = HeatParticleClusterFeature & IVec;
+
+declare interface InnerCircleWaveOptions {
+    textureUrl: string[];
+    position: IVector3;
+    width: number;
+    height: number;
+    isScaleAnimate: boolean;
+    isOpacityAnimate: boolean;
+}
+
+declare interface InnerCylinderWaveOptions {
+    position: IVector3;
+    topRadius: number;
+    bottomRadius: number;
+    height: number;
+    texturePath: string;
+    color: string;
+}
+
+/**
+ * 向量
+ */
+declare type IVector = IVector2 | IVector3_2 | IVector4;
+
+/**
+ * 二维向量
+ */
+declare interface IVector2 {
+    	x: number;
+    	y: number;
+}
+
+/**
+ * 三维向量
+ */
+declare interface IVector3_2 extends IVector2 {
+    	z: number;
+}
+
+/**
+ * 四维向量
+ */
+declare interface IVector4 extends IVector3_2 {
+    	w: number;
+}
+
+/**
+ * 向量接口类型转向量类型
+ */
+declare type IVectorToVector<V extends IVector> = V extends IVector4 ? Vector4 : (V extends IVector3_2 ? Vector3 : Vector2);
+
+declare interface LineGradientParams {
+    ratio: number;
+    length: number;
+    startRadius: number;
+    endRadius: number;
+    addedRadius: number;
+    defaultRadius: number;
+    index: number;
+    startDensity: number;
+    endDensity: number;
+    addedDensity: number;
+    defaultDensity: number;
+    startValue: number;
+    endValue: number;
+    addedValue: number;
+    defaultValue: number;
+}
+
+export declare interface LinePointInfo {
+    lineStep: number;
+    matrix: Matrix4;
+}
+
+export declare class ParticleCluster extends Points {
+    readonly isParticleCluster = true;
+    constructor(options?: ParticleClusterOptions);
+    get options(): ParticleClusterGeometryOptions;
+    set options(value: ParticleClusterGeometryOptions);
+    setOptions(options: ParticleClusterGeometryOptions): void;
+    addPoint(point: ParticleClusterFeaturePoint<IVector3_2>[] | ParticleClusterFeaturePoint<IVector3_2>, options?: Omit<ParticleClusterGeometryOptions, "points">): void;
+    convertPoints(points: ParticleClusterFeaturePoint<IVector3_2>[]): ParticleClusterFeatureVector<IVector3_2>[];
+}
+
+/**
+ * 粒子簇信息
+ */
+export declare interface ParticleClusterData<IVec extends IVector> {
+    /**
+     * 粒子的坐标列表
+     */
+    particles: IVectorToVector<IVec>[];
+    /**
+     * 每个粒子对应的值
+     */
+    values: number[];
+}
+
+/**
+ * 粒子簇特征
+ */
+export declare interface ParticleClusterFeature {
+    /**
+     * 半径
+     *
+     * @defaultValue 10
+     */
+    radius?: number;
+    /**
+     * 值
+     *
+     * @defaultValue 100
+     */
+    value?: number;
+    /**
+     * 实心因子
+     *
+     * @defaultValue 0.7
+     */
+    solid?: number;
+    /**
+     * 空心因子
+     *
+     * @defaultValue 0
+     */
+    hollow?: number;
+    /**
+     * 中心点的密度
+     * @remarks
+     * 单位空间中有多少个点
+     *
+     * @defaultValue 1
+     */
+    density?: number;
+    /**
+     * 粒子云的形状
+     */
+    shape?: ParticleClusterShape;
+    /**
+     * 密度梯度函数
+     */
+    densityGradient?: GetGradientValue;
+    valueGradient?: GetGradientValue;
+    /**
+     * 映射区间
+     * @remarks
+     * x 为最小值，y 为最大值
+     *
+     * @defaultValue {x:0,y:100}
+     */
+    clim?: IVector2;
+    /**
+     * 生成粒子时使用的距离步长
+     * @remarks
+     * 这个也会影响粒子的密度 和 粒子个数；
+     * 建议所有粒子的步长一样；
+     *
+     * @defaultValue 3
+     */
+    step?: number;
+}
+
+/**
+ * 粒子簇特性点
+ */
+export declare type ParticleClusterFeaturePoint<IVec extends IVector> = ParticleClusterFeature & IVec;
+
+/**
+ * 粒子簇特性向量
+ */
+export declare type ParticleClusterFeatureVector<IVec extends IVector> = ParticleClusterFeature & IVectorToVector<IVec>;
+
+export declare class ParticleClusterGeometry extends ClusterGeometry {
+    readonly isParticleClusterGeometry = true;
+    constructor(options?: ParticleClusterGeometryOptions);
+    get options(): ParticleClusterGeometryOptions;
+    set options(value: ParticleClusterGeometryOptions);
+    get clusterType(): ClusterType | undefined;
+    set clusterType(value: ClusterType | undefined);
+    setOptions(options: ParticleClusterGeometryOptions): void;
+    updateClusters(): void;
+    createClusters(options: ParticleClusterGeometryOptions): ParticleClusterData<IVector3_2>[];
+    /**
+     * 添加点
+     * @param point
+     * @param options
+     */
+    addPoint(point: ParticleClusterFeaturePoint<IVector3_2>[] | ParticleClusterFeaturePoint<IVector3_2>, options?: Omit<ParticleClusterGeometryOptions, "points">): void;
+}
+
+/**
+ * ParticleClusterGeometry 的选项
+ */
+export declare type ParticleClusterGeometryOptions = CreatePointParticleClusterDataArrOptions<IVector3_2> & CreateLineParticleClusterDataArrOptions<IVector3_2> & CreateHeatParticleClusterDataArrOptions<IVector3_2> & Omit<ClusterGeometryOptions, "clusters"> & {
+    clusterType?: ClusterType;
+};
+
+/**
+ * createPointParticleClusterObject3D 的选项
+ */
+export declare type ParticleClusterOptions = ParticleClusterGeometryOptions & PointsMaterialParameters;
+
+/**
+ * 粒子云的形状
+ */
+export declare enum ParticleClusterShape {
+    /**
+     * 圆形
+     */
+    Circle = 0,
+    /**
+     * 方形
+     */
+    Square = 1
+}
+
+/**
+ * 点粒子簇
+ */
+export declare type PointParticleClusterInfo<IVec extends IVector> = Required<ParticleClusterFeature> & IVectorToVector<IVec>;
+
+export declare interface PointsWaveOptions extends PluginObjectInfo {
+    xAxisCount?: number;
+    zAxisCount?: number;
+    showDistance?: number;
+    separation?: number;
+    size?: number;
+    maxFluctua?: number;
+    color?: IColor;
+    opacity?: number;
+}
+
+export declare interface Smoke2Options extends PluginObjectInfo {
+    imgUrl?: string;
+    radius?: number;
+    maxLife?: number;
+    maxSize?: number;
+    rate?: number;
+    colors?: IColor[];
+    blending?: Blending;
+}
+
+export declare interface SmokeOptions extends PluginObjectInfo {
+    imgUrl?: string;
+    count?: number;
+    maxAge?: number;
+    size?: number;
+    acceleration?: number;
+    velocity?: IVector3;
+    color?: IColor[];
+}
+
+export declare interface SparklesOptions extends PluginObjectInfo {
+    count?: number;
+    speed?: number | Float32Array;
+    opacity?: number | Float32Array;
+    color?: IColor | Float32Array;
+    size?: number | Float32Array;
+    scalar?: number | [number, number, number] | IVector3;
+    noise?: number | [number, number, number] | IVector3 | Float32Array;
+}
+
+/**
+ * 默认的值梯度函数
+ */
+export declare function valueGradient_Default({ ratio, value }: GradientParams): number;
+
+/**
+ * 值类型函数
+ */
+export declare type ValuesAccumulate = (values: AccumulateValue[], clim: IVector2, density: number) => number;
+
+export declare function valuesAccumulate_Default(values: AccumulateValue[], clim: IVector2): number;
+
+declare interface WaterOptions extends ShaderMaterialParameters {
+    /**
+     * 水面的多边形区域
+     */
+    polygon: IVector3[];
+    /**
+     * 水面的高度
+     * @remarks
+     * 默认为第一个顶点的 y 值
+     */
+    height?: number;
+    /**
+     * 太阳的照射的方向
+     */
+    sunDirection?: Vector3;
+    /**
+     * 太阳的颜色
+     */
+    sunColor?: ColorRepresentation;
+    /**
+     * 水的颜色
+     */
+    waterColor?: ColorRepresentation;
+    /**
+     * 水波的强度
+     */
+    distortionScale?: number;
+    /**
+     * 透明度
+     */
+    alpha?: number;
+    /**
+     * 速度
+     */
+    speed?: number;
+    /**
+     * 水面法线纹理
+     */
+    waterNormals?: string | Texture;
+    fog?: boolean;
+    eye?: Vector3;
+    clipBias?: number;
+    textureWidth?: number;
+    textureHeight?: number;
+}
+
+export declare interface WeatherOptions {
+    /**
+     * 粒子贴图
+     */
+    imgUrl?: string;
+    /**
+     * 颜色
+     */
+    color?: IColor;
+    /**
+     * 大小
+     */
+    size?: number;
+    /**
+     * 不透明度
+     */
+    opacity?: number;
+    /**
+     * 粒子数量
+     */
+    count?: number;
+    /**
+     * 粒子范围
+     */
+    range?: number;
+    /**
+     * 粒子左右速度的随机范围
+     */
+    velocityX?: [number, number];
+    /**
+     * 粒子上下速度的随机范围
+     */
+    velocityY?: [number, number];
+}
+
+export { }