new CircleOutlineGeometry(options)
A description of the outline of a circle on the ellipsoid.
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Object with the following properties:
Properties
|
- Source:
- See:
-
- CircleOutlineGeometry.createGeometry
- Packable
Throws:
-
-
radius must be greater than zero.
- Type
- DeveloperError
-
-
-
granularity must be greater than zero.
- Type
- DeveloperError
-
Example
// Create a circle.
var circle = new Cesium.CircleOutlineGeometry({
center : Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883),
radius : 100000.0
});
var geometry = Cesium.CircleOutlineGeometry.createGeometry(circle);
Members
(static) packedLength :Number
The number of elements used to pack the object into an array.
Type:
- Number
- Source:
Methods
(static) createGeometry(circleGeometry) → {Geometry|undefined}
Computes the geometric representation of an outline of a circle on an ellipsoid, including its vertices, indices, and a bounding sphere.
Parameters:
Name | Type | Description |
---|---|---|
circleGeometry |
CircleOutlineGeometry | A description of the circle. |
- 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 |
CircleOutlineGeometry | 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) → {CircleOutlineGeometry}
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 |
CircleOutlineGeometry |
<optional> |
The object into which to store the result. |
- Source:
Returns:
The modified result parameter or a new CircleOutlineGeometry instance if one was not provided.