1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*
* Copyright (C) 2003, 2004 Jason Bevins (original libnoise code)
* Copyright 2010 Thomas J. Hodge (java port of libnoise)
*
* This file is part of libnoiseforjava.
*
* libnoiseforjava is a Java port of the C++ library libnoise, which may be found at
* http://libnoise.sourceforge.net/. libnoise was developed by Jason Bevins, who may be
* contacted at jlbezigvins@gmzigail.com (for great email, take off every 'zig').
* Porting to Java was done by Thomas Hodge, who may be contacted at
* libnoisezagforjava@gzagmail.com (remove every 'zag').
*
* libnoiseforjava is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* libnoiseforjava is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* libnoiseforjava. If not, see <http://www.gnu.org/licenses/>.
*
*/
package libnoiseforjava.module;
import libnoiseforjava.exception.ExceptionInvalidParam;
public class ScalePoint extends ModuleBase
{
/// Noise module that scales the coordinates of the input value before
/// returning the output value from a source module.
///
/// The getValue() method multiplies the ( @a x, @a y, @a z ) coordinates
/// of the input value with a scaling factor before returning the output
/// value from the source module. To set the scaling factor, call the
/// setScale() method. To set the scaling factor to apply to the
/// individual @a x, @a y, or @a z coordinates, call the setXScale(),
/// setYScale() or setZScale() methods, respectively.
///
/// This noise module requires one source module.
// Default scaling factor applied to the @a x coordinate for the
/// ScalePoint noise module.
static final double DEFAULT_SCALE_POINT_X = 1.0;
/// Default scaling factor applied to the @a y coordinate for the
/// ScalePoint noise module.
static final double DEFAULT_SCALE_POINT_Y = 1.0;
/// Default scaling factor applied to the @a z coordinate for the
/// ScalePoint noise module.
static final double DEFAULT_SCALE_POINT_Z = 1.0;
/// Scaling factor applied to the @a x coordinate of the input value.
double xScale;
/// Scaling factor applied to the @a y coordinate of the input value.
double yScale;
/// Scaling factor applied to the @a z coordinate of the input value.
double zScale;
public ScalePoint (ModuleBase sourceModule) throws ExceptionInvalidParam
{
super(1);
setSourceModule(0, sourceModule);
xScale = DEFAULT_SCALE_POINT_X;
yScale = DEFAULT_SCALE_POINT_Y;
zScale = DEFAULT_SCALE_POINT_Z;
}
public double getValue (double x, double y, double z)
{
assert (sourceModules[0] != null);
return sourceModules[0].getValue (x * xScale, y * yScale,
z * zScale);
}
/// Returns the scaling factor applied to the @a x coordinate of the
/// input value.
///
/// @returns The scaling factor applied to the @a x coordinate.
public double getXScale ()
{
return xScale;
}
/// Returns the scaling factor applied to the @a y coordinate of the
/// input value.
///
/// @returns The scaling factor applied to the @a y coordinate.
public double getYScale ()
{
return yScale;
}
/// Returns the scaling factor applied to the @a z coordinate of the
/// input value.
///
/// @returns The scaling factor applied to the @a z coordinate.
public double getZScale ()
{
return zScale;
}
/// Sets the scaling factor to apply to the input value.
///
/// @param scale The scaling factor to apply.
///
/// The getValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
public void setScale (double scale)
{
this.xScale = scale;
this.yScale = scale;
this.zScale = scale;
}
/// Sets the scaling factor to apply to the ( @a x, @a y, @a z )
/// coordinates of the input value.
///
/// @param xScale The scaling factor to apply to the @a x coordinate.
/// @param yScale The scaling factor to apply to the @a y coordinate.
/// @param zScale The scaling factor to apply to the @a z coordinate.
///
/// The getValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
public void setScale (double xScale, double yScale, double zScale)
{
this.xScale = xScale;
this.yScale = yScale;
this.zScale = zScale;
}
/// Sets the scaling factor to apply to the @a x coordinate of the
/// input value.
///
/// @param xScale The scaling factor to apply to the @a x coordinate.
///
/// The getValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
public void setXScale (double xScale)
{
this.xScale = xScale;
}
/// Sets the scaling factor to apply to the @a y coordinate of the
/// input value.
///
/// @param yScale The scaling factor to apply to the @a y coordinate.
///
/// The getValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
public void setYScale (double yScale)
{
this.yScale = yScale;
}
/// Sets the scaling factor to apply to the @a z coordinate of the
/// input value.
///
/// @param zScale The scaling factor to apply to the @a z coordinate.
///
/// The getValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
public void setZScale (double zScale)
{
this.zScale = zScale;
}
}
|
