PolylineGeometryUpdater

new Cesium.PolylineGeometryUpdater(entity, scene)
engine/Source/DataSources/PolylineGeometryUpdater.js 71

A GeometryUpdater for polylines. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Name Type Description
entity Entity The entity containing the geometry to be visualized.
scene Scene The scene where visualization is taking place.

Members

readonly arcType : ArcType
engine/Source/DataSources/PolylineGeometryUpdater.js 295

Gets a value indicating if the path of the line.

readonly clampToGround : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 309

Gets a value indicating if the geometry is clamped to the ground. Returns false if polylines on terrain is not supported.

readonly classificationTypeProperty : Property
engine/Source/DataSources/PolylineGeometryUpdater.js 245

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

readonly depthFailMaterialProperty : MaterialProperty
engine/Source/DataSources/PolylineGeometryUpdater.js 178

Gets the material property used to fill the geometry when it fails the depth test.

readonly distanceDisplayConditionProperty : Property
engine/Source/DataSources/PolylineGeometryUpdater.js 233

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/PolylineGeometryUpdater.js 126

Gets the entity associated with this geometry.

readonly fillEnabled : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 138

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

readonly fillMaterialProperty : MaterialProperty
engine/Source/DataSources/PolylineGeometryUpdater.js 166

Gets the material property used to fill the geometry.

readonly geometryChanged : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 282

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

readonly hasConstantFill : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 150

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

readonly hasConstantOutline : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 200

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

readonly id : string
engine/Source/DataSources/PolylineGeometryUpdater.js 114

Gets the unique ID associated with this updater

readonly isClosed : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 271

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

readonly isDynamic : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 258

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

readonly outlineColorProperty : Property
engine/Source/DataSources/PolylineGeometryUpdater.js 210

Gets the Color property for the geometry outline.

readonly outlineEnabled : boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 190

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

readonly shadowsProperty : Property
engine/Source/DataSources/PolylineGeometryUpdater.js 221

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

readonly zIndex : number
engine/Source/DataSources/PolylineGeometryUpdater.js 321

Gets the zindex

Methods

createFillGeometryInstance(time) → GeometryInstance
engine/Source/DataSources/PolylineGeometryUpdater.js 361

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/PolylineGeometryUpdater.js 448

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/PolylineGeometryUpdater.js 472

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/PolylineGeometryUpdater.js 463

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

isFilled(time) → boolean
engine/Source/DataSources/PolylineGeometryUpdater.js 344

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/PolylineGeometryUpdater.js 334

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