AngleF (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.math.AngleF

```
public final class AngleF
extends java.lang.Object
```
An AngleF encapsulates angles in forms such as degrees and radians.
This class is immutable and therefore thread-safe.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`float`	`degrees` The angle in degrees.
`float`	`degreesMaximum` The maximum angle in degrees.
`float`	`degreesMinimum` The minimum angle in degrees.
`float`	`radians` The angle in radians.
`float`	`radiansMaximum` The maximum angle in radians.
`float`	`radiansMinimum` The minimum angle in radians.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AngleF`	`add(AngleF angle)` Adds `angle` to this `AngleF` instance.
`static AngleF`	`degrees(float degrees)` Returns a new `AngleF` instance based on an angle in degrees.
`static AngleF`	`degrees(float degrees, float degreesA, float degreesB)` Returns a new `AngleF` instance based on an angle in degrees and an interval of valid degrees.
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `AngleF` instance for equality.
`static AngleF`	`fieldOfView(float focalDistance, float resolution)` Returns a Field of View (FoV) `AngleF` based on `focalDistance` and `resolution`.
`float`	`getDegrees()` Returns the angle in degrees.
`float`	`getDegreesMaximum()` Returns the maximum angle in degrees.
`float`	`getDegreesMinimum()` Returns the minimum angle in degrees.
`float`	`getRadians()` Returns the angle in radians.
`float`	`getRadiansMaximum()` Returns the maximum angle in radians.
`float`	`getRadiansMinimum()` Returns the minimum angle in radians.
`AngleF`	`half()` Returns a new `AngleF` instance that represents half of this `AngleF` instance.
`int`	`hashCode()` Returns a hash code for this `AngleF` instance.
`static AngleF`	`pitch(Point3F eye, Point3F lookAt)` Returns a new pitch `AngleF` instance based on `eye` and `lookAt`.
`static AngleF`	`pitch(Vector3F direction)` Returns a new pitch `AngleF` instance based on `direction`.
`static AngleF`	`radians(float radians)` Returns a new `AngleF` instance based on an angle in radians.
`static AngleF`	`radians(float radians, float radiansA, float radiansB)` Returns a new `AngleF` instance based on an angle in radians and an interval of valid radians.
`AngleF`	`subtract(AngleF angle)` Subtracts `angle` from this `AngleF` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `AngleF` instance.
`static AngleF`	`yaw(Point3F eye, Point3F lookAt)` Returns a new yaw `AngleF` instance based on `eye` and `lookAt`.
`static AngleF`	`yaw(Vector3F direction)` Returns a new yaw `AngleF` instance based on `direction`.

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

- Field Detail
  - degrees
```
public final float degrees
```
    The angle in degrees.
  - degreesMaximum
```
public final float degreesMaximum
```
    The maximum angle in degrees.
  - degreesMinimum
```
public final float degreesMinimum
```
    The minimum angle in degrees.
  - radians
```
public final float radians
```
    The angle in radians.
  - radiansMaximum
```
public final float radiansMaximum
```
    The maximum angle in radians.
  - radiansMinimum
```
public final float radiansMinimum
```
    The minimum angle in radians.
- Method Detail
  - add
```
public AngleF add(AngleF angle)
```
    Adds angle to this AngleF instance.
    Returns a new AngleF instance with the result of the addition.
    If angle is null, a NullPointerException will be thrown.
    
    Parameters:
    
    angle - the AngleF to add
    
    Returns:
    
    a new AngleF instance with the result of the addition
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, angle is null
  - half
```
public AngleF half()
```
    Returns a new AngleF instance that represents half of this AngleF instance.
    
    Returns:
    
    a new AngleF instance that represents half of this AngleF instance
  - subtract
```
public AngleF subtract(AngleF angle)
```
    Subtracts angle from this AngleF instance.
    Returns a new AngleF instance with the result of the subtraction.
    If angle is null, a NullPointerException will be thrown.
    
    Parameters:
    
    angle - the AngleF to subtract
    
    Returns:
    
    a new AngleF instance with the result of the subtraction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, angle is null
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this AngleF instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this AngleF instance
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this AngleF instance for equality.
    Returns true if, and only if, object is an instance of AngleF, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this AngleF instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of AngleF, and their respective values are equal, false otherwise
  - getDegrees
```
public float getDegrees()
```
    Returns the angle in degrees.
    
    Returns:
    
    the angle in degrees
  - getDegreesMaximum
```
public float getDegreesMaximum()
```
    Returns the maximum angle in degrees.
    
    Returns:
    
    the maximum angle in degrees
  - getDegreesMinimum
```
public float getDegreesMinimum()
```
    Returns the minimum angle in degrees.
    
    Returns:
    
    the minimum angle in degrees
  - getRadians
```
public float getRadians()
```
    Returns the angle in radians.
    
    Returns:
    
    the angle in radians
  - getRadiansMaximum
```
public float getRadiansMaximum()
```
    Returns the maximum angle in radians.
    
    Returns:
    
    the maximum angle in radians
  - getRadiansMinimum
```
public float getRadiansMinimum()
```
    Returns the minimum angle in radians.
    
    Returns:
    
    the minimum angle in radians
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this AngleF instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this AngleF instance
  - degrees
```
public static AngleF degrees(float degrees)
```
    Returns a new AngleF instance based on an angle in degrees.
    Calling this method is equivalent to the following:
```
 
 AngleF.degrees(degrees, 0.0F, 360.0F)
 
 
```
    Parameters:
    
    degrees - the angle in degrees
    
    Returns:
    
    a new AngleF instance based on an angle in degrees
  - degrees
```
public static AngleF degrees(float degrees,
                             float degreesA,
                             float degreesB)
```
    Returns a new AngleF instance based on an angle in degrees and an interval of valid degrees.
    
    Parameters:
    
    degrees - the angle in degrees
    
    degreesA - the degrees that represents one of the ends of the interval of valid degrees
    
    degreesB - the degrees that represents one of the ends of the interval of valid degrees
    
    Returns:
    
    a new AngleF instance based on an angle in degrees and an interval of valid degrees
  - fieldOfView
```
public static AngleF fieldOfView(float focalDistance,
                                 float resolution)
```
    Returns a Field of View (FoV) AngleF based on focalDistance and resolution.
    This method allows you to use resolution in either X- or Y-direction. So, either width or height.
    
    Parameters:
    
    focalDistance - the focal distance (also known as focal length}
    
    resolution - the resolution in X- or Y-direction (width or height)
    
    Returns:
    
    a Field of View (FoV) AngleF based on focalDistance and resolution
  - pitch
```
public static AngleF pitch(Point3F eye,
                           Point3F lookAt)
```
    Returns a new pitch AngleF instance based on eye and lookAt.
    If either eye or lookAt are null, a NullPointerException will be thrown.
    
    Parameters:
    
    eye - the Point3F on which the "eye" is positioned
    
    lookAt - the Point3F to which the "eye" is looking
    
    Returns:
    
    a new pitch AngleF instance based on eye and lookAt
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either eye or lookAt are null
  - pitch
```
public static AngleF pitch(Vector3F direction)
```
    Returns a new pitch AngleF instance based on direction.
    If direction is null, a NullPointerException will be thrown.
    
    Parameters:
    
    direction - a normalized direction Vector3F
    
    Returns:
    
    a new pitch AngleF instance based on direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, direction is null
  - radians
```
public static AngleF radians(float radians)
```
    Returns a new AngleF instance based on an angle in radians.
    Calling this method is equivalent to the following:
```
 
 AngleF.radians(radians, 0.0F, PI * 2.0F)
 
 
```
    Parameters:
    
    radians - the angle in radians
    
    Returns:
    
    a new AngleF instance based on an angle in radians
  - radians
```
public static AngleF radians(float radians,
                             float radiansA,
                             float radiansB)
```
    Returns a new AngleF instance based on an angle in radians and an interval of valid radians.
    
    Parameters:
    
    radians - the angle in radians
    
    radiansA - the radians that represents one of the ends of the interval of valid radians
    
    radiansB - the radians that represents one of the ends of the interval of valid radians
    
    Returns:
    
    a new AngleF instance based on an angle in radians and an interval of valid radians
  - yaw
```
public static AngleF yaw(Point3F eye,
                         Point3F lookAt)
```
    Returns a new yaw AngleF instance based on eye and lookAt.
    If either eye or lookAt are null, a NullPointerException will be thrown.
    
    Parameters:
    
    eye - the Point3F on which the "eye" is positioned
    
    lookAt - the Point3F to which the "eye" is looking
    
    Returns:
    
    a new yaw AngleF instance based on eye and lookAt
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either eye or lookAt are null
  - yaw
```
public static AngleF yaw(Vector3F direction)
```
    Returns a new yaw AngleF instance based on direction.
    If direction is null, a NullPointerException will be thrown.
    
    Parameters:
    
    direction - a normalized direction Vector3F
    
    Returns:
    
    a new yaw AngleF instance based on direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, direction is null

Class AngleF

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

degrees

degreesMaximum

degreesMinimum

radians

radiansMaximum

radiansMinimum

Method Detail

add

half

subtract

toString

equals

getDegrees

getDegreesMaximum

getDegreesMinimum

getRadians

getRadiansMaximum

getRadiansMinimum

hashCode

degrees

degrees

fieldOfView

pitch

pitch

radians

radians

yaw

yaw