new CorridorGraphics(optionsopt)
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.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
Object with the following properties:
Properties
|
- Source:
- See:
Members
cornerType :Property
Gets or sets the
CornerType Property specifying how corners are styled.
Type:
- Default Value:
- CornerType.ROUNDED
- Source:
(readonly) definitionChanged :Event
Gets the event that is raised whenever a property or sub-property is changed or modified.
Type:
- Source:
distanceDisplayCondition :Property
Gets or sets the
DistanceDisplayCondition Property specifying at what distance from the camera that this corridor will be displayed.
Type:
- Source:
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.
Type:
- Source:
fill :Property
Gets or sets the boolean Property specifying whether the corridor is filled with the provided material.
Type:
- Default Value:
- true
- Source:
granularity :Property
Gets or sets the numeric Property specifying the sampling distance between each latitude and longitude point.
Type:
- Default Value:
- {CesiumMath.RADIANS_PER_DEGREE}
- Source:
height :Property
Gets or sets the numeric Property specifying the altitude of the corridor.
Type:
- Default Value:
- 0.0
- Source:
material :MaterialProperty
Gets or sets the Property specifying the material used to fill the corridor.
Type:
- Default Value:
- Color.WHITE
- Source:
outline :Property
Gets or sets the Property specifying whether the corridor is outlined.
Type:
- Default Value:
- false
- Source:
outlineColor :Property
Gets or sets the Property specifying the
Color of the outline.
Type:
- Default Value:
- Color.BLACK
- Source:
outlineWidth :Property
Gets or sets the numeric Property specifying the width of the outline.
Type:
- Default Value:
- 1.0
- Source:
positions :Property
Gets or sets a Property specifying the array of
Cartesian3 positions that define the centerline of the corridor.
Type:
- Source:
shadows :Property
Get or sets the enum Property specifying whether the corridor
casts or receives shadows from each light source.
Type:
- Default Value:
- ShadowMode.DISABLED
- Source:
show :Property
Gets or sets the boolean Property specifying the visibility of the corridor.
Type:
- Default Value:
- true
- Source:
width :Property
Gets or sets the numeric Property specifying the width of the corridor.
Type:
- Source:
Methods
clone(resultopt) → {CorridorGraphics}
Duplicates this instance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
result |
CorridorGraphics |
<optional> |
The object onto which to store the result. |
- Source:
Returns:
The modified result parameter or a new instance if one was not provided.
- Type
- CorridorGraphics
merge(source)
Assigns each unassigned property on this object to the value
of the same property on the provided source object.
Parameters:
| Name | Type | Description |
|---|---|---|
source |
CorridorGraphics | The object to be merged into this object. |
- Source: