three-base 2.0.137 → 2.0.145

package/WaterFlow/ReservoirSystem.d.ts

@@ -0,0 +1,106 @@
+import * as THREE from 'three';
+import { ShallowWaterSurface } from './ShallowWaterSurface';
+import type { BasinConfig } from './types';
+/**
+ * 构造选项：几何口径（length/width/壁高）+ 平面位置（centerX/centerZ）+ 尾流水面网格分辨率。
+ * flowTexture 是溢出水花着色器采样的噪声图，缺省时 uniforms.uFlowMap 为 undefined。
+ */
+export interface ReservoirOptions {
+    flowTexture?: THREE.Texture;
+    length?: number;
+    width?: number;
+    bottomY?: number;
+    rimY?: number;
+    centerX?: number;
+    centerZ?: number;
+    waveWidth?: number;
+    waveHeight?: number;
+}
+/** update 的入参：入口水流量 + 撞击点/能量 + 是否正在喷射。 */
+export interface ReservoirUpdateOptions {
+    flowRate: number;
+    captureFraction?: number;
+    impactX: number;
+    impactZ?: number;
+    impactEnergy?: number;
+    emitting?: boolean;
+}
+/** update 的出参：本次入流/溢流的口径，供调用方做音效或统计。 */
+export interface ReservoirUpdateResult {
+    captured: boolean;
+    captureFraction: number;
+    incomingRate: number;
+    missedRate: number;
+    overflowRate: number;
+}
+export declare class ReservoirSystem {
+    /** 几何口径（全部由构造参数推导，构造后不变）。 */
+    private readonly length;
+    private readonly width;
+    private readonly bottomY;
+    private readonly rimY;
+    private readonly innerBottomY;
+    private readonly maxWaterY;
+    private readonly innerLength;
+    private readonly innerWidth;
+    private readonly surfaceArea;
+    private readonly capacity;
+    /** 水量与溢流状态（每帧变化）。 */
+    private volume;
+    private overflowRate;
+    private motionOverflowRate;
+    private overflowIntensity;
+    private active;
+    private particleFluidMode;
+    /** 容器晃动（xz 两个分量复用 Vector2 的 x/y）。 */
+    private readonly motionPreviousPosition;
+    private readonly motionVelocity;
+    private readonly motionAcceleration;
+    private readonly sloshOffset;
+    private readonly sloshVelocity;
+    private readonly motionWaveImpulse;
+    /** 池体节点与拾取体。 */
+    readonly renderer: THREE.WebGLRenderer;
+    readonly group: THREE.Group;
+    readonly hitMeshes: THREE.Mesh[];
+    readonly rimFoamMaterial: THREE.MeshBasicMaterial;
+    readonly rimFoamGroup: THREE.Group;
+    readonly waterMaterial: THREE.ShaderMaterial;
+    readonly waterBody: THREE.Mesh;
+    /** 浅水波面；非WebGL2 或缺浮点扩展时为 null（此时只保留水体盒）。 */
+    readonly surface: ShallowWaterSurface | null;
+    readonly overflowMaterial: THREE.ShaderMaterial;
+    readonly overflowGroup: THREE.Group;
+    /** 溢流粒子（GPU points）的缓冲与状态。 */
+    readonly dropCount: number;
+    private readonly dropPositions;
+    private readonly dropVelocities;
+    private readonly dropLife;
+    private readonly dropMaxLife;
+    private readonly dropBounces;
+    private readonly dropSizes;
+    private readonly dropAlpha;
+    private dropCursor;
+    private dropAccumulator;
+    readonly dropMaterial: THREE.ShaderMaterial;
+    readonly spillPoints: THREE.Points;
+    constructor(renderer: THREE.WebGLRenderer, { flowTexture, length, width, bottomY, rimY, centerX, centerZ, waveWidth, waveHeight, }?: ReservoirOptions);
+    setActive(active: boolean): void;
+    setParticleFluidMode(enabled: boolean): void;
+    moveTo(x: number, z: number): void;
+    reset(fillRatio?: number): void;
+    updateContainerMotion(delta: number): void;
+    clearSpillParticles(): void;
+    spawnSpillParticle(): void;
+    updateSpillParticles(delta: number): void;
+    updateGeometry(): void;
+    update(delta: number, elapsed: number, { flowRate, captureFraction, impactX, impactZ, impactEnergy, emitting, }: ReservoirUpdateOptions): ReservoirUpdateResult;
+    setPixelRatio(pixelRatio: number): void;
+    get fillRatio(): number;
+    get waterY(): number;
+    get centerX(): number;
+    get centerZ(): number;
+    get minX(): number;
+    get maxX(): number;
+    get collisionBounds(): BasinConfig;
+}