PolylineGeometryUpdater

new Cesium.PolylineGeometryUpdater(entity, scene)
DataSources/PolylineGeometryUpdater.js 105

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

readonlyarcType : ArcType
DataSources/PolylineGeometryUpdater.js 323

Gets a value indicating if the path of the line.

readonlyclampToGround : Boolean
DataSources/PolylineGeometryUpdater.js 337

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

readonlyclassificationTypeProperty : Property
DataSources/PolylineGeometryUpdater.js 272

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

readonlydepthFailMaterialProperty : MaterialProperty
DataSources/PolylineGeometryUpdater.js 205

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

readonlydistanceDisplayConditionProperty : Property
DataSources/PolylineGeometryUpdater.js 260

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

readonlyentity : Entity
DataSources/PolylineGeometryUpdater.js 157

Gets the entity associated with this geometry.

readonlyfillEnabled : Boolean
DataSources/PolylineGeometryUpdater.js 169

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

readonlyfillMaterialProperty : MaterialProperty
DataSources/PolylineGeometryUpdater.js 193

Gets the material property used to fill the geometry.

readonlygeometryChanged : Boolean
DataSources/PolylineGeometryUpdater.js 310

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

readonlyhasConstantFill : Boolean
DataSources/PolylineGeometryUpdater.js 181

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

readonlyhasConstantOutline : Boolean
DataSources/PolylineGeometryUpdater.js 227

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

readonlyid : String
DataSources/PolylineGeometryUpdater.js 145

Gets the unique ID associated with this updater

readonlyisClosed : Boolean
DataSources/PolylineGeometryUpdater.js 299

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

readonlyisDynamic : Boolean
DataSources/PolylineGeometryUpdater.js 286

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

readonlyoutlineColorProperty : Property
DataSources/PolylineGeometryUpdater.js 237

Gets the Color property for the geometry outline.

readonlyoutlineEnabled : Boolean
DataSources/PolylineGeometryUpdater.js 217

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

readonlyshadowsProperty : Property
DataSources/PolylineGeometryUpdater.js 248

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

readonlyzIndex : Number
DataSources/PolylineGeometryUpdater.js 349

Gets the zindex

Methods

createDynamicUpdater(primitives, groundPrimitives) → DynamicGeometryUpdater
DataSources/PolylineGeometryUpdater.js 581

Creates the dynamic updater to be used when GeometryUpdater#isDynamic is true.
Name Type Description
primitives PrimitiveCollection The primitive collection to use.
groundPrimitives PrimitiveCollection | OrderedGroundPrimitiveCollection The primitive collection to use for ordered ground primitives.
Returns:
The dynamic updater used to update the geometry each frame.
Throws:

createFillGeometryInstance(time) → GeometryInstance
DataSources/PolylineGeometryUpdater.js 386

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

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()
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
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
DataSources/PolylineGeometryUpdater.js 372

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

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.