NearFarScalar - Cesium Documentation

# NearFarScalar

#### new NearFarScalar(near, nearValue, far, farValue)

  Represents a scalar value's lower and upper bound at a near distance and far distance in eye space.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `near` | Number | `0.0` | optional The lower bound of the camera range.
  `nearValue` | Number | `0.0` | optional The value at the lower bound of the camera range.
  `far` | Number | `1.0` | optional The upper bound of the camera range.
  `farValue` | Number | `0.0` | optional The value at the upper bound of the camera range.

  ##### See:

  - Packable
  Source: Core/NearFarScalar.js, line 24

### Members

#### staticNearFarScalar.packedLength :Number

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

#### far :Number

  The upper bound of the camera range.
  Default Value: `1.0`
  Source: Core/NearFarScalar.js, line 42

#### farValue :Number

  The value at the upper bound of the camera range.
  Default Value: `0.0`
  Source: Core/NearFarScalar.js, line 48

#### near :Number

  The lower bound of the camera range.
  Default Value: `0.0`
  Source: Core/NearFarScalar.js, line 30

#### nearValue :Number

  The value at the lower bound of the camera range.
  Default Value: `0.0`
  Source: Core/NearFarScalar.js, line 36

### Methods

#### staticNearFarScalar.clone(nearFarScalar, result) → NearFarScalar

  Duplicates a NearFarScalar instance.

  Name | Type | Description
  --- | --- | ---
  `nearFarScalar` | NearFarScalar | The NearFarScalar to duplicate.
  `result` | NearFarScalar | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new NearFarScalar instance if one was not provided. (Returns undefined if nearFarScalar is undefined)
  Source: Core/NearFarScalar.js, line 58

#### staticNearFarScalar.equals(left, right) → Boolean

  Compares the provided NearFarScalar and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `left` | NearFarScalar | optional The first NearFarScalar.
  `right` | NearFarScalar | optional The second NearFarScalar.

  ##### Returns:

  `true` if left and right are equal; otherwise `false`.
  Source: Core/NearFarScalar.js, line 140

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

  Stores the provided instance into the provided array.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `value` | NearFarScalar |  | 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/NearFarScalar.js, line 88

#### staticNearFarScalar.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` | NearFarScalar |  | optional The object into which to store the result.

  Source: Core/NearFarScalar.js, line 113

#### clone(result) → NearFarScalar

  Duplicates this instance.

  Name | Type | Description
  --- | --- | ---
  `result` | NearFarScalar | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new NearFarScalar instance if one was not provided.
  Source: Core/NearFarScalar.js, line 156

#### equals(right) → Boolean

  Compares this instance to the provided NearFarScalar and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `right` | NearFarScalar | optional The right hand side NearFarScalar.

  ##### Returns:

  `true` if left and right are equal; otherwise `false`.
  Source: Core/NearFarScalar.js, line 167