Package org.pushingpixels.substance.extras.api.painterpack.noise

Class CompoundNoiseFilter

java.lang.Object

org.pushingpixels.substance.extras.api.painterpack.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.pushingpixels.substance.extras.api.painterpack.noise.NoiseFilter

NoiseFilter.TrigKind

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.LinkedList<NoiseFilter>	chain	Filter chain.

Constructor Summary

Constructors

Constructor	Description
CompoundNoiseFilter(NoiseFilter... chain)	Creates a new compound filter.

Method Summary

Modifier and Type	Method	Description
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.