麻辣GIS微信平台

更多 GIS 干货

微信关注不错过

Cesium API - CesiumTerrainProvider 中文文档

本文介绍下Cesium中 CesiumTerrainProvider API的详细使用说明。

CesiumTerrainProvider API 调用方法

new Cesium.CesiumTerrainProvider(options)
以Cesium地形格式访问地形数据的TerrainProvider
Name Type Description
options Object 对象,具有以下属性:
Name Type Default Description
url Resource | String | Promise.<Resource> | Promise.<String> Cesium地形服务器的URL。
requestVertexNormals Boolean false optional 指示客户端是否应该从服务器请求额外的光照信息,以每个顶点法线的形式表示(如果可用)。
requestWaterMask Boolean false optional 指示客户端是否应该从服务器请求每个瓦片的水掩膜(如果可用)。
requestMetadata Boolean true optional 指示客户端是否应该从服务器请求每个瓦片元数据(如果可用)。
ellipsoid Ellipsoid optional 椭球。如果没有指定,则使用WGS84椭球体。
credit Credit | String optional 将显示在画布上的数据源的版权(credit)。
示例:
// 创建带有法线的Arctic DEM地形。
var viewer = new Cesium.Viewer('cesiumContainer', {
    terrainProvider : new Cesium.CesiumTerrainProvider({
        url : Cesium.IonResource.fromAssetId(3956),
        requestVertexNormals : true
    })
});
参考:

成员变量

获取一个对象,该对象可用于从该提供器确定地形的可用性,例如在点和矩形中。 在CesiumTerrainProvider#ready返回true之前,不应该调用这个函数。 如果可用性信息不可用,则此属性可能未定义。注意,这反映了当前已知可用的瓦片。 将来可能会发现更多可用的瓦片,例如,如果可用性信息存在于树的更深处,而不是在根处都可以发现。 但是,现在可用的瓦片将来也一定可用。
获取地形提供器处于活动状态时显示的版权(credit)。通常这是用来确认地形的来源。 在CesiumTerrainProvider#ready返回true之前,不应该调用这个函数。
获取地形提供器遇到异步错误时引发的事件。通过订阅事件, 您将收到错误通知,并可能从中恢复。事件监听器传递一个TileProviderError的实例。
hasMetadata : Boolean
获取一个值,该值指示请求的瓦片是否包含元数据。 在CesiumTerrainProvider#ready返回true之前,不应该调用这个函数。
hasVertexNormals : Boolean
取一个值,指示请求的瓦片是否包含顶点法线。 在CesiumTerrainProvider#ready返回true之前,不应该调用这个函数。
hasWaterMask : Boolean
获取一个值,指示提供器是否包含水掩膜。水掩膜显示了地球上哪些区域是水而不是陆地,因此它们可以被渲染成一个带有波浪的反射面。 在CesiumTerrainProvider#ready返回true之前,不应该调用这个函数。
获取一个值,指示提供器是否已能使用。
readonlyreadyPromise : Promise.<Boolean>
获取一个约定,当提供器能使用时解析为true。
requestMetadata : Boolean
布尔值,指示客户端是否应该从服务器请求元数据。 只有在客户端请求元数据和服务器提供元数据的情况下,元数据才被附加到标准的瓦片网格数据中。
requestVertexNormals : Boolean
布尔值,指示客户端是否应该从服务器请求顶点法线。 只有在客户端请求顶点法线和服务器提供顶点法线的情况下,顶点法线数据才被附加到标准的瓦片网格数据中。
requestWaterMask : Boolean
布尔值,指示客户端是否应该从服务器请求一个水掩膜。 只有在客户端请求水掩膜并且服务器提供了水掩膜的情况下,才会将水掩膜数据附加到标准的瓦片网格数据中。
获取地形提供器使用的切片方案。 在CesiumTerrainProvider#ready返回true之前,不应该调用这个函数。

内置方法

getLevelMaximumGeometricError(level)Number
获取给定级别瓦片中允许的最大几何误差。
Name Type Description
level Number 要为其获取最大几何误差的瓦片级级。
返回值:
最大几何误差。
getTileDataAvailable(x, y, level)Boolean
确定是否可以加载瓦片的数据。
Name Type Description
x Number 要为其请求几何图形的瓦片的X坐标。
y Number 要为其请求几何图形的瓦片的Y坐标。
level Number 要为其请求几何图形的瓦片的级别。
返回值:
如果地形提供器不支持,则undefined,否则为true或false。
loadTileDataAvailability(x, y, level)undefined|Promise
确保为瓦片加载可用性数据。
Name Type Description
x Number 要为其请求几何图形的瓦片的X坐标。
y Number 要为其请求几何图形的瓦片的Y坐标。
level Number 要为其请求几何图形的瓦片的级别。
返回值:
如果不需要加载任何内容则为undefined,或者在所需的瓦片加载完成时解析的出的约定。
requestTileGeometry(x, y, level, request)Promise.<TerrainData>|undefined
请求给定瓦片的几何图形。在CesiumTerrainProvider#ready返回true之前,不应该调用这个函数。 结果必须包括地形数据,并可以选择包括一个水掩模和哪些子瓦片可用的指示。
Name Type Description
x Number 要为其请求几何图形的瓦片的X坐标。
y Number 要为其请求几何图形的瓦片的Y坐标。
level Number 要为其请求几何图形的瓦片的级别。
request Request optional 请求对象。仅供内部使用。
返回值:
请求的几何图形的约定。 如果此方法返回undefined而不是约定(promise),则表示有太多请求已经挂起,稍后将重试请求。
异常情况:

其他API

Cesium中文API文档手册(v1.63.1版本)参考:《Cesium中文API文档手册(v1.63.1版本)

相关阅读

麻辣GIS-Sailor

作者:

GIS爱好者,学GIS,更爱玩GIS。

声明

1.本文所分享的所有需要用户下载使用的内容(包括但不限于软件、数据、图片)来自于网络或者麻辣GIS粉丝自行分享,版权归该下载资源的合法拥有者所有,如有侵权请第一时间联系本站删除。

2.下载内容仅限个人学习使用,请切勿用作商用等其他用途,否则后果自负。

手机阅读
公众号关注
知识星球
手机阅读
麻辣GIS微信公众号关注
最新GIS干货
关注麻辣GIS知识星球
私享圈子

留言板(小编看到第一时间回复)