VoxelProvider

new Cesium.VoxelProvider()
engine/Source/Scene/VoxelProvider.js 16

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

This feature is not final and is subject to change without Cesium's standard deprecation policy.

See:

Members

readonly componentTypes : Array.<MetadataComponentType>
engine/Source/Scene/VoxelProvider.js 173

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

readonly dimensions : Cartesian3
engine/Source/Scene/VoxelProvider.js 113

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.

readonly globalTransform : Matrix4|undefined
engine/Source/Scene/VoxelProvider.js 52

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

readonly maxBounds : Cartesian3|undefined
engine/Source/Scene/VoxelProvider.js 101

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.

readonly maximumTileCount : number|undefined
engine/Source/Scene/VoxelProvider.js 209

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.

readonly maximumValues : Array.<Array.<number>>|undefined
engine/Source/Scene/VoxelProvider.js 197

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

readonly minBounds : Cartesian3|undefined
engine/Source/Scene/VoxelProvider.js 88

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.

readonly minimumValues : Array.<Array.<number>>|undefined
engine/Source/Scene/VoxelProvider.js 185

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

readonly names : Array.<string>
engine/Source/Scene/VoxelProvider.js 149

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

readonly paddingAfter : Cartesian3|undefined
engine/Source/Scene/VoxelProvider.js 137

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.

readonly paddingBefore : Cartesian3|undefined
engine/Source/Scene/VoxelProvider.js 125

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.

readonly deprecated ready : boolean
engine/Source/Scene/VoxelProvider.js 29

Gets a value indicating whether or not the provider is ready for use.

Deprecated: true

readonly deprecated readyPromise : Promise.<VoxelProvider>
engine/Source/Scene/VoxelProvider.js 41

Gets the promise that will be resolved when the provider is ready for use.

Deprecated: true

readonly shape : VoxelShapeType
engine/Source/Scene/VoxelProvider.js 75

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

readonly shapeTransform : Matrix4|undefined
engine/Source/Scene/VoxelProvider.js 63

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

readonly types : Array.<MetadataType>
engine/Source/Scene/VoxelProvider.js 161

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

Methods

requestData(options) → Promise.<Array.<Array>>|undefined
engine/Source/Scene/VoxelProvider.js 253

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.
Name Type Description
options object optional Object with the following properties:
Name Type Default Description
tileLevel number 0 optional The tile's level.
tileX number 0 optional The tile's X coordinate.
tileY number 0 optional The tile's Y coordinate.
tileZ number 0 optional The tile's Z coordinate.
Returns:
A promise to an array of typed arrays containing the requested voxel data or undefined if there was a problem loading the data.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets