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.
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
Object with the following properties:
|
Throws:
-
DeveloperError : At least two positions are required.
-
DeveloperError : width must be greater than or equal to one.
-
DeveloperError : colors has an invalid length.
- PolylineGeometry#createGeometry
Example:
// A polyline with two connected line segments
const polyline = new Cesium.PolylineGeometry({
positions : Cesium.Cartesian3.fromDegreesArray([
0.0, 0.0,
5.0, 0.0,
5.0, 5.0
]),
width : 10.0
});
const geometry = Cesium.PolylineGeometry.createGeometry(polyline);
Demo:
See:
Members
The number of elements used to pack the object into an array.
Methods
static Cesium.PolylineGeometry.createGeometry(polylineGeometry) → Geometry|undefined
Computes the geometric representation of a polyline, including its vertices, indices, and a bounding sphere.
Name | Type | Description |
---|---|---|
polylineGeometry |
PolylineGeometry | A description of the polyline. |
Returns:
The computed vertices and indices.
Stores the provided instance into the provided array.
Name | Type | Default | Description |
---|---|---|---|
value |
PolylineGeometry | The value to pack. | |
array |
Array.<number> | The array to pack into. | |
startingIndex |
number |
0
|
optional The index into the array at which to start packing the elements. |
Returns:
The array that was packed into
static Cesium.PolylineGeometry.unpack(array, startingIndex, result) → PolylineGeometry
Retrieves an instance from a packed array.
Name | Type | Default | Description |
---|---|---|---|
array |
Array.<number> | The packed array. | |
startingIndex |
number |
0
|
optional The starting index of the element to be unpacked. |
result |
PolylineGeometry | optional The object into which to store the result. |
Returns:
The modified result parameter or a new PolylineGeometry instance if one was not provided.