DTS二次开发文档

Class: Weather

Weather

Weather类，提供天气相关的参数设置和获取接口

<protected> new Weather()

See:

Methods

disableRainSnow(fn)

关闭雨雪效果

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

getDateTime(fn)

获取日期时间

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
获取的日期时间
{
            "hour":	9, // 时
            "minute":	0, // 分
            "year":	2021, // 年
            "month":	10, // 月
            "day":	28, // 日
            "latitude":	20.000000, // 经度
            "longitude":	116.000000, // 维度
            "timeZone":	8.000000, // 时区
            "daynightLoop":	0, // 是否日夜循环，0关闭 1开启
            "dayLength":	3.000000 //模拟时长，即几分钟模拟循环一天，仅在开启日夜循环后生效
        }

getOceanWave(fn)

查询海浪效果参数

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

getParams(fn)

获取天气相关的参数

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
获取的天气参数
{
        "darkMode":	0, //是否黑暗模式，0关闭 1打开
        "cloudDensity":	0.500000, //云层密度，取值范围：[0~1.0]
        "cloudThickness": 2.00000, //云层厚度，取值范围：[0~20.0]
        "fogDensity":	0.100000, //整体雾浓度，取值范围:[0~1.0]
        "fogGroundDensity":	0.000000, //地面雾浓度，取值范围:[0~1.0]
        "fogGroundHeight":	0.000000, //地面雾高度，取值范围:[0~10]（单位KM）
        "rainsnow":	0, //是否雨雪效果，0关闭 1打开
        "rainsnowStrength":	0.000000, //雨雪强度（必须大于0，才会有下雨效果），取值范围:[0~1.0]
        "rainsnowSpeed":	0.300000, //雨雪速度，取值范围:[0~10]
        "raindropSize":	0.200000, //雨滴大小，取值范围:[0~5]
        "snowflakeSize":	0.800000, //雪花大小，取值范围:[0~25]
        "sunSize": 25, //太阳尺寸，取值范围:[0~100]
        "sunColor": [1,1,1,1], //太阳尺寸，取值范围:[0~100]
        "moonSize": 30,//月亮尺寸，取值范围:[0~100]
        "sunIntensity": 0.7,//太阳光照射强度，取值范围:[0~10]
        "moonIntensity": 30,//月亮光照射强度，取值范围:[0~100]
        "ambientLightIntensity": 0.3,//环境光强度，取值范围:[0~10]
        "temperature": 8500,//色温值，取值范围:[1700~12000]
        "shadowQuality": 2,//阴影质量，取值范围：[1~5]
        "shadowDistance": 2000,//阴影可视距离，取值范围:[0~任意正数]，单位：米
        }

setAmbientLightIntensity(ambientLightIntensity, fn)

设置环境光强度

Parameters:
Name Type Description
ambientLightIntensity number

环境光强度，取值范围:[0~5]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setCloudDensity(cloudDensity, fn)

设置云层的密度

Parameters:
Name Type Description
cloudDensity number

云层密度，取值范围：[0~1.0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setCloudParam(cloudsColor, cloudsAltitude, cloudShadowStrength, fn)

设置云效参数

Parameters:
Name Type Description
cloudsColor number

云层颜色，支持四种格式，取值示例
cloudsAltitude number

云层海拔高度，单位：千米/km，取值范围：[0~8km]
cloudShadowStrength number

云层阴影，取值范围:[0~1]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setCloudThickness(cloudThickness, fn)

设置云层的厚度

Parameters:
Name Type Description
cloudThickness number

云层厚度，取值范围：[0~0.5]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setDarkMode(bDark, fn)

设置是否进入黑暗模式 效果图：

Parameters:
Name Type Description
bDark boolean

布尔值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setDateTime(year, month, day, hour, minute, daynightLoop, fn)

设置日期时间

Parameters:
Name Type Description
year number

年
month number

月
day number

日
hour number

时
minute number

分
daynightLoop boolean

是否日夜循环 如果为true 则三分钟模拟循环一天
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setEarthCloudIntensity(earthCloudIntensity, fn)

球面工程坐标系下，设置地球大气云层的亮度

Parameters:
Name Type Description
earthCloudIntensity number

地球大气云层的亮度，默认值：0，取值范围：[0~1]，设置0则隐藏云层
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Returns:

setEarthNightLightIntensity(earthNightLightIntensity, fn)

球面工程坐标系下，设置地球夜晚灯光的亮度

Parameters:
Name Type Description
earthNightLightIntensity number

地球夜晚灯光的亮度，默认值：0，取值范围：[0~1]，设置0则关闭灯光
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Returns:

setEarthStarBackgroundIntensity(earthStarBackgroundIntensity, fn)

球面工程坐标系下，设置星空背景的亮度

Parameters:
Name Type Description
earthStarBackgroundIntensity number

星空背景的亮度，默认值：0，取值范围：[0~1]，设置0则关闭星空背景亮度
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Returns:

setFogParam(fogDensity, fogColor, fogHeightFalloff, fogStartDistance, fogOpacity, fn)

设置雾效参数。 效果图：

Parameters:
Name Type Description
fogDensity number

雾的浓度，取值范围:[0~2.0]
fogColor number

雾的颜色，支持四种格式，取值示例
fogHeightFalloff number

高度衰减，取值范围:[0~2]
fogStartDistance number

起雾距离，取值范围:[0~10000]
fogOpacity number

透明度，取值范围:[0.00~1.00]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setHighCloud(highCloudLayerCoverage, highCloudWindSpeed, highCloudWindDirection, cirrusCloudDensity, cirrostratusCloudDensity, cirrocumulusCloudDensity, fn)

设置高云层效果参数

Parameters:
Name Type Description
highCloudLayerCoverage number

密度，取值范围：[0~1]
highCloudWindSpeed number

风速，取值范围：[0~100]
highCloudWindDirection number

风向，取值范围：[0~360]
cirrusCloudDensity number

卷云密度，取值范围：[0~1]
cirrostratusCloudDensity number

卷层云密度，取值范围：[0~1]
cirrocumulusCloudDensity number

卷积云密度，取值范围：[0~1]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setLowCloud(lowCloudCoverage, lowCloudDensity, lowCloudHeight, lowCloudWindSpeed, lowCloudWindDirection, fn)

设置低云层效果参数

Parameters:
Name Type Description
lowCloudCoverage number

覆盖率，取值范围：[0~1]
lowCloudDensity number

密度，取值范围：[0~1]
lowCloudHeight number

厚度，取值范围：[0~0.5]
lowCloudWindSpeed number

风速，取值范围：[0~100]
lowCloudWindDirection number

风向，取值范围：[0~360]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setMoonIntensity(moonIntensity, fn)

设置月亮光照强度

Parameters:
Name Type Description
moonIntensity number

月亮光照强度，取值范围:[0~1]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setMoonSize(moonSize, fn)

设置月亮尺寸

Parameters:
Name Type Description
moonSize number

月亮尺寸，取值范围:[0~10]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setOceanWave(options, fn)

设置海浪效果参数

Parameters:
Name Type Description
options object

海浪效果的相关参数如下：

  • scale (number) 海浪起伏整体的缩放倍率（包括以下波长、振幅和速度参数），默认值：1

  • length (number) 海浪的波长，值越大海面越平静，默认值：6米

  • amplitude (number) 海浪的振幅，值越大上下起伏越大，默认值：4.2米

  • speed (number) 海浪的运动速度倍率，值越大海浪运动越快，默认值：9

  • formDensity (number) 海浪泡沫的强度，默认值：0.2，取值范围：[0,1]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setRainParam(strength, speed, raindropSize, rainColor, alignCamera, overcastStrength, fn)

设置雨效。注意：开启雨效前需先设置云层的厚度和密度，效果图：

Parameters:
Name Type Description
strength number

雨效强度（必须大于0，才会有下雨效果），取值范围:[0~1.0]
speed number

雨效速度，取值范围:[0~1.0]
raindropSize number

雨滴大小，取值范围:[0~1.0]
rainColor Color

雨滴颜色，支持四种格式，取值示例
alignCamera number

相机移动对齐，取值范围:[0~1.0]
overcastStrength number

阴天程度，取值范围:[0~1.0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setShadowDistance(shadowDistance, fn)

设置阴影可视距离，即相机镜头距离物体阴影的距离

Parameters:
Name Type Description
shadowDistance number

阴影可视距离，取值范围:[10~30000]，单位：米
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setShadowIntensity(shadowIntensity, fn)

设置阴影强度，值越大表示阴影越强

Parameters:
Name Type Description
shadowIntensity number

阴影强度，取值范围：[0.00~1.00]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setShadowQuality(shadowQuality, fn)

设置阴影质量，值越大表示阴影越精细，但也越消耗显卡性能

Parameters:
Name Type Description
shadowQuality number

阴影质量，取值范围：[1~5]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setSkyVisibleMaxHeight(maxHeight, fn)

设置天空球效果的失效高度，默认值：50000米(50公里)

Parameters:
Name Type Description
maxHeight number

控制天空显示的最大相机高度，相机位置的Z值超过此高度则进入黑暗模式
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setSnowParam(strength, speed, snowflakeSize, snowColor, alignCamera, overcastStrength, fn)

设置雪效。注意：开启雪效前需先设置云层的厚度和密度，效果图：

Parameters:
Name Type Description
strength number

雪效强度（必须大于0，才会有下雪效果），取值范围:[0~1.0]
speed number

雪效速度，取值范围:[0~1.0]
snowflakeSize number

雪花大小，取值范围:[0~1.0]
snowColor Color

雪花颜色，支持四种格式，取值示例
alignCamera number

相机移动对齐，取值范围:[0~1.0]
overcastStrength number

阴天程度，取值范围:[0~1.0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setSunColor(sunColor, fn)

设置太阳颜色

Parameters:
Name Type Description
sunColor Color

太阳颜色，支持四种格式，取值示例
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setSunIntensity(sunIntensity, fn)

设置太阳光照射强度

Parameters:
Name Type Description
sunIntensity number

太阳光照射强度，取值范围:[0~40]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setSunSize(sunSize, fn)

设置太阳尺寸

Parameters:
Name Type Description
sunSize number

太阳尺寸，取值范围:[0~10]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setTemperature(temperature, fn)

设置色温值

Parameters:
Name Type Description
temperature number

色温值，单位：开尔文，简称K，取值范围:[1700~12000]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

simulateTime(startTime, endTime, duration, fn)

模拟时间播放

Parameters:
Name Type Description
startTime array | number

开始时间，类型可以是数组或数字。 如果是数组，则设置时、分：[hour, minute]；如果是数字，则设置整点：hour。
endTime array | number

结束时间，类型可以是数组或数字。 如果是数组，则设置时、分：[hour, minute]；如果是数字，则设置整点：hour。
duration number

模拟的时长，单位：秒
fn function

可选的回调函数，请参考二次开发：异步接口调用方式