TerrainLoader

TerrainLoader

地形加载器父类,不能直接实例化。

Constructor

new TerrainLoader(options)

Author:
  • zpc
Parameters:
Name Type Description
options Object 拥有以下属性的对象:
Properties
Name Type Attributes Default Description
id String <optional>
Cesium.createGuid() 地形ID。
name String <optional>
"" 地形名称。

Members

(readonly) availability :Cesium.TileAvailability

获取一个对象,该对象可用于从该提供器确定地形的可用性,例如在点和矩形中。 在TerrainLoader#ready返回true之前,不应该调用这个函数。如果可用性信息不可用,则此属性可能未定义。
Type:
  • Cesium.TileAvailability

(readonly) credit :Cesium.Credit

获取地形提供器处于活动状态时显示的版权(credit)。通常这是用来确认地形的来源。 在TerrainLoader#ready返回true之前,不应该调用这个函数。
Type:
  • Cesium.Credit

(readonly) errorEvent :Cesium.Event

获取地形提供器遇到异步错误时引发的事件。通过订阅事件, 您将收到错误通知,并可能从中恢复。事件监听器传递一个Cesium.TileProviderError的实例。
Type:
  • Cesium.Event

(readonly) hasVertexNormals :Boolean

获取一个值,指示请求的瓦片是否包含顶点法线。 在TerrainLoader#ready返回true之前,不应该调用这个属性。
Type:
  • Boolean

(readonly) hasWaterMask :Boolean

获取一个值,指示提供器是否包含水掩膜。水掩膜显示了地球上哪些区域是水而不是陆地,因此它们可以被渲染成一个带有波浪的反射面。 在TerrainLoader#ready返回true之前,不应该调用这个属性。
Type:
  • Boolean

(readonly) id :String

获取地形加载器的唯一标识符。
Type:
  • String

(readonly) provider :Cesium.TerrainProvider

获取地形加载器包装的地形提供器。
Type:
  • Cesium.TerrainProvider

(readonly) ready :Boolean

获取一个值,指示提供器是否已能使用。
Type:
  • Boolean

(readonly) readyPromise :Promise.<Boolean>

获取一个约定,当提供器能使用时解析为true。
Type:
  • Promise.<Boolean>

(readonly) tilingScheme :Cesium.TilingScheme

获取地形提供器使用的切片方案。 在TerrainLoader#ready返回true之前,不应该调用这个函数。
Type:
  • Cesium.TilingScheme

Methods

(static) getEstimatedLevelZeroGeometricErrorForAHeightmap(ellipsoid, tileImageWidth, numberOfTilesAtLevelZero) → {Number}

当几何图形来自高度图时,确定适当的几何误差估计值。
Parameters:
Name Type Description
ellipsoid Cesium.Ellipsoid 地形要附着的椭球体。
tileImageWidth Number 与单个瓦片关联的高度图的宽度(以像素为单位)。
numberOfTilesAtLevelZero Number 瓦片级别为零时水平方向的瓦片数。
Returns:
估算的几何误差。
Type
Number

(static) getRegularGridIndices(width, height) → {Uint16Array|Uint32Array}

获取表示规则格网的三角形网格的索引列表。 使用相同的格网宽度和高度多次调用此函数将返回相同的索引列表。 顶点的总数必须小于或等于65536。
Parameters:
Name Type Description
width Number 在水平方向上规则格网中的顶点数。
height Number 在垂直方向上规则格网中的顶点数。
Returns:
索引列表。Uint16Array返回64KB或更少,Uint32Array返回4GB或更少。
Type
Uint16Array | Uint32Array

getLevelMaximumGeometricError(level) → {Number}

获取给定级别瓦片中允许的最大几何误差。在TerrainLoader#ready返回true之前,不应该调用这个函数。
Parameters:
Name Type Description
level Number 要为其获取最大几何误差的瓦片级级。
Returns:
最大几何误差。
Type
Number

getTileDataAvailable(x, y, level) → {Boolean}

确定是否可以加载瓦片的数据。
Parameters:
Name Type Description
x Number 要为其请求几何图形的瓦片的X坐标。
y Number 要为其请求几何图形的瓦片的Y坐标。
level Number 要为其请求几何图形的瓦片的级别。
Returns:
如果地形提供器不支持,则undefined,否则为true或false。
Type
Boolean

loadTileDataAvailability(x, y, level) → {undefined|Promise}

确保为瓦片加载可用性数据。
Parameters:
Name Type Description
x Number 要为其请求几何图形的瓦片的X坐标。
y Number 要为其请求几何图形的瓦片的Y坐标。
level Number 要为其请求几何图形的瓦片的级别。
Returns:
如果不需要加载任何内容则为undefined,或者在所需的瓦片加载完成时解析的出的约定。
Type
undefined | Promise

requestTileGeometry(x, y, level, requestopt) → {Promise.<Cesium.TerrainData>|undefined}

请求给定瓦片的几何图形。在TerrainLoader#ready返回true之前,不应该调用这个函数。 结果必须包括地形数据,并可以选择包括一个水掩模和哪些子瓦片可用的指示。
Parameters:
Name Type Attributes Description
x Number 要为其请求几何图形的瓦片的X坐标。
y Number 要为其请求几何图形的瓦片的Y坐标。
level Number 要为其请求几何图形的瓦片的级别。
request Request <optional>
请求对象。仅供内部使用。
Returns:
请求的几何图形的约定。 如果此方法返回undefined而不是约定(promise),则表示有太多请求已经挂起,稍后将重试请求。
Type
Promise.<Cesium.TerrainData> | undefined