KBE3D / KBCore / Cesium / GridImageryProvider

类: GridImageryProvider

An ImageryProvider that draws a wireframe grid on every tile with controllable background and glow. May be useful for custom rendering effects or debugging terrain.

参数

Object describing initialization options

属性

proxy

readonly proxy: Proxy

Gets the proxy used by this provider.

---

tileWidth

readonly tileWidth: number

Gets the width of each tile, in pixels.

---

tileHeight

readonly tileHeight: number

Gets the height of each tile, in pixels.

---

maximumLevel

readonly maximumLevel: number | undefined

Gets the maximum level-of-detail that can be requested.

---

minimumLevel

readonly minimumLevel: number

Gets the minimum level-of-detail that can be requested.

---

tilingScheme

readonly tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

---

rectangle

readonly rectangle: Rectangle

Gets the rectangle, in radians, of the imagery provided by this instance.

---

tileDiscardPolicy

readonly tileDiscardPolicy: TileDiscardPolicy

Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered.

---

errorEvent

readonly errorEvent: Event

Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

---

credit

readonly credit: Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

---

hasAlphaChannel

readonly hasAlphaChannel: boolean

Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel. If this property is false, an alpha channel, if present, will be ignored. If this property is true, any images without an alpha channel will be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage and texture upload time are reduced.

方法

_drawGrid()

_drawGrid(): void

Draws a grid of lines into a canvas.

返回

void

---

_createGridCanvas()

_createGridCanvas(): void

Render a grid into a canvas with background and glow

返回

void

---

getTileCredits()

getTileCredits(x: number, y: number, level: number): Credit[]

Gets the credits to be displayed when a given tile is displayed.

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level;

返回

Credit[]

The credits to be displayed when the tile is displayed.

---

requestImage()

requestImage(x: number, y: number, level: number, request?: Request): Promise<HTMLCanvasElement>

Requests the image for a given tile.

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level.

request?

Request

The request object. Intended for internal use only.

返回

Promise<HTMLCanvasElement>

The resolved image as a Canvas DOM object.

---

pickFeatures()

pickFeatures(x: number, y: number, level: number, longitude: number, latitude: number): undefined

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

参数

x

number

The tile X coordinate.

y

number

The tile Y coordinate.

level

number

The tile level.

longitude

number

The longitude at which to pick features.

latitude

number

The latitude at which to pick features.

返回

undefined

Undefined since picking is not supported.

构造函数

构造函数

new GridImageryProvider(options: ConstructorOptions): GridImageryProvider

参数

options

ConstructorOptions

返回

GridImageryProvider