NearFarScalar - Cesium Documentation

NearFarScalar

new NearFarScalar

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

Parameters:

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

See:

Packable

Source:

/Source/Core/NearFarScalar.js

Members

far :Number

The upper bound of the camera range.

Default Value:

farValue :Number

The value at the upper bound of the camera range.

Default Value:

near :Number

The lower bound of the camera range.

Default Value:

nearValue :Number

The value at the lower bound of the camera range.

Default Value:

<static> packedLength :Number

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

Methods

clone

Duplicates this instance.

Parameters:

Name	Type	Argument	Description
`result`	NearFarScalar	<optional>	The object onto which to store the result.

Returns:

NearFarScalar The modified result parameter or a new NearFarScalar instance if one was not provided.

equals

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

Parameters:

Name	Type	Argument	Description
`right`	NearFarScalar	<optional>	The right hand side NearFarScalar.

Returns:

Boolean true if left and right are equal; otherwise false.

<static> clone

Duplicates a NearFarScalar instance.

Parameters:

Name	Type	Argument	Description
`nearFarScalar`	NearFarScalar		The NearFarScalar to duplicate.
`result`	NearFarScalar	<optional>	The object onto which to store the result.

Returns:

NearFarScalar The modified result parameter or a new NearFarScalar instance if one was not provided. (Returns undefined if nearFarScalar is undefined)

<static> equals

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

Parameters:

Name	Type	Argument	Description
`left`	NearFarScalar	<optional>	The first NearFarScalar.
`right`	NearFarScalar	<optional>	The second NearFarScalar.

Returns:

Boolean true if left and right are equal; otherwise false.

<static> pack

Stores the provided instance into the provided array.

Parameters:

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

Throws:

DeveloperError : value is required.
DeveloperError : array is required.

<static> unpack

Retrieves an instance from a packed array.

Parameters:

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

Throws:

DeveloperError : array is required.