kotlin-cesium-engine/cesium.engine/VoxelPrimitive

VoxelPrimitive

external class VoxelPrimitive(options: VoxelPrimitive.ConstructorOptions? = definedExternally)(source)

A primitive that renders voxel data from a VoxelProvider.

See also

Online Documentation

Constructors

constructor(options: VoxelPrimitive.ConstructorOptions? = definedExternally)

Types

ConstructorOptions

sealed interface ConstructorOptions

Properties

val boundingSphere: BoundingSphere

Gets the bounding sphere.

var clippingPlanes: ClippingPlaneCollection

The ClippingPlaneCollection used to selectively disable rendering the primitive.

var customShader: CustomShader

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

customShaderCompilationEvent

val customShaderCompilationEvent: DefaultEvent

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

var debugDraw: Boolean

Gets or sets whether or not to render debug visualizations.

var depthTest: Boolean

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

val dimensions: Cartesian3

Gets the voxel dimensions.

var disableUpdate: Boolean

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

var 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

var maxClippingBounds: Cartesian3

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

val maximumValues: ReadonlyArray<ReadonlyArray<Double>>

Gets the maximum value per channel of the voxel data.

var 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

var minClippingBounds: Cartesian3

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

val minimumValues: ReadonlyArray<ReadonlyArray<Double>>

Gets the minimum value per channel of the voxel data.

val modelMatrix: Matrix4

Gets the model matrix.

nearestSampling

var nearestSampling: Boolean

Gets or sets the nearest sampling.

orientedBoundingBox

val orientedBoundingBox: OrientedBoundingBox

Gets the oriented bounding box.

val provider: VoxelProvider

Gets the VoxelProvider associated with this primitive.

val ready: Boolean

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

screenSpaceError

var screenSpaceError: Int

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.

val shape: VoxelShapeType

Gets the shape type.

var show: Boolean

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

var stepSize: Double

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.

Functions

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.

fun isDestroyed(): Boolean

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