Class: CircleGeometry

CircleGeometry

new CircleGeometry(options)

A description of a circle on the ellipsoid. Circle 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
center Cartesian3 The circle's center point in the fixed frame.
radius Number The radius in meters.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid the circle will be on.
height Number <optional>
 0.0 The distance in meters between the circle and the ellipsoid surface.
granularity Number <optional>
 0.02 The angular distance between points on the circle in radians.
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
extrudedHeight Number <optional>
 0.0 The distance in meters between the circle's extruded face and the ellipsoid surface.
stRotation Number <optional>
 0.0 The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
Source:
See:
Throws:
Example
// Create a circle.
var circle = new Cesium.CircleGeometry({
  center : Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883),
  radius : 100000.0
});
var geometry = Cesium.CircleGeometry.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 a circle on an ellipsoid, including its vertices, indices, and a bounding sphere.
Parameters:
Name Type Description
circleGeometry CircleGeometry 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 CircleGeometry 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) → {CircleGeometry}

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 CircleGeometry <optional>
 The object into which to store the result.
Source:
Returns:
The modified result parameter or a new CircleGeometry instance if one was not provided.
Type
CircleGeometry