agi.foundation.cesium

(agi.foundation.cesium-2023r1.jar)

Class NearFarScalar

java.lang.Object

agi.foundation.cesium.NearFarScalar

All Implemented Interfaces:

IEquatable<NearFarScalar>, ImmutableValueType, ValueType

public final class NearFarScalar
extends Object
implements IEquatable<NearFarScalar>, ImmutableValueType

A numeric value which will be linearly interpolated between two values based on an object's distance from the camera, in eye coordinates. The computed value will interpolate between the near value and the far value while the camera distance falls between the near distance and the far distance, and will be clamped to the near or far value while the distance is less than the near distance or greater than the far distance, respectively.

Constructor Summary

Constructors

Constructor and Description
NearFarScalar() Initializes a new instance.
NearFarScalar(double[] elements) Initializes a new instance from the first four consecutive elements in the provided array.
NearFarScalar(double[] elements, int startIndex) Initializes a new instance from four consecutive elements in the provided array.
NearFarScalar(double nearDistance, double nearValue, double farDistance, double farValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(NearFarScalar left, NearFarScalar right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(NearFarScalar other) Indicates whether another instance of this type is exactly equal to this instance.
double	get(int index) Gets the value of the specified element with index of 0, 1, 2, and 3 corresponding to the coordinates NearDistance (get), NearValue (get), FarDistance (get), FarValue (get).
double	getFarDistance() Gets the upper bound of the camera distance range.
double	getFarValue() Gets the value to use at the upper bound of the camera distance range.
int	getLength() Gets the number of elements in this set of coordinates.
double	getNearDistance() Gets the lower bound of the camera distance range.
double	getNearValue() Gets the value to use at the lower bound of the camera distance range.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(NearFarScalar left, NearFarScalar right) Returns true if the two instances are not exactly equal.
String	toString() Returns the string representation of the value of this instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NearFarScalar

public NearFarScalar()

Initializes a new instance.

NearFarScalar

public NearFarScalar(double nearDistance,
                     double nearValue,
                     double farDistance,
                     double farValue)

Initializes a new instance.

Parameters:

nearDistance - The lower bound of the camera distance range.

nearValue - The value to use at the lower bound of the camera distance range.

farDistance - The upper bound of the camera distance range.

farValue - The value to use at the upper bound of the camera distance range.

NearFarScalar

public NearFarScalar(@Nonnull
                     double[] elements)

Initializes a new instance from the first four consecutive elements in the provided array.

Parameters:

elements - The array of coordinate values.

Throws:

ArgumentNullException - The array of elements cannot be null.

ArgumentOutOfRangeException - An object of this type must be constructed from an array with at least four elements.

NearFarScalar

public NearFarScalar(@Nonnull
                     double[] elements,
                     int startIndex)

Initializes a new instance from four consecutive elements in the provided array.

Parameters:

elements - The array of coordinate values.

startIndex - The index of the first element in the array to use.

Throws:

ArgumentNullException - Thrown when the array of elements is null.

ArgumentOutOfRangeException - Thrown when an object of this type is constructed from an array with less than four elements.

Method Detail

getNearDistance

public final double getNearDistance()

Gets the lower bound of the camera distance range.

getNearValue

public final double getNearValue()

Gets the value to use at the lower bound of the camera distance range.

getFarDistance

public final double getFarDistance()

Gets the upper bound of the camera distance range.

getFarValue

public final double getFarValue()

Gets the value to use at the upper bound of the camera distance range.

getLength

public final int getLength()

Gets the number of elements in this set of coordinates.

get

public final double get(int index)

Gets the value of the specified element with index of 0, 1, 2, and 3 corresponding to the coordinates NearDistance (get), NearValue (get), FarDistance (get), FarValue (get).

Parameters:

index - The index to retrieve.

Returns:

The coordinate associated with the specified index.

Throws:

ArgumentOutOfRangeException - Thrown when index is less than 0 or greater than or equal to Length (get).

equalsType

public final boolean equalsType(@Nonnull
                                NearFarScalar other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<NearFarScalar>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns the string representation of the value of this instance.

Overrides:

toString in class Object

Returns:

A string that represents the value of this instance in the form "NearDistance (get), NearValue (get), FarDistance (get), FarValue (get)".

equals

public static boolean equals(@Nonnull
                             NearFarScalar left,
                             @Nonnull
                             NearFarScalar right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                NearFarScalar left,
                                @Nonnull
                                NearFarScalar right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.