new SimplePolylineGeometry(options)
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.
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Object with the following properties:
Properties
|
- Source:
- See:
-
- SimplePolylineGeometry#createGeometry
Throws:
-
-
At least two positions are required.
- Type
- DeveloperError
-
-
-
colors has an invalid length.
- Type
- DeveloperError
-
Example
// A polyline with two connected line segments
var polyline = new Cesium.SimplePolylineGeometry({
positions : Cesium.Cartesian3.fromDegreesArray([
0.0, 0.0,
5.0, 0.0,
5.0, 5.0
])
});
var geometry = Cesium.SimplePolylineGeometry.createGeometry(polyline);
Members
packedLength :Number
The number of elements used to pack the object into an array.
Type:
- Number
- Source:
Methods
(static) createGeometry(simplePolylineGeometry) → {Geometry}
Computes the geometric representation of a simple polyline, including its vertices, indices, and a bounding sphere.
Parameters:
Name | Type | Description |
---|---|---|
simplePolylineGeometry |
SimplePolylineGeometry | A description of the polyline. |
- Source:
Returns:
The computed vertices and indices.
- Type
- Geometry
(static) pack(value, array, startingIndexopt) → {Array.<Number>}
Stores the provided instance into the provided array.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
value |
SimplePolylineGeometry | 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) → {SimplePolylineGeometry}
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 |
SimplePolylineGeometry |
<optional> |
The object into which to store the result. |
- Source:
Returns:
The modified result parameter or a new SimplePolylineGeometry instance if one was not provided.