CorridorGeometryUpdater

new Cesium.CorridorGeometryUpdater(entity, scene)
DataSources/CorridorGeometryUpdater.js 87

A GeometryUpdater for corridors. 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

staticCesium.CorridorGeometryUpdater.materialAppearanceType : Appearance
DataSources/CorridorGeometryUpdater.js 133

Gets the type of Appearance to use for material-based geometry.

staticCesium.CorridorGeometryUpdater.perInstanceColorAppearanceType : Appearance
DataSources/CorridorGeometryUpdater.js 125

Gets the type of Appearance to use for simple color-based geometry.

readonlydistanceDisplayConditionProperty : Property
DataSources/CorridorGeometryUpdater.js 262

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

readonlyentity : Entity
DataSources/CorridorGeometryUpdater.js 146

Gets the entity associated with this geometry.

readonlyfillEnabled : Boolean
DataSources/CorridorGeometryUpdater.js 158

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

readonlyfillMaterialProperty : MaterialProperty
DataSources/CorridorGeometryUpdater.js 185

Gets the material property used to fill the geometry.

readonlygeometryChanged : Boolean
DataSources/CorridorGeometryUpdater.js 314

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

readonlyhasConstantFill : Boolean
DataSources/CorridorGeometryUpdater.js 170

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

readonlyhasConstantOutline : Boolean
DataSources/CorridorGeometryUpdater.js 209

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

readonlyisClosed : Boolean
DataSources/CorridorGeometryUpdater.js 289

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

readonlyisDynamic : Boolean
DataSources/CorridorGeometryUpdater.js 276

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

readonlyonTerrain : Boolean
DataSources/CorridorGeometryUpdater.js 301

Gets a value indicating if the geometry should be drawn on terrain.

readonlyoutlineColorProperty : Property
DataSources/CorridorGeometryUpdater.js 224

Gets the Color property for the geometry outline.

readonlyoutlineEnabled : Boolean
DataSources/CorridorGeometryUpdater.js 197

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

readonlyoutlineWidth : Number
DataSources/CorridorGeometryUpdater.js 237

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

readonlyshadowsProperty : Property
DataSources/CorridorGeometryUpdater.js 250

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

Methods

createDynamicUpdater(primitives, groundPrimitives) → DynamicGeometryUpdater
DataSources/CorridorGeometryUpdater.js 560

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

createFillGeometryInstance(time) → GeometryInstance
DataSources/CorridorGeometryUpdater.js 351

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/CorridorGeometryUpdater.js 403

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/CorridorGeometryUpdater.js 443

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/CorridorGeometryUpdater.js 434

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

isFilled(time) → Boolean
DataSources/CorridorGeometryUpdater.js 338

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/CorridorGeometryUpdater.js 327

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.