Class: WallGeometry

WallGeometry

new WallGeometry(options)

A description of a wall, which is similar to a KML line string. A wall is defined by a series of points, which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
positions Array.<Cartesian3> An array of Cartesian objects, which are the points of the wall.
granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
maximumHeights Array.<Number> <optional>
 An array parallel to positions that give the maximum height of the wall at positions. If undefined, the height of each position in used.
minimumHeights Array.<Number> <optional>
 An array parallel to positions that give the minimum height of the wall at positions. If undefined, the height at each position is 0.0.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid for coordinate manipulation
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
Source:
See:
  • WallGeometry#createGeometry
  • WallGeometry#fromConstantHeight
Throws:
  • positions length must be greater than or equal to 2.
    Type
    DeveloperError
  • positions and maximumHeights must have the same length.
    Type
    DeveloperError
  • positions and minimumHeights must have the same length.
    Type
    DeveloperError
Example
// create a wall that spans from ground level to 10000 meters
var wall = new Cesium.WallGeometry({
  positions : Cesium.Cartesian3.fromDegreesArrayHeights([
    19.0, 47.0, 10000.0,
    19.0, 48.0, 10000.0,
    20.0, 48.0, 10000.0,
    20.0, 47.0, 10000.0,
    19.0, 47.0, 10000.0
  ])
});
var geometry = Cesium.WallGeometry.createGeometry(wall);

Members

packedLength :Number

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

Methods

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

Computes the geometric representation of a wall, including its vertices, indices, and a bounding sphere.
Parameters:
Name Type Description
wallGeometry WallGeometry A description of the wall.
Source:
Returns:
The computed vertices and indices.
Type
Geometry | undefined

(static) fromConstantHeights(options) → {WallGeometry}

A description of a wall, which is similar to a KML line string. A wall is defined by a series of points, which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
positions Array.<Cartesian3> An array of Cartesian objects, which are the points of the wall.
maximumHeight Number <optional>
 A constant that defines the maximum height of the wall at positions. If undefined, the height of each position in used.
minimumHeight Number <optional>
 A constant that defines the minimum height of the wall at positions. If undefined, the height at each position is 0.0.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid for coordinate manipulation
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
Source:
See:
  • WallGeometry#createGeometry
Returns:
Type
WallGeometry
Example
// create a wall that spans from 10000 meters to 20000 meters
var wall = Cesium.WallGeometry.fromConstantHeights({
  positions : Cesium.Cartesian3.fromDegreesArray([
    19.0, 47.0,
    19.0, 48.0,
    20.0, 48.0,
    20.0, 47.0,
    19.0, 47.0,
  ]),
  minimumHeight : 20000.0,
  maximumHeight : 10000.0
});
var geometry = Cesium.WallGeometry.createGeometry(wall);

(static) pack(value, array, startingIndexopt) → {Array.<Number>}

Stores the provided instance into the provided array.
Parameters:
Name Type Attributes Default Description
value WallGeometry 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) → {WallGeometry}

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