org.cesiumjs.cs.scene

Class TimeDynamicPointCloud

java.lang.Object

org.cesiumjs.cs.scene.TimeDynamicPointCloud

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

Provides playback of time-dynamic point cloud data. Point cloud frames are prefetched in intervals determined by the average frame load time and the current clock speed. If intermediate frames cannot be loaded in time to meet playback speed, they will be skipped. If frames are sufficiently small or the clock is sufficiently slow then no frames will be skipped.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
ClippingPlaneCollection	clippingPlanes The ClippingPlaneCollection used to selectively disable rendering the point cloud.
Event	frameChanged The event fired to indicate that a new frame was rendered.
Event	frameFailed The event fired to indicate that a frame failed to load.
int	maximumMemoryUsage The maximum amount of GPU memory (in MB) that may be used to cache point cloud frames.
Matrix4	modelMatrix A 4x4 transformation matrix that transforms the point cloud.
PointCloudShading	shading Options for controlling point size based on geometric error and eye dome lighting.
Number	shadows Determines whether the point cloud casts or receives shadows from each light source.
boolean	show Determines if the point cloud will be shown.
Cesium3DTileStyle	style The style, defined using the 3D Tiles Styling language, applied to each point in the point cloud.

Constructor Summary

Constructors

Constructor and Description
TimeDynamicPointCloud(TimeDynamicPointCloudOptions options)

Method Summary

Modifier and Type	Method and Description
BoundingSphere	boundingSphere() The bounding sphere of the frame being rendered.
void	destroy() Destroys the WebGL resources held by this object.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
void	makeStyleDirty() Marks the point cloud's TimeDynamicPointCloud#style as dirty, which forces all points to re-evaluate the style in the next frame.
Promise<TimeDynamicPointCloud,Void>	readyPromise() Gets the promise that will be resolved when the point cloud renders a frame for the first time.
int	totalMemoryUsageInBytes() The total amount of GPU memory in bytes used by the point cloud.

Methods inherited from class java.lang.Object

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

Field Detail

clippingPlanes

@JsProperty
public ClippingPlaneCollection clippingPlanes

The ClippingPlaneCollection used to selectively disable rendering the point cloud.

frameChanged

@JsProperty
public Event frameChanged

The event fired to indicate that a new frame was rendered. The time dynamic point cloud TimeDynamicPointCloud is passed to the event listener. Default: new Event()

frameFailed

@JsProperty
public Event frameFailed

The event fired to indicate that a frame failed to load. A frame may fail to load if the request for its uri fails or processing fails due to invalid content. If there are no event listeners, error messages will be logged to the console. The error object passed to the listener contains two properties: uri: the uri of the failed frame. message: the error message. Default: new Event()

maximumMemoryUsage

@JsProperty
public int maximumMemoryUsage

The maximum amount of GPU memory (in MB) that may be used to cache point cloud frames. Frames that are not being loaded or rendered are unloaded to enforce this. If decreasing this value results in unloading tiles, the tiles are unloaded the next frame. Default: 256

modelMatrix

@JsProperty
public Matrix4 modelMatrix

A 4x4 transformation matrix that transforms the point cloud. Default: Matrix4.IDENTITY()

shading

@JsProperty
public PointCloudShading shading

Options for controlling point size based on geometric error and eye dome lighting.

shadows

@JsProperty
public Number shadows

Determines whether the point cloud casts or receives shadows from each light source. Enabling shadows has a performance impact. A point cloud that casts shadows must be rendered twice, once from the camera and again from the light's point of view. Shadows are rendered only when Viewer#shadows is true. Default: ShadowMode.ENABLED()

show

@JsProperty
public boolean show

Determines if the point cloud will be shown. Default: true

style

@JsProperty
public Cesium3DTileStyle style

The style, defined using the 3D Tiles Styling language, applied to each point in the point cloud. Assign undefined to remove the style, which will restore the visual appearance of the point cloud to its default when no style was applied.

Constructor Detail

TimeDynamicPointCloud

@JsConstructor
public TimeDynamicPointCloud(TimeDynamicPointCloudOptions options)

Method Detail

boundingSphere

@JsProperty(name="boundingSphere")
public BoundingSphere boundingSphere()

The bounding sphere of the frame being rendered. Returns undefined if no frame is being rendered.

readyPromise

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

Gets the promise that will be resolved when the point cloud renders a frame for the first time.

totalMemoryUsageInBytes

@JsProperty(name="totalMemoryUsageInBytes")
public int totalMemoryUsageInBytes()

The total amount of GPU memory in bytes used by the point cloud.

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.

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.

makeStyleDirty

@JsMethod
public void makeStyleDirty()

Marks the point cloud's TimeDynamicPointCloud#style as dirty, which forces all points to re-evaluate the style in the next frame.