ImageTexture (org.dayflower.pathtracer API)

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

All Implemented Interfaces:

Texture
```
public final class ImageTexture
extends java.lang.Object
implements Texture
```
An ImageTexture is a Texture implementation that models a texture based on an image.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`RELATIVE_OFFSET_DATA` The relative offset of the Data parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_HEIGHT` The relative offset of the Height 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`	`RELATIVE_OFFSET_WIDTH` The relative offset of the Width parameter in the `float` array.
`static int`	`TYPE` The type number associated with a `ImageTexture`.

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

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 `ImageTexture` instance for equality.
`int[]`	`getData()` Returns the data of the image as an `int` array.
`int`	`getDataLength()` Returns the length of the data in this `ImageTexture` instance.
`float`	`getDegrees()` Returns the angle in degrees that this `ImageTexture` instance should be rotated.
`float`	`getHeight()` Returns the height of this `ImageTexture` instance.
`float`	`getScaleU()` Returns the scale factor in the U-direction assigned to this `ImageTexture` instance.
`float`	`getScaleV()` Returns the scale factor in the V-direction assigned to this `ImageTexture` instance.
`int`	`getSize()` Returns the size of this `ImageTexture` instance.
`int`	`getType()` Returns the type of this `ImageTexture` instance.
`float`	`getWidth()` Returns the width of this `ImageTexture` instance.
`int`	`hashCode()` Returns a hash code for this `ImageTexture` instance.
`boolean`	`isEmissive()` Returns `true` if, and only if, this `ImageTexture` instance is emissive, `false` otherwise.
`static ImageTexture`	`load(java.io.File file)` Loads an `ImageTexture` from a file.
`static ImageTexture`	`load(java.io.File file, float degrees)` Loads an `ImageTexture` from a file given an angle in degrees to rotate it.
`static ImageTexture`	`load(java.io.File file, float degrees, float scaleU, float scaleV)` Loads an `ImageTexture` from a file given an angle in degrees to rotate it and the scale factors in the U- and V-directions.
`static ImageTexture`	`random(int width, int height, float degrees, float scaleU, float scaleV)` Returns a randomly generated `ImageTexture` based on its width and height.
`ImageTexture`	`redoGammaCorrection()` Performs a Gamma Correction redo operation.
`float[]`	`toArray()` Returns a `float` array representation of this `ImageTexture` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `ImageTexture` instance.
`ImageTexture`	`undoGammaCorrection()` Performs a Gamma Correction undo operation.

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

- Field Detail
  - RELATIVE_OFFSET_DATA
```
public static final int RELATIVE_OFFSET_DATA
```
    The relative offset of the Data parameter in the float array. The value is 8.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_HEIGHT
```
public static final int RELATIVE_OFFSET_HEIGHT
```
    The relative offset of the Height parameter in the float array. The value is 5.
    
    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 2.
    
    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 3.
    
    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
  - RELATIVE_OFFSET_WIDTH
```
public static final int RELATIVE_OFFSET_WIDTH
```
    The relative offset of the Width parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final int TYPE
```
    The type number associated with a ImageTexture. The number is 5.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - redoGammaCorrection
```
public ImageTexture redoGammaCorrection()
```
    Performs a Gamma Correction redo operation.
    Returns this ImageTexture instance.
    
    Returns:
    
    this ImageTexture instance
  - undoGammaCorrection
```
public ImageTexture undoGammaCorrection()
```
    Performs a Gamma Correction undo operation.
    Returns this ImageTexture instance.
    
    Returns:
    
    this ImageTexture instance
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this ImageTexture instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this ImageTexture instance
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this ImageTexture instance for equality.
    Returns true if, and only if, object is an instance of ImageTexture, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this ImageTexture instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of ImageTexture, and their respective values are equal, false otherwise
  - isEmissive
```
public boolean isEmissive()
```
    Returns true if, and only if, this ImageTexture instance is emissive, false otherwise.
    
    Specified by:
    
    isEmissive in interface Texture
    
    Returns:
    
    true if, and only if, this ImageTexture instance is emissive, false otherwise
  - getDegrees
```
public float getDegrees()
```
    Returns the angle in degrees that this ImageTexture instance should be rotated.
    
    Returns:
    
    the angle in degrees that this ImageTexture instance should be rotated
  - getHeight
```
public float getHeight()
```
    Returns the height of this ImageTexture instance.
    
    Returns:
    
    the height of this ImageTexture instance
  - getScaleU
```
public float getScaleU()
```
    Returns the scale factor in the U-direction assigned to this ImageTexture instance.
    
    Returns:
    
    the scale factor in the U-direction assigned to this ImageTexture instance
  - getScaleV
```
public float getScaleV()
```
    Returns the scale factor in the V-direction assigned to this ImageTexture instance.
    
    Returns:
    
    the scale factor in the V-direction assigned to this ImageTexture instance
  - getWidth
```
public float getWidth()
```
    Returns the width of this ImageTexture instance.
    
    Returns:
    
    the width of this ImageTexture instance
  - toArray
```
public float[] toArray()
```
    Returns a float array representation of this ImageTexture instance.
    
    Specified by:
    
    toArray in interface Texture
    
    Returns:
    
    a float array representation of this ImageTexture instance
  - getDataLength
```
public int getDataLength()
```
    Returns the length of the data in this ImageTexture instance.
    
    Returns:
    
    the length of the data in this ImageTexture instance
  - getSize
```
public int getSize()
```
    Returns the size of this ImageTexture instance.
    
    Specified by:
    
    getSize in interface Texture
    
    Returns:
    
    the size of this ImageTexture instance
  - getType
```
public int getType()
```
    Returns the type of this ImageTexture instance.
    
    Specified by:
    
    getType in interface Texture
    
    Returns:
    
    the type of this ImageTexture instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this ImageTexture instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this ImageTexture instance
  - getData
```
public int[] getData()
```
    Returns the data of the image as an int array.
    Modifying the array will not affect this ImageTexture instance.
    
    Returns:
    
    the data of the image as an int array
  - load
```
public static ImageTexture load(java.io.File file)
```
    Loads an ImageTexture from a file.
    Returns an ImageTexture instance.
    Calling this method is equivalent to calling ImageTexture.load(file, 0.0F).
    If file is null, a NullPointerException will be thrown.
    If an I/O-error occurs when loading the image, an UncheckedIOException will be thrown.
    
    Parameters:
    
    file - a File denoting a file to load from
    
    Returns:
    
    an ImageTexture instance
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, file is null
    
    java.io.UncheckedIOException - thrown if, and only if, an I/O-error occurs when loading the image
  - load
```
public static ImageTexture load(java.io.File file,
                                float degrees)
```
    Loads an ImageTexture from a file given an angle in degrees to rotate it.
    Returns an ImageTexture instance.
    Calling this method is equivalent to calling ImageTexture.load(file, degrees, 1.0F, 1.0F).
    If file is null, a NullPointerException will be thrown.
    If an I/O-error occurs when loading the image, an UncheckedIOException will be thrown.
    
    Parameters:
    
    file - a File denoting a file to load from
    
    degrees - an angle in degrees to rotate the ImageTexture
    
    Returns:
    
    an ImageTexture instance
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, file is null
    
    java.io.UncheckedIOException - thrown if, and only if, an I/O-error occurs when loading the image
  - load
```
public static ImageTexture load(java.io.File file,
                                float degrees,
                                float scaleU,
                                float scaleV)
```
    Loads an ImageTexture from a file given an angle in degrees to rotate it and the scale factors in the U- and V-directions.
    Returns an ImageTexture instance.
    If file is null, a NullPointerException will be thrown.
    If an I/O-error occurs when loading the image, an UncheckedIOException will be thrown.
    
    Parameters:
    
    file - a File denoting a file to load from
    
    degrees - an angle in degrees to rotate the ImageTexture
    
    scaleU - the scale factor in the U-direction
    
    scaleV - the scale factor in the V-direction
    
    Returns:
    
    an ImageTexture instance
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, file is null
    
    java.io.UncheckedIOException - thrown if, and only if, an I/O-error occurs when loading the image
  - random
```
public static ImageTexture random(int width,
                                  int height,
                                  float degrees,
                                  float scaleU,
                                  float scaleV)
```
    Returns a randomly generated ImageTexture based on its width and height.
    
    Parameters:
    
    width - the width of the ImageTexture
    
    height - the height of the ImageTexture
    
    degrees - an angle in degrees to rotate the ImageTexture
    
    scaleU - the scale factor in the U-direction
    
    scaleV - the scale factor in the V-direction
    
    Returns:
    
    a randomly generated ImageTexture based on its width and height

Class ImageTexture

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RELATIVE_OFFSET_DATA

RELATIVE_OFFSET_HEIGHT

RELATIVE_OFFSET_RADIANS_COS

RELATIVE_OFFSET_RADIANS_SIN

RELATIVE_OFFSET_SCALE_U

RELATIVE_OFFSET_SCALE_V

RELATIVE_OFFSET_WIDTH

TYPE

Method Detail

redoGammaCorrection

undoGammaCorrection

toString

equals

isEmissive

getDegrees

getHeight

getScaleU

getScaleV

getWidth

toArray

getDataLength

getSize

getType

hashCode

getData

load

load

load

random