org.cesiumjs.cs.datasources.updater

Class GeometryUpdater

java.lang.Object

org.cesiumjs.cs.datasources.updater.GeometryUpdater

Direct Known Subclasses:

EllipseGeometryUpdater, EllipsoidGeometryUpdater, PlaneGeometryUpdater, PolygonGeometryUpdater, PolylineGeometryUpdater, RectangleGeometryUpdater, WallGeometryUpdater

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

Defines the interface for a geometry updater. A GeometryUpdater maps geometry defined as part of a Entity into Geometry instances. These instances are then visualized by GeometryVisualizer. This type defines an interface and cannot be instantiated directly.

Author:

Serge Silaev aka iSergio

See Also:

EllipseGeometryUpdater, EllipsoidGeometryUpdater, PolygonGeometryUpdater, PolylineGeometryUpdater, RectangleGeometryUpdater, WallGeometryUpdater

Constructor Summary

Constructors

Constructor and Description
GeometryUpdater(Entity entity, Scene scene)

Method Summary

Modifier and Type	Method and Description
DynamicGeometryUpdater	createDynamicUpdater(PrimitiveCollection primitives) Creates the dynamic updater to be used when isDynamic() is true.
GeometryInstance	createFillGeometryInstance(JulianDate time) Creates the geometry instance which represents the fill of the geometry.
GeometryInstance	createOutlineGeometryInstance(JulianDate time) Creates the geometry instance which represents the outline of the geometry.
void	destroy() Destroys and resources used by the object.
Property	distanceDisplayConditionProperty() Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this geometry will be displayed.
Entity	entity() Gets the entity associated with this geometry.
boolean	fillEnabled() Gets a value indicating if the geometry has a fill component.
MaterialProperty	fillMaterialProperty() Gets the material property used to fill the geometry.
boolean	geometryChanged() Gets an event that is raised whenever the public properties of this updater change.
boolean	hasConstantFill() Gets a value indicating if fill visibility varies with simulation time.
boolean	hasConstantOutline() Gets a value indicating if the geometry has an outline component.
boolean	isClosed() Gets a value indicating if the geometry is closed.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
boolean	isDynamic() Gets a value indicating if the geometry is time-varying.
boolean	isFilled(JulianDate time) Checks if the geometry is filled at the provided time.
boolean	isOutlineVisible(JulianDate time) Checks if the geometry is outlined at the provided time.
Property	outlineColorProperty() Gets the Color property for the geometry outline.
boolean	outlineEnabled() Gets a value indicating if the geometry has an outline component.
double	outlineWidth() Gets the constant with of the geometry outline, in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeometryUpdater

@JsConstructor
public GeometryUpdater(Entity entity,
                                      Scene scene)

Method Detail

distanceDisplayConditionProperty

@JsProperty(name="distanceDisplayConditionProperty")
public Property distanceDisplayConditionProperty()

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this geometry will be displayed.

entity

@JsProperty(name="entity")
public Entity entity()

Gets the entity associated with this geometry.

fillEnabled

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

Gets a value indicating if the geometry has a fill component.

fillMaterialProperty

@JsProperty(name="fillMaterialProperty")
public MaterialProperty fillMaterialProperty()

Gets the material property used to fill the geometry.

geometryChanged

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

Gets an event that is raised whenever the public properties of this updater change.

hasConstantFill

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

Gets a value indicating if fill visibility varies with simulation time.

hasConstantOutline

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

Gets a value indicating if the geometry has an outline component.

isClosed

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

Gets a value indicating if the geometry is closed. This property is only valid for static geometry.

isDynamic

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

Gets a value indicating if the geometry is time-varying. If true, all visualization is delegated to the DynamicGeometryUpdater returned by GeometryUpdater#createDynamicUpdater.

outlineColorProperty

@JsProperty(name="outlineColorProperty")
public Property outlineColorProperty()

Gets the Color property for the geometry outline.

outlineEnabled

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

Gets a value indicating if the geometry has an outline component.

outlineWidth

@JsProperty(name="outlineWidth")
public double outlineWidth()

Gets the constant with of the geometry outline, in pixels. This value is only valid if isDynamic is false.

createDynamicUpdater

@JsMethod
public DynamicGeometryUpdater createDynamicUpdater(PrimitiveCollection primitives)

Creates the dynamic updater to be used when isDynamic() is true.

Parameters:

primitives - The primitive collection to use.

Returns:

The dynamic updater used to update the geometry each frame.

createFillGeometryInstance

@JsMethod
public GeometryInstance createFillGeometryInstance(JulianDate time)

Creates the geometry instance which represents the fill of the geometry.

Parameters:

time - The time to use when retrieving initial attribute values.

Returns:

The geometry instance representing the filled portion of the geometry.

createOutlineGeometryInstance

@JsMethod
public GeometryInstance createOutlineGeometryInstance(JulianDate time)

Creates the geometry instance which represents the outline of the geometry.

Parameters:

time - The time to use when retrieving initial attribute values.

Returns:

The geometry instance representing the outline portion of the geometry.

destroy

@JsMethod
public void destroy()

Destroys and resources used by the object. Once an object is destroyed, it should not be used.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns true if this object was destroyed; otherwise, false.

Returns:

True if this object was destroyed; otherwise, false.

isFilled

@JsMethod
public boolean isFilled(JulianDate time)

Checks if the geometry is filled at the provided time.

Parameters:

time - The time for which to retrieve visibility.

Returns:

true if geometry is filled at the provided time, false otherwise.

isOutlineVisible

@JsMethod
public boolean isOutlineVisible(JulianDate time)

Checks if the geometry is outlined at the provided time.

Parameters:

time - The time for which to retrieve visibility.

Returns:

true if geometry is outlined at the provided time, false otherwise.