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
interface RequestDataOptions

Properties

Link copied to clipboard
abstract val componentTypes: <Error class: unknown class><MetadataComponentType>

Gets the metadata component types.

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.

Link copied to clipboard
abstract val globalTransform: Matrix4

A transform from local space to global space.

Link copied to clipboard
abstract val maxBounds: Cartesian3?

Gets the maximum bounds. If undefined, the shape's default maximum bounds will be used instead.

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.

Link copied to clipboard
abstract val maximumValues: <Error class: unknown class><<Error class: unknown class><Double>>?

Gets the metadata maximum values.

Link copied to clipboard
abstract val minBounds: Cartesian3?

Gets the minimum bounds. If undefined, the shape's default minimum bounds will be used instead.

Link copied to clipboard
abstract val minimumValues: <Error class: unknown class><<Error class: unknown class><Double>>?

Gets the metadata minimum values.

Link copied to clipboard
abstract val names: <Error class: unknown class><String>

Gets the metadata names.

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.

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.

Link copied to clipboard
abstract val shape: VoxelShapeType

Gets the VoxelShapeType

Link copied to clipboard
abstract val shapeTransform: Matrix4

A transform from shape space to local space.

Link copied to clipboard
abstract val types: <Error class: unknown class><MetadataType>

Gets the metadata types.

Functions

Link copied to clipboard
suspend fun requestData(options: VoxelProvider.RequestDataOptions? = definedExternally): VoxelContent?

Requests the data for a given tile.

Link copied to clipboard
abstract fun requestDataAsync(options: VoxelProvider.RequestDataOptions? = definedExternally): <Error class: unknown class><VoxelContent>?