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>
Gets the metadata component types.
This should not be called before
VoxelProvider#ready
returns true.
readonly 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.
readonly globalTransform : Matrix4|undefined
A transform from local space to global space. If undefined, the identity matrix will be used instead.
readonly maxBounds : Cartesian3|undefined
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.
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.
Gets the metadata maximum values.
This should not be called before
VoxelProvider#ready
returns true.
readonly minBounds : Cartesian3|undefined
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.
Gets the metadata minimum values.
This should not be called before
VoxelProvider#ready
returns true.
Gets the metadata names.
This should not be called before
VoxelProvider#ready
returns true.
readonly paddingAfter : Cartesian3|undefined
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
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 shape : VoxelShapeType
Gets the
VoxelShapeType
This should not be called before VoxelProvider#ready
returns true.
readonly shapeTransform : Matrix4|undefined
A transform from shape space to local space. If undefined, the identity matrix will be used instead.
readonly types : Array.<MetadataType>
Gets the metadata types.
This should not be called before
VoxelProvider#ready
returns true.
Methods
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:
|
Returns:
A promise to an array of typed arrays containing the requested voxel data or undefined if there was a problem loading the data.