Plane (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.scene.shape.Plane

All Implemented Interfaces:

Shape
```
public final class Plane
extends java.lang.Object
implements Shape
```
A Shape implementation that implements a plane.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`Point3F`	`a` A `Point3F` denoting the point A.
`Point3F`	`b` A `Point3F` denoting the point B.
`Point3F`	`c` A `Point3F` denoting the point C.
`static int`	`RELATIVE_OFFSET_A_OFFSET` The relative offset of the A Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_B_OFFSET` The relative offset of the B Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_C_OFFSET` The relative offset of the C Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_SURFACE_NORMAL_OFFSET` The relative offset of the Surface Normal Offset parameter in the `float` array.
`static int`	`SIZE` The size of a `Plane` in the `float` array.
`Vector3F`	`surfaceNormal` The surface normal.
`static int`	`TYPE` The type number associated with a `Plane`.

Constructor Summary

Constructors
Constructor and Description

Plane(Point3F a, Point3F b, Point3F c)
Constructs a new Plane instance.

Constructors
Constructor and Description
`Plane(Point3F a, Point3F b, Point3F c)` Constructs a new `Plane` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `Plane` instance for equality.
`Point3F`	`getA()` Returns the point A.
`Point3F`	`getB()` Returns the point B.
`Point3F`	`getC()` Returns the point C.
`int`	`getSize()` Returns the size of this `Plane` instance.
`Vector3F`	`getSurfaceNormal()` Returns the surface normal.
`int`	`getType()` Returns the type of this `Plane` instance.
`int`	`hashCode()` Returns a hash code for this `Plane` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `Plane` instance.

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

- Field Detail
  - RELATIVE_OFFSET_A_OFFSET
```
public static final int RELATIVE_OFFSET_A_OFFSET
```
    The relative offset of the A Offset parameter in the float array. The value is 0.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_B_OFFSET
```
public static final int RELATIVE_OFFSET_B_OFFSET
```
    The relative offset of the B Offset parameter in the float array. The value is 1.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_C_OFFSET
```
public static final int RELATIVE_OFFSET_C_OFFSET
```
    The relative offset of the C Offset parameter in the float array. The value is 2.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_SURFACE_NORMAL_OFFSET
```
public static final int RELATIVE_OFFSET_SURFACE_NORMAL_OFFSET
```
    The relative offset of the Surface Normal Offset parameter in the float array. The value is 3.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    The size of a Plane in the float array. The size is 4.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final int TYPE
```
    The type number associated with a Plane. The number is 3.
    
    See Also:
    
    Constant Field Values
  - a
```
public final Point3F a
```
    A Point3F denoting the point A.
  - b
```
public final Point3F b
```
    A Point3F denoting the point B.
  - c
```
public final Point3F c
```
    A Point3F denoting the point C.
  - surfaceNormal
```
public final Vector3F surfaceNormal
```
    The surface normal.
- Constructor Detail
  - Plane
```
public Plane(Point3F a,
             Point3F b,
             Point3F c)
```
    Constructs a new Plane instance.
    If either a, b or c are null, a NullPointerException will be thrown.
    
    Parameters:
    
    a - a Point3F denoting the point A
    
    b - a Point3 denoting the point A
    
    c - a Point3 denoting the point A
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either a, b or c are null
- Method Detail
  - getA
```
public Point3F getA()
```
    Returns the point A.
    
    Returns:
    
    the point A
  - getB
```
public Point3F getB()
```
    Returns the point B.
    
    Returns:
    
    the point B
  - getC
```
public Point3F getC()
```
    Returns the point C.
    
    Returns:
    
    the point C
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this Plane instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Plane instance
  - getSurfaceNormal
```
public Vector3F getSurfaceNormal()
```
    Returns the surface normal.
    
    Returns:
    
    the surface normal
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this Plane instance for equality.
    Returns true if, and only if, object is an instance of Plane, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this Plane instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of Plane, and their respective values are equal, false otherwise
  - getSize
```
public int getSize()
```
    Returns the size of this Plane instance.
    
    Specified by:
    
    getSize in interface Shape
    
    Returns:
    
    the size of this Plane instance
  - getType
```
public int getType()
```
    Returns the type of this Plane instance.
    
    Specified by:
    
    getType in interface Shape
    
    Returns:
    
    the type of this Plane instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this Plane instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this Plane instance

Class Plane

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RELATIVE_OFFSET_A_OFFSET

RELATIVE_OFFSET_B_OFFSET

RELATIVE_OFFSET_C_OFFSET

RELATIVE_OFFSET_SURFACE_NORMAL_OFFSET

SIZE

TYPE

a

b

c

surfaceNormal

Constructor Detail

Plane

Method Detail

getA

getB

getC

toString

getSurfaceNormal

equals

getSize

getType

hashCode