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:
|
Demo:
See:
Members
classificationType : Property
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
Gets or sets the
CornerType Property specifying how corners are styled.
-
Default Value:
CornerType.ROUNDED
readonlydefinitionChanged : Event
Gets the event that is raised whenever a property or sub-property is changed or modified.
distanceDisplayCondition : Property
Gets or sets the
DistanceDisplayCondition Property specifying at what distance from the camera that this corridor will be displayed.
extrudedHeight : Property
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.
extrudedHeightReference : Property
Gets or sets the Property specifying the extruded
HeightReference.
-
Default Value:
HeightReference.NONE
Gets or sets the boolean Property specifying whether the corridor is filled with the provided material.
-
Default Value:
true
granularity : Property
Gets or sets the numeric Property specifying the sampling distance between each latitude and longitude point.
-
Default Value:
{CesiumMath.RADIANS_PER_DEGREE}
Gets or sets the numeric Property specifying the altitude of the corridor.
-
Default Value:
0.0
heightReference : Property
Gets or sets the Property specifying the
HeightReference.
-
Default Value:
HeightReference.NONE
Gets or sets the Property specifying the material used to fill the corridor.
-
Default Value:
Color.WHITE
outline : Property
Gets or sets the Property specifying whether the corridor is outlined.
-
Default Value:
false
outlineColor : Property
Gets or sets the Property specifying the
Color of the outline.
-
Default Value:
Color.BLACK
outlineWidth : Property
Gets or sets the numeric Property specifying the width of the outline.
-
Default Value:
1.0
positions : Property
Gets or sets a Property specifying the array of
Cartesian3 positions that define the centerline of the corridor.
shadows : Property
Get or sets the enum Property specifying whether the corridor
casts or receives shadows from each light source.
-
Default Value:
ShadowMode.DISABLED
Gets or sets the boolean Property specifying the visibility of the corridor.
-
Default Value:
true
Gets or sets the numeric Property specifying the width of the corridor.
Gets or sets the zIndex Property specifying the ordering of the corridor. Only has an effect if the coridor is static and neither height or exturdedHeight are specified.
-
Default Value:
0
Methods
clone(result) → CorridorGraphics
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.
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. |