GeometryUpdater

new Cesium.GeometryUpdater(options)
engine/Source/DataSources/GeometryUpdater.js 41

An abstract class for updating geometry entities.
Name Type Description
options object An object with the following properties:
Name Type Description
entity Entity The entity containing the geometry to be visualized.
scene Scene The scene where visualization is taking place.
geometryOptions object Options for the geometry
geometryPropertyName string The geometry property name
observedPropertyNames Array.<string> The entity properties this geometry cares about

Members

readonly classificationTypeProperty : Property
engine/Source/DataSources/GeometryUpdater.js 228

Gets or sets the ClassificationType Property specifying if this geometry will classify terrain, 3D Tiles, or both when on the ground.

readonly distanceDisplayConditionProperty : Property
engine/Source/DataSources/GeometryUpdater.js 216

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

readonly entity : Entity
engine/Source/DataSources/GeometryUpdater.js 96

Gets the entity associated with this geometry.

readonly fillEnabled : boolean
engine/Source/DataSources/GeometryUpdater.js 108

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

readonly fillMaterialProperty : MaterialProperty
engine/Source/DataSources/GeometryUpdater.js 137

Gets the material property used to fill the geometry.

readonly geometryChanged : boolean
engine/Source/DataSources/GeometryUpdater.js 279

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

readonly hasConstantFill : boolean
engine/Source/DataSources/GeometryUpdater.js 120

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

readonly hasConstantOutline : boolean
engine/Source/DataSources/GeometryUpdater.js 161

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

readonly id : string
engine/Source/DataSources/GeometryUpdater.js 84

Gets the unique ID associated with this updater

readonly isClosed : boolean
engine/Source/DataSources/GeometryUpdater.js 254

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

readonly isDynamic : boolean
engine/Source/DataSources/GeometryUpdater.js 241

Gets a value indicating if the geometry is time-varying.

readonly outlineColorProperty : Property
engine/Source/DataSources/GeometryUpdater.js 178

Gets the Color property for the geometry outline.

readonly outlineEnabled : boolean
engine/Source/DataSources/GeometryUpdater.js 149

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

readonly outlineWidth : number
engine/Source/DataSources/GeometryUpdater.js 191

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

readonly shadowsProperty : Property
engine/Source/DataSources/GeometryUpdater.js 204

Gets the property specifying whether the geometry casts or receives shadows from light sources.

Methods

createFillGeometryInstance(time) → GeometryInstance
engine/Source/DataSources/GeometryUpdater.js 327

Creates the geometry instance which represents the fill of the geometry.
Name Type Description
time JulianDate The time to use when retrieving initial attribute values.
Returns:
The geometry instance representing the filled portion of the geometry.
Throws:
  • DeveloperError : This instance does not represent a filled geometry.

createOutlineGeometryInstance(time) → GeometryInstance
engine/Source/DataSources/GeometryUpdater.js 339

Creates the geometry instance which represents the outline of the geometry.
Name Type Description
time JulianDate The time to use when retrieving initial attribute values.
Returns:
The geometry instance representing the outline portion of the geometry.
Throws:
  • DeveloperError : This instance does not represent an outlined geometry.

destroy()
engine/Source/DataSources/GeometryUpdater.js 356

Destroys and resources used by the object. Once an object is destroyed, it should not be used.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.

isDestroyed() → boolean
engine/Source/DataSources/GeometryUpdater.js 347

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

isFilled(time) → boolean
engine/Source/DataSources/GeometryUpdater.js 308

Checks if the geometry is filled at the provided time.
Name Type Description
time JulianDate The time for which to retrieve visibility.
Returns:
true if geometry is filled at the provided time, false otherwise.

isOutlineVisible(time) → boolean
engine/Source/DataSources/GeometryUpdater.js 292

Checks if the geometry is outlined at the provided time.
Name Type Description
time JulianDate The time for which to retrieve visibility.
Returns:
true if geometry is outlined at the provided time, false otherwise.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets