VoxelPrimitive

new Cesium.VoxelPrimitive(options)
@cesium/engine/Source/Scene/VoxelPrimitive.js 47

A primitive that renders voxel data from a VoxelProvider.
Name Type Description
options object optional Object with the following properties:
Name Type Default Description
provider VoxelProvider optional The voxel provider that supplies the primitive with tile data.
modelMatrix Matrix4 Matrix4.IDENTITY optional The model matrix used to transform the primitive.
customShader CustomShader optional The custom shader used to style the primitive.
clock Clock optional The clock used to control time dynamic behavior.
Experimental

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

See:

Members

readonly boundingSphere : BoundingSphere
@cesium/engine/Source/Scene/VoxelPrimitive.js 531

Gets the bounding sphere.

clippingPlanes : ClippingPlaneCollection
@cesium/engine/Source/Scene/VoxelPrimitive.js 880

The ClippingPlaneCollection used to selectively disable rendering the primitive.

customShader : CustomShader
@cesium/engine/Source/Scene/VoxelPrimitive.js 896

Gets or sets the custom shader. If undefined, VoxelPrimitive.DefaultCustomShader is set.

readonly customShaderCompilationEvent : Event
@cesium/engine/Source/Scene/VoxelPrimitive.js 933

Gets an event that is raised whenever a custom shader is compiled.

debugDraw : boolean
@cesium/engine/Source/Scene/VoxelPrimitive.js 666

Gets or sets whether or not to render debug visualizations.

depthTest : boolean
@cesium/engine/Source/Scene/VoxelPrimitive.js 685

Gets or sets whether or not to test against depth when rendering.

readonly dimensions : Cartesian3
@cesium/engine/Source/Scene/VoxelPrimitive.js 590

Gets the voxel dimensions.

disableUpdate : boolean
@cesium/engine/Source/Scene/VoxelPrimitive.js 647

Gets or sets whether or not the primitive should update when the view changes.

maxBounds : Cartesian3
@cesium/engine/Source/Scene/VoxelPrimitive.js 815

Gets or sets the maximum bounds in the shape's local coordinate system. Voxel data is stretched or squashed to fit the bounds.

maxClippingBounds : Cartesian3
@cesium/engine/Source/Scene/VoxelPrimitive.js 858

Gets or sets the maximum clipping location in the shape's local coordinate system. Any voxel content outside the range is clipped.

readonly maximumValues : Array.<Array.<number>>
@cesium/engine/Source/Scene/VoxelPrimitive.js 616

Gets the maximum value per channel of the voxel data.

minBounds : Cartesian3
@cesium/engine/Source/Scene/VoxelPrimitive.js 795

Gets or sets the minimum bounds in the shape's local coordinate system. Voxel data is stretched or squashed to fit the bounds.

minClippingBounds : Cartesian3
@cesium/engine/Source/Scene/VoxelPrimitive.js 835

Gets or sets the minimum clipping location in the shape's local coordinate system. Any voxel content outside the range is clipped.

readonly minimumValues : Array.<Array.<number>>
@cesium/engine/Source/Scene/VoxelPrimitive.js 603

Gets the minimum value per channel of the voxel data.

readonly modelMatrix : Matrix4
@cesium/engine/Source/Scene/VoxelPrimitive.js 557

Gets the model matrix.

nearestSampling : boolean
@cesium/engine/Source/Scene/VoxelPrimitive.js 707

Gets or sets the nearest sampling.

readonly orientedBoundingBox : OrientedBoundingBox
@cesium/engine/Source/Scene/VoxelPrimitive.js 544

Gets the oriented bounding box.

readonly provider : VoxelProvider
@cesium/engine/Source/Scene/VoxelPrimitive.js 518

Gets the VoxelProvider associated with this primitive.

readonly ready : boolean
@cesium/engine/Source/Scene/VoxelPrimitive.js 505

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

screenSpaceError : number
@cesium/engine/Source/Scene/VoxelPrimitive.js 754

Gets or sets the screen space error in pixels. If the screen space size of a voxel is greater than the screen space error, the tile is subdivided. Lower screen space error corresponds with higher detail rendering, but could result in worse performance and higher memory consumption.

readonly shape : VoxelShapeType
@cesium/engine/Source/Scene/VoxelPrimitive.js 577

Gets the shape type.

show : boolean
@cesium/engine/Source/Scene/VoxelPrimitive.js 628

Gets or sets whether or not this primitive should be displayed.

stepSize : number
@cesium/engine/Source/Scene/VoxelPrimitive.js 775

Gets or sets the step size multiplier used during raymarching. The lower the value, the higher the rendering quality, but also the worse the performance.

Methods

destroy()
@cesium/engine/Source/Scene/VoxelPrimitive.js 1663

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
voxelPrimitive = voxelPrimitive && voxelPrimitive.destroy();
See:

isDestroyed() → boolean
@cesium/engine/Source/Scene/VoxelPrimitive.js 1644

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/ion-sdk-measurements
packages/ion-sdk-sensors
packages/ion-sdk-geometry
@cesium/engine
@cesium/widgets