agi.foundation.coordinates

(agi.foundation.core-2024r3.jar)

Class PyramidalBounds

java.lang.Object

agi.foundation.coordinates.PyramidalBounds

All Implemented Interfaces:

IEquatable<PyramidalBounds>, ImmutableValueType, ValueType, IEquatableEpsilon<PyramidalBounds>

public final class PyramidalBounds
extends Object
implements IEquatable<PyramidalBounds>, IEquatableEpsilon<PyramidalBounds>, ImmutableValueType

Holds two Pyramidal values which form the bounds of a range of pyramidal coordinates.

Constructor Summary

Constructors

Constructor and Description
PyramidalBounds() Initializes a new instance.
PyramidalBounds(Pyramidal lowerBound, Pyramidal upperBound) Holds two Pyramidal values which form the bounds of a range of pyramidal coordinates.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(PyramidalBounds left, PyramidalBounds right) Returns true if the two instances are exactly equal.
boolean	equalsEpsilon(PyramidalBounds other, double epsilon) Indicates whether each value of another instance of this type is within the required tolerance of the corresponding value of this instance.
boolean	equalsType(PyramidalBounds other) Indicates whether another instance of this type is exactly equal to this instance.
boolean	getIsUndefined() Gets a value indicating whether any of the bounds coordinates for this instance have the value Double.NaN.
Pyramidal	getLowerBound() Gets the minimal value defining the bounds.
static PyramidalBounds	getUndefined() Gets a set of PyramidalBounds with values of Double.NaN.
Pyramidal	getUpperBound() Gets the maximal value defining the bounds.
Bounds	getZBounds() Gets the bounds for the Z coordinate.
Bounds	getZXAngleBounds() Gets the bounds for the ZXAngle coordinate.
Bounds	getZYAngleBounds() Gets the bounds for the ZYAngle coordinate.
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(PyramidalBounds left, PyramidalBounds 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

PyramidalBounds

public PyramidalBounds()

Initializes a new instance.

PyramidalBounds

public PyramidalBounds(@Nonnull
                       Pyramidal lowerBound,
                       @Nonnull
                       Pyramidal upperBound)

Holds two Pyramidal values which form the bounds of a range of pyramidal coordinates.

Parameters:

lowerBound - The minimal values defining the bounds.

upperBound - The maximal values defining the bounds.

Throws:

ArgumentException - Thrown when the upperBound is less than the lowerBound or when one value in any of the coordinates is Double.NaN and the other is not.

Method Detail

getUndefined

@Nonnull
public static PyramidalBounds getUndefined()

Gets a set of PyramidalBounds with values of Double.NaN.

Use IsUndefined (get) to test whether a PyramidalBounds instance is undefined since it will return true if any of the values are Double.NaN.

getLowerBound

@Nonnull
public final Pyramidal getLowerBound()

Gets the minimal value defining the bounds.

getUpperBound

@Nonnull
public final Pyramidal getUpperBound()

Gets the maximal value defining the bounds.

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

equalsType

public final boolean equalsType(@Nonnull
                                PyramidalBounds other)

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

Specified by:

equalsType in interface IEquatable<PyramidalBounds>

Parameters:

other - The instance to compare to this instance.

Returns:

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

equalsEpsilon

public final boolean equalsEpsilon(@Nonnull
                                   PyramidalBounds other,
                                   double epsilon)

Indicates whether each value of another instance of this type is within the required tolerance of the corresponding value of this instance.

Specified by:

equalsEpsilon in interface IEquatableEpsilon<PyramidalBounds>

Parameters:

other - The set of PyramidalBounds to compare to this instance.

epsilon - The limit at which the absolute differences between the values will not be considered equal.

Returns:

true if the absolute differences are less than or equal to epsilon; otherwise false.

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 values of this instance in the form "LowerBound (get), UpperBound (get)".

equals

public static boolean equals(@Nonnull
                             PyramidalBounds left,
                             @Nonnull
                             PyramidalBounds 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
                                PyramidalBounds left,
                                @Nonnull
                                PyramidalBounds 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.

getIsUndefined

public final boolean getIsUndefined()

Gets a value indicating whether any of the bounds coordinates for this instance have the value Double.NaN.

getZXAngleBounds

@Nonnull
public final Bounds getZXAngleBounds()

Gets the bounds for the ZXAngle coordinate.

getZYAngleBounds

@Nonnull
public final Bounds getZYAngleBounds()

Gets the bounds for the ZYAngle coordinate.

getZBounds

@Nonnull
public final Bounds getZBounds()

Gets the bounds for the Z coordinate.