Skip to content
导览

Class: EnvironmentManager

Details

获取环境管理类

Example

js
const environmentManager = await cloud.getEnvironmentManager();
const environmentManager = await cloud.getEnvironmentManager();

Hierarchy

  • Callable

    EnvironmentManager

Properties

showNetworkInformation

showNetworkInformation: (show: boolean) => void

Type declaration

▸ (show): void

Details

显示网速状态(只有视频流模式生效)

Examples

js
const envManager = await cloud.getEnvironmentManager();
envManager.showNetworkInformation(true);
const envManager = await cloud.getEnvironmentManager();
envManager.showNetworkInformation(true);
Parameters
NameTypeDescription
showboolean是否显示,取值范围 true 或 false
Returns

void

Methods

setSunLightIntensity

setSunLightIntensity(SunStrength): Promise<any>

构造函数

Details

设置太阳光照强度

Examples

js
environmentManager = await cloud.getEnvironmentManager();
var num=0.5;
environmentManager.setSunLightIntensity(num);
environmentManager = await cloud.getEnvironmentManager();
var num=0.5;
environmentManager.setSunLightIntensity(num);

Parameters

NameTypeDescription
SunStrengthnumber光照强度,取值范围 [0,100]

Returns

Promise<any>


getSunLightIntensity

getSunLightIntensity(): Promise<number>

构造函数

Details

获取太阳光照强度

Examples

js
environmentManager = await cloud.getEnvironmentManager();
var num= await environmentManager.getSunLightIntensity();
environmentManager = await cloud.getEnvironmentManager();
var num= await environmentManager.getSunLightIntensity();

Returns

Promise<number>

number 返回光照强度


setSnapPoint

setSnapPoint(param): Promise<boolean>

构造函数

Details

设置捕捉点的类型

Examples

js
environmentManager = await cloud.getEnvironmentManager();
var param={
    meshVertex :true,
    modelFeaturePoints :true,
    modelCenterPoint :true,
    scaleSplitPoint :true,
    scaleSplitPointQuantity :1
     }
 var temp=await environmentManager.setSnapPoint(param);
environmentManager = await cloud.getEnvironmentManager();
var param={
    meshVertex :true,
    modelFeaturePoints :true,
    modelCenterPoint :true,
    scaleSplitPoint :true,
    scaleSplitPointQuantity :1
     }
 var temp=await environmentManager.setSnapPoint(param);

Parameters

NameTypeDescription
paramSnapPoinInfo捕捉点结构体

Returns

Promise<boolean>

bool 是否设置成功


setOutlineConfig

setOutlineConfig(config): Promise<boolean>

构造函数

Details

设置轮廓线的颜色

Examples

js
environmentManager = await cloud.getEnvironmentManager()
const config: OutlineConfig = {
   color: '0xff33ffff',
}
const temp = await environmentManager.setOutlineConfig(config)
environmentManager = await cloud.getEnvironmentManager()
const config: OutlineConfig = {
   color: '0xff33ffff',
}
const temp = await environmentManager.setOutlineConfig(config)

Parameters

NameTypeDescription
configOutlineConfig轮廓线设置

Returns

Promise<boolean>

bool 是否设置成功


setSkybox

setSkybox(type, exposureIntensity): undefined | Promise<any>

构造函数

Details

设置天空盒

Examples

js
environmentManager = await cloud.getEnvironmentManager();
var type=0;
var Intensity=1;
environmentManager.setSkybox(type,Intensity);
environmentManager = await cloud.getEnvironmentManager();
var type=0;
var Intensity=1;
environmentManager.setSkybox(type,Intensity);

Parameters

NameTypeDescription
typeSkyboxType天空盒类型
exposureIntensitynumber曝光强度[0,2]

Returns

undefined | Promise<any>


setEnvironmentLightIntensity

setEnvironmentLightIntensity(environmentLight): Promise<any>

设置环境光强度

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setEnvironmentLightIntensity(2.0);
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setEnvironmentLightIntensity(2.0);

Parameters

NameTypeDescription
environmentLightnumber环境光强度

Returns

Promise<any>


getEnvironmentLightIntensity

getEnvironmentLightIntensity(): Promise<number>

获取环境光强度

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
var intensity = environmentManager.getEnvironmentLightIntensity();
var environmentManager = await cloud.getEnvironmentManager();
var intensity = environmentManager.getEnvironmentLightIntensity();

Returns

Promise<number>


setSunDirection

setSunDirection(timeZone, year, month, day, hour, minute): Promise<any>

设置太阳光方向

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setSunDirection(8,2023,2,3,11,49);
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setSunDirection(8,2023,2,3,11,49);

Parameters

NameTypeDescription
timeZonenumber时区
yearnumber
monthnumber
daynumber
hournumber小时
minutenumber分钟

Returns

Promise<any>


setShadow

setShadow(isShow): Promise<any>

设置是否显示阴影

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setShadow(true);
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setShadow(true);

Parameters

NameTypeDescription
isShowbooleantrue为显示,false为不显示

Returns

Promise<any>


setViewCube

setViewCube(isShow): Promise<any>

设置viewCube是否显示

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setViewCube(false);
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setViewCube(false);

Parameters

NameTypeDescription
isShowbooleantrue为显示,false为隐藏

Returns

Promise<any>


showDebugInfo

showDebugInfo(isShow): Promise<any>

设置调试信息是否显示

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.showDebugInfo(true);
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.showDebugInfo(true);

Parameters

NameTypeDescription
isShowbooleantrue为显示,false为隐藏

Returns

Promise<any>


showGrid

showGrid(isShow): Promise<any>

设置网格是否显示

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.showGrid(true);
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.showGrid(true);

Parameters

NameTypeDescription
isShowbooleantrue为显示,false为隐藏

Returns

Promise<any>


setCoordStyle

setCoordStyle(style): void

设置坐标轴类型(可以在setting.json中进行配置)

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setCoordStyle("CS_ENU");
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.setCoordStyle("CS_ENU");

Parameters

NameTypeDescription
stylestringCS_ENU或者CS_XYZ

Returns

void


ScreenShot

ScreenShot(fileName?, widthPx?, hightPx?): Promise<any>

获取场景图片

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.ScreenShot();  //不传返回base64格式的数据
environmentManager.ScreenShot("D:/123.bmp");
environmentManager.ScreenShot("D:/123.png");
environmentManager.ScreenShot("D:/123.png",2560,1440);
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.ScreenShot();  //不传返回base64格式的数据
environmentManager.ScreenShot("D:/123.bmp");
environmentManager.ScreenShot("D:/123.png");
environmentManager.ScreenShot("D:/123.png",2560,1440);

Parameters

NameTypeDescription
fileName?string生成图片路径和名称,必须以.bmp或者.png结尾,不传返回base64格式的数据 widthPx,hightPx默认为云渲染像素
widthPx?number-
hightPx?number-

Returns

Promise<any>


addPointLightEffect

addPointLightEffect(lightParamList): void

批量添加点光源

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
const light : PointLight[] = [
 {
   position:{x:0,y:1,z:0},
   color:'0xffff0000',
   intensity:1,
   range:100,
 },
 {
   position:{x:0,y:1,z:0},
   color:'0xffff0000',
   intensity:2,
   range:100,
 },
];
environmentManager.addPointLightEffect(light);
var environmentManager = await cloud.getEnvironmentManager();
const light : PointLight[] = [
 {
   position:{x:0,y:1,z:0},
   color:'0xffff0000',
   intensity:1,
   range:100,
 },
 {
   position:{x:0,y:1,z:0},
   color:'0xffff0000',
   intensity:2,
   range:100,
 },
];
environmentManager.addPointLightEffect(light);

Parameters

NameTypeDescription
lightParamListPointLight[]点光源参数组

Returns

void


addPointLightEffectByUrl

addPointLightEffectByUrl(url): void

通过url批量添加点光源

Examples

typescript
//文件json格式
//{
// "lightParamList": [
//     {
//         "position": { "x": 1, "y": 1, "z": -1 },
//         "color": "0xff00ff00",
//         "intensity": 5,
//         "range": 2
//     },
//     {
//         "position": { "x": 2, "y": 1, "z": -1 },
//         "color": "0xffff00ff",
//         "intensity": 6,
//         "range": 2
//    },
//     {
//         "position": { "x": 3, "y": 1, "z": -1 },
//         "color": "0xffffff00",
//         "intensity": 7,
//         "range": 2
//     }
// ]
//}
var environmentManager = await cloud.getEnvironmentManager();
const url = 'http://172.17.20.92:8089/fileUpload/download/1674250509793210370';
environmentManager.addPointLightEffectByUrl(url);
//文件json格式
//{
// "lightParamList": [
//     {
//         "position": { "x": 1, "y": 1, "z": -1 },
//         "color": "0xff00ff00",
//         "intensity": 5,
//         "range": 2
//     },
//     {
//         "position": { "x": 2, "y": 1, "z": -1 },
//         "color": "0xffff00ff",
//         "intensity": 6,
//         "range": 2
//    },
//     {
//         "position": { "x": 3, "y": 1, "z": -1 },
//         "color": "0xffffff00",
//         "intensity": 7,
//         "range": 2
//     }
// ]
//}
var environmentManager = await cloud.getEnvironmentManager();
const url = 'http://172.17.20.92:8089/fileUpload/download/1674250509793210370';
environmentManager.addPointLightEffectByUrl(url);

Parameters

NameTypeDescription
urlstring点光源参数文件地址

Returns

void


clearPointLightEffect

clearPointLightEffect(): void

清除所有点光源

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.clearPointLightEffect();
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.clearPointLightEffect();

Returns

void


addSpotLightEffect

addSpotLightEffect(spotLightParamList): void

批量添加聚光灯

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
const light : SpotLight[] = [
 {
   position:{x:0,y:2,z:0},
   target:{x:0,y:1,z:0},
   color:'0xffff0000',
   intensity:1,
   range:100,
   penumbra:0.1,
   shadow:true,
   angle:20
 },
 {
   position:{x:1,y:2,z:0},
   target:{x:1,y:1,z:0},
   color:'0xffff0000',
   intensity:2,
   range:100,
   penumbra:0.1,
   shadow:true,
   angle:30
 },
];
environmentManager.addSpotLightEffect(light);
var environmentManager = await cloud.getEnvironmentManager();
const light : SpotLight[] = [
 {
   position:{x:0,y:2,z:0},
   target:{x:0,y:1,z:0},
   color:'0xffff0000',
   intensity:1,
   range:100,
   penumbra:0.1,
   shadow:true,
   angle:20
 },
 {
   position:{x:1,y:2,z:0},
   target:{x:1,y:1,z:0},
   color:'0xffff0000',
   intensity:2,
   range:100,
   penumbra:0.1,
   shadow:true,
   angle:30
 },
];
environmentManager.addSpotLightEffect(light);

Parameters

NameTypeDescription
spotLightParamListSpotLight[]聚光灯参数组

Returns

void


clearSpotLightEffect

clearSpotLightEffect(): void

清除所有聚光灯

Examples

typescript
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.clearSpotLightEffect();
var environmentManager = await cloud.getEnvironmentManager();
environmentManager.clearSpotLightEffect();

Returns

void