Class: RectangleGeometry

RectangleGeometry

new RectangleGeometry(options)

A description of a cartographic rectangle on an ellipsoid centered at the origin. Rectangle 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
rectangle Rectangle A cartographic rectangle with north, south, east and west properties in radians.
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid on which the rectangle lies.
granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
height Number <optional>
 0.0 The distance in meters between the rectangle and the ellipsoid surface.
rotation Number <optional>
 0.0 The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
stRotation Number <optional>
 0.0 The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
extrudedHeight Number <optional>
 The distance in meters between the rectangle's extruded face and the ellipsoid surface.
closeTop Boolean <optional>
 true Specifies whether the rectangle has a top cover when extruded.
closeBottom Boolean <optional>
 true Specifies whether the rectangle has a bottom cover when extruded.
Source:
See:
  • RectangleGeometry#createGeometry
Throws:
  • options.rectangle.north must be in the interval [-Pi/2, Pi/2].
    Type
    DeveloperError
  • options.rectangle.south must be in the interval [-Pi/2, Pi/2].
    Type
    DeveloperError
  • options.rectangle.east must be in the interval [-Pi, Pi].
    Type
    DeveloperError
  • options.rectangle.west must be in the interval [-Pi, Pi].
    Type
    DeveloperError
  • options.rectangle.north must be greater than options.rectangle.south.
    Type
    DeveloperError
Example
// 1. create an rectangle
var rectangle = new Cesium.RectangleGeometry({
  ellipsoid : Cesium.Ellipsoid.WGS84,
  rectangle : Cesium.Rectangle.fromDegrees(-80.0, 39.0, -74.0, 42.0),
  height : 10000.0
});
var geometry = Cesium.RectangleGeometry.createGeometry(rectangle);

// 2. create an extruded rectangle without a top
var rectangle = new Cesium.RectangleGeometry({
  ellipsoid : Cesium.Ellipsoid.WGS84,
  rectangle : Cesium.Rectangle.fromDegrees(-80.0, 39.0, -74.0, 42.0),
  height : 10000.0,
  extrudedHeight: 300000,
  closeTop: false
});
var geometry = Cesium.RectangleGeometry.createGeometry(rectangle);

Members

(static) packedLength :Number

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

Methods

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

Computes the geometric representation of an rectangle, including its vertices, indices, and a bounding sphere.
Parameters:
Name Type Description
rectangleGeometry RectangleGeometry A description of the rectangle.
Source:
Throws:
Rotated rectangle is invalid.
Type
DeveloperError
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 RectangleGeometry 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) → {RectangleGeometry}

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