NearFarScalar

new Cesium.NearFarScalar(near, nearValue, far, farValue)
engine/Source/Core/NearFarScalar.js 17

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:

Members

static Cesium.NearFarScalar.packedLength : Number
engine/Source/Core/NearFarScalar.js 76

The number of elements used to pack the object into an array.

far : Number
engine/Source/Core/NearFarScalar.js 35

The upper bound of the camera range.
Default Value: 1.0

farValue : Number
engine/Source/Core/NearFarScalar.js 41

The value at the upper bound of the camera range.
Default Value: 0.0

near : Number
engine/Source/Core/NearFarScalar.js 23

The lower bound of the camera range.
Default Value: 0.0

nearValue : Number
engine/Source/Core/NearFarScalar.js 29

The value at the lower bound of the camera range.
Default Value: 0.0

Methods

static Cesium.NearFarScalar.clone(nearFarScalar, result) → NearFarScalar
engine/Source/Core/NearFarScalar.js 51

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)

static Cesium.NearFarScalar.equals(left, right) → Boolean
engine/Source/Core/NearFarScalar.js 142

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.

static Cesium.NearFarScalar.pack(value, array, startingIndex) → Array.<Number>
engine/Source/Core/NearFarScalar.js 87

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.
Returns:
The array that was packed into

static Cesium.NearFarScalar.unpack(array, startingIndex, result) → NearFarScalar
engine/Source/Core/NearFarScalar.js 115

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.
Returns:
The modified result parameter or a new NearFarScalar instance if one was not provided.

clone(result) → NearFarScalar
engine/Source/Core/NearFarScalar.js 160

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.

equals(right) → Boolean
engine/Source/Core/NearFarScalar.js 171

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.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets