JSAPI Three API Reference
    正在准备搜索索引...

    类 WaterMaterial

    水体材质，用于模拟真实的水面效果。

    支持水下折射、岸边泡沫、菲涅耳反射、水体深度渐变、焦散等复杂水面光照效果。

    const waterMaterial = new mapvthree.WaterMaterial({
        waterColor: [0.1, 0.3, 0.8],
        foamSpeed: 0.05,
        depthSoftness: 5,
    });

    层级

    • CommonShaderMaterial
      • WaterMaterial
    索引

    构造函数

    constructor

    方法

    dispose

    访问器

    crestFoam crestFoamColor depthSoftness foamDepthSoftness foamScale foamSoftness foamSpeed offsetScale specularStrength style timeScaleFactor useEnvMap uvScale waterColor

    构造函数

    • 构造函数

      参数

      • parameters: {
            crestFoam?: number;
            crestFoamColor?: number[];
            depthSoftness?: number;
            foamDepthSoftness?: number;
            foamScale?: number;
            foamSoftness?: number;
            foamSpeed?: number;
            offsetScale?: number;
            specularStrength?: number;
            timeScaleFactor?: number;
            useEnvMap?: boolean;
            uvScale?: number;
            waterColor?: number[];
        } = {}

        材质参数

        • 可选crestFoam?: number

          波峰泡沫判断阈值，范围0-1，默认为0.70

        • 可选crestFoamColor?: number[]

          波峰泡沫颜色，默认为[0.3, 0.3, 0.6]

        • 可选depthSoftness?: number

          水深渐变过渡，默认为5

        • 可选foamDepthSoftness?: number

          泡沫在水深维度上的衰减程度，默认为1

        • 可选foamScale?: number

          泡沫贴图缩放比例，默认为100

        • 可选foamSoftness?: number

          泡沫边缘模糊程度，默认为3

        • 可选foamSpeed?: number

          泡沫流动速度，默认为0.050

        • 可选offsetScale?: number

          波浪扰动高度偏移，默认为1

        • 可选specularStrength?: number

          高光闪耀强度，默认为1.5

        • 可选timeScaleFactor?: number

          时间缩放因子，默认为0.001

        • 可选useEnvMap?: boolean

          是否使用环境贴图，默认为true

        • 可选uvScale?: number

          UV缩放比例，默认为1000.0

        • 可选waterColor?: number[]

          水体的主颜色（深水区域颜色），默认为[1/255, 46/255, 120/255]

      返回 WaterMaterial

    方法

    • 释放资源 清理所有纹理和缓存

      返回 void

    访问器

    • get crestFoam(): number

      控制波峰泡沫的判断阈值，1最大，默认0.7

      返回 number

    • set crestFoam(value: number): void

      设置波峰泡沫的判断阈值

      参数

      • value: number

        波峰泡沫阈值，范围0-1

      返回 void

    • get crestFoamColor(): number[]

      波峰泡沫颜色

      返回 number[]

    • set crestFoamColor(value: number[]): void

      设置波峰泡沫颜色

      参数

      • value: number[]

        RGB颜色数组，范围0-1

      返回 void

    • get depthSoftness(): number

      控制水深渐变过渡，默认为5

      返回 number

    • set depthSoftness(value: number): void

      设置水深渐变过渡

      参数

      • value: number

        水深渐变过渡值

      返回 void

    • get foamDepthSoftness(): number

      控制泡沫在水深维度上的衰减程度，泡沫从深度为0到foamDepthSoftness范围衰减，默认为1

      返回 number

    • set foamDepthSoftness(value: number): void

      设置泡沫在水深维度上的衰减程度

      参数

      • value: number

        泡沫深度衰减值

      返回 void

    • get foamScale(): number

      控制泡沫贴图缩放比例，默认为100

      返回 number

    • set foamScale(value: number): void

      设置泡沫贴图缩放比例

      参数

      • value: number

        泡沫贴图缩放比例

      返回 void

    • get foamSoftness(): number

      控制泡沫边缘模糊的程度

      返回 number

    • set foamSoftness(value: number): void

      设置泡沫边缘模糊的程度

      参数

      • value: number

        泡沫边缘模糊值

      返回 void

    • get foamSpeed(): number

      控制泡沫的流动速度（用于 tFoamNoise 采样偏移）

      返回 number

    • set foamSpeed(value: number): void

      设置泡沫的流动速度

      参数

      • value: number

        泡沫流动速度

      返回 void

    • get offsetScale(): number

      控制波浪扰动高度偏移，默认为1

      返回 number

    • set offsetScale(value: number): void

      设置波浪扰动高度偏移

      参数

      • value: number

        波浪扰动高度偏移

      返回 void

    • get specularStrength(): number

      高光闪耀强度

      返回 number

    • set specularStrength(value: number): void

      设置高光闪耀强度

      参数

      • value: number

        高光强度值

      返回 void

    • get style(): string

      水体样式

      返回 string

    • set style(style: "river" | "lake" | "ocean"): void

      设置水系样式，默认为lake

      参数

      • style: "river" | "lake" | "ocean"

        样式名称，只接受'river', 'lake', 'ocean'

      返回 void

    • get timeScaleFactor(): number

      时间缩放因子

      返回 number

    • set timeScaleFactor(value: number): void

      设置时间缩放因子

      参数

      • value: number

        时间缩放因子

      返回 void

    • get useEnvMap(): boolean

      是否使用环境贴图

      返回 boolean

    • set useEnvMap(value: boolean): void

      设置是否使用环境贴图

      参数

      • value: boolean

        是否启用环境贴图

      返回 void

    • get uvScale(): number

      UV缩放比例

      返回 number

    • set uvScale(value: number): void

      设置UV缩放比例

      参数

      • value: number

        UV缩放比例

      返回 void

    • get waterColor(): number[]

      水体的主颜色（深水区域颜色）

      返回 number[]

    • set waterColor(value: number[]): void

      设置水体的主颜色（深水区域颜色）

      参数

      • value: number[]

        RGB颜色数组，范围0-1

      返回 void

    显示设置

    成员可见性

    目录

    构造函数
    方法
    访问器