org.jvnet.substance.painter.noise
Class CompoundNoiseFilter

java.lang.Object
  org.jvnet.substance.painter.noise.CompoundNoiseFilter

All Implemented Interfaces:

NoiseFilter

public class CompoundNoiseFilter
extends java.lang.Object
implements NoiseFilter

Compound noise filter that contains a chain of filters. 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 java.util.LinkedList<NoiseFilter>

chain Filter chain.

Constructor Summary

CompoundNoiseFilter(NoiseFilter... chain)
Creates a new compound 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

chain

protected java.util.LinkedList<NoiseFilter> chain

Filter chain.

Constructor Detail

CompoundNoiseFilter

public CompoundNoiseFilter(NoiseFilter... chain)

Creates a new compound filter.

Parameters:

chain - Filter chain.

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.