镜头控制操作

1. 设置场景镜头视界
2. 获取场景镜头视界
3. 设置场景镜头模式
4. 限制镜头视界
5. 设置镜头视界限制状态
6. 漫游镜头
7. 设置漫游镜头状态
8. 环绕旋转镜头
9. 路径移动镜头
10. 设置路径移动镜头状态
11. 模型跟随镜头
12. 设置模型跟随镜头状态
13. 聚焦图层
14. 聚焦类别图层
15. 聚焦图层子对象
16. 聚焦图例子图层
17. 聚焦模型
18. 聚焦类别模型
19. 聚焦建筑
20. 聚焦楼层
21. 聚焦房间
22. 聚焦世界地图
23. 聚焦世界国家
24. 聚焦中国地图
25. 聚焦中国省份
26. 聚焦地理信息节点
27. 聚焦到上一级地理信息节点
28. 聚焦到下一级地理信息节点
29. 聚焦地理信息节点中的地点

1. 设置场景镜头视界

功能描述

设置三维场景中镜头视界

调用方法

JavaScript

let jsonData = {
  coordType: 0,
  coordTypeZ: 0,
  centerCoord: [113.93989639458, 22.5110484727475], //以深圳湾经纬度为例
  coordZ: 500,
  distance: 1500,
  pitch: 35,
  heading: 0,
  fly: true,
  duration: 0.5,
};

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

参数描述

属性	类型	说明
coordType	Number	XY 轴坐标模式坐标类型(0:X 经度 Y 纬度；1:X 米 Y 米，相对世界 00 点) 目前该属性仅支持属性值为 0
coordTypeZ	Number	Z 轴坐标模式坐标高度类型，单位：米(0:相对 3D 世界 0 海拔；1:相对 3D 世界地表；2:相对 3D 模型表面) 目前该属性仅支持属性值为 0
centerCoord	Array	中心点的坐标 lng,lat
coordZ	Number	Z 轴高度（单位：米）
distance	Number	镜头距中心点距离(单位:米)
pitch	Number	镜头俯仰角，摄像机和观察点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89
heading	Number	镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360
fly	Boolean	true: 飞行动画(飞行时间根据当前点与目标点计算,则 pitch 及 heading 不生效, 会自行计算); false: 立刻跳转过去(有一个短暂飞行动画,并按照 distance, pitch, heading 设置镜头)
duration	Number	飞行时间，秒
fov	Number	镜头视场角，单位：度；不传时保持场景当前视场角不变

回调数据

JSON

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

回调数据参数描述

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

设置场景镜头视界流渲染效果

设置场景镜头视界端渲染效果

返回本章目录

2. 获取场景镜头视界

功能描述

获取三维场景中镜头视界

调用方法

JavaScript

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

回调数据

JSON

{
  "result": 1,
  "message": "成功。",
  "coordType": 0,
  "coordTypeZ": 0,
  "centerCoord": [
    113.92489539458,
    22.5120589227475
  ],
  "coordZ": 6000,
  "distance": 20000,
  "pitch": 73,
  "heading": 127,
  "fov": 30,
  "status": "free"
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
coordType	Number	XY 轴坐标模式坐标类型(0:X 经度 Y 纬度；1:X 米 Y 米，相对世界 00 点) 目前该属性仅支持属性值为 0
coordTypeZ	Number	Z 轴坐标模式坐标高度类型，单位：米(0:相对 3D 世界 0 海拔；1:相对 3D 世界地表；2:相对 3D 模型表面) 目前该属性仅支持属性值为 0
centerCoord	Array	XY 轴坐标，X：经度；Y：纬度
coordZ	Number	Z 轴高度（单位：米）
distance	Number	镜头与坐标点距离(单位:米)
pitch	Number	镜头俯仰角(-89~+89)
heading	Number	镜头偏航角(0 正北, 0~359)
fov	Number	当前摄像机视角
status	String	相机状态，free：自由；flying：正在飞行；orbiting：正在自动旋转；roaming：正在漫游；

返回本章目录

3. 设置场景镜头模式

功能描述

设置三维场景中镜头模式

调用方法

JavaScript

let jsonData = {
  mode: 'default',
  speed: 10,
  turnSpeed: 0.1,
  eyesHeight: 1.8,
  collision: false,
  gravity: false,
  thirdPersonType: 0,
};

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

参数描述

属性	类型	说明	端渲染	流渲染
mode	String	摄像机模式，"default": 默认交互行为，"walk", 第一人称或者第三人称行走，WSAD 移动，鼠标左键或右键按下旋转，"fly"，第一人称飞行，WSAD 移动，Q 降 E 升，鼠标左键或右键按下旋转，"topView"，顶视图	支持	支持
speed	Number	当 mode 为"walk"或者"fly“的时候，摄像机移动速度	支持	支持
turnSpeed	Number	当 mode 为"walk"的时候，鼠标按下旋转时的速度，0 为最慢，1 为最快	支持	支持
eyesHeight	Number	当 mode 为"walk"的时候，摄像机的高度	支持	支持
collision	Boolean	是否启用碰撞检测	不支持	支持
gravity	Boolean	当 mode 为"walk"的时候是否启用重力，启用后，可以按空格键跳跃	不支持	支持
thirdPersonType	Number	当 mode 为"walk"的时候，可以选择不同的第三人称模型，0：表示关闭第三人称，1：表示 1 号人物模型，2：表示 2 号人物模型	不支持	支持

返回本章目录

4. 限制镜头视界

功能描述

限制三维场景中镜头视界

调用方法

JavaScript

let jsonData = {
  coordType: 0,
  coordTypeZ: 0,
  limitPitch: [5, 30],
  limitYaw: [30, 300],
  limitDistance: [160, 1000],
  limitCoordZ: [10, 300], // 端渲染暂不支持此属性
  center: [113.319824, 23.107891], // 端渲染暂不支持此属性
  radius: 1000, // 端渲染暂不支持此属性
};
appInstance.uniCall('restrictCamera', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明	端渲染	流渲染
coordType	Number	XY 轴坐标模式坐标类型(0:X 经度 Y 纬度；1:X 米 Y 米，相对世界 00 点) 目前该属性仅支持属性值为 0	支持	支持
coordTypeZ	Number	Z 轴坐标模式坐标高度类型，单位：米(0:相对 3D 世界 0 海拔；1:相对 3D 世界地表；2:相对 3D 模型表面) 目前该属性仅支持属性值为 0	支持	支持
limitPitch	Array	镜头俯仰角限制，摄像机和观察点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89	支持	支持
limitYaw	Array	镜头偏航角限制，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360	支持	支持
limitDistance	Array	摄像机镜头距离限制 (单位:米)	支持	支持
limitCoordZ	Array	摄像机坐标高度限制 (单位:米)。	不支持	支持
center	Array	视点限制区中心坐标。	不支持	支持
radius	Number	视点限制区半径，会形成一个球体，并在所有条件中取交集。	不支持	支持

回调数据

JSON

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

回调数据参数描述

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

限制镜头视界流渲染效果

限制镜头视界端渲染效果

返回本章目录

5. 设置镜头视界限制状态

功能描述

设置三维场景中镜头视界限制状态

调用方法

JavaScript

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

参数描述

属性	类型	说明
state	String	restricted：受限；free：不受限制

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

6. 漫游镜头

功能描述

调整镜头到指定视野

调用方法

JavaScript

let jsonData = {
  coordType: 0,
  coordTypeZ: 0,
  loopMode: 'none',
  points: [
    {
      coord: [114.0091198976084, 22.54002276469996], //以深圳湾经纬度为例
      coordZ: 100,
      distance: 1000,
      pitch: 30,
      yaw: 20,
      speed: 600,
    },
    {
      coord: [113.94033481501867, 22.552220518959626],
      coordZ: 100,
      distance: 1000,
      pitch: 30,
      yaw: 20,
      speed: 600,
    },
    {
      coord: [113.93203721147756, 22.514991783112677],
      coordZ: 100,
      distance: 1000,
      pitch: 30,
      yaw: 20,
      speed: 600,
    },
    {
      coord: [113.91325238327491, 22.47417072925387],
      coordZ: 100,
      distance: 1000,
      pitch: 30,
      yaw: 20,
      speed: 600,
    },
    {
      coord: [113.89786284605646, 22.48010945895795],
      coordZ: 100,
      distance: 1000,
      pitch: 30,
      yaw: 20,
      speed: 600,
    },
  ],
};
appInstance.uniCall('roamingCamera', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
coordType	Number	XY 轴坐标模式坐标类型(0:X 经度 Y 纬度；1:X 米 Y 米，相对世界 00 点) 目前该属性仅支持属性值为 0
coordTypeZ	Number	Z 轴坐标模式坐标高度类型，单位：米(0:相对 3D 世界 0 海拔；1:相对 3D 世界地表；2:相对 3D 模型表面) 目前该属性仅支持属性值为 0
loopMode	String	循环模式，none：不循环；round：往返循环；repeat：从头循环
points	Array	相机漫游数据集合
points[0].coord	Array	XY 轴坐标，X：经度；Y：纬度
points[0].coordZ	Number	Z 轴高度（单位：米）
points[0].distance	Number	镜头与坐标点距离(单位:米)
points[0].pitch	Number	镜头俯仰角，摄像机和观察点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89
points[0].yaw	Number	镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360
points[0].speed	Number	镜头速度 (单位:米/秒)
points[].coord	Array	XY 轴坐标，X：经度；Y：纬度
points[].coordZ	Number	Z 轴高度（单位：米）
points[].distance	Number	镜头与坐标点距离(单位:米)
points[].pitch	Number	镜头俯仰角，摄像机和观察点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89
points[].yaw	Number	镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360
points[].speed	Number	镜头速度 (单位:米/秒)

回调数据

JSON

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

回调数据参数描述

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

漫游镜头流渲染效果

漫游镜头端渲染效果

返回本章目录

7. 设置漫游镜头状态

功能描述

设置漫游镜头状态

调用方法

JavaScript

appInstance.uniCall('setCameraRoamingState', { state: 'stop' }, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
state	String	pause:暂停移动; continue:继续移动; stop:停止移动, 释放焦点

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

8. 环绕旋转镜头

功能描述

环绕旋转镜头视野

调用方法

JavaScript

let jsonData = {
  enabled: true,
  duration: 60,
  direction: 'clockwise',
  interruptable: true,
};

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

参数描述

属性	类型	说明
enabled	Boolean	是否启用相机围绕目标飞行
duration	Number	飞行一周所需要的秒数，数值越大飞行越慢
direction	String	飞行方向，clockwise 为顺时针，counterclockwise 为逆时针
interruptable	Boolean	是否可以被打断，默认为 true
rotateAxis	String	相机环绕时的旋转轴。auto 为按当前距离自动切换（即在地表绕视点旋转，在太空绕地轴旋转）；earthAxis 为固定绕地轴旋转，viewpoint 为固定绕视点旋转；默认值为 auto，即不传参数时按当前距离自动切换

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

9. 路径移动镜头

功能描述

镜头跟随路径移动

调用方法

JavaScript

let jsonData = {
  pathId: 'pathId',
  loopMode: 'round',
  reverse: false,
  distance: 300,
  pitch: 35,
  speed: 2,
};
appInstance.uniCall('pathingCamera', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
pathId	String	路径 ID (唯一标识)
loopMode	String	循环模式：none，不循环；round，往返；repeat，从头循环
reverse	Boolean	是否反向移动
distance	Number	镜头距离覆盖物距离(单位:米)
pitch	Number	镜头俯仰角，摄像机和观察点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89
speed	Number	镜头速度 (单位:米/秒)

回调数据

JSON

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

回调数据参数描述

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

路径移动镜头流渲染效果

路径移动镜头端渲染效果

返回本章目录

10. 设置路径移动镜头状态

功能描述

设置镜头跟随路径移动的状态

调用方法

JavaScript

appInstance.uniCall('setCameraPathingState', { state: 'stop' }, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
state	String	pause:暂停移动; continue:继续移动; stop:停止移动, 释放焦点

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

11. 模型跟随镜头

功能描述

模型跟随镜头

调用方法

JavaScript

let jsonData = {
  modelId: 'modelId',
  distance: 1000,
  distanceMin: 10,
  distanceMax: 20000,
  pitch: 30,
  heading: 0,
  focusType: 'auto',
  viewPoint: 'center',
  pointOffset: [0, 0, 2],
  relative: 'self',
};

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

参数描述

属性	类型	说明
modelId	String	镜头跟踪的模型 Id，镜头和模型之前保持相对静止关系，支持运动的模型
distance	Number	镜头与被跟踪物体的距离(单位:米)
distanceMin	Number	镜头与被跟踪物体的最近距离(单位:米)
distanceMax	Number	镜头与被跟踪物体的最远距离(单位:米)
pitch	Number	镜头俯仰角，摄像机和观察点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89
heading	Number	镜头偏航角，摄像机在模型前进方向正南为 0 度，摄像机绕被观察模型顺时针旋转为正，单位：度，值域范围：-360~360
focusType	String	聚焦模式，"auto": 根据模型大小，自动计算 distance，"custom": 使用用户传入的 distance，默认:"auto"
viewPoint	String	视点位置，"pivot"：轴点；"center"，对象中心。默认值："center"
pointOffset	Array	视点的位置偏移，默认值是[0, 0, 0]，表示相对于对象中心或者轴点的相对自身坐标系的 x、y、z 偏移位置（单位：米）
relative	String	视角的相对位置，"self"，视角相对模型固定，"world"，视角相对世界固定。鼠标可以支持环绕模型旋转和缩放。如果在 self 模式下，鼠标旋转了，会自动变为 world 模式，直到用户重新调用 followingCamera 设置为 self 模式。

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

12. 设置模型跟随镜头状态

功能描述

设置模型跟随镜头状态

调用方法

JavaScript

let jsonData = {
  state: 'stop',
};

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

参数描述

属性	类型	说明
state	String	pause:暂停跟随; continue:继续跟随; stop:停止跟随, 释放焦点

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

13. 聚焦图层

功能描述

聚焦图层

调用方法

JavaScript

let jsonData = {
  id: 'layerId',
  overlayType: 'landmark',
  pitch: 30,
  heading: 0,
  ratio: 1,
  pointOffset: [0, 0, 2],
  distance: 100,
};
appInstance.uniCall('focusById', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明	端渲染	流渲染
id	String	图层 ID （唯一标识）	支持	支持
overlayType	String	图层类别 overlayType，详见内置枚举	支持	不支持 3DTile 和 gisMap
pitch	Number	聚焦后镜头俯仰角，摄像机和聚焦点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89，如果无则是默认角度	支持	支持
heading	Number	聚焦后镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360	支持	支持
ratio	Number	聚焦镜头中所有元素占屏幕比例的系数，默认值为 1，值域范围 0-2，小于 1 为对象占屏幕的比例小，大于 1 为比例大，设置 distance 后 ratio 参数不生效	支持	支持
pointOffset	Array	视点的位置偏移，默认值是[0, 0, 0]，表示相对自身坐标系的 x、y、z 偏移位置（单位：米）	支持	支持
distance	Number	聚焦后摄像机的默认镜头距对象距离(单位:米)，如果无则根据对象大小自动计算	支持	支持

回调数据

JSON

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

回调数据参数描述

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

聚焦图层流渲染效果

聚焦图层端渲染效果

返回本章目录

14. 聚焦类别图层

功能描述

聚焦类别图层

调用方法

JavaScript

appInstance.uniCall(
  'focusByType',
  {
    overlayType: 'landmark',
    ratio: 1,
  },
  (result) => {
    console.log(result);
  }
);

参数描述

属性	类型	说明	端渲染	流渲染
overlayType	String	图层类别 overlayType，详见内置枚举	不支持 3DTile	不支持 3DTile 和 gisMap
ratio	Number	聚焦镜头中所有元素占屏幕比例的系数，默认值为 1，值域范围 0-2，小于 1 为对象占屏幕的比例小，大于 1 为比例大	支持	支持

回调数据

JSON

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

回调数据参数描述

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

聚焦类别图层流渲染效果

聚焦类别图层端渲染效果

返回本章目录

15. 聚焦图层子对象

功能描述

聚焦图层子对象

调用方法

JavaScript

let jsonData = {
  id: 'overlayId',
  idLayer: 'layerId',
  layerType: 'landmarkLayer',
  pitch: 30,
  heading: 0,
  distance: 100,
  relative: 'world',
};
appInstance.uniCall('focusByLayer', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
id	String	图层中子对象 id
idLayer	String	图层（唯一标识）ID
layerType	String	含子对象图层类别 objLayerType，详见内置枚举
pitch	Number	聚焦后镜头俯仰角，摄像机和聚焦点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89，如果无则是默认角度
heading	Number	聚焦后镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360
distance	Number	聚焦后摄像机的默认镜头距对象距离(单位:米)，如果无则根据对象大小自动计算
relative	String	摄像机视角的相对位置，"self"，视角相对模型正方向为 0 度，"world"，视角相对世界正南为 0 度

回调数据

JSON

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

回调数据参数描述

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

聚焦图层子图层流渲染效果

聚焦图层子图层端渲染效果

返回本章目录

16. 聚焦图例子图层

功能描述

聚焦图例子图层

调用方法

JavaScript

let jsonData = {
  legend: 'legendName',
  idLayer: 'layerId',
  layerType: 'landmarkLayer',
};
appInstance.uniCall('focusByLegend', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
legend	String	图例名称
idLayer	String	图层（唯一标识）ID
layerType	String	含图例图层类别 lengendLayerType，详见内置枚举

回调数据

JSON

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

回调数据参数描述

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

聚焦图例子图层流渲染效果

聚焦图例子图层端渲染效果

返回本章目录

17. 聚焦模型

功能描述

聚焦模型

调用方法

JavaScript

let jsonData = {
  id: 'modelId',
  layerId: 'layerId',
  modelType: 'model',
  pitch: 30,
  heading: 0,
  distance: 100,
  focusType: 'auto',
  viewPoint: 'center',
  pointOffset: [0, 0, 2],
  relative: 'world',
};
appInstance.uniCall('focusModel', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明	端渲染	流渲染
id	String	模型 ID	支持	支持
layerId	String	模型所属的图层 Id，Id 可以通过 getModelsByType 接口获得。	支持	不支持
modelType	String	model（模型），building（建筑物），connection（关系线），iconModel（模型型号），graphic（图形），analysis（分析）	不支持 graphic 和 analysis	支持
pitch	Number	聚焦后镜头俯仰角，摄像机和聚焦点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89，如果无则是默认角度	支持	支持
heading	Number	聚焦后镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360	支持	支持
distance	Number	聚焦后摄像机的默认镜头距对象距离(单位:米)，如果无则根据对象大小自动计算	支持	支持
focusType	String	聚焦模式，"auto": 根据模型大小，自动计算 distance，"custom": 使用用户传入的 distance，默认:"auto"	支持	支持
viewPoint	String	视点位置，"pivot"：轴点；"center"，对象中心。默认值："center"	支持	支持
pointOffset	Array	视点的位置偏移，默认值是[0, 0, 0]，表示相对于对象中心或者轴点的相对自身坐标系的 x、y、z 偏移位置（单位：米）	支持	支持
relative	String	摄像机视角的相对位置，"self"，视角相对模型正方向为 0 度，"world"，视角相对世界正南为 0 度	支持	支持

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

18. 聚焦类别模型

功能描述

聚焦类别模型

调用方法

JavaScript

appInstance.uniCall('focusModelByType', { modelType: 'model' }, (result) => {
  console.log(result);
});

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

19. 聚焦建筑

功能描述

聚焦建筑

调用方法

JavaScript

let jsonData = {
  buildingId: 'building0001',
  pitch: 30,
  heading: 0,
  distance: 100,
};
appInstance.uniCall('focusBuilding', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
buildingId	String	建筑物 ID
pitch	Number	聚焦后镜头俯仰角，摄像机和聚焦点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89，如果无则是默认角度
heading	Number	聚焦后镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360
distance	Number	聚焦后摄像机的默认镜头距对象距离(单位:米)，如果无则根据对象大小自动计算

回调数据

JSON

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

回调数据参数描述

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

聚焦建筑流渲染效果

聚焦建筑端渲染效果

返回本章目录

20. 聚焦楼层

功能描述

聚焦楼层

调用方法

JavaScript

let jsonData = {
  buildingId: 'building0001',
  floor: 3,
  pitch: 30,
  heading: 0,
  distance: 100,
};
appInstance.uniCall('focusFloor', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
buildingId	String	建筑物 ID
floor	Number	楼层
pitch	Number	聚焦后镜头俯仰角，摄像机和聚焦点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89，如果无则是默认角度
heading	Number	聚焦后镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360
distance	Number	聚焦后摄像机的默认镜头距对象距离(单位:米)，如果无则根据对象大小自动计算

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

21. 聚焦房间

功能描述

聚焦房间

调用方法

JavaScript

let jsonData = {
  buildingId: 'building0001',
  floor: 3,
  room: 'room0001',
  pitch: 30,
  heading: 0,
  distance: 100,
};
appInstance.uniCall('focusRoom', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
buildingId	String	建筑物 ID
floor	Number	楼层
room	String	房间
pitch	Number	聚焦后镜头俯仰角，摄像机和聚焦点同一水平面为 0 度，摄像机高于观察点为正方向，单位：度，值域范围：-89~89，如果无则是默认角度
heading	Number	聚焦后镜头偏航角，摄像机在观察点正南为 0 度，摄像机绕观察点顺时针旋转为正，单位：度，值域范围：-360~360
distance	Number	聚焦后摄像机的默认镜头距对象距离(单位:米)，如果无则根据对象大小自动计算

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

22. 聚焦世界地图流

功能描述

聚焦世界地图

调用方法

JavaScript

let jsonData = {
  style: 'global01',
};

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

参数描述

属性	类型	说明
style	String	聚焦到全球视角，需要在可执行程序目录下有相应的资源

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

23. 聚焦世界国家流

功能描述

聚焦世界国家

调用方法

JavaScript

let jsonData = {
  country: 'name',
  distance: 5000,
};

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

参数描述

属性	类型	说明
country	String	国家名称，中文或者英文
distance	Number	单位，米

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

24. 聚焦中国地图流

功能描述

聚焦中国地图

调用方法

JavaScript

let jsonData = {
  style: 'global01',
};

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

参数描述

属性	类型	说明
style	String	聚焦到中国视角，需要在可执行程序目录下有相应的资源

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

25. 聚焦中国省份流

功能描述

聚焦中国省份

调用方法

JavaScript

let jsonData = {
  province: 'name',
  distance: 5000,
};

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

参数描述

属性	类型	说明
country	String	中国省名称，中文
distance	Number	单位，米
province	String	中国省名称（中文）

回调数据

JSON

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

回调数据参数描述

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

返回本章目录

26. 聚焦地理信息节点

功能描述

按地理层级或节点名称聚焦到地理信息节点。

调用方法

JavaScript

let jsonData = {
  name: '中国',
};
appInstance.uniCall('focusGeoLevel', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
geoLevel	Number	地理层级数值，取值 1–10（1 为全球级，10 为房间级）
name	String	节点名称，按 administrativeName 精确匹配，同层多节点时用于消歧

回调数据

JSON

{
  "result": 1,
  "message": "成功。",
  "data": {
    "poiId": "china",
    "targetType": "state",
    "action": "switchState"
  }
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
data	Object	命中信息，含 node 地理层级节点、poiId、targetType、action 底层 API 名称

geoLevel 与 name 至少提供一个，两者都传时以 name 精确定位为准。

5.0 端渲染不支持，计划于后续版本添加支持。

返回本章目录

27. 聚焦到上一级地理信息节点

功能描述

从当前地理层级节点向上卷一级并聚焦。

调用方法

JavaScript

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

回调数据

JSON

{
  "result": 1,
  "message": "成功。",
  "data": {
    "poiId": "china",
    "targetType": "state",
    "action": "switchState"
  }
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
data	Object	命中信息，含 node 地理层级节点、poiId、targetType、action 底层 API 名称

已处于最高可聚焦层级（全球级）时继续上卷，引擎返回 result 为 0 并给出层级边界说明，属预期回应而非缺陷。

5.0 端渲染不支持，计划于后续版本添加支持。

返回本章目录

28. 聚焦到下一级地理信息节点

功能描述

从当前地理层级节点向下钻一级并聚焦。

调用方法

JavaScript

let jsonData = {
  name: '北京市',
};
appInstance.uniCall('focusLowerGeoLevel', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
name	String	下级节点名称，按 administrativeName 精确匹配；不传时下钻到第一个子节点

回调数据

JSON

{
  "result": 1,
  "message": "成功。",
  "data": {
    "poiId": "china_province_11",
    "targetType": "state",
    "action": "switchState"
  }
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
data	Object	命中信息，含 node 地理层级节点、poiId、targetType、action 底层 API 名称

5.0 端渲染不支持，计划于后续版本添加支持。

返回本章目录

29. 聚焦地理信息节点中的地点

功能描述

按 POI 标识聚焦到地理信息节点中的地点类目标（状态、位置、建筑、楼层、房间）。

调用方法

JavaScript

let jsonData = {
  id: 'poi-entrance',
};
appInstance.uniCall('focusPlace', jsonData, (result) => {
  console.log(result);
});

参数描述

属性	类型	说明
id	String	POI 唯一标识符，取自 getSceneGraph 返回的节点 id；不能为空

回调数据

JSON

{
  "result": 1,
  "message": "成功。",
  "data": {
    "poiId": "poi-entrance",
    "targetType": "room",
    "action": "focusRoom"
  }
}

回调数据参数描述

属性	类型	说明
result	Number	1：代表成功；0：代表失败
message	String	成功或者失败原因
data	Object	命中信息，含 node 地理层级节点、poiId、targetType、action 底层 API 名称

model 与 icon 类目标不属于“地点”范畴，请改用 focusModel、focusById 等既有聚焦指令。

5.0 端渲染不支持，计划于后续版本添加支持。

返回本章目录

镜头控制操作 ​

目录 ​

1. 设置场景镜头视界 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

设置场景镜头视界流渲染效果 ​

设置场景镜头视界端渲染效果 ​

2. 获取场景镜头视界 ​

功能描述 ​

调用方法 ​

回调数据 ​

回调数据参数描述 ​

3. 设置场景镜头模式 ​

功能描述 ​

调用方法 ​

参数描述 ​

4. 限制镜头视界 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

限制镜头视界流渲染效果 ​

限制镜头视界端渲染效果 ​

5. 设置镜头视界限制状态 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

6. 漫游镜头 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

漫游镜头流渲染效果 ​

漫游镜头端渲染效果 ​

7. 设置漫游镜头状态 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

8. 环绕旋转镜头 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

9. 路径移动镜头 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

路径移动镜头流渲染效果 ​

路径移动镜头端渲染效果 ​

10. 设置路径移动镜头状态 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

11. 模型跟随镜头 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

12. 设置模型跟随镜头状态 ​

功能描述 ​

调用方法 ​

参数描述 ​

回调数据 ​

回调数据参数描述 ​

13. 聚焦图层 ​

镜头控制操作

目录

1. 设置场景镜头视界

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

设置场景镜头视界流渲染效果

设置场景镜头视界端渲染效果

2. 获取场景镜头视界

功能描述

调用方法

回调数据

回调数据参数描述

3. 设置场景镜头模式

功能描述

调用方法

参数描述

4. 限制镜头视界

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

限制镜头视界流渲染效果

限制镜头视界端渲染效果

5. 设置镜头视界限制状态

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

6. 漫游镜头

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

漫游镜头流渲染效果

漫游镜头端渲染效果

7. 设置漫游镜头状态

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

8. 环绕旋转镜头

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

9. 路径移动镜头

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

路径移动镜头流渲染效果

路径移动镜头端渲染效果

10. 设置路径移动镜头状态

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

11. 模型跟随镜头

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

12. 设置模型跟随镜头状态

功能描述

调用方法

参数描述

回调数据

回调数据参数描述

13. 聚焦图层