Class TerrainVisualizer

Utility class for visualizing terrain provider boundaries and debugging terrain loading.

Constructors

constructor

new TerrainVisualizer(
viewer: Viewer,
options?: TerrainVisualizer.ConstructorOptions,
): TerrainVisualizer
Creates a new TerrainVisualizer.
Parameters
- viewer: Viewer
  The Cesium viewer instance
- Optionaloptions: TerrainVisualizer.ConstructorOptions
  TerrainVisualizer.ConstructorOptions
Returns TerrainVisualizer
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:39

Properties

`Private`_collection

_collection: Collection<EntityCollection, Entity>

`Private`_colors

_colors: Map<string, Color> = ...

`Private`_level

_level: number = 15

`Private` `Optional`_terrainProvider

_terrainProvider?: HybridTerrainProvider

`Private`_tileCoordinatesLayer

_tileCoordinatesLayer: undefined | ImageryLayer

`Private`_viewer

_viewer: Viewer

`Private`_visible

_visible: boolean = false

Accessors

collection

get collection(): Collection<EntityCollection, Entity>
The collection used in the visualizer.

Returns Collection<EntityCollection, Entity>
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:322

colors

get colors(): Map<string, Color>
The colors used in the visualizer

Returns Map<string, Color>
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:330

level

get level(): number
The current zoom level set on the visualizer.

Returns number
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:307
set level(level: number): void
Set zoom level on the visualizer.
Parameters
- level: number
Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:311

terrainProvider

get terrainProvider(): undefined | HybridTerrainProvider
The hybrid terrain instance used in the visualizer

Returns undefined | HybridTerrainProvider
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:334

viewer

get viewer(): Viewer
The viewer used in the visualizer

Returns Viewer
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:326

visible

get visible(): boolean
Whether the grid is currently visible.

Returns boolean
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:318

Methods

`Private`_calculateTileBounds

_calculateTileBounds(
    rectangle: Rectangle,
    level: number,
    tilingScheme: TilingScheme,
): { end: any; start: any }
Parameters
- rectangle: Rectangle
- level: number
- tilingScheme: TilingScheme
Returns { end: any; start: any }
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:161

`Private`_createTileEntity

_createTileEntity(
    x: number,
    y: number,
    level: number,
    tilingScheme: TilingScheme,
): null | Entity
Parameters
- x: number
- y: number
- level: number
- tilingScheme: TilingScheme
Returns null | Entity
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:207

`Private`_displayTileGrid

_displayTileGrid(visibleRectangle: Rectangle, level: number): void
Parameters
- visibleRectangle: Rectangle
- level: number
Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:142

`Private`_ensureTileCoordinatesLayer

_ensureTileCoordinatesLayer(): void
Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:118

`Private`_generateVisibleTiles

_generateVisibleTiles(
    bounds: { end: any; start: any },
    level: number,
    tilingScheme: TilingScheme,
): { entity: Entity }[]
Parameters
- bounds: { end: any; start: any }
- level: number
- tilingScheme: TilingScheme
Returns { entity: Entity }[]
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:182

`Private`_getTileColor

_getTileColor(x: number, y: number, level: number): Color
Parameters
- x: number
- y: number
- level: number
Returns Color
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:232

`Private`_getVisibleRectangle

_getVisibleRectangle(): undefined | Rectangle
Private
Gets the rectangle representing the current view.

Returns undefined | Rectangle
The current view rectangle or undefined.
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:300

`Private`_isValidRectangle

_isValidRectangle(rectangle: Rectangle): boolean
Parameters
- rectangle: Rectangle
Returns boolean
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:130

clear

clear(): void
Clears all visualizations.

Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:90

flyTo

flyTo(rectangle: Rectangle, options?: { duration?: number }): void
Flies the camera to focus on a rectangle.
Parameters
- rectangle: Rectangle
  The rectangle to focus on.
- Optionaloptions: { duration?: number }
  Viewer.flyTo
Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:285

hide

hide(): void
Hides the tile grid.

Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:257

setColors

setColors(colors: Record<string, Color>): void
Sets the colors used for visualization.
Parameters
- colors: Record<string, Color>
  Map of role names to colors
Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:272

setTerrainProvider

setTerrainProvider(terrainProvider: HybridTerrainProvider): void
Sets the terrain provider to visualize.
Parameters
- terrainProvider: HybridTerrainProvider
  The terrain provider to visualize.
Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:71

show

show(level?: number): void
Shows a grid of tiles at the specified level.
Parameters
- level: number = 15
  The zoom level to visualize
Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:99

update

update(): void
Updates all active visualizations.

Returns void
- Defined in dev/terrain/visualizer/terrain-visualizer.ts:79

Class TerrainVisualizer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TerrainVisualizer

Properties

Private_collection

Private_colors

Private_level

Private Optional_terrainProvider

Private_tileCoordinatesLayer

Private_viewer

Private_visible

Accessors

collection

Returns Collection<EntityCollection, Entity>

colors

Returns Map<string, Color>

level

Returns number

Parameters

Returns void

terrainProvider

Returns undefined | HybridTerrainProvider

viewer

Returns Viewer

visible

Returns boolean

Methods

Private_calculateTileBounds

Parameters

Returns { end: any; start: any }

Private_createTileEntity

Parameters

Returns null | Entity

Private_displayTileGrid

Parameters

Returns void

Private_ensureTileCoordinatesLayer

Returns void

Private_generateVisibleTiles

Parameters

Returns { entity: Entity }[]

Private_getTileColor

Parameters

Returns Color

Private_getVisibleRectangle

Returns undefined | Rectangle

Private_isValidRectangle

Parameters

Returns boolean

clear

Returns void

flyTo

Parameters

Returns void

hide

Returns void

setColors

Parameters

Returns void

setTerrainProvider

Parameters

Returns void

show

Parameters

Returns void

update

Returns void

Settings

On This Page

`Private`_collection

`Private`_colors

`Private`_level

`Private` `Optional`_terrainProvider

`Private`_tileCoordinatesLayer

`Private`_viewer

`Private`_visible

`Private`_calculateTileBounds

`Private`_createTileEntity

`Private`_displayTileGrid

`Private`_ensureTileCoordinatesLayer

`Private`_generateVisibleTiles

`Private`_getTileColor

`Private`_getVisibleRectangle

`Private`_isValidRectangle