CorridorGeometry

new CorridorGeometry

A description of a corridor.

Parameters:

Name	Type	Argument	Default	Description
`options.positions`	Array			An array of {Cartesain3} positions that define the center of the corridor.
`options.width`	Number			The distance between the edges of the corridor in meters.
`options.ellipsoid`	Ellipsoid	<optional>	Ellipsoid.WGS84	The ellipsoid to be used as a reference.
`options.granularity`	Number	<optional>	CesiumMath.RADIANS_PER_DEGREE	The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
`options.height`	Number	<optional>	0	The distance in meters between the ellipsoid surface and the positions.
`options.extrudedHeight`	Number	<optional>		The distance in meters between the ellipsoid surface and the extrusion.
`options.vertexFormat`	VertexFormat	<optional>	VertexFormat.DEFAULT	The vertex attributes to be computed.
`options.cornerType`	Boolean	<optional>	CornerType.ROUNDED	Determines the style of the corners.

Throws:

DeveloperError : options.positions is required.
DeveloperError : options.width is required.

Example

var corridor = new CorridorGeometry({
  vertexFormat : VertexFormat.POSITION_ONLY,
  positions : ellipsoid.cartographicArrayToCartesianArray([
        Cartographic.fromDegrees(-72.0, 40.0),
        Cartographic.fromDegrees(-70.0, 35.0)
    ]),
  width : 100000
});

See:

CorridorGeometry#createGeometry

Source:

/Source/Core/CorridorGeometry.js

Methods

<static> createGeometry

Computes the geometric representation of a corridor, including its vertices, indices, and a bounding sphere.

Parameters:

Name	Type	Description
`corridorGeometry`	CorridorGeometry	A description of the corridor.

Throws:

DeveloperError : Count of unique positions must be greater than 1.

Returns:

Geometry The computed vertices and indices.