OrthoNormalBasis33F (org.dayflower.pathtracer API)

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

```
public final class OrthoNormalBasis33F
extends java.lang.Object
```
An OrthoNormalBasis33F denotes an orthonormal basis.
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
`Vector3F`	`u` A `Vector3F` pointing in the U-direction.
`Vector3F`	`v` A `Vector3F` pointing in the V-direction.
`Vector3F`	`w` A `Vector3F` pointing in the W-direction.

Constructor Summary

Constructors
Constructor and Description
`OrthoNormalBasis33F()` Constructs a new `OrthoNormalBasis33F` instance.
`OrthoNormalBasis33F(Point3F eye, Point3F lookAt)` Constructs a new `OrthoNormalBasis33F` instance given `eye` and `lookAt`.
`OrthoNormalBasis33F(Point3F eye, Point3F lookAt, Vector3F v)` Constructs a new `OrthoNormalBasis33F` instance given `eye`, `lookAt` and `v`.
`OrthoNormalBasis33F(Vector3F w)` Constructs a new `OrthoNormalBasis33F` instance given `w`.
`OrthoNormalBasis33F(Vector3F w, Vector3F v)` Constructs a new `OrthoNormalBasis` instance given `w` and `v`.
`OrthoNormalBasis33F(Vector3F w, Vector3F v, Vector3F u)` Constructs a new `OrthoNormalBasis33F` instance given `w`, `v` and `u`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `OrthoNormalBasis33F` instance for equality.
`OrthoNormalBasis33F`	`flipU()` Flips the U-direction.
`OrthoNormalBasis33F`	`flipV()` Flips the V-direction.
`OrthoNormalBasis33F`	`flipW()` Flips the W-direction.
`Vector3F`	`getU()` Returns the `Vector3F` pointing in the U-direction.
`Vector3F`	`getV()` Returns the `Vector3F` pointing in the V-direction.
`Vector3F`	`getW()` Returns the `Vector3F` pointing in the W-direction.
`int`	`hashCode()` Returns a hash code for this `OrthoNormalBasis33F` instance.
`OrthoNormalBasis33F`	`swapUV()` Swaps the U- and V-directions.
`OrthoNormalBasis33F`	`swapUW()` Swaps the U- and W-directions.
`OrthoNormalBasis33F`	`swapVU()` Swaps the V- and U-directions.
`OrthoNormalBasis33F`	`swapWU()` Swaps the W- and U-directions.
`OrthoNormalBasis33F`	`swapVW()` Swaps the V- and W-directions.
`OrthoNormalBasis33F`	`swapWV()` Swaps the W- and V-directions.
`java.lang.String`	`toString()` Returns a `String` representation of this `OrthoNormalBasis33F` instance.
`OrthoNormalBasis33F`	`transform(Matrix44F m)` Performs a transformation.

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

- Field Detail
  - u
```
public final Vector3F u
```
    A Vector3F pointing in the U-direction.
  - v
```
public final Vector3F v
```
    A Vector3F pointing in the V-direction.
  - w
```
public final Vector3F w
```
    A Vector3F pointing in the W-direction.
- Constructor Detail
  - OrthoNormalBasis33F
```
public OrthoNormalBasis33F()
```
    Constructs a new OrthoNormalBasis33F instance.
    Calling this constructor is equivalent to the following:
```
 
 new OrthoNormalBasis33F(Vector3F.z(), Vector3F.y(), Vector3F.x())
 
 
```
  - OrthoNormalBasis33F
```
public OrthoNormalBasis33F(Point3F eye,
                           Point3F lookAt)
```
    Constructs a new OrthoNormalBasis33F instance given eye and lookAt.
    Calling this constructor is equivalent to the following:
```
 
 new OrthoNormalBasis33F(eye, lookAt, Vector3F.y())
 
 
```
    If either eye or lookAt are null, a NullPointerException will be thrown.
    Parameters:
    
    eye - a Point3F denoting the eye from which the W-direction is computed
    
    lookAt - a Point3F used in the computation of the W-direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either eye or lookAt are null
  - OrthoNormalBasis33F
```
public OrthoNormalBasis33F(Point3F eye,
                           Point3F lookAt,
                           Vector3F v)
```
    Constructs a new OrthoNormalBasis33F instance given eye, lookAt and v.
    The W-direction is computed by Vector3F.direction(lookAt, eye), which is the opposite direction.
    If either eye, lookAt or v are null, a NullPointerException will be thrown.
    
    Parameters:
    
    eye - a Point3F denoting the eye from which the W-direction is computed
    
    lookAt - a Point3F used in the computation of the W-direction
    
    v - a Vector3F denoting the V-direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either eye, lookAt or v are null
  - OrthoNormalBasis33F
```
public OrthoNormalBasis33F(Vector3F w)
```
    Constructs a new OrthoNormalBasis33F instance given w.
    If w is null, a NullPointerException will be thrown.
    
    Parameters:
    
    w - a Vector3F pointing in the W-direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, w is null
  - OrthoNormalBasis33F
```
public OrthoNormalBasis33F(Vector3F w,
                           Vector3F v)
```
    Constructs a new OrthoNormalBasis instance given w and v.
    If either w or v are null, a NullPointerException will be thrown.
    
    Parameters:
    
    w - a Vector3F pointing in the W-direction
    
    v - a Vector3 pointing in the V-direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either w or v are null
  - OrthoNormalBasis33F
```
public OrthoNormalBasis33F(Vector3F w,
                           Vector3F v,
                           Vector3F u)
```
    Constructs a new OrthoNormalBasis33F instance given w, v and u.
    If either w, v or u are null, a NullPointerException will be thrown.
    
    Parameters:
    
    w - a Vector3F pointing in the W-direction
    
    v - a Vector3F pointing in the V-direction
    
    u - a Vector3F pointing in the U-direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either w, v or u are null
- Method Detail
  - flipU
```
public OrthoNormalBasis33F flipU()
```
    Flips the U-direction.
    Returns a new OrthoNormalBasis33F with the U-direction flipped.
    
    Returns:
    
    a new OrthoNormalBasis33F with the U-direction flipped
  - flipV
```
public OrthoNormalBasis33F flipV()
```
    Flips the V-direction.
    Returns a new OrthoNormalBasis33F with the V-direction flipped.
    
    Returns:
    
    a new OrthoNormalBasis33F with the V-direction flipped
  - flipW
```
public OrthoNormalBasis33F flipW()
```
    Flips the W-direction.
    Returns a new OrthoNormalBasis33F with the W-direction flipped.
    
    Returns:
    
    a new OrthoNormalBasis33F with the W-direction flipped
  - swapUV
```
public OrthoNormalBasis33F swapUV()
```
    Swaps the U- and V-directions.
    Returns a new OrthoNormalBasis33F with the U- and V-directions swapped.
    This method does the same thing as swapVU().
    
    Returns:
    
    a new OrthoNormalBasis33F with the U- and V-directions swapped
  - swapUW
```
public OrthoNormalBasis33F swapUW()
```
    Swaps the U- and W-directions.
    Returns a new OrthoNormalBasis33F with the U- and W-directions swapped.
    This method does the same thing as swapWU().
    
    Returns:
    
    a new OrthoNormalBasis33F with the U- and W-directions swapped
  - swapVU
```
public OrthoNormalBasis33F swapVU()
```
    Swaps the V- and U-directions.
    Returns a new OrthoNormalBasis33F with the V- and U-directions swapped.
    This method does the same thing as swapUV().
    
    Returns:
    
    a new OrthoNormalBasis33F with the V- and U-directions swapped
  - swapVW
```
public OrthoNormalBasis33F swapVW()
```
    Swaps the V- and W-directions.
    Returns a new OrthoNormalBasis33F with the V- and W-directions swapped.
    This method does the same thing as swapWV().
    
    Returns:
    
    a new OrthoNormalBasis33F with the V- and W-directions swapped
  - swapWU
```
public OrthoNormalBasis33F swapWU()
```
    Swaps the W- and U-directions.
    Returns a new OrthoNormalBasis33F with the W- and U-directions swapped.
    This method does the same thing as swapUW().
    
    Returns:
    
    a new OrthoNormalBasis33F with the W- and U-directions swapped
  - swapWV
```
public OrthoNormalBasis33F swapWV()
```
    Swaps the W- and V-directions.
    Returns a new OrthoNormalBasis33F with the W- and V-directions swapped.
    This method does the same thing as swapVW().
    
    Returns:
    
    a new OrthoNormalBasis33F with the W- and V-directions swapped
  - transform
```
public OrthoNormalBasis33F transform(Matrix44F m)
```
    Performs a transformation.
    Returns a new OrthoNormalBasis33F with the result of the transformation.
    If m is null, a NullPointerException will be thrown.
    
    Parameters:
    
    m - a Matrix44F
    
    Returns:
    
    a new OrthoNormalBasis33F with the result of the transformation
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, m is null
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this OrthoNormalBasis33F instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this OrthoNormalBasis33F instance
  - getU
```
public Vector3F getU()
```
    Returns the Vector3F pointing in the U-direction.
    
    Returns:
    
    the Vector3F pointing in the U-direction
  - getV
```
public Vector3F getV()
```
    Returns the Vector3F pointing in the V-direction.
    
    Returns:
    
    the Vector3F pointing in the V-direction
  - getW
```
public Vector3F getW()
```
    Returns the Vector3F pointing in the W-direction.
    
    Returns:
    
    the Vector3F pointing in the W-direction
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this OrthoNormalBasis33F instance for equality.
    Returns true if, and only if, object is an instance of OrthoNormalBasis33F, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this OrthoNormalBasis33F instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of OrthoNormalBasis33F, and their respective values are equal, false otherwise
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this OrthoNormalBasis33F instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this OrthoNormalBasis33F instance

Class OrthoNormalBasis33F

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

u

v

w

Constructor Detail

OrthoNormalBasis33F

OrthoNormalBasis33F

OrthoNormalBasis33F

OrthoNormalBasis33F

OrthoNormalBasis33F

OrthoNormalBasis33F

Method Detail

flipU

flipV

flipW

swapUV

swapUW

swapVU

swapVW

swapWU

swapWV

transform

toString

getU

getV

getW

equals

hashCode