PolylineGeometry

new PolylineGeometry

A description of a polyline modeled as a line strip; the first two positions define a line segment, and each additional position defines a line segment from the previous position. The polyline is capable of displaying with a material.

Parameters:

Name	Type	Argument	Default	Description
`options.positions`	Array			An array of Cartesian3 defining the positions in the polyline as a line strip.
`options.width`	Number	<optional>	1.0	The width in pixels.
`options.colors`	Array	<optional>	undefined	An Array of Color defining the per vertex or per segment colors.
`options.colorsPerVertex`	Boolean	<optional>	false	A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices.

Throws:

DeveloperError : At least two positions are required.
DeveloperError : width must be greater than or equal to one.
DeveloperError : colors has an invalid length.

Example

// A polyline with two connected line segments
var polyline = new PolylineGeometry({
  positions : ellipsoid.cartographicArrayToCartesianArray([
    Cartographic.fromDegrees(0.0, 0.0),
    Cartographic.fromDegrees(5.0, 0.0),
    Cartographic.fromDegrees(5.0, 5.0)
  ]),
  width : 10.0
});
var geometry = PolylineGeometry.createGeometry(polyline);

See:

PolylineGeometry#createGeometry

Source:

/Source/Core/PolylineGeometry.js

Methods

<static> createGeometry

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

Parameters:

Name	Type	Description
`polylineGeometry`	PolylineGeometry	A description of the polyline.

Returns:

Geometry The computed vertices and indices.