Package com.luciad.cartesian

Class Angle

java.lang.Object
com.luciad.cartesian.Angle
public final class Angle extends Object
An angle on a mathematical circle: degrees, counter-clockwise from right/X-axis.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Angle.Direction
    Represents the different angular directions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Angle(double degrees)
    Creates an angle based on the given angular value in degrees.
    Angle(Angle angle)
    Creates an angle based on another angle.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object other)
     
    static Angle
    fromRadians(double radians)
    Creates an Angle from an angle value in radians.
    double
    getDegrees()
    Returns the value in degrees constrained between [0, 360].
    double
    getRadians()
    Returns the value in radians constrained between [0, 2*PI]
    int
    hashCode()
     
    Angle
    minus(Angle other)
    Subtracts another angle from the angle and normalizes the result between 0 and 360 degrees.
    static double
    normalize(double degrees)
    Normalizes the degree value to the range ]-180, +180].
    Angle
    plus(Angle other)
    Adds the angle to another angle and normalizes the result between 0 and 360 degrees.
    Azimuth
    toAzimuth()
    Converts the angle to an Azimuth.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Angle

      public Angle(double degrees) throws IllegalArgumentException
      Creates an angle based on the given angular value in degrees.
      Parameters:
      degrees - an angle in degree
      Throws:
      IllegalArgumentException - when degrees is NaN or infinite.

    • Angle

      public Angle(@NotNull Angle angle)
      Creates an angle based on another angle.
      Parameters:
      angle - an angle.

  • Method Details

    • normalize

      public static double normalize(double degrees)
      Normalizes the degree value to the range ]-180, +180].
      Parameters:
      degrees - a value in degrees
      Returns:
      a degrees value, normalized to ]-180, +180].

    • fromRadians

      @NotNull public static Angle fromRadians(double radians) throws IllegalArgumentException
      Creates an Angle from an angle value in radians.
      Parameters:
      radians - an angle in radians
      Returns:
      a new angle based on the given angle in radians
      Throws:
      IllegalArgumentException - when radians is NaN or infinite.

    • getDegrees

      public double getDegrees()
      Returns the value in degrees constrained between [0, 360].
      Returns:
      the value in degrees constrained between [0, 360].

    • getRadians

      public double getRadians()
      Returns the value in radians constrained between [0, 2*PI]
      Returns:
      the value in radians constrained between [0, 2*PI].

    • toAzimuth

      @NotNull public Azimuth toAzimuth()
      Converts the angle to an Azimuth.
      Returns:
      the result of the convertion.

    • plus

      @NotNull public Angle plus(@NotNull Angle other)
      Adds the angle to another angle and normalizes the result between 0 and 360 degrees.
      Parameters:
      other - the other angle.
      Returns:
      the sum of the two angles.

    • minus

      @NotNull public Angle minus(@NotNull Angle other)
      Subtracts another angle from the angle and normalizes the result between 0 and 360 degrees.
      Parameters:
      other - the other angle.
      Returns:
      the result of the subtraction.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object