A primitive that renders voxel data from a
VoxelProvider
.
Name | Type | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
optional
Object with the following properties:
|
Experimental
This feature is not final and is subject to change without Cesium's standard deprecation policy.
See:
Members
readonly boundingSphere : BoundingSphere
Gets the bounding sphere.
clippingPlanes : ClippingPlaneCollection
The
ClippingPlaneCollection
used to selectively disable rendering the primitive.
customShader : CustomShader
Gets or sets the custom shader. If undefined,
VoxelPrimitive.DefaultCustomShader
is set.
readonly customShaderCompilationEvent : Event
Gets an event that is raised whenever a custom shader is compiled.
Gets or sets whether or not to render debug visualizations.
Gets or sets whether or not to test against depth when rendering.
readonly dimensions : Cartesian3
Gets the voxel dimensions.
Gets or sets whether or not the primitive should update when the view changes.
maxBounds : Cartesian3
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
Gets or sets the maximum clipping location in the shape's local coordinate system.
Any voxel content outside the range is clipped.
Gets the maximum value per channel of the voxel data.
minBounds : Cartesian3
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
Gets or sets the minimum clipping location in the shape's local coordinate system.
Any voxel content outside the range is clipped.
Gets the minimum value per channel of the voxel data.
readonly modelMatrix : Matrix4
Gets the model matrix.
Gets or sets the nearest sampling.
readonly orientedBoundingBox : OrientedBoundingBox
Gets the oriented bounding box.
readonly provider : VoxelProvider
Gets the
VoxelProvider
associated with this primitive.
Gets a value indicating whether or not the primitive is ready for use.
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
Gets the shape type.
Gets or sets whether or not this primitive should be displayed.
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
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
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:
Returns true if this object was destroyed; otherwise, false.
If this object was destroyed, it should not be used; calling any function other than
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
.