环境设置插件
环境设置,是指对场景视图中环境可视化的各种属性进行配置。把其集成为一个插件,可以方便用户模拟场景在真实环境下的效果。
环境设置插件
环境设置,是指对场景视图中环境可视化的各种属性进行配置。把其集成为一个插件,可以方便用户模拟场景在真实环境下的效果。
1. 功能说明
环境设置插件集成的功能有:开启或关闭实时天气、设置天气效果和更新光照环境。
2. 构造
在SDK中实例化环境设置插件,代码示例如下:
const environmentPlugin = new ubm.EnvironmentPlugin()
3. 属性
| 属性 | 类型 | 可选 | 说明 |
|---|---|---|---|
| time | string | -- | 四季光照时间 |
| WeatherType | string | -- | 天气类型 |
3.1 四季光照时间
这是指在不同季节时间点,需要具体写出年月日,时分秒,例如:
environmentPlugin.model.time = 'December 21, 2024 18:00:00 UTC+0800'
3.2 天气类型
天气类型有以下几种:
| 值 | 说明 |
|---|---|
| sunny | 晴天 |
| cloudy | 刮风 |
| rainy | 下雨 |
| snowy | 下雪 |
| foggy | 起雾 |
4. 方法
| 方法 | 说明 |
|---|---|
| startLiveWeather() | 开启实时天气 |
| closeLiveWeather() | 关闭实时天气 |
| setWeather() | 设置天气效果 |
| updateLight() | 更新光照 |
4.1 开启实时天气
startLiveWeather(): void
开启实时天气,代码示例如下:
environmentPlugin.model.startLiveWeather()
4.2 关闭实时天气
closeLiveWeather(): void
关闭实时天气,代码示例如下:
environmentPlugin.model.closeLiveWeather()
4.3 设置天气效果
setWeather(type: string, strength: number): void
参数type是天气类型WeatherType;
参数strength是天气强度,值为0-1,0最弱,1最强,默认值是0.5。
设置下雪天气效果,代码示例如下:
environmentPlugin.model.setWeather('snowy',1)
4.4 更新光照
updateLight(time: string): void
参数time是属性四季光照时间time。
更新场景光照,代码示例如下:
environmentPlugin.model.updateLight('December 21, 2024 18:00:00 UTC+0800')

BIMFlux AI
