Angle (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.Angle

```
public class Angle
extends Object
```
Angle object Angle represents an angle The reason for the class is to help remember about radian/degree problems, to keep the angle in the right range (0, 2*PI) or (-PI, PI) as required, and to format output.
To construct an angle the user must consciously use RADIANS
The angle returned is always in RADIANS (except if getDegrees() is used)

If SIGNED is used, the angle is in the range -180 to 180 (-pi to pi)
If UNSIGNED is used, the angle is in the range 0 to 360 (0 to 2*pi)
Default is SIGNED
Default value of Angle is 0.0; Constructions of invalid angles should throw exceptions rather than try to make invalid angles.

Author:

(C) P. Murray-Rust, 1996

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Angle.Range
range

static class Angle.Units
units

Nested Classes
Modifier and Type	Class and Description
`static class`	`Angle.Range` range
`static class`	`Angle.Units` units

Field Summary

Fields
Modifier and Type Field and Description

static double DEGREES_IN_RADIAN

Fields
Modifier and Type	Field and Description
`static double`	`DEGREES_IN_RADIAN`

Constructor Summary

Constructors
Constructor and Description
`Angle()` create default Angle default is (0.0)
`Angle(Angle a)` copy constructor
`Angle(double a)` create an angle IN RADIANS
`Angle(double a, Angle.Units units)` construct using degrees or radians
`Angle(double y, double x)` from X and Y components (uses atan2)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`double`	`cos()` trigonometric functions
`double`	`getAngle()` get angle in radians
`double`	`getDegrees()` get angle in degrees
`double`	`getRadian()` get angle in radians
`Integer`	`getRightAngle(Angle eps)` Tests whether this is a right angle.
`boolean`	`greaterThan(Angle a)` is one angle greater than another (after normalisation)
`boolean`	`greaterThan(double a)` is one angle greater than another (after normalisation)
`boolean`	`greaterThanOrEquals(Angle a)` is one angle greater than or equal to another (after normalisation)
`boolean`	`greaterThanOrEquals(double a)` is one angle greater than or equal to another (after normalisation)
`boolean`	`isEqualTo(Angle a)` are two angles equal
`boolean`	`isEqualTo(Angle a, double eps)` are two angles equal
`boolean`	`isEqualTo(double a)` Deprecated. // use epsilon method
`boolean`	`isEqualTo(double a, double epsilon)` compare angles allowing for epsilon
`boolean`	`lessThan(Angle a)` is one angle less than another (after normalisation)
`boolean`	`lessThan(double a)` is one angle less than another (after normalisation)
`boolean`	`lessThanOrEquals(Angle a)` is one angle less than or equal to another (after normalisation)
`boolean`	`lessThanOrEquals(double a)` is one angle less than or equal to another (after normalisation)
`Angle`	`multiplyBy(double f)` multiply an angle by a scalar
`static double`	`normalise(double angle)` normalise angle.
`void`	`normalizeTo2Pi()` Normalises angle to be in range 0 -> Math.PI * 2.
`void`	`normalizeToPlusMinusPI()` normalizes angle to be in range - Math.PI -> Math.PI.
`Angle`	`plus(Angle a2)` add two angles
`void`	`putDegrees(double a)`
`void`	`setRange(Angle.Range range)` set type of range
`void`	`shallowCopy(Angle a)` shallowCopy
`double`	`sin()` sin of angle
`Angle`	`subtract(Angle a2)` subtract two angles
`double`	`tan()` tan.
`String`	`toString()` to string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEGREES_IN_RADIAN
```
public static final double DEGREES_IN_RADIAN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Angle
```
public Angle()
```
    create default Angle default is (0.0)
  - Angle
```
public Angle(double a)
```
    create an angle IN RADIANS
    
    Parameters:
    
    a - radian value
  - Angle
```
public Angle(double a,
             Angle.Units units)
```
    construct using degrees or radians
    
    Parameters:
    
    a - value of angle
    
    units - unit of angle. It can either be in DEGREES or RADIANS
  - Angle
```
public Angle(double y,
             double x)
```
    from X and Y components (uses atan2)
    
    Parameters:
    
    x - The x coordinate of the point
    
    y - The y coordinate of the point
  - Angle
```
public Angle(Angle a)
```
    copy constructor
    
    Parameters:
    
    a - Angle object that needs to be copied
- Method Detail
  - shallowCopy
```
public void shallowCopy(Angle a)
```
    shallowCopy
    
    Parameters:
    
    a - Angle object that needs to be copied
  - plus
```
public Angle plus(Angle a2)
```
    add two angles
    
    Parameters:
    
    a2 - the specified angle to be added to this angle
    
    Returns:
    
    new angle
  - subtract
```
public Angle subtract(Angle a2)
```
    subtract two angles
    
    Parameters:
    
    a2 - the specified angle to be subtracted from this angle
    
    Returns:
    
    new angle
  - multiplyBy
```
public Angle multiplyBy(double f)
```
    multiply an angle by a scalar
    
    Parameters:
    
    f - a floating point scalar value
    
    Returns:
    
    new angle
  - cos
```
public double cos()
```
    trigonometric functions
    
    Returns:
    
    cosine of angle
  - sin
```
public double sin()
```
    sin of angle
    
    Returns:
    
    sine
  - tan
```
public double tan()
```
    tan.
    
    Returns:
    
    the tan
  - normalise
```
public static double normalise(double angle)
```
    normalise angle. to range 0 -> 2*PI
    
    Parameters:
    
    angle - the angle to be normalised
    
    Returns:
    
    normalised angle
  - normalizeToPlusMinusPI
```
public void normalizeToPlusMinusPI()
```
    normalizes angle to be in range - Math.PI -> Math.PI.
  - normalizeTo2Pi
```
public void normalizeTo2Pi()
```
    Normalises angle to be in range 0 -> Math.PI * 2.
  - getRightAngle
```
public Integer getRightAngle(Angle eps)
```
    Tests whether this is a right angle.
    
    Parameters:
    
    eps - tolerance
    
    Returns:
    
    1 for PI/2, -1 for -PI/2 else 0
  - isEqualTo
```
public boolean isEqualTo(double a)
```
    Deprecated. // use epsilon method
    
    are two normalised angles equal.
    
    Parameters:
    
    a - the specified angle to which this angle is compared
    
    Returns:
    
    boolean
  - isEqualTo
```
public boolean isEqualTo(double a,
                         double epsilon)
```
    compare angles allowing for epsilon
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be equal to
    
    epsilon - tolerance limit for equality
    
    Returns:
    
    boolean
  - greaterThan
```
public boolean greaterThan(double a)
```
    is one angle greater than another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be greater
    
    Returns:
    
    greater than
  - greaterThanOrEquals
```
public boolean greaterThanOrEquals(double a)
```
    is one angle greater than or equal to another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be greater than or equal to
    
    Returns:
    
    greater than or equals
  - lessThan
```
public boolean lessThan(double a)
```
    is one angle less than another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be lesser
    
    Returns:
    
    <
  - lessThanOrEquals
```
public boolean lessThanOrEquals(double a)
```
    is one angle less than or equal to another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be lesser than or equal to
    
    Returns:
    
    <=
  - isEqualTo
```
public boolean isEqualTo(Angle a)
```
    are two angles equal
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be equal to
    
    Returns:
    
    ==
  - isEqualTo
```
public boolean isEqualTo(Angle a,
                         double eps)
```
    are two angles equal
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be equal to
    
    eps - epsilon tolerance limit for equality
    
    Returns:
    
    ==
  - greaterThan
```
public boolean greaterThan(Angle a)
```
    is one angle greater than another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be greater (after normalisation)
    
    Returns:
    
    >
  - greaterThanOrEquals
```
public boolean greaterThanOrEquals(Angle a)
```
    is one angle greater than or equal to another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be greater than or equal to (after normalisation)
    
    Returns:
    
    >=
  - lessThan
```
public boolean lessThan(Angle a)
```
    is one angle less than another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be lesser (after normalisation)
    
    Returns:
    
    <
  - lessThanOrEquals
```
public boolean lessThanOrEquals(Angle a)
```
    is one angle less than or equal to another (after normalisation)
    
    Parameters:
    
    a - the specified angle to which this angle is compared to be lesser than or equal to (after normalisation)
    
    Returns:
    
    <=
  - getAngle
```
public double getAngle()
```
    get angle in radians
    
    Returns:
    
    angle
  - getRadian
```
public double getRadian()
```
    get angle in radians
    
    Returns:
    
    angle
  - getDegrees
```
public double getDegrees()
```
    get angle in degrees
    
    Returns:
    
    angle
  - putDegrees
```
public void putDegrees(double a)
```
    Parameters:
    
    a - angle in degrees
  - setRange
```
public void setRange(Angle.Range range)
```
    set type of range
    
    Parameters:
    
    range - type of range
  - toString
```
public String toString()
```
    to string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string

Class Angle

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEGREES_IN_RADIAN

Constructor Detail

Angle

Angle

Angle

Angle

Angle

Method Detail

shallowCopy

plus

subtract

multiplyBy

cos

sin

tan

normalise

normalizeToPlusMinusPI

normalizeTo2Pi

getRightAngle

isEqualTo

isEqualTo

greaterThan

greaterThanOrEquals

lessThan

lessThanOrEquals

isEqualTo

isEqualTo

greaterThan

greaterThanOrEquals

lessThan

lessThanOrEquals

getAngle

getRadian

getDegrees

putDegrees

setRange

toString