org.cesiumjs.cs.scene

Class GroundPrimitive

java.lang.Object

org.cesiumjs.cs.scene.Primitive

org.cesiumjs.cs.scene.GroundPrimitive

Direct Known Subclasses:

AbstractPrimitive

@JsType(isNative=true,
        namespace="Cesium",
        name="GroundPrimitive")
public class GroundPrimitive
extends Primitive

A ground primitive represents geometry draped over the terrain in the Scene. The geometry must be from a single GeometryInstance. Batching multiple geometries is not yet supported. A primitive combines the geometry instance with an Appearance that describes the full shading, including Material and RenderState. Roughly, the geometry instance defines the structure and placement, and the appearance defines the visual characteristics. Decoupling geometry and appearance allows us to mix and match most of them and add a new geometry or appearance independently of each other. Only the PerInstanceColorAppearance is supported at this time. For correct rendering, this feature requires the EXT_frag_depth WebGL extension. For hardware that do not support this extension, there will be rendering artifacts for some viewing angles.

Author:

Serge Silaev aka iSergio

See Also:

Primitive, ClassificationPrimitive, GeometryInstance, Appearance

Field Summary

Fields

Modifier and Type	Field and Description
Number	classificationType Determines whether terrain, 3D Tiles or both will be classified.
boolean	debugShowBoundingVolume This property is for debugging only; it is not for production use nor is it optimized.
boolean	debugShowShadowVolume This property is for debugging only; it is not for production use nor is it optimized.
boolean	show Determines if the primitive will be shown.

Fields inherited from class org.cesiumjs.cs.scene.Primitive

appearance, cull, geometryInstances, modelMatrix, shadows

Constructor Summary

Constructors

Constructor and Description
GroundPrimitive()
GroundPrimitive(GroundPrimitiveOptions options)

Method Summary

Modifier and Type	Method and Description
boolean	allowPicking() When true, each geometry instance will only be pickable with Scene#pick.
boolean	asynchronous() Determines if the geometry instances will be created and batched on a web worker.
boolean	compressVertices() When true, geometry vertices are compressed, which will save memory.
GeometryInstance[]	geometryInstances() The geometry instance rendered with this primitive.
static Promise<JsObject,Void>	initializeTerrainHeights() Initializes the minimum and maximum terrain heights.
boolean	interleave() Determines if geometry vertex attributes are interleaved, which can slightly improve rendering performance.
static boolean	isSupported(Scene scene) Determines if GroundPrimitive rendering is supported.
boolean	ready() Determines if the primitive is complete and ready to render.
Promise<Primitive,Void>	readyPromise() Gets a promise that resolves when the primitive is ready to render.
boolean	releaseGeometryInstances() When true, the primitive does not keep a reference to the input geometryInstances to save memory.
static boolean	supportsMaterials(Scene scene) Checks if the given Scene supports materials on GroundPrimitives.
boolean	vertexCacheOptimize() When true, geometry vertices are optimized for the pre and post-vertex-shader caches.

Methods inherited from class org.cesiumjs.cs.scene.Primitive

destroy, getGeometryInstanceAttributes, isDestroyed, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

classificationType

@JsProperty
public Number classificationType

Determines whether terrain, 3D Tiles or both will be classified. Default: ClassificationType.TERRAIN()

debugShowBoundingVolume

@JsProperty
public boolean debugShowBoundingVolume

This property is for debugging only; it is not for production use nor is it optimized. Draws the bounding sphere for each draw command in the primitive. Default: false

debugShowShadowVolume

@JsProperty
public boolean debugShowShadowVolume

This property is for debugging only; it is not for production use nor is it optimized. Draws the shadow volume for each geometry in the primitive.

show

@JsProperty
public boolean show

Determines if the primitive will be shown. This affects all geometry instances in the primitive. Default: true

Constructor Detail

GroundPrimitive

@JsConstructor
public GroundPrimitive()

GroundPrimitive

@JsConstructor
public GroundPrimitive(GroundPrimitiveOptions options)

Method Detail

allowPicking

@JsProperty(name="allowPicking")
public boolean allowPicking()

When true, each geometry instance will only be pickable with Scene#pick. When false, GPU memory is saved. Default: true

Overrides:

allowPicking in class Primitive

asynchronous

@JsProperty(name="asynchronous")
public boolean asynchronous()

Determines if the geometry instances will be created and batched on a web worker. Default: true

Overrides:

asynchronous in class Primitive

compressVertices

@JsProperty(name="compressVertices")
public boolean compressVertices()

When true, geometry vertices are compressed, which will save memory. Default: true

Overrides:

compressVertices in class Primitive

geometryInstances

@JsProperty(name="geometryInstances")
public GeometryInstance[] geometryInstances()

The geometry instance rendered with this primitive. This may be undefined if options.releaseGeometryInstances is true when the primitive is constructed. Changing this property after the primitive is rendered has no effect. Because of the rendering technique used, all geometry instances must be the same color. If there is an instance with a differing color, a DeveloperError will be thrown on the first attempt to render. Default: undefined

interleave

@JsProperty(name="interleave")
public boolean interleave()

Determines if geometry vertex attributes are interleaved, which can slightly improve rendering performance. Default: false

Overrides:

interleave in class Primitive

ready

@JsProperty(name="ready")
public boolean ready()

Determines if the primitive is complete and ready to render. If this property is true, the primitive will be rendered the next time that Primitive.update(Object) is called.

Overrides:

ready in class Primitive

readyPromise

@JsProperty(name="readyPromise")
public Promise<Primitive,Void> readyPromise()

Gets a promise that resolves when the primitive is ready to render.

Overrides:

readyPromise in class Primitive

releaseGeometryInstances

@JsProperty(name="releaseGeometryInstances")
public boolean releaseGeometryInstances()

When true, the primitive does not keep a reference to the input geometryInstances to save memory. Default: true

Overrides:

releaseGeometryInstances in class Primitive

vertexCacheOptimize

@JsProperty(name="vertexCacheOptimize")
public boolean vertexCacheOptimize()

When true, geometry vertices are optimized for the pre and post-vertex-shader caches. Default: true

Overrides:

vertexCacheOptimize in class Primitive

initializeTerrainHeights

@JsMethod
public static Promise<JsObject,Void> initializeTerrainHeights()

Initializes the minimum and maximum terrain heights. This only needs to be called if you are creating the GroundPrimitive synchronously.

Returns:

A promise that will resolve once the terrain heights have been loaded.

isSupported

@JsMethod
public static boolean isSupported(Scene scene)

Determines if GroundPrimitive rendering is supported.

Parameters:

scene - The scene.

Returns:

true if GroundPrimitives are supported; otherwise, returns false

supportsMaterials

@JsMethod
public static boolean supportsMaterials(Scene scene)

Checks if the given Scene supports materials on GroundPrimitives. Materials on GroundPrimitives require support for the WEBGL_depth_texture extension.

Parameters:

scene - The current scene.

Returns:

Whether or not the current scene supports materials on GroundPrimitives.