org.dayflower.pathtracer.scene

Class Surface

java.lang.Object

org.dayflower.pathtracer.scene.Surface

public final class Surface
extends java.lang.Object

A Surface is a model of a surface with different properties.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields

Modifier and Type	Field and Description
static int	RELATIVE_OFFSET_MATERIAL The relative offset of the Material parameter in the float array.
static int	RELATIVE_OFFSET_NOISE_AMOUNT The relative offset of the Noise Amount parameter in the float array.
static int	RELATIVE_OFFSET_NOISE_SCALE The relative offset of the Noise Scale parameter in the float array.
static int	RELATIVE_OFFSET_TEXTURE_ALBEDO_OFFSET The relative offset of the Texture Albedo Offset parameter in the float array.
static int	RELATIVE_OFFSET_TEXTURE_EMISSION_OFFSET The relative offset of the Texture Emission Offset parameter in the float array.
static int	RELATIVE_OFFSET_TEXTURE_NORMAL_OFFSET The relative offset of the Texture Normal Offset parameter in the float array.
static int	SIZE The size of a Surface in the float array.

Constructor Summary

Constructors

Constructor and Description
Surface(Material material, Texture textureAlbedo, Texture textureEmission, Texture textureNormal) Constructs a new Surface instance.
Surface(Material material, Texture textureAlbedo, Texture textureEmission, Texture textureNormal, float noiseAmount, float noiseScale) Constructs a new Surface instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Compares object to this Surface instance for equality.
Material	getMaterial() Returns the Material of this Surface instance.
float	getNoiseAmount() Returns the Noise amount of this Surface instance.
float	getNoiseScale() Returns the Noise scale of this Surface instance.
Texture	getTextureAlbedo() Returns the Albedo Texture of this Surface instance.
Texture	getTextureEmission() Returns the Emission Texture of this Surface instance.
Texture	getTextureNormal() Returns the Normal Map Texture of this Surface instance.
int	hashCode() Returns a hash code for this Surface instance.
java.lang.String	toString() Returns a String representation of this Surface instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RELATIVE_OFFSET_MATERIAL

public static final int RELATIVE_OFFSET_MATERIAL

The relative offset of the Material parameter in the float array. The value is 0.

See Also:

Constant Field Values

RELATIVE_OFFSET_NOISE_AMOUNT

public static final int RELATIVE_OFFSET_NOISE_AMOUNT

The relative offset of the Noise Amount parameter in the float array. The value is 4.

See Also:

Constant Field Values

RELATIVE_OFFSET_NOISE_SCALE

public static final int RELATIVE_OFFSET_NOISE_SCALE

The relative offset of the Noise Scale parameter in the float array. The value is 5.

See Also:

Constant Field Values

RELATIVE_OFFSET_TEXTURE_ALBEDO_OFFSET

public static final int RELATIVE_OFFSET_TEXTURE_ALBEDO_OFFSET

The relative offset of the Texture Albedo Offset parameter in the float array. The value is 1.

See Also:

Constant Field Values

RELATIVE_OFFSET_TEXTURE_EMISSION_OFFSET

public static final int RELATIVE_OFFSET_TEXTURE_EMISSION_OFFSET

The relative offset of the Texture Emission Offset parameter in the float array. The value is 2.

See Also:

Constant Field Values

RELATIVE_OFFSET_TEXTURE_NORMAL_OFFSET

public static final int RELATIVE_OFFSET_TEXTURE_NORMAL_OFFSET

The relative offset of the Texture 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 Surface in the float array. The size is 6.

See Also:

Constant Field Values

Constructor Detail

Surface

public Surface(Material material,
               Texture textureAlbedo,
               Texture textureEmission,
               Texture textureNormal)

Constructs a new Surface instance.

Calling this constructor is equivalent to new Surface(material, textureAlbedo, textureEmission, textureNormal, 0.0F, 0.0F).

If either material, textureAlbedo, textureEmission or textureNormal are null, a NullPointerException will be thrown.

Parameters:

material - a Material

textureAlbedo - an Albedo Texture

textureEmission - an Emission Texture

textureNormal - a Normal Texture

Throws:

java.lang.NullPointerException - thrown if, and only if, either material, textureAlbedo, textureEmission or textureNormal are null

Surface

public Surface(Material material,
               Texture textureAlbedo,
               Texture textureEmission,
               Texture textureNormal,
               float noiseAmount,
               float noiseScale)

Constructs a new Surface instance.

If either material, textureAlbedo, textureEmission or textureNormal are null, a NullPointerException will be thrown.

Parameters:

material - a Material

textureAlbedo - an Albedo Texture

textureEmission - an Emission Texture

textureNormal - a Normal Texture

noiseAmount - the noise amount

noiseScale - the noise scale

Throws:

java.lang.NullPointerException - thrown if, and only if, either material, textureAlbedo, textureEmission or textureNormal are null

Method Detail

getMaterial

public Material getMaterial()

Returns the Material of this Surface instance.

Returns:

the Material of this Surface instance

toString

public java.lang.String toString()

Returns a String representation of this Surface instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Surface instance

getTextureAlbedo

public Texture getTextureAlbedo()

Returns the Albedo Texture of this Surface instance.

Returns:

the Albedo Texture of this Surface instance

getTextureEmission

public Texture getTextureEmission()

Returns the Emission Texture of this Surface instance.

Returns:

the Emission Texture of this Surface instance

getTextureNormal

public Texture getTextureNormal()

Returns the Normal Map Texture of this Surface instance.

Returns:

the Normal Map Texture of this Surface instance

equals

public boolean equals(java.lang.Object object)

Compares object to this Surface instance for equality.

Returns true if, and only if, object is an instance of Surface, and their respective values are equal, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - the Object to compare to this Surface instance for equality

Returns:

true if, and only if, object is an instance of Surface, and their respective values are equal, false otherwise

getNoiseAmount

public float getNoiseAmount()

Returns the Noise amount of this Surface instance.

Returns:

the Noise amount of this Surface instance

getNoiseScale

public float getNoiseScale()

Returns the Noise scale of this Surface instance.

Returns:

the Noise scale of this Surface instance

hashCode

public int hashCode()

Returns a hash code for this Surface instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this Surface instance