001: /*
002: * Copyright (c) 2005-2008 Substance Kirill Grouchnikov. All Rights Reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of Substance Kirill Grouchnikov nor the names of
015: * its contributors may be used to endorse or promote products derived
016: * from this software without specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
020: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
021: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
022: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
023: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
025: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
026: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
027: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029: */
030: package org.jvnet.substance.painter.noise;
031:
032: import java.util.LinkedList;
033:
034: /**
035: * Noise filter that produces fabric-like distribution. This filter contains a
036: * collection of links, each one with its own orientation. Using a combination
037: * of filter links it's possible to create a composite complex fabric effect.
038: * This class is part of officially supported API.
039: *
040: * @author Kirill Grouchnikov
041: */
042: public class FabricFilter implements NoiseFilter {
043: /**
044: * Fabric links.
045: */
046: protected LinkedList<FabricFilterLink> links;
047:
048: /**
049: * A single fabric link.
050: *
051: * @author Kirill Grouchnikov
052: */
053: public static class FabricFilterLink extends BaseNoiseFilter {
054: /**
055: * Creates a new fabric link.
056: *
057: * @param xFactor
058: * Stretch factor for X axis.
059: * @param yFactor
060: * Stretch factor for Y axis.
061: * @param zFactor
062: * Stretch factor for Z axis.
063: * @param valueFactor
064: * Stretch factor for value.
065: * @param trigKind
066: * Trigonometry function.
067: */
068: public FabricFilterLink(double xFactor, double yFactor,
069: double zFactor, double valueFactor, TrigKind trigKind) {
070: super (xFactor, yFactor, zFactor, valueFactor, trigKind);
071: }
072:
073: /**
074: * Creates a new fabric link oriented along X axis.
075: *
076: * @param xFactor
077: * Stretch factor for X axis.
078: * @param valueFactor
079: * Stretch factor for value.
080: * @param trigKind
081: * Trigonometry function.
082: * @return Fabric link oriented along X axis.
083: */
084: public static FabricFilterLink getXLink(double xFactor,
085: double valueFactor, TrigKind trigKind) {
086: return new FabricFilterLink(xFactor, 0.0, 0.0, valueFactor,
087: trigKind);
088: }
089:
090: /**
091: * Creates a new fabric link oriented along Y axis.
092: *
093: * @param yFactor
094: * Stretch factor for Y axis.
095: * @param valueFactor
096: * Stretch factor for value.
097: * @param trigKind
098: * Trigonometry function.
099: * @return Fabric link oriented along Y axis.
100: */
101: public static FabricFilterLink getYLink(double yFactor,
102: double valueFactor, TrigKind trigKind) {
103: return new FabricFilterLink(0.0, yFactor, 0.0, valueFactor,
104: trigKind);
105: }
106:
107: /**
108: * Creates a new fabric link oriented along Z axis.
109: *
110: * @param zFactor
111: * Stretch factor for Z axis.
112: * @param valueFactor
113: * Stretch factor for value.
114: * @param trigKind
115: * Trigonometry function.
116: * @return Fabric link oriented along Z axis.
117: */
118: public static FabricFilterLink getZLink(double zFactor,
119: double valueFactor, TrigKind trigKind) {
120: return new FabricFilterLink(0.0, 0.0, zFactor, valueFactor,
121: trigKind);
122: }
123:
124: /*
125: * (non-Javadoc)
126: *
127: * @see org.jvnet.substance.painter.noise.NoiseFilter#apply(double,
128: * double, double, double)
129: */
130: public double apply(double x, double y, double z,
131: double origValue) {
132: double trans = this .xFactor * x + this .yFactor * y
133: + this .zFactor * z + this .valueFactor * origValue;
134: double trig = (this .trigKind == TrigKind.COSINE) ? Math
135: .cos(trans) : Math.sin(trans);
136: return trig;
137: }
138: }
139:
140: /**
141: * Creates fabric filter.
142: *
143: * @param links
144: * Fabric links.
145: */
146: public FabricFilter(FabricFilterLink... links) {
147: this .links = new LinkedList<FabricFilterLink>();
148: for (FabricFilterLink link : links) {
149: this .links.add(link);
150: }
151: }
152:
153: /*
154: * (non-Javadoc)
155: *
156: * @see org.jvnet.substance.painter.noise.NoiseFilter#apply(double, double,
157: * double, double)
158: */
159: public double apply(double x, double y, double z, double origValue) {
160: double val = 1.0;
161: for (FabricFilterLink link : this .links)
162: val *= link.apply(x, y, z, origValue);
163: return 0.5 + 0.5 * val;
164: }
165: }
|