BoxGeometry - Cesium Documentation

# BoxGeometry

#### new BoxGeometry(options)

  Describes a cube centered at the origin.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `minimumCorner` | Cartesian3 |  | The minimum x, y, and z coordinates of the box.
  `maximumCorner` | Cartesian3 |  | The maximum x, y, and z coordinates of the box.
  `vertexFormat` | VertexFormat | `VertexFormat.DEFAULT` | optional The vertex attributes to be computed.

  ##### Example:

      var box = new Cesium.BoxGeometry({
        vertexFormat : Cesium.VertexFormat.POSITION_ONLY,
        maximumCorner : new Cesium.Cartesian3(250000.0, 250000.0, 250000.0),
        minimumCorner : new Cesium.Cartesian3(-250000.0, -250000.0, -250000.0)
      });
      var geometry = Cesium.BoxGeometry.createGeometry(box);

  ##### Demo:

  - Cesium Sandcastle Box Demo

  ##### See:

  - BoxGeometry.fromDimensions
  - BoxGeometry.createGeometry
  - Packable
  Source: Core/BoxGeometry.js, line 55

### Members

#### staticBoxGeometry.packedLength :Number

  The number of elements used to pack the object into an array.
  Source: Core/BoxGeometry.js, line 123

### Methods

#### staticBoxGeometry.createGeometry(boxGeometry) → Geometry

  Computes the geometric representation of a box, including its vertices, indices, and a bounding sphere.

  Name | Type | Description
  --- | --- | ---
  `boxGeometry` | BoxGeometry | A description of the box.

  ##### Returns:

  The computed vertices and indices.
  Source: Core/BoxGeometry.js, line 196

#### staticBoxGeometry.fromDimensions()

  Creates a cube centered at the origin given its dimensions.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `options.dimensions` | Cartesian3 |  | The width, depth, and height of the box stored in the x, y, and z coordinates of the `Cartesian3`, respectively.
  `options.vertexFormat` | VertexFormat | `VertexFormat.DEFAULT` | optional The vertex attributes to be computed.

  ##### Throws:

  - DeveloperError : All dimensions components must be greater than or equal to zero.

  ##### Example:

      var box = Cesium.BoxGeometry.fromDimensions({
        vertexFormat : Cesium.VertexFormat.POSITION_ONLY,
        dimensions : new Cesium.Cartesian3(500000.0, 500000.0, 500000.0)
      });
      var geometry = Cesium.BoxGeometry.createGeometry(box);

  ##### See:

  - BoxGeometry.createGeometry
  Source: Core/BoxGeometry.js, line 94

#### staticBoxGeometry.pack(value, array, startingIndex)

  Stores the provided instance into the provided array.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `value` | Object |  | The value to pack.
  `array` | Array.<Number> |  | The array to pack into.
  `startingIndex` | Number | `0` | optional The index into the array at which to start packing the elements.

  Source: Core/BoxGeometry.js, line 133

#### staticBoxGeometry.unpack(array, startingIndex, result)

  Retrieves an instance from a packed array.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `array` | Array.<Number> |  | The packed array.
  `startingIndex` | Number | `0` | optional The starting index of the element to be unpacked.
  `result` | BoxGeometry |  | optional The object into which to store the result.

  Source: Core/BoxGeometry.js, line 166