CorridorGraphics

CorridorGraphics

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

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.

Gets or sets the CornerType Property specifying how corners are styled.

Default Value: CornerType.ROUNDED

readonlydefinitionChanged : Event DataSources/CorridorGraphics.js 88

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

distanceDisplayCondition : Property DataSources/CorridorGraphics.js 203

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

extrudedHeight : Property DataSources/CorridorGraphics.js 132

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 155