camera

凡拓数创数字孪生 2025年6月4日 14:37

收藏文档

## functions
setCameraState(jsonData, callback)
设置场景镜头视界
getCameraState(jsonData, callback)
获取场景镜头视界
restrictCamera(jsonData, callback)
限制镜头视界
setCameraRestrictionState(jsonData, callback)
设置镜头视界限制状态
roamingCamera(jsonData, callback)
漫游镜头
setCameraRoamingState(jsonData, callback)
设置漫游镜头状态
setCameraLookAt(jsonData, callback)
设置镜头跳转
pathingCamera(jsonData, callback)
路径移动相机
setPathingCameraState(jsonData, callback)
设置路径移动相机状态
setFirstPersonCameraControl(jsonData, callback)
设置第一人称漫游模式
setFirstPersonCameraControlState(jsonData, callback)
设置第一人称漫游模式状态
followingCamera(jsonData, callback)
镜头跟随模型
setCameraFollowingState(jsonData, callback)
设置镜头跟随模型状态
autoRotate(jsonData, callback)
自动旋转
## 设置场景镜头视界
setCameraState(jsonData, callback)
Kind: global function
| Param                         | Type     | Description |
|-------------------------------|----------|-------------|
| jsonData                      | Object   | 参数          |
| jsonData.distanceMin          | Number   | 最小滚动距离      |
| jsonData.distanceMax          | Number   | 最大滚动距离      |
| jsonData.viewDistanceMin      | Number   | 最小可视距离      |
| jsonData.viewDistanceMax      | Number   | 最大可视距离      |
| jsonData.inclinationAngleMin  | Number   | 最小俯仰角（角度）   |
| jsonData.inclinationAngleMax  | Number   | 最大俯仰角（角度）   |
| jsonData.rotationAngleLimited | Boolean  | 旋转角限制开关     |
| jsonData.rotationAngleMin     | Number   | 最小旋转角（角度）   |
| jsonData.rotationAngleMax     | Number   | 最大旋转角（角度）   |
| jsonData.positionMin          | Array    | 相机包围盒最小边界限制 |
| jsonData.positionMax          | Array    | 相机包围盒最大边界限制 |
| callback                      | function | 回调函数        |
## 获取场景镜头视界
getCameraState(jsonData, callback)
Kind: global function
| Param    | Type     | Description |
|----------|----------|-------------|
| jsonData | Object   | 参数          |
| callback | function | 回调函数        |
## 限制镜头视界
restrictCamera(jsonData, callback)
Kind: global function

| Param                     | Type     | Description |
|---------------------------|----------|-------------|
| jsonData                  | Object   | 参数          |
| jsonData.rotationAngleMin | Number   | 最小旋转角（角度）   |
| jsonData.rotationAngleMax | Number   | 最大旋转角（角度）   |
| callback                  | function | 回调函数        |
## 设置镜头视界限制状态
setCameraRestrictionState(jsonData, callback)
Kind: global function

| Param          | Type     | Description |
|----------------|----------|-------------|
| jsonData       | Object   | 参数          |
| jsonData.state | Boolean  | 限制状态        |
| callback       | function | 回调函数        |
## 漫游镜头
roamingCamera(jsonData, callback)
Kind: global function

| Param              | Type     | Description                          |
|--------------------|----------|--------------------------------------|
| jsonData           | Object   | 参数                                   |
| jsonData.coordType | Number   | XY 轴坐标类别，0：X 米，Y米; 1: X 经度，Y 纬度      |
| jsonData.position  | Array    | 相机位置 二维数组 数组元素仍为数组                   |
| jsonData.target    | Array    | 相机焦点 二维数组 数组元素仍为数组                   |
| jsonData.flyTime   | Array    | 每段漫游持续时长 二维数组 数组元素仍为数组               |
| jsonData.loopMode  | String   | 循环模式，none：不循环；round：往返循环；repeat：从头循环 |
| callback           | function | 回调函数                                 |
## 设置漫游镜头状态
setCameraRoamingState(jsonData, callback)
Kind: global function

| Param          | Type     | Description                                |
|----------------|----------|--------------------------------------------|
| jsonData       | Object   | 参数                                         |
| jsonData.state | Number   | pause:暂停移动; continue:继续移动; stop:停止移动, 漫游结束 |
| callback       | function | 回调函数                                       |
## 设置镜头跳转
setCameraLookAt(jsonData, callback)
Kind: global function

| Param             | Type     | Description |
|-------------------|----------|-------------|
| jsonData          | Object   | 参数          |
| jsonData.position | Array    | 相机位置        |
| jsonData.target   | Array    | 相机焦点        |
| jsonData.flyTime  | Array    | 每段漫游持续时长    |
| callback          | function | 回调函数        |
## 路径移动相机
pathingCamera(jsonData, callback)
Kind: global function

| Param              | Type     | Description                          |
|--------------------|----------|--------------------------------------|
| jsonData           | Object   | 参数                                   |
| jsonData.pathIndex | Number   | 根据已绘制线触发运动动画                         |
| jsonData.height    | Number   | 相对路线偏移高度                             |
| jsonData.speed     | Number   | 漫游速度                                 |
| jsonData.isShow    | Boolean  | 是否沿路径旋转模型                            |
| jsonData.isRotate  | Boolean  | 每段漫游持续时长                             |
| jsonData.loopMode  | String   | 循环模式，none：不循环；round：往返循环；repeat：从头循环 |
| jsonData.pitch     | Number   | 镜头俯仰角                                |
| callback           | function | 回调函数                                 |
## 设置路径移动相机状态
setPathingCameraState(jsonData, callback)
Kind: global function

| Param          | Type     | Description                           |
|----------------|----------|---------------------------------------|
| jsonData       | Object   | 参数                                    |
| jsonData.state | String   | 跟随模型状态:暂停跟随; continue:继续跟随; stop:停止跟随 |
| callback       | function | 回调函数                                  |
## 设置第一人称漫游模式
setFirstPersonCameraControl(jsonData, callback)
Kind: global function

| Param                  | Type     | Description                      |
|------------------------|----------|----------------------------------|
| jsonData               | Object   | 参数                               |
| jsonData.colliders     | Array    | 碰撞对象                             |
| jsonData.personHeight  | Number   | 第一人称漫高度                          |
| jsonData.birthPosition | Array    | 第一人称漫自定义出生位置，若值为null则随相机位置，设置出生点 |
| jsonData.isCollision   | Boolean  | 是否碰撞检测                           |
| jsonData.moveSpeed     | Number   | 移动速度                             |
| jsonData.lookSpeed     | Number   | 转向速度                             |
| jsonData.speedUp       | Number   | 加速度（同时按shift后的速度倍数）              |
| jsonData.distance      | Number   | 前后碰撞的距离                          |
| callback               | function | 回调函数                             |
## 设置第一人称漫游模式状态
setFirstPersonCameraControlState(jsonData, callback)
Kind: global function

| Param          | Type     | Description                                    |
|----------------|----------|------------------------------------------------|
| jsonData       | Object   | 参数                                             |
| jsonData.state | String   | 模式状态，start:继续移动 设置第一人称漫游后才可继续; stop:停止移动, 漫游结束 |
| callback       | function | 回调函数                                           |
## 镜头跟随模型
followingCamera(jsonData, callback)
Kind: global function

| Param               | Type     | Description                       |
|---------------------|----------|-----------------------------------|
| jsonData            | Object   | 参数                                |
| jsonData.modelIndex | Number   | 镜头跟踪的模型Id，镜头和模型之前保持相对静止关系，支持运动的模型 |
| jsonData.distance   | Number   | 镜头与被跟踪物体的距离(单位:米)                 |
| jsonData.pitch      | Number   | 镜头俯仰角(5~89)                       |
| jsonData.heading    | Number   | 镜头偏航角(0正北, 0~359)                 |
| callback            | function | 回调函数                              |
## 设置镜头跟随模型状态
setCameraFollowingState(jsonData, callback)
Kind: global function
| Param          | Type     | Description                                |
|----------------|----------|--------------------------------------------|
| jsonData       | Object   | 参数                                         |
| jsonData.state | String   | 跟随模型状态:暂停跟随; continue:继续跟随; stop:停止跟随 释放焦点 |
| callback       | function | 回调函数                                       |
## 自动旋转
autoRotate(jsonData, callback)
Kind: global function
| Param         | Type     | Description |
|---------------|----------|-------------|
| jsonData      | Object   | 参数          |
| jsonData.flag | Boolean  | 是否自动旋转      |
| callback      | function | 回调函数        |