Class: EllipseGeometry

EllipseGeometry

new EllipseGeometry(options)

A description of an ellipse on an ellipsoid. Ellipse 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 ellipse's center point in the fixed frame.
semiMajorAxis Number The length of the ellipse's semi-major axis in meters.
semiMinorAxis Number The length of the ellipse's semi-minor axis in meters.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid the ellipse will be on.
height Number <optional>
 0.0 The distance in meters between the ellipse and the ellipsoid surface.
extrudedHeight Number <optional>
 The distance in meters between the ellipse's extruded face and the ellipsoid surface.
rotation Number <optional>
 0.0 The angle of rotation counter-clockwise from north.
stRotation Number <optional>
 0.0 The rotation of the texture coordinates counter-clockwise from north.
granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The angular distance between points on the ellipse in radians.
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
Source:
See:
Throws:
  • semiMajorAxis and semiMinorAxis must be greater than zero.
    Type
    DeveloperError
  • semiMajorAxis must be greater than or equal to the semiMinorAxis.
    Type
    DeveloperError
  • granularity must be greater than zero.
    Type
    DeveloperError
Example
// Create an ellipse.
var ellipse = new Cesium.EllipseGeometry({
  center : Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883),
  semiMajorAxis : 500000.0,
  semiMinorAxis : 300000.0,
  rotation : Cesium.Math.toRadians(60.0)
});
var geometry = Cesium.EllipseGeometry.createGeometry(ellipse);

Members

(static) packedLength :Number

The number of elements used to pack the object into an array.
Type:
  • Number
Source:

Methods

(static) createGeometry(ellipseGeometry) → {Geometry|undefined}

Computes the geometric representation of a ellipse on an ellipsoid, including its vertices, indices, and a bounding sphere.
Parameters:
Name Type Description
ellipseGeometry EllipseGeometry A description of the ellipse.
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 EllipseGeometry 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) → {EllipseGeometry}

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