kotlin-cesium-engine/cesium.engine/VoxelProvider

VoxelProvider

abstract external class VoxelProvider(source)

Provides voxel data. Intended to be used with VoxelPrimitive. This type describes an interface and is not intended to be instantiated directly.

See also

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
sealed interface RequestDataOptions

Properties

Link copied to clipboard
abstract val componentTypes: ReadonlyArray<MetadataComponentType>

Gets the metadata component types. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val dimensions: Cartesian3

Gets the number of voxels per dimension of a tile. This is the same for all tiles in the dataset. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val globalTransform: Matrix4?

A transform from local space to global space. If undefined, the identity matrix will be used instead.

Link copied to clipboard
abstract val maxBounds: Cartesian3?

Gets the maximum bounds. If undefined, the shape's default maximum bounds will be used instead. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val maximumTileCount: Double?

The maximum number of tiles that exist for this provider. This value is used as a hint to the voxel renderer to allocate an appropriate amount of GPU memory. If this value is not known it can be undefined. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val maximumValues: ReadonlyArray<ReadonlyArray<Double>>?

Gets the metadata maximum values. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val minBounds: Cartesian3?

Gets the minimum bounds. If undefined, the shape's default minimum bounds will be used instead. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val minimumValues: ReadonlyArray<ReadonlyArray<Double>>?

Gets the metadata minimum values. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val names: ReadonlyArray<String>

Gets the metadata names. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val paddingAfter: Cartesian3?

Gets the number of padding voxels after the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val paddingBefore: Cartesian3?

Gets the number of padding voxels before the tile. This improves rendering quality when sampling the edge of a tile, but it increases memory usage. This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val shape: VoxelShapeType

Gets the VoxelShapeType This should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract val shapeTransform: Matrix4?

A transform from shape space to local space. If undefined, the identity matrix will be used instead.

Link copied to clipboard
abstract val types: ReadonlyArray<MetadataType>

Gets the metadata types. This should not be called before VoxelProvider.ready returns true.

Functions

Link copied to clipboard
suspend fun requestData(options: VoxelProvider.RequestDataOptions? = definedExternally): ReadonlyArray<ReadonlyArray<Any>>?

Requests the data for a given tile. The data is a flattened 3D array ordered by X, then Y, then Z. This function should not be called before VoxelProvider.ready returns true.

Link copied to clipboard
abstract fun requestDataAsync(options: VoxelProvider.RequestDataOptions? = definedExternally): Promise<ReadonlyArray<ReadonlyArray<Any>>>?