Environment

模式模块主要做环境的管理

7 个 APIpiclient.emit
environment.setTime环境-设置时间
#

设置时间

参数说明

参数类型必填默认值说明
hourstring否——
minutestring否——
percentOfDaystring否—一天的百分比,大于0时hour/minute无效
可选值:hourminute

调用

typescript
piclient.emit("environment.setTime",{
	hour:15, //小时, 0-23
	minute: 30, //分钟 0-59
	percentOfDay: 0 //一天的百分比 0-1,大于0时hour/minute无效
})
environment.setWeather环境-设置天气
#

设置天气

参数说明

参数类型必填默认值说明
weatherstring否—天气, 1-11 晴空万里/少云/多云/阴天/雾天/小雨/中雨/暴风雨/小雪/中雪/暴风雪

调用

typescript
piclient.emit("environment.setWeather",{
	weather: "2" //天气, 1-11 晴空万里/少云/多云/阴天/雾天/小雨/中雨/暴风雨/小雪/中雪/暴风雪
})
environment.timePass环境-时间流逝
#

时光流逝控制

参数说明

参数类型必填默认值说明
timeSpeedstring否—0表示不流逝

调用

typescript
piclient.emit("environment.timePass",{
	timeSpeed: "1", //0表示不流逝
})
environment.setPostProcessParam环境-设置后处理参数
#

设置后处理参数

参数说明

参数类型必填默认值说明
paramNamestring否—生效的属性名 自动曝光,最小曝光,最大曝光,全局着色
paramValuestring否——
motionBlursstring否—运动模糊
saturationstring否—饱和度
contraststring否—对比度
exposurestring否—自动曝光
minBrightnessstring否—最小曝光
maxBrightnessstring否—最大曝光
whiteBalancestring否—白平衡
vignettestring否—暗角强度
colorGainstring否—全局着色
shadowContraststring否—暗部对比度
lensFlarestring否—镜头光晕
LUTstring否—LUT
ambientOcclusionstring否—环境光遮蔽

调用

typescript
piclient.emit("environment.setPostProcessParam",{
	paramName: "", // 生效的属性名 自动曝光,最小曝光,最大曝光,全局着色
	paramValue: "",
	motionBlurs: "0.5", //运动模糊
	saturation: "1.0", //饱和度
	contrast: "1.0", //对比度
	exposure: "1.0", //自动曝光
	minBrightness: "-1.0", //最小曝光
	maxBrightness: "1.0", //最大曝光
	whiteBalance: "6500", //白平衡
	vignette: "0.4", //暗角强度
	colorGain: "1.0", //全局着色
	shadowContrast: "1.0", //暗部对比度
	lensFlare: "1.0", //镜头光晕
	LUT: "FFFFFFFF", //LUT
	ambientOcclusion: "0.5", //环境光遮蔽
})
environment.setWeatherParam环境-设置天气参数
#

设置天气参数

参数说明

参数类型必填默认值说明
Rainstring否—雨量
Snowstring否—雪量
WindDirectionstring否—风向
WindIntensitystring否—雨量
CloudCoveragestring否—云彩密度
ThunderLightningstring否—雷电强度
Fogstring否—雾强度

调用

typescript
piclient.emit("environment.setWeatherParam",{
	Rain: "0.0", //雨量
	Snow: "0.0", //雪量
	WindDirection: "0.0", //风向
	WindIntensity: "0.0", //雨量
	CloudCoverage: "0.0", //云彩密度
	ThunderLightning: "0.0", //雷电强度
	Fog: "0.0", //雾强度
})
environment.setSkyParam环境-设置天空参数
#

设置天空参数

参数说明

参数类型必填默认值说明
cloudAltitudestring否—云层高度
cloudSpeedstring否—云朵速度
cloudDirectionstring否—云朵方向
cloudShadowsstring否—云朵阴影
fogDensitystring否—雾密度
fogDistancestring否—雾范围
skyLightIntensitystring否—天光强度
sunLightIntensitystring否—日光强度
sunAnglestring否—日光角度
moonShadowstring否—月光阴影
moonLightIntensitystring否—月光强度
moonScalestring否—月亮大小
moonPhasestring否—月相
showStarstring否—显示星系
starsIntensitystring否—星光强度
starsTilingstring否—星星密度

调用

typescript
piclient.emit("environment.setSkyParam",{
	cloudAltitude: "0.6", //云层高度
	cloudSpeed: "0.07", //云朵速度
	cloudDirection: "1.0", //云朵方向
	cloudShadows: "true", //云朵阴影
	fogDensity: "0.001", //雾密度
	fogDistance: "1.0", //雾范围
	skyLightIntensity: "1", //天光强度
	sunLightIntensity: "5", //日光强度
	sunAngle: "0", //日光角度
	moonShadow: "true", //月光阴影
	moonLightIntensity: "0.12", //月光强度
	moonScale: "0.7", //月亮大小
	moonPhase: "0.0", //月相
	showStar: "false", //显示星系
	starsIntensity: "0.75", //星光强度
	starsTiling: "3", //星星密度
})
environment.setDisplayParam环境-设置显示参数
#

设置显示参数

参数说明

参数类型必填默认值说明
shadowDistancestring否—阴影距离
POICullDistancestring否—POI剔除距离