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

Class FabricFilter.FabricFilterLink

java.lang.Object

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

org.pushingpixels.substance.extras.api.painterpack.noise.FabricFilter.FabricFilterLink

All Implemented Interfaces:

NoiseFilter

Enclosing class:

FabricFilter

public static class FabricFilter.FabricFilterLink
extends BaseNoiseFilter

A single fabric link.

Nested Class Summary

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

NoiseFilter.TrigKind

Field Summary

Fields inherited from class org.pushingpixels.substance.extras.api.painterpack.noise.BaseNoiseFilter

trigKind, valueFactor, xFactor, yFactor, zFactor

Constructor Summary

Constructors

Constructor	Description
FabricFilterLink(double xFactor, double yFactor, double zFactor, double valueFactor, NoiseFilter.TrigKind trigKind)	Creates a new fabric link.

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.
static FabricFilter.FabricFilterLink	getXLink(double xFactor, double valueFactor, NoiseFilter.TrigKind trigKind)	Creates a new fabric link oriented along X axis.
static FabricFilter.FabricFilterLink	getYLink(double yFactor, double valueFactor, NoiseFilter.TrigKind trigKind)	Creates a new fabric link oriented along Y axis.
static FabricFilter.FabricFilterLink	getZLink(double zFactor, double valueFactor, NoiseFilter.TrigKind trigKind)	Creates a new fabric link oriented along Z axis.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FabricFilterLink

public FabricFilterLink(double xFactor,
                        double yFactor,
                        double zFactor,
                        double valueFactor,
                        NoiseFilter.TrigKind trigKind)

Creates a new fabric link.

Parameters:

xFactor - Stretch factor for X axis.

yFactor - Stretch factor for Y axis.

zFactor - Stretch factor for Z axis.

valueFactor - Stretch factor for value.

trigKind - Trigonometry function.

Method Detail

getXLink

public static FabricFilter.FabricFilterLink getXLink(double xFactor,
                                                     double valueFactor,
                                                     NoiseFilter.TrigKind trigKind)

Creates a new fabric link oriented along X axis.

Parameters:

xFactor - Stretch factor for X axis.

valueFactor - Stretch factor for value.

trigKind - Trigonometry function.

Returns:

Fabric link oriented along X axis.

getYLink

public static FabricFilter.FabricFilterLink getYLink(double yFactor,
                                                     double valueFactor,
                                                     NoiseFilter.TrigKind trigKind)

Creates a new fabric link oriented along Y axis.

Parameters:

yFactor - Stretch factor for Y axis.

valueFactor - Stretch factor for value.

trigKind - Trigonometry function.

Returns:

Fabric link oriented along Y axis.

getZLink

public static FabricFilter.FabricFilterLink getZLink(double zFactor,
                                                     double valueFactor,
                                                     NoiseFilter.TrigKind trigKind)

Creates a new fabric link oriented along Z axis.

Parameters:

zFactor - Stretch factor for Z axis.

valueFactor - Stretch factor for value.

trigKind - Trigonometry function.

Returns:

Fabric link oriented along Z axis.

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.

Parameters:

x - X coordinate.

y - Y coordinate.

z - Z coordinate.

origValue - The original noise value.

Returns:

New noise value.