其他控制操作

目录

• 1. 设置环境天气
• 2. 设置环境光照
• 3. 获取环境参数
• 4. 设置基准位置
• 5. 获取当前基准位置
• 6. 恢复默认基准位置
• 7. 获取默认基准位置
• 8. 设置指南针
• 9. 增加水印
• 10. 删除水印
• 11. 设置分辨率
• 12. 设置日志模式
• 13. 设置对象交互轴
• 14. 设置消批计时状态
• 15. 获取场景坐标

1. 设置环境天气

引入版本：3.0 起支持

环境天气

功能描述

设置环境天气

调用方法

let jsonData = {
  envWeather: 'Sunny',
};

appInstance.uniCall('setEnvWeather', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明	端渲染	流渲染
envWeather	String	天气类型（具体类型参考下图 envWeather 枚举值）	只支持 sunny，snow，Rain	支持

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

envWeather 枚举值

• Sunny
• Cloudy
• PartlyCloudy
• Overcast
• LightRain
• ModerateRain
• HeavyRain
• LightSnow
• ModerateSnow
• HeavySnow
• Foggy
• Dust
• Haze

返回本章目录

2. 设置环境光照

引入版本：3.0 起支持

环境光照

功能描述

设置环境光照

调用方法

let jsonData = {
  envTime: '15:45',
  envDate: '2024/1/31',
  envTimeZone: 'UTC+8',
  fixedTime: false,
  alwayForward: false,
  duration: 5,
};

appInstance.uniCall('setEnvTime', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明	端渲染	流渲染
envTime	String	设置时间，结合 envDate 属性和 setBaseCenter 接口，可以显示正确的日照角度	支持	支持
envDate	String	设置日期，结合 envTime 属性和 setBaseCenter 接口，可以显示正确的日照角度	不支持	支持
envTimeZone	String	设置时区，默认值：UTC+8，可取值：UTC、UTC+1 至 UTC+12、UTC-1 至 UTC-12	不支持	支持
fixedTime	Boolean	时间是否固定，false：默认值，会从用户设置的时间，一秒一秒往后走，若走到晚上，则场景会变成黑夜效果，true：场景中的时间一直是用户设置的时间	不支持	支持
alwayForward	String	时间是否总是向前，false：如果新时间小于当前时间，时间会倒回去，true：如果新时间小于当前时间，会经历 23:59 分再到新时间	支持	支持
duration	Number	切换时间，秒	支持	支持

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

envTime 枚举值

• 12:00
• 14:00
• 22:00

返回本章目录

3. 获取环境参数 流

引入版本：3.6.2 起支持

功能描述

获取环境参数

调用方法

appInstance.uniCall('getEnv', {}, (result) => {
  console.log(result);
});

回调数据

{
  "result": 1,
  "message": "成功。",
  "envTime": "15:45",
  "envDate": "2024/1/31",
  "envTimeZone": "UTC+8",
  "fixedTime": false,
  "envWeather": "Sunny",
  "envSeason": "Spring"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
envTime	String	获取当前场景时间
envDate	String	获取当前场景日期
envTimeZone	String	获取当前时区日期
fixedTime	Bool	获取当前场景时间是否固定
envWeather	String	获取当前场景天气
envSeason	String	获取当前场景时间季节

返回本章目录

4. 设置基准位置

引入版本：3.0 起支持

功能描述

设置基准位置

调用方法

let jsonData = {
  originLon: 116.463367050494,
  originLat: 22.014588965130102,
  originHeight: 0,
};
appInstance.uniCall('setBaseCenter', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
originLon	Number	中心点经度
originLat	Number	中心点维度
originHeight	Number	单位 m

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

5. 获取当前基准位置

引入版本：3.1 起支持

功能描述

获取当前基准位置

调用方法

appInstance.uniCall('getBaseCenter', {}, (result) => {
  console.log(result);
});

回调数据

{
  "result": 1,
  "message": "成功。",
  "originLon": 116.463367050494,
  "originLat": 22.014588965130102,
  "originHeight": 0
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
originLon	Number	中心点经度
originLat	Number	中心点维度
originHeight	Number	单位 m

返回本章目录

6. 恢复默认基准位置

引入版本：3.1 起支持

功能描述

恢复默认基准位置

调用方法

appInstance.uniCall('resetDefaultBaseCenter', {}, (result) => {
  console.log(result);
});

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

7. 获取默认基准位置

引入版本：3.1 起支持

功能描述

获取默认基准位置

调用方法

appInstance.uniCall('getDefaultBaseCenter', {}, (result) => {
  console.log(result);
});

回调数据

{
  "result": 1,
  "message": "成功。",
  "originLon": 116.463367050494,
  "originLat": 22.014588965130102,
  "originHeight": 0
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
originLon	Number	中心点经度
originLat	Number	中心点维度
originHeight	Number	单位 m

返回本章目录

8. 设置指南针

引入版本：3.2 起支持

功能描述

设置指南针

调用方法

let jsonData = {
  dockHorizontal: 'left',
  dockVertical: 'top',
  offset: [250, 100],
  size: 50,
  visible: true,
};
appInstance.uniCall('setCompass', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
dockHorizontal	String	水平对齐方式 left, center, right
dockVertical	String	垂直对齐方式 top, middle, bottom
offset	Array	以指南针原本位置的左上角为基准，向右下偏移的像素量，本例中是向右偏移 250 像素，向下偏移 100 像素
size	Number	大小，以像素为单位
visible	Boolean	显隐控制，true：显示；false：隐藏

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

9. 增加水印

引入版本：3.2 起支持

功能描述

增加水印

调用方法

let jsonData = {
  watermarkId: 'id',
  url: 'http://www.tuguan.net/logo.png',
  dockHorizontal: 'left',
  dockVertical: 'top',
  offset: [250, 100],
  scale: 0.5,
  alpha: 0.5,
};
appInstance.uniCall('addWatermark', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
watermarkId	String	水印 id
url	String	水印图片
dockHorizontal	String	水平对齐方式 left, center, right
dockVertical	String	垂直对齐方式 top, middle, bottom
offset	Array	以水印原本位置的左上角为基准，向右下偏移的像素量，本例中是向右偏移 250 像素，向下偏移 100 像素
scale	Number	缩放系数 0.01 ~ 10 倍
alpha	Number	透明度 0 ~ 1

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

10. 删除水印

引入版本：3.2 起支持

功能描述

删除水印

调用方法

let jsonData = {
  watermarkId: 'id',
};
appInstance.uniCall('removeWatermark', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
watermarkId	String	水印 id

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

11. 设置分辨率

引入版本：3.1 起支持

功能描述

设置分辨率

调用方法

let jsonData = {
  width: 1920,
  height: 1080,
  qp: 33,
  fpsMax: 30,
};
appInstance.uniCall('setResolution', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明	端渲染	流渲染
width	Number	分辨率的宽，不能超过 4096，对端渲染而言是 实际渲染分辨率	支持	支持
height	Number	分辨率的高，不能超过 2160，对端渲染而言是 实际渲染分辨率	支持	支持
qp	Number	视频质量参数，范围：10 至 40，值越小画质越清晰，常用数值范围 22-30。只会修改当前会话的参数，设置后即时生效。	不支持	支持
fpsMax	Number	最大帧率 20，60	支持	支持

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

12. 设置日志模式

引入版本：3.2 起支持

功能描述

设置日志模式

调用方法

let jsonData = {
  mode: true,
};
appInstance.uniCall('setLogMode', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
mode	Boolean	true 开启，false 关闭

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

13. 设置对象交互轴

引入版本：3.3 起支持

功能描述

设置对象交互轴

调用方法

let jsonData = {
  overlayType: 'landmark',
  idLayer: 'landmarkId',
  id: 'landmarkId',
  ids: ['Car03', 'Car01'],
  relative: 'self',
  axisType: 'transform',
  directionType: ['all'],
  unit: 1,
};
appInstance.uniCall('showObjectAxis', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明	端渲染	流渲染
overlayType	String	目前支持的 overlayType 是：landmark，path，area，circularArea，model，3DMarker，modelTrailLayer，modelLandmarkLayer，iconModelTrailLayer，iconModelLandmarkLayer，landmarkLayer	不支持 3DMarker landmarkLayer	支持
idLayer	String	如果是 landmark，path，area，circularArea，3DMarker（只支持流），modelTrailLayer，modelLandmarkLayer，iconModelTrailLayer，iconModelLandmarkLayer，landmarkLayer 类型的 overlayType，需要图层 Id，如果是 model 的 overlayType，可以为空	不支持 3DMarker landmarkLayer	支持
id	String	如果是 landmark，path，area，modelTrailLayer，modelLandmarkLayer，iconModelTrailLayer，iconModelLandmarkLayer，landmarkLayer 类型的 overlayType，是图层子对象 id，如果是 model 类型的 overlayType，就是模型 id	不支持 landmarkLayer	支持
ids	Array	如果希望有多个相同类型的对象显示交互轴，通过数组传入全部 ID，这些 ID 会和单独 id 属性合并成处理	支持	支持
relative	String	当轴类型是旋转，并且多选模型状态时，旋转的主轴是那里。self：每个模型沿自己的轴旋转；group：全部模型按照全部选中模型组的中心旋转	支持	支持
axisType	String	显示交互轴的类型，none：不显示，scale：缩放轴，transform：平移轴，rotation：旋转轴	支持	支持
directionType	Array	显示轴的方向，“all”，全显示，“x"，“y”，“z”，缩放轴、平移轴、旋转轴都有，"xy"，“yz”，“zy”，沿面平移和沿面缩放，可以多选组合。如果不写默认是“all”	支持	支持
unit	Number	交互轴交互时的最小单位，如果是平移，单位是米，如果是缩放，单位是倍率，如果是旋转，单位是度	支持	支持

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

14. 设置消批计时状态 流

引入版本：4.0 起支持

功能描述

设置消批计时状态

调用方法

let jsonData = {
  state: 'play',
};
appInstance.uniCall('setObjCountdown', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
state	String	带有自动消批属性的图层的倒计时状态，包括：TrailLayer、ModelTrailLayer、IconModelTrailLayer，如果没有新的数据更新，倒计时时间是否计数。"play": 倒计时，"pause": 暂停倒计时，"reset": 倒计时重新开始

回调数据

{
  "result": 1,
  "message": "成功。"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因

返回本章目录

15. 获取场景坐标

引入版本：3.3.3 起支持

功能描述

获取场景坐标

调用方法

let jsonData = {
  x: 10,
  y: 20,
};

appInstance.uniCall('pickScreen', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
x	Number	屏幕 x 轴 坐标
y	Number	屏幕 y 轴 坐标

回调数据

{
  "result": 1,
  "message": "成功。",
  "data": [
    {
      "coordType": 0, // 坐标类别，0：X 经度，Y 纬度；
      "coord": [113.320381, 23.108027],
      "coordZ": 100 // 高度米
    },
    {
      "coordType": 1, // 坐标类别 , 1：X 米，Y米，相对世界00点
      "coord": [200, 300],
      "coordZ": 100 // 高度米
    }
  ]
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
data[0].coordType	Number	坐标类别，0：X 经度，Y 纬度,1：X 米，Y 米，相对世界 00 点
data[0].coord	Array	轴坐标，X：经度；Y：纬度
data[0].coordZ	Number	高度(米)

返回本章目录