CheckerboardTexture (org.dayflower.pathtracer API)

java.lang.Object
- org.dayflower.pathtracer.scene.texture.CheckerboardTexture

All Implemented Interfaces:

Texture
```
public final class CheckerboardTexture
extends java.lang.Object
implements Texture
```
A CheckerboardTexture is a Texture implementation that models a texture with a checkerboard pattern.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`RELATIVE_OFFSET_COLOR_0` The relative offset of the Color 0 parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_COLOR_1` The relative offset of the Color 1 parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_RADIANS_COS` The relative offset of the Radians Cos parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_RADIANS_SIN` The relative offset of the Radians Sin parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_SCALE_U` The relative offset of the Scale U parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_SCALE_V` The relative offset of the Scale V parameter in the `float` array.
`static int`	`SIZE` The size of a `CheckerboardTexture` in the `float` array.
`static int`	`TYPE` The type number associated with a `CheckerboardTexture`.

Fields inherited from interface org.dayflower.pathtracer.scene.Texture
RELATIVE_OFFSET_SIZE, RELATIVE_OFFSET_TYPE

Constructor Summary

Constructors
Constructor and Description
`CheckerboardTexture()` Constructs a new `CheckerboardTexture` instance.
`CheckerboardTexture(Color color)` Constructs a new `CheckerboardTexture` instance with a given `Color`.
`CheckerboardTexture(Color color0, Color color1)` Constructs a new `CheckerboardTexture` instance with two different `Color`s.
`CheckerboardTexture(Color color0, Color color1, float scaleU, float scaleV)` Constructs a new `CheckerboardTexture` instance with two different `Color`s and scale factors in the U- and V-directions.
`CheckerboardTexture(Color color0, Color color1, float scaleU, float scaleV, float degrees)` Constructs a new `CheckerboardTexture` instance with two different `Color`s, scale factors in the U- and V-directions and the angle in degrees to rotate it.
`CheckerboardTexture(Color color, float scaleU, float scaleV)` Constructs a new `CheckerboardTexture` instance with a given `Color` and scale factors in the U- and V-directions.
`CheckerboardTexture(Color color, float scaleU, float scaleV, float degrees)` Constructs a new `CheckerboardTexture` instance with a given `Color`, scale factors in the U- and V-directions and the angle in degrees to rotate it.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `CheckerboardTexture` instance for equality.
`Color`	`getColor0()` Returns one of the two `Color`s assigned to this `CheckerboardTexture` instance.
`Color`	`getColor1()` Returns one of the two `Color`s assigned to this `CheckerboardTexture` instance.
`float`	`getDegrees()` Returns the angle in degrees that this `CheckerboardTexture` instance should be rotated.
`float`	`getScaleU()` Returns the scale factor in the U-direction assigned to this `CheckerboardTexture` instance.
`float`	`getScaleV()` Returns the scale factor in the V-direction assigned to this `CheckerboardTexture` instance.
`int`	`getSize()` Returns the size of this `CheckerboardTexture` instance.
`int`	`getType()` Returns the type of this `CheckerboardTexture` instance.
`int`	`hashCode()` Returns a hash code for this `CheckerboardTexture` instance.
`boolean`	`isEmissive()` Returns `true` if, and only if, this `CheckerboardTexture` instance is emissive, `false` otherwise.
`float[]`	`toArray()` Returns a `float` array representation of this `CheckerboardTexture` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `CheckerboardTexture` instance.

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

- Field Detail
  - RELATIVE_OFFSET_COLOR_0
```
public static final int RELATIVE_OFFSET_COLOR_0
```
    The relative offset of the Color 0 parameter in the float array. The value is 2.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_COLOR_1
```
public static final int RELATIVE_OFFSET_COLOR_1
```
    The relative offset of the Color 1 parameter in the float array. The value is 3.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_RADIANS_COS
```
public static final int RELATIVE_OFFSET_RADIANS_COS
```
    The relative offset of the Radians Cos parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_RADIANS_SIN
```
public static final int RELATIVE_OFFSET_RADIANS_SIN
```
    The relative offset of the Radians Sin parameter in the float array. The value is 5.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_SCALE_U
```
public static final int RELATIVE_OFFSET_SCALE_U
```
    The relative offset of the Scale U parameter in the float array. The value is 6.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_SCALE_V
```
public static final int RELATIVE_OFFSET_SCALE_V
```
    The relative offset of the Scale V parameter in the float array. The value is 7.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    The size of a CheckerboardTexture in the float array. The size is 8.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final int TYPE
```
    The type number associated with a CheckerboardTexture. The number is 2.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CheckerboardTexture
```
public CheckerboardTexture()
```
    Constructs a new CheckerboardTexture instance.
    Calling this constructor is equivalent to calling new CheckerboardTexture(Color.GRAY).
  - CheckerboardTexture
```
public CheckerboardTexture(Color color)
```
    Constructs a new CheckerboardTexture instance with a given Color.
    Calling this constructor is equivalent to calling new CheckerboardTexture(color, 5.0F, 5.0F).
    If color is null, a NullPointerException will be thrown.
    
    Parameters:
    
    color - a Color
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, color is null
  - CheckerboardTexture
```
public CheckerboardTexture(Color color0,
                           Color color1)
```
    Constructs a new CheckerboardTexture instance with two different Colors.
    Calling this constructor is equivalent to calling new CheckerboardTexture(color0, color1, 5.0F, 5.0F).
    If either color0 or color1 are null, a NullPointerException will be thrown.
    
    Parameters:
    
    color0 - a Color
    
    color1 - a Color
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either color0 or color1 are null
  - CheckerboardTexture
```
public CheckerboardTexture(Color color0,
                           Color color1,
                           float scaleU,
                           float scaleV)
```
    Constructs a new CheckerboardTexture instance with two different Colors and scale factors in the U- and V-directions.
    Calling this constructor is equivalent to calling new CheckerboardTexture(color0, color1, scaleU, scaleV, 0.0F).
    If either color0 or color1 are null, a NullPointerException will be thrown.
    
    Parameters:
    
    color0 - a Color
    
    color1 - a Color
    
    scaleU - the scale factor in the U-direction
    
    scaleV - the scale factor in the V-direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either color0 or color1 are null
  - CheckerboardTexture
```
public CheckerboardTexture(Color color0,
                           Color color1,
                           float scaleU,
                           float scaleV,
                           float degrees)
```
    Constructs a new CheckerboardTexture instance with two different Colors, scale factors in the U- and V-directions and the angle in degrees to rotate it.
    If either color0 or color1 are null, a NullPointerException will be thrown.
    
    Parameters:
    
    color0 - a Color
    
    color1 - a Color
    
    scaleU - the scale factor in the U-direction
    
    scaleV - the scale factor in the V-direction
    
    degrees - the angle in degrees to rotate it
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either color0 or color1 are null
  - CheckerboardTexture
```
public CheckerboardTexture(Color color,
                           float scaleU,
                           float scaleV)
```
    Constructs a new CheckerboardTexture instance with a given Color and scale factors in the U- and V-directions.
    Calling this constructor is equivalent to calling new CheckerboardTexture(color, scaleU, scaleV, 0.0F).
    If color is null, a NullPointerException will be thrown.
    
    Parameters:
    
    color - a Color
    
    scaleU - the scale factor in the U-direction
    
    scaleV - the scale factor in the V-direction
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, color is null
  - CheckerboardTexture
```
public CheckerboardTexture(Color color,
                           float scaleU,
                           float scaleV,
                           float degrees)
```
    Constructs a new CheckerboardTexture instance with a given Color, scale factors in the U- and V-directions and the angle in degrees to rotate it.
    Calling this constructor is equivalent to calling new CheckerboardTexture(color, color, scaleU, scaleV, degrees).
    If color is null, a NullPointerException will be thrown.
    
    Parameters:
    
    color - a Color
    
    scaleU - the scale factor in the U-direction
    
    scaleV - the scale factor in the V-direction
    
    degrees - the angle in degrees to rotate it
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, color is null
- Method Detail
  - getColor0
```
public Color getColor0()
```
    Returns one of the two Colors assigned to this CheckerboardTexture instance.
    
    Returns:
    
    one of the two Colors assigned to this CheckerboardTexture instance
  - getColor1
```
public Color getColor1()
```
    Returns one of the two Colors assigned to this CheckerboardTexture instance.
    
    Returns:
    
    one of the two Colors assigned to this CheckerboardTexture instance
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this CheckerboardTexture instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this CheckerboardTexture instance
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this CheckerboardTexture instance for equality.
    Returns true if, and only if, object is an instance of CheckerboardTexture, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this CheckerboardTexture instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of CheckerboardTexture, and their respective values are equal, false otherwise
  - isEmissive
```
public boolean isEmissive()
```
    Returns true if, and only if, this CheckerboardTexture instance is emissive, false otherwise.
    
    Specified by:
    
    isEmissive in interface Texture
    
    Returns:
    
    true if, and only if, this CheckerboardTexture instance is emissive, false otherwise
  - getDegrees
```
public float getDegrees()
```
    Returns the angle in degrees that this CheckerboardTexture instance should be rotated.
    
    Returns:
    
    the angle in degrees that this CheckerboardTexture instance should be rotated
  - getScaleU
```
public float getScaleU()
```
    Returns the scale factor in the U-direction assigned to this CheckerboardTexture instance.
    
    Returns:
    
    the scale factor in the U-direction assigned to this CheckerboardTexture instance
  - getScaleV
```
public float getScaleV()
```
    Returns the scale factor in the V-direction assigned to this CheckerboardTexture instance.
    
    Returns:
    
    the scale factor in the V-direction assigned to this CheckerboardTexture instance
  - toArray
```
public float[] toArray()
```
    Returns a float array representation of this CheckerboardTexture instance.
    
    Specified by:
    
    toArray in interface Texture
    
    Returns:
    
    a float array representation of this CheckerboardTexture instance
  - getSize
```
public int getSize()
```
    Returns the size of this CheckerboardTexture instance.
    
    Specified by:
    
    getSize in interface Texture
    
    Returns:
    
    the size of this CheckerboardTexture instance
  - getType
```
public int getType()
```
    Returns the type of this CheckerboardTexture instance.
    
    Specified by:
    
    getType in interface Texture
    
    Returns:
    
    the type of this CheckerboardTexture instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this CheckerboardTexture instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this CheckerboardTexture instance

Class CheckerboardTexture

Field Summary

Fields inherited from interface org.dayflower.pathtracer.scene.Texture

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RELATIVE_OFFSET_COLOR_0

RELATIVE_OFFSET_COLOR_1

RELATIVE_OFFSET_RADIANS_COS

RELATIVE_OFFSET_RADIANS_SIN

RELATIVE_OFFSET_SCALE_U

RELATIVE_OFFSET_SCALE_V

SIZE

TYPE

Constructor Detail

CheckerboardTexture

CheckerboardTexture

CheckerboardTexture

CheckerboardTexture

CheckerboardTexture

CheckerboardTexture

CheckerboardTexture

Method Detail

getColor0

getColor1

toString

equals

isEmissive

getDegrees

getScaleU

getScaleV

toArray

getSize

getType

hashCode