org.dayflower.pathtracer.scene.texture

Class ConstantTexture

java.lang.Object

org.dayflower.pathtracer.scene.texture.ConstantTexture

All Implemented Interfaces:

Texture

public final class ConstantTexture
extends java.lang.Object
implements Texture

A ConstantTexture is a Texture implementation that models a texture with a constant color.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields

Modifier and Type	Field and Description
static int	RELATIVE_OFFSET_COLOR The relative offset of the Color parameter in the float array.
static int	SIZE The size of a ConstantTexture in the float array.
static int	TYPE The type number associated with a ConstantTexture.

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

RELATIVE_OFFSET_SIZE, RELATIVE_OFFSET_TYPE

Constructor Summary

Constructors

Constructor and Description
ConstantTexture() Constructs a new ConstantTexture instance.
ConstantTexture(Color color) Constructs a new ConstantTexture instance given a Color as its color.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Compares object to this ConstantTexture instance for equality.
Color	getColor() Returns the Color assigned to this ConstantTexture instance.
int	getSize() Returns the size of this ConstantTexture instance.
int	getType() Returns the type of this ConstantTexture instance.
int	hashCode() Returns a hash code for this ConstantTexture instance.
boolean	isEmissive() Returns true if, and only if, this ConstantTexture instance is emissive, false otherwise.
float[]	toArray() Returns a float array representation of this ConstantTexture instance.
java.lang.String	toString() Returns a String representation of this ConstantTexture instance.

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE_OFFSET_COLOR

public static final int RELATIVE_OFFSET_COLOR

The relative offset of the Color parameter in the float array. The value is 2.

See Also:

Constant Field Values

SIZE

public static final int SIZE

The size of a ConstantTexture in the float array. The size is 3.

See Also:

Constant Field Values

TYPE

public static final int TYPE

The type number associated with a ConstantTexture. The number is 3.

See Also:

Constant Field Values

Constructor Detail

ConstantTexture

public ConstantTexture()

Constructs a new ConstantTexture instance.

Calling this constructor is equivalent to calling new ConstantTexture(Color.GREEN).

ConstantTexture

public ConstantTexture(Color color)

Constructs a new ConstantTexture instance given a Color as its color.

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

Method Detail

getColor

public Color getColor()

Returns the Color assigned to this ConstantTexture instance.

Returns:

the Color assigned to this ConstantTexture instance

toString

public java.lang.String toString()

Returns a String representation of this ConstantTexture instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this ConstantTexture instance

equals

public boolean equals(java.lang.Object object)

Compares object to this ConstantTexture instance for equality.

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

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

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

isEmissive

public boolean isEmissive()

Returns true if, and only if, this ConstantTexture instance is emissive, false otherwise.

Specified by:

isEmissive in interface Texture

Returns:

true if, and only if, this ConstantTexture instance is emissive, false otherwise

toArray

public float[] toArray()

Returns a float array representation of this ConstantTexture instance.

Specified by:

toArray in interface Texture

Returns:

a float array representation of this ConstantTexture instance

getSize

public int getSize()

Returns the size of this ConstantTexture instance.

Specified by:

getSize in interface Texture

Returns:

the size of this ConstantTexture instance

getType

public int getType()

Returns the type of this ConstantTexture instance.

Specified by:

getType in interface Texture

Returns:

the type of this ConstantTexture instance

hashCode

public int hashCode()

Returns a hash code for this ConstantTexture instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this ConstantTexture instance