要构造 CesiumTerrainProvider,请调用
一个访问 Cesium 地形格式地形数据的 CesiumTerrainProvider.fromIonAssetId 或 CesiumTerrainProvider.fromUrl。不要直接调用构造函数。
TerrainProvider。
地形格式可以是以下之一:
| Name | Type | Description |
|---|---|---|
options |
CesiumTerrainProvider.ConstructorOptions | optional 描述初始化选项的对象 |
- createWorldTerrain
- CesiumTerrainProvider.fromUrl
- CesiumTerrainProvider.fromIonAssetId
- TerrainProvider
Example:
// Create Arctic DEM terrain with normals.
try {
const viewer = new Cesium.Viewer("cesiumContainer", {
terrainProvider: await Cesium.CesiumTerrainProvider.fromIonAssetId(3956, {
requestVertexNormals: true
})
});
} catch (error) {
console.log(error);
}
See:
Members
readonly availability : TileAvailability|undefined
获取一个可用于确定此提供程序地形可用性的对象,例如在点和矩形中。如果可用性信息不可用,则此属性可能为 undefined。请注意,这反映的是当前已知可用的瓦片。未来可能会发现更多可用的瓦片,例如,如果可用性信息存在于树的更深层,而不是在根节点处全部可发现。然而,当前可用的瓦片在未来不会变为不可用。
readonly credit : Credit
获取当此地形提供程序处于活动状态时要显示的版权信息。通常这用于标注地形的来源。
readonly errorEvent : Event
获取当地形提供程序遇到异步错误时引发的事件。通过订阅该事件,你会收到错误通知并有可能从中恢复。事件监听器会接收到一个
TileProviderError 实例。
获取一个值,指示请求的瓦片是否包含元数据。
获取一个值,指示请求的瓦片是否包含顶点法线。
获取一个值,指示提供程序是否包含水面掩码。水面掩码指示地球上哪些区域是水域而非陆地,从而可以将它们渲染为带有动画波纹的反射表面。
布尔标志,指示客户端是否应向服务器请求元数据。仅当客户端请求元数据且服务器提供元数据时,元数据才会附加到标准瓦片网格数据中。
布尔标志,指示客户端是否应向服务器请求顶点法线。仅当客户端请求顶点法线且服务器提供顶点法线时,顶点法线数据才会附加到标准瓦片网格数据中。
布尔标志,指示客户端是否应向服务器请求水面掩码。仅当客户端请求水面掩码且服务器提供水面掩码时,水面掩码数据才会附加到标准瓦片网格数据中。
readonly tilingScheme : GeographicTilingScheme
获取此提供程序使用的瓦片方案。
Methods
static Cesium.CesiumTerrainProvider.fromIonAssetId(assetId, options) → Promise.<CesiumTerrainProvider>
从访问 Cesium 地形格式地形数据的 Cesium ion 资源 ID 创建一个
TerrainProvider
地形格式可以是以下之一:
| Name | Type | Description |
|---|---|---|
assetId |
number | Cesium ion 资源 ID。 |
options |
CesiumTerrainProvider.ConstructorOptions | optional 描述初始化选项的对象. |
Returns:
Throws:
-
RuntimeError :layer.json 未指定格式
-
RuntimeError :layer.json 指定了未知格式
-
RuntimeError :layer.json 指定了不支持的 quantized-mesh 版本
-
RuntimeError :layer.json 未指定 tiles 属性,或指定了空数组
-
RuntimeError :layer.json 未指定任何瓦片 URL 模板
Example:
// Create Arctic DEM terrain with normals.
try {
const viewer = new Cesium.Viewer("cesiumContainer", {
terrainProvider: await Cesium.CesiumTerrainProvider.fromIonAssetId(3956, {
requestVertexNormals: true
})
});
} catch (error) {
console.log(error);
}
static Cesium.CesiumTerrainProvider.fromUrl(url, options) → Promise.<CesiumTerrainProvider>
创建一个访问 Cesium 地形格式地形数据的
TerrainProvider。
地形格式可以是以下之一:
| Name | Type | Description |
|---|---|---|
url |
Resource | string | Promise.<Resource> | Promise.<string> | Cesium 地形服务器的 URL。 |
options |
CesiumTerrainProvider.ConstructorOptions | optional 描述初始化选项的对象. |
Returns:
Throws:
-
RuntimeError :layer.json 未指定格式
-
RuntimeError :layer.json 指定了未知格式
-
RuntimeError :layer.json 指定了不支持的 quantized-mesh 版本
-
RuntimeError :layer.json 未指定 tiles 属性,或指定了空数组
-
RuntimeError :layer.json 未指定任何瓦片 URL 模板
Example:
// Create Arctic DEM terrain with normals.
try {
const viewer = new Cesium.Viewer("cesiumContainer", {
terrainProvider: await Cesium.CesiumTerrainProvider.fromUrl(
Cesium.IonResource.fromAssetId(3956), {
requestVertexNormals: true
})
});
} catch (error) {
console.log(error);
}
获取在给定层级上瓦片允许的最大几何误差。
| Name | Type | Description |
|---|---|---|
level |
number | 要获取最大几何误差的瓦片层级。 |
Returns:
最大几何误差。
确定瓦片的数据是否可加载。
| Name | Type | Description |
|---|---|---|
x |
number | 要请求几何体的瓦片的 X 坐标。 |
y |
number | 要请求几何体的瓦片的 Y 坐标。 |
level |
number | 要请求几何体的瓦片的层级。 |
Returns:
如果不支持或可用性未知则为 undefined,否则为 true 或 false。
确保我们为某个瓦片加载可用性数据
| Name | Type | Description |
|---|---|---|
x |
number | 要请求几何体的瓦片的 X 坐标。 |
y |
number | 要请求几何体的瓦片的 Y 坐标。 |
level |
number | 要请求几何体的瓦片的层级。 |
Returns:
如果无需加载任何内容则为 undefined,或者在所有必需瓦片加载完成时解析的 Promise
requestTileGeometry(x, y, level, request) → Promise.<TerrainData>|undefined
请求给定瓦片的几何体。结果必须包含地形数据,并可以包含水面掩码以及哪些子瓦片可用的指示。
| Name | Type | Description |
|---|---|---|
x |
number | 要请求几何体的瓦片的 X 坐标。 |
y |
number | 要请求几何体的瓦片的 Y 坐标。 |
level |
number | 要请求几何体的瓦片的层级。 |
request |
Request | optional 请求对象。仅供内部使用。 |
Returns:
请求几何体的 Promise。如果此方法返回 undefined 而非 Promise,则表示已有太多请求待处理,该请求将在稍后重试。
Type Definitions
CesiumTerrainProvider 构造函数的初始化选项
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
requestVertexNormals |
boolean |
<optional> |
false | 指示客户端是否应从服务器请求额外光照信息的标志(如果可用,以逐顶点法线的形式)。 |
requestWaterMask |
boolean |
<optional> |
false | 指示客户端是否应从服务器请求逐瓦片水面掩码的标志(如果可用)。 |
requestMetadata |
boolean |
<optional> |
true | 指示客户端是否应从服务器请求逐瓦片元数据的标志(如果可用)。 |
ellipsoid |
Ellipsoid |
<optional> |
Ellipsoid.default | 椭球体。如果未指定,则使用默认椭球体。 |
credit |
Credit | string |
<optional> |
数据源的版权信息,显示在画布上。 |
