org.cesiumjs.cs.scene

Class ClassificationPrimitive

java.lang.Object

org.cesiumjs.cs.scene.Primitive

org.cesiumjs.cs.scene.ClassificationPrimitive

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

A classification primitive represents a volume enclosing geometry in the Scene to be highlighted. 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. Valid geometries are BoxGeometry, CylinderGeometry, EllipsoidGeometry, PolylineVolumeGeometry, and SphereGeometry. Geometries that follow the surface of the ellipsoid, such as CircleGeometry, CorridorGeometry, EllipseGeometry, PolygonGeometry, and RectangleGeometry, are also valid if they are extruded volumes; otherwise, they will not be rendered.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Number	classificationType Determines whether terrain, 3D Tiles or both will be classified.
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.
Appearance	depthFailAppearance The Appearance used to shade this primitive when it fails the depth test.
Matrix4	modelMatrix The 4x4 transformation matrix that transforms the primitive (all geometry instances) from model to world coordinates.
Number	shadows Determines whether this primitive casts or receives shadows from each light source.
boolean	show Determines if the primitive will be shown.

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

appearance, geometryInstances

Constructor Summary

Constructors

Constructor and Description
ClassificationPrimitive()
ClassificationPrimitive(ClassificationPrimitiveOptions 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 instances rendered with this primitive.
boolean	interleave() Determines if geometry vertex attributes are interleaved, which can slightly improve rendering performance.
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.
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.BOTH()

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

depthFailAppearance

@JsProperty
public Appearance depthFailAppearance

The Appearance used to shade this primitive when it fails the depth test. Each geometry instance is shaded with the same appearance. Some appearances, like PerInstanceColorAppearance allow giving each instance unique properties. When using an appearance that requires a color attribute, like PerInstanceColorAppearance, add a depthFailColor per-instance attribute instead. Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported, there may be artifacts. Default: undefined

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(org.cesiumjs.cs.core.Cartesian3). This property is only supported in 3D mode. Default: Matrix4.IDENTITY()

shadows

@JsProperty
public Number 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 Value: true

Constructor Detail

ClassificationPrimitive

@JsConstructor
public ClassificationPrimitive()

ClassificationPrimitive

@JsConstructor
public ClassificationPrimitive(ClassificationPrimitiveOptions 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 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

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 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