FractionalBrownianMotionTexture (org.dayflower.pathtracer API)

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

All Implemented Interfaces:

Texture
```
public final class FractionalBrownianMotionTexture
extends java.lang.Object
implements Texture
```
A FractionalBrownianMotionTexture is a Texture implementation that uses fractional Brownian motion (fBm) to compute its image data.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`RELATIVE_OFFSET_ADDEND` The relative offset of the Addend parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_FREQUENCY` The relative offset of the Frequency parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_GAIN` The relative offset of the Gain parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_MULTIPLIER` The relative offset of the Multiplier parameter in the `float` array.
`static int`	`RELATIVE_OFFSET_OCTAVES` The relative offset of the Octaves parameter in the `float` array.
`static int`	`SIZE` The size of a `FractionalBrownianMotionTexture` in the `float` array.
`static int`	`TYPE` The type number associated with a `FractionalBrownianMotionTexture`.

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

Constructor Summary

Constructors
Constructor and Description
`FractionalBrownianMotionTexture(Color addend, Color multiplier, float frequency, float gain, int octaves)` Constructs a new `FractionalBrownianMotionTexture` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)` Compares `object` to this `FractionalBrownianMotionTexture` instance for equality.
`Color`	`getAddend()` Returns the addend assigned to this `FractionalBrownianMotionTexture` instance.
`float`	`getFrequency()` Returns the frequency assigned to this `FractionalBrownianMotionTexture` instance.
`float`	`getGain()` Returns the gain assigned to this `FractionalBrownianMotionTexture` instance.
`Color`	`getMultiplier()` Returns the multiplier assigned to this `FractionalBrownianMotionTexture` instance.
`int`	`getOctaves()` Returns the octaves assigned to this `FractionalBrownianMotionTexture` instance.
`int`	`getSize()` Returns the size of this `FractionalBrownianMotionTexture` instance.
`int`	`getType()` Returns the type of this `FractionalBrownianMotionTexture` instance.
`int`	`hashCode()` Returns a hash code for this `FractionalBrownianMotionTexture` instance.
`boolean`	`isEmissive()` Returns `true` if, and only if, this `FractionalBrownianMotionTexture` instance is emissive, `false` otherwise.
`float[]`	`toArray()` Returns a `float` array representation of this `FractionalBrownianMotionTexture` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `FractionalBrownianMotionTexture` instance.

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

- Field Detail
  - RELATIVE_OFFSET_ADDEND
```
public static final int RELATIVE_OFFSET_ADDEND
```
    The relative offset of the Addend parameter in the float array. The value is 2.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_FREQUENCY
```
public static final int RELATIVE_OFFSET_FREQUENCY
```
    The relative offset of the Frequency parameter in the float array. The value is 4.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_GAIN
```
public static final int RELATIVE_OFFSET_GAIN
```
    The relative offset of the Gain parameter in the float array. The value is 5.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_MULTIPLIER
```
public static final int RELATIVE_OFFSET_MULTIPLIER
```
    The relative offset of the Multiplier parameter in the float array. The value is 3.
    
    See Also:
    
    Constant Field Values
  - RELATIVE_OFFSET_OCTAVES
```
public static final int RELATIVE_OFFSET_OCTAVES
```
    The relative offset of the Octaves parameter in the float array. The value is 6.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final int SIZE
```
    The size of a FractionalBrownianMotionTexture in the float array. The size is 7.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final int TYPE
```
    The type number associated with a FractionalBrownianMotionTexture. The number is 4.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FractionalBrownianMotionTexture
```
public FractionalBrownianMotionTexture(Color addend,
                                       Color multiplier,
                                       float frequency,
                                       float gain,
                                       int octaves)
```
    Constructs a new FractionalBrownianMotionTexture instance.
    If either addend or multiplier are null, a NullPointerException will be thrown.
    
    Parameters:
    
    addend - the addend to use
    
    multiplier - the multiplier to use
    
    frequency - the frequency to use
    
    gain - the gain to use
    
    octaves - the octaves to use
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either addend or multiplier are null
- Method Detail
  - getAddend
```
public Color getAddend()
```
    Returns the addend assigned to this FractionalBrownianMotionTexture instance.
    
    Returns:
    
    the addend assigned to this FractionalBrownianMotionTexture instance
  - getMultiplier
```
public Color getMultiplier()
```
    Returns the multiplier assigned to this FractionalBrownianMotionTexture instance.
    
    Returns:
    
    the multiplier assigned to this FractionalBrownianMotionTexture instance
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this FractionalBrownianMotionTexture instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this FractionalBrownianMotionTexture instance
  - equals
```
public boolean equals(java.lang.Object object)
```
    Compares object to this FractionalBrownianMotionTexture instance for equality.
    Returns true if, and only if, object is an instance of FractionalBrownianMotionTexture, and their respective values are equal, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the Object to compare to this FractionalBrownianMotionTexture instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of FractionalBrownianMotionTexture, and their respective values are equal, false otherwise
  - isEmissive
```
public boolean isEmissive()
```
    Returns true if, and only if, this FractionalBrownianMotionTexture instance is emissive, false otherwise.
    
    Specified by:
    
    isEmissive in interface Texture
    
    Returns:
    
    true if, and only if, this FractionalBrownianMotionTexture instance is emissive, false otherwise
  - getFrequency
```
public float getFrequency()
```
    Returns the frequency assigned to this FractionalBrownianMotionTexture instance.
    
    Returns:
    
    the frequency assigned to this FractionalBrownianMotionTexture instance
  - getGain
```
public float getGain()
```
    Returns the gain assigned to this FractionalBrownianMotionTexture instance.
    
    Returns:
    
    the gain assigned to this FractionalBrownianMotionTexture instance
  - toArray
```
public float[] toArray()
```
    Returns a float array representation of this FractionalBrownianMotionTexture instance.
    
    Specified by:
    
    toArray in interface Texture
    
    Returns:
    
    a float array representation of this FractionalBrownianMotionTexture instance
  - getOctaves
```
public int getOctaves()
```
    Returns the octaves assigned to this FractionalBrownianMotionTexture instance.
    
    Returns:
    
    the octaves assigned to this FractionalBrownianMotionTexture instance
  - getSize
```
public int getSize()
```
    Returns the size of this FractionalBrownianMotionTexture instance.
    
    Specified by:
    
    getSize in interface Texture
    
    Returns:
    
    the size of this FractionalBrownianMotionTexture instance
  - getType
```
public int getType()
```
    Returns the type of this FractionalBrownianMotionTexture instance.
    
    Specified by:
    
    getType in interface Texture
    
    Returns:
    
    the type of this FractionalBrownianMotionTexture instance
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this FractionalBrownianMotionTexture instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this FractionalBrownianMotionTexture instance

Class FractionalBrownianMotionTexture

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_ADDEND

RELATIVE_OFFSET_FREQUENCY

RELATIVE_OFFSET_GAIN

RELATIVE_OFFSET_MULTIPLIER

RELATIVE_OFFSET_OCTAVES

SIZE

TYPE

Constructor Detail

FractionalBrownianMotionTexture

Method Detail

getAddend

getMultiplier

toString

equals

isEmissive

getFrequency

getGain

toArray

getOctaves

getSize

getType

hashCode