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 144

Gets the metadata component types.

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

Gets the number of voxels per dimension of a tile. This is the same for all tiles in the dataset.

readonly globalTransform : Matrix4
engine/Source/Scene/VoxelProvider.js 29

A transform from local space to global space.
Default Value: Matrix4.IDENTITY

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

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

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

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.

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

Gets the metadata maximum values.

readonly metadataOrder : VoxelMetadataOrder
engine/Source/Scene/VoxelProvider.js 156

Gets the ordering of the metadata in the buffers.
Default Value: VoxelMetadataOrder.XYZ

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

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

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

Gets the metadata minimum values.

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

Gets the metadata names.

readonly paddingAfter : Cartesian3
engine/Source/Scene/VoxelProvider.js 111

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.
Default Value: Cartesian3.ZERO

readonly paddingBefore : Cartesian3
engine/Source/Scene/VoxelProvider.js 99

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.
Default Value: Cartesian3.ZERO

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

Gets the VoxelShapeType

readonly shapeTransform : Matrix4
engine/Source/Scene/VoxelProvider.js 41

A transform from shape space to local space.
Default Value: Matrix4.IDENTITY

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

Gets the metadata types.

Methods

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

Requests the data for a given tile.
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 resolving to a VoxelContent containing the data for the tile, or undefined if the request could not be scheduled this frame.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets