three-base 2.0.142 → 2.0.145

package/WaterFlow/types.d.ts

@@ -1,161 +1,161 @@
-/**
- * WaterFlow 模块共享类型（单一来源，供 WaterFlow 目录内各 .ts 复用）。
- *
- * 2026-10-08 皇上旨「项目代码就应该写成 ts 来校验，尽量不写 js」——
- * 原 WaterFlow/ 下 7 个手写 .js 全部改写为 .ts，公共入参/出参类型集中在此，
- * 避免各文件重复声明高度相似的结构（也避免 any）。
- */
-import type { Camera, DepthTexture, Scene, Texture, Vector3, Vector4, WebGLRenderer, WebGLRenderTarget } from 'three';
-/** 深度解码口径：普通透视深度 | three-base 的对数深度（logarithmicDepthBuffer）。 */
-export type DepthMode = 'standard' | 'logarithmic';
-/** 「注入基础纹理」模式：直接消费调用方已有的颜色/深度，省掉一遍主场景渲染。 */
-export interface WaterFlowBaseTextures {
-    colorTexture: Texture;
-    depthTexture: DepthTexture | Texture;
-    depthMode?: DepthMode;
-}
-/** renderInto 的入参：在基础纹理之上再加「输出目标 + 相机」。 */
-export interface WaterFlowRenderOptions extends WaterFlowBaseTextures {
-    /** 合成输出目标；null 表示沿用调用方当前渲染目标（由 renderer.getRenderTarget() 决定）。 */
-    outputTarget: WebGLRenderTarget | null;
-    camera: Camera;
-}
-/** 模拟参数（可部分更新，故全部可选）。 */
-export interface FluidParameters {
-    speed?: number;
-    aperture?: number;
-    fillRatio?: number;
-    emitting?: boolean;
-    turbulence?: number;
-}
-/** 蓄水池状态。 */
-export interface ReservoirState {
-    active?: boolean;
-    fillRatio?: number;
-}
-/** 容器（盆）几何口径：x 范围、z 半宽、中心、水面高度与壁高。 */
-export interface BasinConfig {
-    minX: number;
-    maxX: number;
-    halfZ: number;
-    centerZ?: number;
-    waterY: number;
-    wallTop: number;
-    floorY?: number;
-    containerFloorY?: number;
-    rimWidth?: number;
-}
-/** ShallowWaterSurface 构造选项。 */
-export interface ShallowWaterSurfaceOptions {
-    width?: number;
-    height?: number;
-    basinMinX?: number;
-    basinMaxX?: number;
-    basinHalfZ?: number;
-    basinCenterZ?: number;
-    waterY?: number;
-    cpuSampling?: boolean;
-}
-/** ShallowWaterSurface.setBounds 的入参（centerZ 省略时按 0 处理）。 */
-export interface ShallowWaterSurfaceBounds {
-    basinMinX: number;
-    basinMaxX: number;
-    basinHalfZ: number;
-    basinCenterZ?: number;
-    waterY: number;
-}
-/**
- * 水面采样结果（ShallowWaterSurface.sampleSurface 回填 target 后返回）。
- * 字段全为可选：调用方可只声明自己关心的部分，结构上兼容 FloatingDuck 的 DuckSurfaceSample。
- */
-export interface WaterSurfaceSample {
-    height?: number;
-    velocityY?: number;
-    slopeX?: number;
-    slopeZ?: number;
-    flowX?: number;
-    flowZ?: number;
-    impact?: number;
-}
-/** 渲染质量档。 */
-export interface FluidQuality {
-    scale: number;
-    activeCount: number;
-    blurRadius: number;
-}
-/** 外层 WaterFlow 构造选项。 */
-export interface WaterFlowOptions {
-    width?: number;
-    height?: number;
-    scale?: number;
-    size?: number;
-    speed?: number;
-    aperture?: number;
-    nozzle?: Vector3;
-    basin?: Vector4;
-    jetDirection?: Vector3;
-    collision?: boolean;
-}
-/** GPUFluidSimulation 构造选项（与外层同源，保留喷嘴/盆/喷流方向）。 */
-export interface FluidSimulationOptions {
-    size?: number;
-    nozzle?: Vector3;
-    basin?: Vector4;
-    speed?: number;
-    aperture?: number;
-    jetDirection?: Vector3;
-    collision?: boolean;
-}
-/** SPHField 构造选项。 */
-export interface SPHFieldOptions {
-    mobile?: boolean;
-}
-/** ScreenSpaceFluidPass 构造选项。 */
-export interface ScreenSpaceFluidPassOptions {
-    width?: number;
-    height?: number;
-    scale?: number;
-    activeCount?: number;
-    externalBase?: {
-        colorTexture: Texture;
-        depthTexture: DepthTexture | Texture;
-        depthMode: DepthMode;
-    } | null;
-}
-/** 屏幕空间 pass 需要的场景/相机（构造期持有，避免每帧反查）。 */
-export interface ScreenSpaceFluidContext {
-    scene: Scene;
-    camera: Camera;
-}
-/** setBaseTextures 的部分更新入参。 */
-export interface PartialBaseTextures {
-    colorTexture?: Texture;
-    depthTexture?: DepthTexture | Texture;
-    depthMode?: DepthMode;
-}
-/** 渲染器能力判定结果：非 WebGL2 或缺浮点扩展时整套流体不可用。 */
-export interface FluidSupportInfo {
-    renderer: WebGLRenderer;
-}
-/**
- * ScreenSpaceFluidPass 视角下的流体模拟器最小契约。
- * 只声明 pass 真正读取的成员（粒子纹理边长 / 粒子数 / 能力位 / 位置与速度纹理），
- * 使 pass 不必耦合 GPUFluidSimulation 的其余实现细节。
- * GPUFluidSimulation 实例天然满足本结构（结构化子类型）。
- */
-export interface ScreenSpaceFluidSource {
-    /** 粒子纹理边长，count === size * size。 */
-    size: number;
-    /** 粒子总数。 */
-    count: number;
-    /** 是否支持浮点纹理；false 时两个纹理成员为 null。 */
-    supported: boolean;
-    positionTexture: Texture | null;
-    velocityTexture: Texture | null;
-}
-/**
- * 「外部注入基础纹理」三元组的非空形态。
- * 等价于 ScreenSpaceFluidPassOptions['externalBase'] 去掉 null，
- * 供 pass 内部字段（externalBase）与 GPUFluidSimulation 之外的调用方直接复用。
- */
-export type ExternalBaseTextures = NonNullable<ScreenSpaceFluidPassOptions['externalBase']>;
+/**
+ * WaterFlow 模块共享类型（单一来源，供 WaterFlow 目录内各 .ts 复用）。
+ *
+ * 2026-10-08 皇上旨「项目代码就应该写成 ts 来校验，尽量不写 js」——
+ * 原 WaterFlow/ 下 7 个手写 .js 全部改写为 .ts，公共入参/出参类型集中在此，
+ * 避免各文件重复声明高度相似的结构（也避免 any）。
+ */
+import type { Camera, DepthTexture, Scene, Texture, Vector3, Vector4, WebGLRenderer, WebGLRenderTarget } from 'three';
+/** 深度解码口径：普通透视深度 | three-base 的对数深度（logarithmicDepthBuffer）。 */
+export type DepthMode = 'standard' | 'logarithmic';
+/** 「注入基础纹理」模式：直接消费调用方已有的颜色/深度，省掉一遍主场景渲染。 */
+export interface WaterFlowBaseTextures {
+    colorTexture: Texture;
+    depthTexture: DepthTexture | Texture;
+    depthMode?: DepthMode;
+}
+/** renderInto 的入参：在基础纹理之上再加「输出目标 + 相机」。 */
+export interface WaterFlowRenderOptions extends WaterFlowBaseTextures {
+    /** 合成输出目标；null 表示沿用调用方当前渲染目标（由 renderer.getRenderTarget() 决定）。 */
+    outputTarget: WebGLRenderTarget | null;
+    camera: Camera;
+}
+/** 模拟参数（可部分更新，故全部可选）。 */
+export interface FluidParameters {
+    speed?: number;
+    aperture?: number;
+    fillRatio?: number;
+    emitting?: boolean;
+    turbulence?: number;
+}
+/** 蓄水池状态。 */
+export interface ReservoirState {
+    active?: boolean;
+    fillRatio?: number;
+}
+/** 容器（盆）几何口径：x 范围、z 半宽、中心、水面高度与壁高。 */
+export interface BasinConfig {
+    minX: number;
+    maxX: number;
+    halfZ: number;
+    centerZ?: number;
+    waterY: number;
+    wallTop: number;
+    floorY?: number;
+    containerFloorY?: number;
+    rimWidth?: number;
+}
+/** ShallowWaterSurface 构造选项。 */
+export interface ShallowWaterSurfaceOptions {
+    width?: number;
+    height?: number;
+    basinMinX?: number;
+    basinMaxX?: number;
+    basinHalfZ?: number;
+    basinCenterZ?: number;
+    waterY?: number;
+    cpuSampling?: boolean;
+}
+/** ShallowWaterSurface.setBounds 的入参（centerZ 省略时按 0 处理）。 */
+export interface ShallowWaterSurfaceBounds {
+    basinMinX: number;
+    basinMaxX: number;
+    basinHalfZ: number;
+    basinCenterZ?: number;
+    waterY: number;
+}
+/**
+ * 水面采样结果（ShallowWaterSurface.sampleSurface 回填 target 后返回）。
+ * 字段全为可选：调用方可只声明自己关心的部分，结构上兼容 FloatingDuck 的 DuckSurfaceSample。
+ */
+export interface WaterSurfaceSample {
+    height?: number;
+    velocityY?: number;
+    slopeX?: number;
+    slopeZ?: number;
+    flowX?: number;
+    flowZ?: number;
+    impact?: number;
+}
+/** 渲染质量档。 */
+export interface FluidQuality {
+    scale: number;
+    activeCount: number;
+    blurRadius: number;
+}
+/** 外层 WaterFlow 构造选项。 */
+export interface WaterFlowOptions {
+    width?: number;
+    height?: number;
+    scale?: number;
+    size?: number;
+    speed?: number;
+    aperture?: number;
+    nozzle?: Vector3;
+    basin?: Vector4;
+    jetDirection?: Vector3;
+    collision?: boolean;
+}
+/** GPUFluidSimulation 构造选项（与外层同源，保留喷嘴/盆/喷流方向）。 */
+export interface FluidSimulationOptions {
+    size?: number;
+    nozzle?: Vector3;
+    basin?: Vector4;
+    speed?: number;
+    aperture?: number;
+    jetDirection?: Vector3;
+    collision?: boolean;
+}
+/** SPHField 构造选项。 */
+export interface SPHFieldOptions {
+    mobile?: boolean;
+}
+/** ScreenSpaceFluidPass 构造选项。 */
+export interface ScreenSpaceFluidPassOptions {
+    width?: number;
+    height?: number;
+    scale?: number;
+    activeCount?: number;
+    externalBase?: {
+        colorTexture: Texture;
+        depthTexture: DepthTexture | Texture;
+        depthMode: DepthMode;
+    } | null;
+}
+/** 屏幕空间 pass 需要的场景/相机（构造期持有，避免每帧反查）。 */
+export interface ScreenSpaceFluidContext {
+    scene: Scene;
+    camera: Camera;
+}
+/** setBaseTextures 的部分更新入参。 */
+export interface PartialBaseTextures {
+    colorTexture?: Texture;
+    depthTexture?: DepthTexture | Texture;
+    depthMode?: DepthMode;
+}
+/** 渲染器能力判定结果：非 WebGL2 或缺浮点扩展时整套流体不可用。 */
+export interface FluidSupportInfo {
+    renderer: WebGLRenderer;
+}
+/**
+ * ScreenSpaceFluidPass 视角下的流体模拟器最小契约。
+ * 只声明 pass 真正读取的成员（粒子纹理边长 / 粒子数 / 能力位 / 位置与速度纹理），
+ * 使 pass 不必耦合 GPUFluidSimulation 的其余实现细节。
+ * GPUFluidSimulation 实例天然满足本结构（结构化子类型）。
+ */
+export interface ScreenSpaceFluidSource {
+    /** 粒子纹理边长，count === size * size。 */
+    size: number;
+    /** 粒子总数。 */
+    count: number;
+    /** 是否支持浮点纹理；false 时两个纹理成员为 null。 */
+    supported: boolean;
+    positionTexture: Texture | null;
+    velocityTexture: Texture | null;
+}
+/**
+ * 「外部注入基础纹理」三元组的非空形态。
+ * 等价于 ScreenSpaceFluidPassOptions['externalBase'] 去掉 null，
+ * 供 pass 内部字段（externalBase）与 GPUFluidSimulation 之外的调用方直接复用。
+ */
+export type ExternalBaseTextures = NonNullable<ScreenSpaceFluidPassOptions['externalBase']>;

package/WaterFlow/types.js

@@ -1 +1 @@
-export {};
+export {};