Class: CorridorGeometry

CorridorGeometry

new CorridorGeometry(options)

A description of a corridor. Corridor geometry can be rendered with both Primitive and GroundPrimitive.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
positions Array.<Cartesian3> An array of positions that define the center of the corridor.
width Number The distance between the edges of the corridor in meters.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid to be used as a reference.
granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
height Number <optional>
 0 The distance in meters between the ellipsoid surface and the positions.
extrudedHeight Number <optional>
 The distance in meters between the ellipsoid surface and the extruded face.
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
cornerType CornerType <optional>
 CornerType.ROUNDED Determines the style of the corners.
Source:
See:
Example
var corridor = new Cesium.CorridorGeometry({
  vertexFormat : Cesium.VertexFormat.POSITION_ONLY,
  positions : Cesium.Cartesian3.fromDegreesArray([-72.0, 40.0, -70.0, 35.0]),
  width : 100000
});

Members

packedLength :Number

The number of elements used to pack the object into an array.
Type:
  • Number
Source:

Methods

(static) createGeometry(corridorGeometry) → {Geometry|undefined}

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.
Source:
Returns:
The computed vertices and indices.
Type
Geometry | undefined

(static) pack(value, array, startingIndexopt) → {Array.<Number>}

Stores the provided instance into the provided array.
Parameters:
Name Type Attributes Default Description
value CorridorGeometry The value to pack.
array Array.<Number> The array to pack into.
startingIndex Number <optional>
 0 The index into the array at which to start packing the elements.
Source:
Returns:
The array that was packed into
Type
Array.<Number>

(static) unpack(array, startingIndexopt, resultopt) → {CorridorGeometry}

Retrieves an instance from a packed array.
Parameters:
Name Type Attributes Default Description
array Array.<Number> The packed array.
startingIndex Number <optional>
 0 The starting index of the element to be unpacked.
result CorridorGeometry <optional>
 The object into which to store the result.
Source:
Returns:
The modified result parameter or a new CorridorGeometry instance if one was not provided.
Type
CorridorGeometry