org.cesiumjs.cs.scene

Class Primitive

java.lang.Object

org.cesiumjs.cs.scene.Primitive

Direct Known Subclasses:

ClassificationPrimitive, DebugModelMatrixPrimitive, GroundPrimitive

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Appearance	appearance The Appearance used to shade this primitive.
boolean	cull When true, the renderer frustum culls and horizon culls the primitive's commands based on their bounding volume.
boolean	debugShowBoundingVolume This property is for debugging only; it is not for production use nor is it optimized.
GeometryInstance[]	geometryInstances The geometry instances rendered with this primitive.
Matrix4	modelMatrix The 4x4 transformation matrix that transforms the primitive (all geometry instances) from model to world coordinates.
int	shadows Determines whether this primitive casts or receives shadows from each light source.
boolean	show Determines if the primitive will be shown.

Constructor Summary

Constructors

Constructor and Description
Primitive()
Primitive(PrimitiveOptions 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.
void	destroy() Destroys the WebGL resources held by this object.
Object	getGeometryInstanceAttributes(Object id) Returns the modifiable per-instance attributes for a GeometryInstance.
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.
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.
void	update(Object frameState) Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.
boolean	vertexCacheOptimize() When true, geometry vertices are optimized for the pre and post-vertex-shader caches.

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 PerInstanceColorAppearance allow giving each instance unique properties.

cull

@JsProperty
public boolean cull

When true, the renderer frustum culls and horizon culls the primitive's commands based on their bounding volume. Set this to false for a small performance gain if you are manually culling the primitive. Default: true

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

geometryInstances

@JsProperty
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.

modelMatrix

@JsProperty
public Matrix4 modelMatrix

The 4x4 transformation matrix that transforms the primitive (all geometry instances) from model to world coordinates. When this is the identity matrix, the primitive is drawn in world coordinates, i.e., Earth's WGS84 coordinates. Local reference frames can be used by providing a different transformation matrix, like that returned by Transforms.eastNorthUpToFixedFrame. This property is only supported in 3D mode. Default: Matrix4.IDENTITY()

shadows

@JsProperty
public int shadows

Determines whether this primitive casts or receives shadows from each light source. Default ShadowMode.DISABLED()

show

@JsProperty
public boolean show

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

Constructor Detail

Primitive

@JsConstructor
public Primitive()

Primitive

@JsConstructor
public Primitive(PrimitiveOptions 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

asynchronous

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

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

compressVertices

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

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

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 Primitive#update is called.

readyPromise

@JsProperty(name="readyPromise")
public Promise<Primitive,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

vertexCacheOptimize

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

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

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.

See Also:

isDestroyed()

getGeometryInstanceAttributes

@JsMethod
public Object getGeometryInstanceAttributes(Object 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.

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.

See Also:

destroy()

update

@JsMethod
public void update(Object frameState)

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: