Triangle (org.dayflower.pathtracer API)

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

All Implemented Interfaces:

Shape
```
public final class Triangle
extends java.lang.Object
implements Shape
```
A Shape implementation that implements a triangle.

Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Triangle.Vertex
A Vertex represents a vertex in a Triangle.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Triangle.Vertex` A `Vertex` represents a vertex in a `Triangle`.

Field Summary

Fields
Modifier and Type	Field and Description
`Triangle.Vertex`	`a` The `Triangle.Vertex` A.
`Triangle.Vertex`	`b` The `Triangle.Vertex` B.
`Triangle.Vertex`	`c` The `Triangle.Vertex` C.
`static int`	`RELATIVE_OFFSET_A_POSITION_OFFSET` The relative offset of the A Position Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_A_SURFACE_NORMAL_OFFSET` The relative offset of the A Surface Normal Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_A_TEXTURE_COORDINATES_OFFSET` The relative offset of the A Texture Coordinates Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_B_POSITION_OFFSET` The relative offset of the B Position Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_B_SURFACE_NORMAL_OFFSET` The relative offset of the B Surface Normal Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_B_TEXTURE_COORDINATES_OFFSET` The relative offset of the B Texture Coordinates Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_C_POSITION_OFFSET` The relative offset of the C Position Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_C_SURFACE_NORMAL_OFFSET` The relative offset of the C Surface Normal Offset parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_C_TEXTURE_COORDINATES_OFFSET` The relative offset of the C Texture Coordinates Offset parameter in the `float` array.
`static int`	`SIZE` The size of a `Triangle` in the `float` array.
`static int`	`TYPE` The type number associated with a `Triangle`.

Constructor Summary

Constructors
Constructor and Description

Triangle(Triangle.Vertex a, Triangle.Vertex b, Triangle.Vertex c)
Constructs a new Triangle instance.

Constructors
Constructor and Description
`Triangle(Triangle.Vertex a, Triangle.Vertex b, Triangle.Vertex c)` Constructs a new `Triangle` instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `Triangle` instance for equality.
`Triangle.Vertex`	`getA()` Returns the `Triangle.Vertex` denoted by A.
`Triangle.Vertex`	`getB()` Returns the `Triangle.Vertex` denoted by B.
`Triangle.Vertex`	`getC()` Returns the `Triangle.Vertex` denoted by C.
`int`	`getSize()` Returns the size of this `Triangle` instance.
`int`	`getType()` Returns the type of this `Triangle` instance.
`int`	`hashCode()` Returns a hash code for this `Triangle` instance.
`static Point3F`	`maximum(java.util.List<Triangle> triangles)` Returns the maximum `Point3F` from the positions of the `Triangle`s in the `List` `triangles`.
`static Point3F`	`minimum(java.util.List<Triangle> triangles)` Returns the minimum `Point3F` from the positions of the `Triangle`s in the `List` `triangles`.
`Triangle`	`rotate(Vector3F w, Vector3F v)` Rotates this `Triangle` instance.
`Triangle`	`scale(float s)` Scales this `Triangle` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `Triangle` instance.
`Triangle`	`translate(float x, float y, float z)` Translates this `Triangle` instance.
`Triangle`	`translateX(float x)` Translates this `Triangle` instance in the X-direction.
`Triangle`	`translateY(float y)` Translates this `Triangle` instance in the Y-direction.
`Triangle`	`translateZ(float z)` Translates this `Triangle` instance in the Z-direction.

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

- Field Detail
  - RELATIVE_OFFSET_A_POSITION_OFFSET
```
public static final int RELATIVE_OFFSET_A_POSITION_OFFSET
```
    The relative offset of the A Position Offset parameter in the float array. The value is 0.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_A_SURFACE_NORMAL_OFFSET
```
public static final int RELATIVE_OFFSET_A_SURFACE_NORMAL_OFFSET
```
    The relative offset of the A Surface Normal Offset parameter in the float array. The value is 3.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_A_TEXTURE_COORDINATES_OFFSET
```
public static final int RELATIVE_OFFSET_A_TEXTURE_COORDINATES_OFFSET
```
    The relative offset of the A Texture Coordinates Offset parameter in the float array. The value is 6.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_B_POSITION_OFFSET
```
public static final int RELATIVE_OFFSET_B_POSITION_OFFSET
```
    The relative offset of the B Position Offset parameter in the float array. The value is 1.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_B_SURFACE_NORMAL_OFFSET
```
public static final int RELATIVE_OFFSET_B_SURFACE_NORMAL_OFFSET
```
    The relative offset of the B Surface Normal Offset parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_B_TEXTURE_COORDINATES_OFFSET
```
public static final int RELATIVE_OFFSET_B_TEXTURE_COORDINATES_OFFSET
```
    The relative offset of the B Texture Coordinates Offset parameter in the float array. The value is 7.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_C_POSITION_OFFSET
```
public static final int RELATIVE_OFFSET_C_POSITION_OFFSET
```
    The relative offset of the C Position Offset parameter in the float array. The value is 2.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_C_SURFACE_NORMAL_OFFSET
```
public static final int RELATIVE_OFFSET_C_SURFACE_NORMAL_OFFSET
```
    The relative offset of the C Surface Normal Offset parameter in the float array. The value is 5.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_C_TEXTURE_COORDINATES_OFFSET
```
public static final int RELATIVE_OFFSET_C_TEXTURE_COORDINATES_OFFSET
```
    The relative offset of the C Texture Coordinates Offset parameter in the float array. The value is 8.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    The size of a Triangle in the float array. The size is 9.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final int TYPE
```
    The type number associated with a Triangle. The number is 2.
    
    See Also:
    
    Constant Field Values
  - a
```
public final Triangle.Vertex a
```
    The Triangle.Vertex A.
  - b
```
public final Triangle.Vertex b
```
    The Triangle.Vertex B.
  - c
```
public final Triangle.Vertex c
```
    The Triangle.Vertex C.
- Constructor Detail
  - Triangle
```
public Triangle(Triangle.Vertex a,
                Triangle.Vertex b,
                Triangle.Vertex c)
```
    Constructs a new Triangle instance.
    If either a, b or c are null, a NullPointerException will be thrown.
    
    Parameters:
    
    a - a Triangle.Vertex denoted by A
    
    b - a Vertex denoted by B
    
    c - a Vertex denoted by C
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either a, b or c are null
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this Triangle instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Triangle instance
  - rotate
```
public Triangle rotate(Vector3F w,
                       Vector3F v)
```
    Rotates this Triangle instance.
    Returns a new rotated version of this Triangle instance.
    If either w or v are null, a NullPointerException will be thrown.
    
    Parameters:
    
    w - a Vector3F
    
    v - a Vector3F
    
    Returns:
    
    a new rotated version of this Triangle instance
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either w or v are null
  - scale
```
public Triangle scale(float s)
```
    Scales this Triangle instance.
    Returns a new scaled version of this Triangle instance.
    
    Parameters:
    
    s - the scaling factor
    
    Returns:
    
    a new scaled version of this Triangle instance
  - translate
```
public Triangle translate(float x,
                          float y,
                          float z)
```
    Translates this Triangle instance.
    Returns a new translated version of this Triangle instance.
    
    Parameters:
    
    x - the amount to translate in the X-direction
    
    y - the amount to translate in the Y-direction
    
    z - the amount to translate in the Z-direction
    
    Returns:
    
    a new translated version of this Triangle instance
  - translateX
```
public Triangle translateX(float x)
```
    Translates this Triangle instance in the X-direction.
    Returns a new translated version of this Triangle instance.
    
    Parameters:
    
    x - the amount to translate in the X-direction
    
    Returns:
    
    a new translated version of this Triangle instance
  - translateY
```
public Triangle translateY(float y)
```
    Translates this Triangle instance in the Y-direction.
    Returns a new translated version of this Triangle instance.
    
    Parameters:
    
    y - the amount to translate in the Y-direction
    
    Returns:
    
    a new translated version of this Triangle instance
  - translateZ
```
public Triangle translateZ(float z)
```
    Translates this Triangle instance in the Z-direction.
    Returns a new translated version of this Triangle instance.
    
    Parameters:
    
    z - the amount to translate in the Z-direction
    
    Returns:
    
    a new translated version of this Triangle instance
  - getA
```
public Triangle.Vertex getA()
```
    Returns the Triangle.Vertex denoted by A.
    
    Returns:
    
    the Vertex denoted by A
  - getB
```
public Triangle.Vertex getB()
```
    Returns the Triangle.Vertex denoted by B.
    
    Returns:
    
    the Vertex denoted by B
  - getC
```
public Triangle.Vertex getC()
```
    Returns the Triangle.Vertex denoted by C.
    
    Returns:
    
    the Vertex denoted by C
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this Triangle instance for equality.
    Returns true if, and only if, object is an instance of Triangle, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this Triangle instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of Triangle, and their respective values are equal, false otherwise
  - getSize
```
public int getSize()
```
    Returns the size of this Triangle instance.
    
    Specified by:
    
    getSize in interface Shape
    
    Returns:
    
    the size of this Triangle instance
  - getType
```
public int getType()
```
    Returns the type of this Triangle instance.
    
    Specified by:
    
    getType in interface Shape
    
    Returns:
    
    the type of this Triangle instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this Triangle instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this Triangle instance
  - maximum
```
public static Point3F maximum(java.util.List<Triangle> triangles)
```
    Returns the maximum Point3F from the positions of the Triangles in the List triangles.
    If either triangles or any of its elements are null, a NullPointerException will be thrown.
    
    Parameters:
    
    triangles - a List with Triangles
    
    Returns:
    
    the maximum Point3 from the positions of the Triangles in the List triangles
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either triangles or any of its elements are null
  - minimum
```
public static Point3F minimum(java.util.List<Triangle> triangles)
```
    Returns the minimum Point3F from the positions of the Triangles in the List triangles.
    If either triangles or any of its elements are null, a NullPointerException will be thrown.
    
    Parameters:
    
    triangles - a List with Triangles
    
    Returns:
    
    the minimum Point3 from the positions of the Triangles in the List triangles
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either triangles or any of its elements are null

Class Triangle

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RELATIVE_OFFSET_A_POSITION_OFFSET

RELATIVE_OFFSET_A_SURFACE_NORMAL_OFFSET

RELATIVE_OFFSET_A_TEXTURE_COORDINATES_OFFSET

RELATIVE_OFFSET_B_POSITION_OFFSET

RELATIVE_OFFSET_B_SURFACE_NORMAL_OFFSET

RELATIVE_OFFSET_B_TEXTURE_COORDINATES_OFFSET

RELATIVE_OFFSET_C_POSITION_OFFSET

RELATIVE_OFFSET_C_SURFACE_NORMAL_OFFSET

RELATIVE_OFFSET_C_TEXTURE_COORDINATES_OFFSET

SIZE

TYPE

a

b

c

Constructor Detail

Triangle

Method Detail

toString

rotate

scale

translate

translateX

translateY

translateZ

getA

getB

getC

equals

getSize

getType

hashCode

maximum

minimum