CorridorGraphics

new Cesium.CorridorGraphics(options)
DataSources/CorridorGraphics.js 46

Describes a corridor, which is a shape defined by a centerline and width that conforms to the curvature of the globe. It can be placed on the surface or at altitude and can optionally be extruded into a volume.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
positions Property optional A Property specifying the array of Cartesian3 positions that define the centerline of the corridor.
width Property optional A numeric Property specifying the distance between the edges of the corridor.
cornerType Property CornerType.ROUNDED optional A CornerType Property specifying the style of the corners.
height Property 0 optional A numeric Property specifying the altitude of the corridor relative to the ellipsoid surface.
extrudedHeight Property optional A numeric Property specifying the altitude of the corridor's extruded face relative to the ellipsoid surface.
show Property true optional A boolean Property specifying the visibility of the corridor.
fill Property true optional A boolean Property specifying whether the corridor is filled with the provided material.
material MaterialProperty Color.WHITE optional A Property specifying the material used to fill the corridor.
outline Property false optional A boolean Property specifying whether the corridor is outlined.
outlineColor Property Color.BLACK optional A Property specifying the Color of the outline.
outlineWidth Property 1.0 optional A numeric Property specifying the width of the outline.
granularity Property Cesium.Math.RADIANS_PER_DEGREE optional A numeric Property specifying the distance between each latitude and longitude.
shadows Property ShadowMode.DISABLED optional An enum Property specifying whether the corridor casts or receives shadows from each light source.
distanceDisplayCondition Property optional A Property specifying at what distance from the camera that this corridor will be displayed.
Demo:
See:

Members

classificationType : Property
DataSources/CorridorGraphics.js 212

Gets or sets the ClassificationType Property specifying whether this corridor will classify terrain, 3D Tiles, or both when on the ground.
Default Value: ClassificationType.BOTH

cornerType : Property
DataSources/CorridorGraphics.js 188

Gets or sets the CornerType Property specifying how corners are styled.
Default Value: CornerType.ROUNDED

readonlydefinitionChanged : Event
DataSources/CorridorGraphics.js 89

Gets the event that is raised whenever a property or sub-property is changed or modified.

distanceDisplayCondition : Property
DataSources/CorridorGraphics.js 204

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

extrudedHeight : Property
DataSources/CorridorGraphics.js 133

Gets or sets the numeric Property specifying the altitude of the corridor extrusion. Setting this property creates a corridor shaped volume starting at height and ending at this altitude.

fill : Property
DataSources/CorridorGraphics.js 156

Gets or sets the boolean Property specifying whether the corridor is filled with the provided material.
Default Value: true

granularity : Property
DataSources/CorridorGraphics.js 141

Gets or sets the numeric Property specifying the sampling distance between each latitude and longitude point.
Default Value: {CesiumMath.RADIANS_PER_DEGREE}

height : Property
DataSources/CorridorGraphics.js 124

Gets or sets the numeric Property specifying the altitude of the corridor.
Default Value: 0.0

material : MaterialProperty
DataSources/CorridorGraphics.js 109

Gets or sets the Property specifying the material used to fill the corridor.
Default Value: Color.WHITE

outline : Property
DataSources/CorridorGraphics.js 164

Gets or sets the Property specifying whether the corridor is outlined.
Default Value: false

outlineColor : Property
DataSources/CorridorGraphics.js 172

Gets or sets the Property specifying the Color of the outline.
Default Value: Color.BLACK

outlineWidth : Property
DataSources/CorridorGraphics.js 180

Gets or sets the numeric Property specifying the width of the outline.
Default Value: 1.0

positions : Property
DataSources/CorridorGraphics.js 116

Gets or sets a Property specifying the array of Cartesian3 positions that define the centerline of the corridor.

shadows : Property
DataSources/CorridorGraphics.js 197

Get or sets the enum Property specifying whether the corridor casts or receives shadows from each light source.
Default Value: ShadowMode.DISABLED

show : Property
DataSources/CorridorGraphics.js 101

Gets or sets the boolean Property specifying the visibility of the corridor.
Default Value: true

width : Property
DataSources/CorridorGraphics.js 148

Gets or sets the numeric Property specifying the width of the corridor.

Methods

clone(result) → CorridorGraphics
DataSources/CorridorGraphics.js 221

Duplicates this instance.
Name Type Description
result CorridorGraphics optional The object onto which to store the result.
Returns:
The modified result parameter or a new instance if one was not provided.

merge(source)
DataSources/CorridorGraphics.js 249

Assigns each unassigned property on this object to the value of the same property on the provided source object.
Name Type Description
source CorridorGraphics The object to be merged into this object.