top
all js glsl

RectanglePrimitive

RectanglePrimitive

new

A renderable rectangular rectangle.

Parameters:
Name Type Argument Default Description
options.ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid that the rectangle is drawn on.
options.rectangle Rectangle <optional>
 undefined The rectangle, which defines the rectangular region to draw.
options.granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The distance, in radians, between each latitude and longitude in the underlying geometry.
options.height Number <optional>
 0.0 The height, in meters, that the rectangle is raised above the RectanglePrimitive#ellipsoid.
options.rotation Number <optional>
 0.0 The angle, in radians, relative to north that the rectangle is rotated. Positive angles rotate counter-clockwise.
options.textureRotationAngle Number <optional>
 0.0 The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
options.show Boolean <optional>
 true Determines if this primitive will be shown.
options.material Material <optional>
 undefined The surface appearance of the primitive.
options.id Object <optional>
 undefined A user-defined object to return when the instance is picked with Scene#pick
options.asynchronous Boolean <optional>
 true Determines if the rectangle will be created asynchronously or block until ready.
options.debugShowBoundingVolume Boolean <optional>
 false For debugging only. Determines if the primitive's commands' bounding spheres are shown.
Example
var rectanglePrimitive = new Cesium.RectanglePrimitive({
  rectangle : Cesium.Rectangle.fromDegrees(0.0, 20.0, 10.0, 30.0)
});
primitives.add(rectanglePrimitive);
Source:

Members

:Boolean

Determines if the geometry instances will be created and batched on a web worker.
Default Value:
  • true

:Boolean

This property is for debugging only; it is not for production use nor is it optimized.

Draws the bounding sphere for each DrawCommand in the primitive.

Default Value:
  • false

:Ellipsoid

The ellipsoid that the rectangle is drawn on.
Default Value:
  • Ellipsoid.WGS84

:Number

The distance, in radians, between each latitude and longitude in the underlying geometry. A lower granularity fits the curvature of the RectanglePrimitive#ellipsoid better, but uses more triangles.
Default Value:
  • CesiumMath.RADIANS_PER_DEGREE

:Number

The height, in meters, that the rectangle is raised above the RectanglePrimitive#ellipsoid.
Default Value:
  • 0.0

:Object

User-defined object returned when the rectangle is picked.
Default Value:
  • undefined
See:

:Material

The surface appearance of the primitive. This can be one of several built-in Material objects or a custom material, scripted with Fabric.

The default material is Material.ColorType.

Example
// 1. Change the color of the default material to yellow
rectangle.material.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);

// 2. Change material to horizontal stripes
rectangle.material = Cesium.Material.fromType(Material.StripeType);
See:

:Rectangle

The rectangle, which defines the rectangular region to draw.
Default Value:
  • undefined

:Number

The angle, in radians, relative to north that the rectangle is rotated. Positive angles rotate counter-clockwise.
Default Value:
  • 0.0

:Boolean

Determines if this primitive will be shown.
Default Value:
  • true

:Number

The angle, in radians, relative to north that the primitive's texture is rotated. Positive angles rotate counter-clockwise.
Default Value:
  • 0.0

Methods

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Throws:
DeveloperError : This object was destroyed, i.e., destroy() was called.
Returns:
Example
rectangle = rectangle && rectangle.destroy();
See:
  • Rectangle#isDestroyed

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:
Boolean true if this object was destroyed; otherwise, false.
See:
  • Rectangle#destroy