Spherical

java.lang.Object
- agi.foundation.coordinates.Spherical

All Implemented Interfaces:

IEquatable<Spherical>, ImmutableValueType, ValueType, IEquatableEpsilon<Spherical>
```
public final class Spherical
extends Object
implements IEquatable<Spherical>, IEquatableEpsilon<Spherical>, ImmutableValueType
```
A set of curvilinear 3-dimensional coordinates.

Constructor Summary

Constructors
Constructor and Description
`Spherical()` Initializes a new instance.
`Spherical(AzimuthElevationRange coordinates)` Initializes a set of `Spherical` coordinates from the provided set of `AzimuthElevationRange` coordinates.
`Spherical(Cartesian coordinates)` Initializes a set of `Spherical` coordinates from the provided set of `Cartesian` coordinates.
`Spherical(Cylindrical coordinates)` Initializes a set of `Spherical` coordinates from the provided set of `Cylindrical` coordinates.
`Spherical(double[] elements)` Initializes a set of `Spherical` coordinates from the first 3 consecutive elements in the provided array.
`Spherical(double[] elements, int startIndex)` Initializes a set of `Spherical` coordinates from the provided array.
`Spherical(double clock, double cone, double magnitude)` Initializes a set of `Spherical` coordinates from the provided clock angle, cone angle, and magnitude.
`Spherical(LongitudeLatitudeRadius coordinates)` Initializes a set of `Spherical` coordinates from the provided set of `LongitudeLatitudeRadius` coordinates.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Indicates whether another object is exactly equal to this instance.
`static boolean`	`equals(Spherical left, Spherical right)` Returns `true` if the two instances are exactly equal.
`boolean`	`equalsEpsilon(Spherical other, double epsilon)` Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
`boolean`	`equalsType(Spherical 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, and 2 corresponding to the coordinates `Clock` (`get`), `Cone` (`get`), and `Magnitude` (`get`).
`double`	`getClock()` Gets the angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
`double`	`getCone()` Gets the angular coordinate measured from the positive z-axis and toward the negative z-axis.
`boolean`	`getIsUndefined()` Gets a value indicating whether any of the coordinates for this instance have the value `Double.NaN`.
`int`	`getLength()` Gets the number of elements in this set of coordinates.
`double`	`getMagnitude()` Gets the linear coordinate measured from the origin.
`static Spherical`	`getUndefined()` Gets a set of `Spherical` coordinates with values of `Double.NaN`.
`static Spherical`	`getZero()` Gets a set of `Spherical` coordinates with values of zero.
`int`	`hashCode()` Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
`UnitSpherical`	`normalize()` Forms a set of `UnitSpherical` coordinates from this instance.
`static boolean`	`notEquals(Spherical left, Spherical 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
  - Spherical
```
public Spherical()
```
    Initializes a new instance.
  - Spherical
```
public Spherical(double clock,
                 double cone,
                 double magnitude)
```
    Initializes a set of Spherical coordinates from the provided clock angle, cone angle, and magnitude.
    
    Parameters:
    
    clock - The angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
    
    cone - The angular coordinate measured from the positive z-axis and toward the negative z-axis.
    
    magnitude - The linear coordinate measured from the origin.
  - Spherical
```
public Spherical(@Nonnull
                 Cylindrical coordinates)
```
    Initializes a set of Spherical coordinates from the provided set of Cylindrical coordinates.
    
    Parameters:
    
    coordinates - The set of Cylindrical coordinates.
  - Spherical
```
public Spherical(@Nonnull
                 Cartesian coordinates)
```
    Initializes a set of Spherical coordinates from the provided set of Cartesian coordinates.
    The radius and magnitude for spherical coordinates are computed using the standard methods. Note that if a component of the cartesian components underflows upon squaring the resulting spherical coordinates may not be correct.
    
    Parameters:
    
    coordinates - The set of Cartesian coordinates.
  - Spherical
```
public Spherical(@Nonnull
                 AzimuthElevationRange coordinates)
```
    Initializes a set of Spherical coordinates from the provided set of AzimuthElevationRange coordinates.
    
    Parameters:
    
    coordinates - The set of AzimuthElevationRange coordinates.
  - Spherical
```
public Spherical(@Nonnull
                 LongitudeLatitudeRadius coordinates)
```
    Initializes a set of Spherical coordinates from the provided set of LongitudeLatitudeRadius coordinates.
    
    Parameters:
    
    coordinates - The set of LongitudeLatitudeRadius coordinates.
  - Spherical
```
public Spherical(@Nonnull
                 double[] elements)
```
    Initializes a set of Spherical coordinates from the first 3 consecutive elements in the provided array.
    
    Parameters:
    
    elements - The array of coordinate values.
    
    Throws:
    
    ArgumentNullException - Thrown when elements is null.
    
    ArgumentOutOfRangeException - An object of this type must be constructed from an array with at least 3 elements.
  - Spherical
```
public Spherical(@Nonnull
                 double[] elements,
                 int startIndex)
```
    Initializes a set of Spherical coordinates from 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 elements is null.
    
    ArgumentOutOfRangeException - Thrown when an object of this type is constructed from an array with less than 3 elements.
- Method Detail
  - getZero
```
@Nonnull
public static Spherical getZero()
```
    Gets a set of Spherical coordinates with values of zero.
  - getUndefined
```
@Nonnull
public static Spherical getUndefined()
```
    Gets a set of Spherical coordinates with values of Double.NaN.
    Use IsUndefined (get) to test whether a Spherical instance is undefined since it will return true if any of the coordinate values are Double.NaN.
  - getClock
```
public final double getClock()
```
    Gets the angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
  - getCone
```
public final double getCone()
```
    Gets the angular coordinate measured from the positive z-axis and toward the negative z-axis.
  - getMagnitude
```
public final double getMagnitude()
```
    Gets the linear coordinate measured from the origin.
  - normalize
```
@Nonnull
public final UnitSpherical normalize()
```
    Forms a set of UnitSpherical coordinates from this instance.
    
    Returns:
    
    The resulting set of UnitSpherical coordinates.
  - getIsUndefined
```
public final boolean getIsUndefined()
```
    Gets a value indicating whether any of the coordinates for this instance have the value Double.NaN.
  - 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, and 2 corresponding to the coordinates Clock (get), Cone (get), and Magnitude (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).
  - 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
                                Spherical other)
```
    Indicates whether another instance of this type is exactly equal to this instance.
    
    Specified by:
    
    equalsType in interface IEquatable<Spherical>
    
    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
                                   Spherical other,
                                   double epsilon)
```
    Indicates whether each coordinate value of another instance of this type is within the required tolerance of the corresponding coordinate value of this instance.
    
    Specified by:
    
    equalsEpsilon in interface IEquatableEpsilon<Spherical>
    
    Parameters:
    
    other - The set of Spherical coordinates to compare to this instance.
    
    epsilon - The limit at which the absolute differences between the coordinate 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 value of this instance in the form Clock, Cone, and Magnitude.
  - equals
```
public static boolean equals(@Nonnull
                             Spherical left,
                             @Nonnull
                             Spherical 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
                                Spherical left,
                                @Nonnull
                                Spherical 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.

Class Spherical

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Spherical

Spherical

Spherical

Spherical

Spherical

Spherical

Spherical

Method Detail

getZero

getUndefined

getClock

getCone

getMagnitude

normalize

getIsUndefined

getLength

get

equals

equalsType

equalsEpsilon

hashCode

toString

equals

notEquals