org.jvnet.substance.painter.noise
Class WoodFilter

java.lang.Object
  extended by org.jvnet.substance.painter.noise.WoodFilter
All Implemented Interfaces:
NoiseFilter

public class WoodFilter
extends java.lang.Object
implements NoiseFilter

Noise filter that produces wood-like distribution. This class is part of officially supported API.

Author:
Kirill Grouchnikov

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.jvnet.substance.painter.noise.NoiseFilter
NoiseFilter.TrigKind
 
Field Summary
protected  double factor
          Stretch factor.
 
Constructor Summary
WoodFilter()
          Creates new wood filter with default stretch factor.
WoodFilter(double factor)
          Create new wood filter.
 
Method Summary
 double apply(double x, double y, double z, double origValue)
          Applies filter on the noise at the specified location.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

factor

protected double factor
Stretch factor.

Constructor Detail

WoodFilter

public WoodFilter()
Creates new wood filter with default stretch factor.


WoodFilter

public WoodFilter(double factor)
Create new wood filter.

Parameters:
factor - Stretch factor.
Method Detail

apply

public double apply(double x,
                    double y,
                    double z,
                    double origValue)
Description copied from interface: NoiseFilter
Applies filter on the noise at the specified location.

Specified by:
apply in interface NoiseFilter
Parameters:
x - X coordinate.
y - Y coordinate.
z - Z coordinate.
origValue - The original noise value.
Returns:
New noise value.