org.cesiumjs.cs.scene

Class GroundPolylinePrimitive

java.lang.Object

org.cesiumjs.cs.scene.GroundPolylinePrimitive

@JsType(isNative=true,
        namespace="Cesium",
        name="GroundPolylinePrimitive")
public class GroundPolylinePrimitive
extends Object

A GroundPolylinePrimitive represents a polyline draped over the terrain in the Scene. Only to be used with GeometryInstances containing GroundPolylineGeometry.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Appearance	appearance The Appearance used to shade this primitive.
ClassificationType	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	show Determines if the primitive will be shown.

Constructor Summary

Constructors

Constructor and Description
GroundPolylinePrimitive()
GroundPolylinePrimitive(GroundPolylinePrimitiveOptions options)

Method Summary

Modifier and Type	Method and Description
boolean	allowPicking() When true, each geometry instance will only be pickable with Scene.pick(Cartesian2).
boolean	asynchronous() Determines if the geometry instances will be created and batched on a web worker.
boolean	debugShowShadowVolume() This property is for debugging only; it is not for production use nor is it optimized.
void	destroy() Destroys the WebGL resources held by this object.
GeometryInstance[]	geometryInstances() The geometry instances rendered with this primitive.
JsObject	getGeometryInstanceAttributes(JsObject id) Returns the modifiable per-instance attributes for a GeometryInstance.
static Promise<Void,Void>	initializeTerrainHeights() Initializes the minimum and maximum terrain heights.
boolean	interleave() Determines if geometry vertex attributes are interleaved, which can slightly improve rendering performance.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
static boolean	isSupported(Scene scene) Checks if the given Scene supports GroundPolylinePrimitives.
boolean	ready() Determines if the primitive is complete and ready to render.
Promise<GroundPolylinePrimitive,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.
void	update() Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Methods inherited from class java.lang.Object

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

Field Detail

appearance

@JsProperty
public Appearance appearance

The Appearance used to shade this primitive. Each geometry instance is shaded with the same appearance. Some appearances, like PolylineColorAppearance allow giving each instance unique properties. Default: undefined

classificationType

@JsProperty
public ClassificationType classificationType

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

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

show

@JsProperty
public boolean show

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

Constructor Detail

GroundPolylinePrimitive

@JsConstructor
public GroundPolylinePrimitive()

GroundPolylinePrimitive

@JsConstructor
public GroundPolylinePrimitive(GroundPolylinePrimitiveOptions options)

Method Detail

allowPicking

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

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

asynchronous

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

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

debugShowShadowVolume

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

This property is for debugging only; it is not for production use nor is it optimized. If true, draws the shadow volume for each geometry in the primitive. Default: false

geometryInstances

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

The geometry instances 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. Default: undefined

interleave

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

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

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 update() is called.

readyPromise

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

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

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

initializeTerrainHeights

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

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

Returns:

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

isSupported

@JsMethod
public static boolean isSupported(Scene scene)

Checks if the given Scene supports GroundPolylinePrimitives. GroundPolylinePrimitives require support for the WEBGL_depth_texture extension.

Parameters:

scene - The current scene.

Returns:

Whether or not the current scene supports GroundPolylinePrimitives.

destroy

@JsMethod
public void destroy()

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.

getGeometryInstanceAttributes

@JsMethod
public JsObject getGeometryInstanceAttributes(JsObject id)

Returns the modifiable per-instance attributes for a GeometryInstance.

Parameters:

id - The id of the GeometryInstance.

Returns:

The typed array in the attribute's format or undefined if the is no instance with id. Example: JsObject attributes = primitive.getGeometryInstanceAttributes('an id'); attributes.setProperty("color", Cesium.ColorGeometryInstanceAttribute.toValue(Cesium.Color.AQUA)); attributes.setProperty("show", Cesium.ShowGeometryInstanceAttribute.toValue(true));

isDestroyed

@JsMethod
public boolean isDestroyed()

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.

update

@JsMethod
public void update()

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive. Do not call this function directly. This is documented just to list the exceptions that may be propagated when the scene is rendered: