# 更新场景

PATCH https://api.bimface.com/scene/{sceneId}

# 说明

通过场景信息和ID,更新已创建场景的相关信息。该接口需配合场景编辑组件一同使用,具体可参考Scene Module文档。需要注意的是,场景中必须包含地图图层,即body中resources字段下必须包含TileLayer的数据,否则场景将无法打开。

# 参数

Authorization * Bearer {accessToken} string
*为必填项
# Path
sceneId * 场景ID integer (int64)
*为必填项
# Body
name * 场景名称 string
sceneSetting * 场景配置信息,需传入json。可基于场景编辑组件接口获取对应值。 SceneSetting
homeView 场景初始视角 HomeView
orientation 相机姿态角 Orientation
roll 翻滚角,默认为0 BigDecimal
pitch 俯仰角,默认为-π/2 BigDecimal
yaw 偏航角,默认为0 BigDecimal
position 相机位置 Position
alt 相机高度 BigDecimal
lon 经度 BigDecimal
lat 纬度 BigDecimal
baseLatLon * 项目基点 BaseLatLon
lon * 经度 BigDecimal
lat * 纬度 BigDecimal
resources * 场景图层资源信息,需传入Json。可基于场景编辑组件接口获取对应值。 < Layer Resource >array
id * 图层ID string
name * 图层名 string
modelId 模型ID,场景中仅支持添加同一项目下流式加载且转换成功/集成成功的模型资源。当typeName为BIMLayer/FeatureLayer/TilesetLayer时必填。 Long
modelType 模型类型,"singleModel"或"integrateModel",分别对应单模型与集成模型。当typeName为BIMLayer/FeatureLayer/TilesetLayer时必填。 string
fileName modelId对应的模型文件名 string
boundingBox 模型包围盒信息 BoundingBox
min 最小坐标点 Coordinate
max 最大坐标点 Coordinate
isVisible 图层可见性 Boolean
parentId 父节点ID string
children 子节点数据,当typeName为GroupLayer时生效。 < Layer Resource >array
priority 图层加载优先级,1/2/3/4/5分别对应高、较高、中、较低、低 int64
transformation 图层坐标变换值,为16*1的数组。 < Double >array
typeName * 图层类型,BIM模型对应BIMLayer,osgb对应TilesetLayer,shp模型对应FeatureLayer,地图对应TileLayer,地形对应TerrainLayer,文件夹对应GroupLayer。 string
url 地图/地形图层的资源访问地址,当typeName为TileLayer/TerrainLayer时必填。 string
maxLevel 地图服务请求的最大层级,当typeName为TileLayer时必填,天地图服务的最大请求层级可设置为18。 string
*为必填项

# 响应

HTTP代码 说明 类型
200 OK GeneralResponse«string»
204 No Content -
401 Unauthorized -
403 Forbidden -
# 200响应参数
GeneralResponse«string»
名称 说明 类型
code 状态代码 string
data 返回数据 string
message 提示消息 string

# 消耗

  • application/json

# 生成

  • */*
  • application/json

# HTTP请求示例

# 请求 path
https://api.bimface.com/scene/2017707858581568
# 请求 header
"Authorization: Bearer cn-e9725999-0b36-4c0e-bdca-38ea88888888"
# 请求 body
{
  "name" : "BIMFACE场景",
  "sceneSetting" : {
    "baseLatLon" : {
      "lat" : 23.0,
      "lon" : 115.56302
    },
    "homeView" : {
      "orientation" : {
        "pitch" : -1.5707963267948966,
        "roll" : 0.0,
        "yaw" : 0.0
      },
      "position" : {
        "alt" : 1000.0,
        "lat" : 23.0,
        "lon" : 115.56302
      }
    }
  },
  "resources" : [ 
    {
      "id":"bim-layer",
      "name":"BIM模型",
      "modelId":1938888813662976,
      "modelType":"singleModel",
      "fileName": "BIMFACE示例模型.rvt",
      "parentId":"root",
      "priority":3,
      "typeName":"BIMLayer"
    },
    {
      "id":"tileset-layer",
      "name":"OSGB模型",
      "modelId":1938888813662966,
      "modelType":"singleModel",
      "fileName": "倾斜摄影模型.osgbzip",
      "parentId":"root",
      "priority":3,
      "typeName":"TilesetLayer"
    },
    {
      "id":"feature-layer",
      "name":"SHP模型",
      "modelId":1938888813662956,
      "modelType":"singleModel",
      "fileName": "shp模型.shpzip",
      "parentId":"root",
      "priority":3,
      "typeName":"FeatureLayer"
    },
    {
      "id":"tile-layer",
      "name":"地图",
      "parentId":"root",
      "priority":1,
      "typeName":"TileLayer",
      "maxLevel":"18",
      "url":"https://t0.tianditu.gov.cn/img_w/wmts?SERVICE=WMTS&REQUEST=GetTile&VERSION=1.0.0&LAYER=img&STYLE=default&TILEMATRIXSET=w&FORMAT=tiles&TILEMATRIX={z}&TILEROW={x}&TILECOL={y}&tk=9fe0f60cd462f38c726d9a12565e1234"
    },
    {
      "id":"terrain-layer",
      "name":"地形",
      "parentId":"root",
      "priority":1,
      "typeName":"TerrainLayer",
      "url":"https://static.bimface.com/gis/dem/srtm/v3/"
    }
  ]
}

说明:该示例中地图数据的url对应为天地图的影像地图资源,若想在场景中使用天地图,需将url中"tk="后的字段替换为可用的天地图Key。地形数据的url对应BIMFACE提供的90m精度地形数据,若想替换为自己的地形数据,可基于BIMFACE的地形数据切片工具对自有的tif地形数据进行切片,发布服务后即可在GIS场景内加载应用自己的地形数据。

# HTTP响应示例

# 响应 200
{
  "code" : "success",
  "data" : "success",
  "message" : null
}