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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*
* Copyright 1997-2008 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*
*/
package javax.media.j3d;
import javax.vecmath.Color3f;
/**
* The ExponentialFog leaf node extends the Fog leaf node by adding a
* fog density that is used as the exponent of the fog equation. The
* density is defined in the local coordinate system of the node, but
* the actual fog equation will ideally take place in eye coordinates.
* <P>
* The fog blending factor, f, is computed as follows:
* <P><UL>
* f = e<sup>-(density * z)</sup><P>
* where
* <ul>z is the distance from the viewpoint.<br>
* density is the density of the fog.<P></ul></UL>
*
* In addition to specifying the fog density, ExponentialFog lets you
* specify the fog color, which is represented by R, G, and B
* color values, where a color of (0,0,0) represents black.
*/
public class ExponentialFog extends Fog {
/**
* Specifies that this ExponentialFog node allows read access to its
* density information.
*/
public static final int
ALLOW_DENSITY_READ = CapabilityBits.EXPONENTIAL_FOG_ALLOW_DENSITY_READ;
/**
* Specifies that this ExponentialFog node allows write access to its
* density information.
*/
public static final int
ALLOW_DENSITY_WRITE = CapabilityBits.EXPONENTIAL_FOG_ALLOW_DENSITY_WRITE;
// Array for setting default read capabilities
private static final int[] readCapabilities = {
ALLOW_DENSITY_READ
};
/**
* Constructs an ExponentialFog node with default parameters.
* The default values are as follows:
* <ul>
* density : 1.0<br>
* </ul>
*/
public ExponentialFog() {
// Just use the defaults
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
}
/**
* Constructs an ExponentialFog node with the specified fog color.
* @param color the fog color
*/
public ExponentialFog(Color3f color) {
super(color);
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
}
/**
* Constructs an ExponentialFog node with the specified fog color
* and density.
* @param color the fog color
* @param density the density of the fog
*/
public ExponentialFog(Color3f color, float density) {
super(color);
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
((ExponentialFogRetained)this.retained).initDensity(density);
}
/**
* Constructs an ExponentialFog node with the specified fog color.
* @param r the red component of the fog color
* @param g the green component of the fog color
* @param b the blue component of the fog color
*/
public ExponentialFog(float r, float g, float b) {
super(r, g, b);
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
}
/**
* Constructs an ExponentialFog node with the specified fog color
* and density.
* @param r the red component of the fog color
* @param g the green component of the fog color
* @param b the blue component of the fog color
* @param density the density of the fog
*/
public ExponentialFog(float r, float g, float b, float density) {
super(r, g, b);
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
((ExponentialFogRetained)this.retained).initDensity(density);
}
/**
* Sets fog density.
* @param density the new density of this fog
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public void setDensity(float density) {
if (isLiveOrCompiled())
if(!this.getCapability(ALLOW_DENSITY_WRITE))
throw new CapabilityNotSetException(J3dI18N.getString("ExponentialFog0"));
if (isLive())
((ExponentialFogRetained)this.retained).setDensity(density);
else
((ExponentialFogRetained)this.retained).initDensity(density);
}
/**
* Gets fog density.
* @return the density of this fog
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public float getDensity() {
if (isLiveOrCompiled())
if(!this.getCapability(ALLOW_DENSITY_READ))
throw new CapabilityNotSetException(J3dI18N.getString("ExponentialFog1"));
return ((ExponentialFogRetained)this.retained).getDensity();
}
/**
* Creates the retained mode ExponentialFogRetained object that this
* ExponentialFog node will point to.
*/
@Override
void createRetained() {
this.retained = new ExponentialFogRetained();
this.retained.setSource(this);
}
/**
* Used to create a new instance of the node. This routine is called
* by <code>cloneTree</code> to duplicate the current node.
* @param forceDuplicate when set to <code>true</code>, causes the
* <code>duplicateOnCloneTree</code> flag to be ignored. When
* <code>false</code>, the value of each node's
* <code>duplicateOnCloneTree</code> variable determines whether
* NodeComponent data is duplicated or copied.
*
* @see Node#cloneTree
* @see Node#cloneNode
* @see Node#duplicateNode
* @see NodeComponent#setDuplicateOnCloneTree
*/
@Override
public Node cloneNode(boolean forceDuplicate) {
ExponentialFog ef = new ExponentialFog();
ef.duplicateNode(this, forceDuplicate);
return ef;
}
/**
* Copies all ExponentialFog information from
* <code>originalNode</code> into
* the current node. This method is called from the
* <code>cloneNode</code> method which is, in turn, called by the
* <code>cloneTree</code> method.<P>
*
* @param originalNode the original node to duplicate.
* @param forceDuplicate when set to <code>true</code>, causes the
* <code>duplicateOnCloneTree</code> flag to be ignored. When
* <code>false</code>, the value of each node's
* <code>duplicateOnCloneTree</code> variable determines whether
* NodeComponent data is duplicated or copied.
*
* @exception RestrictedAccessException if this object is part of a live
* or compiled scenegraph.
*
* @see Node#duplicateNode
* @see Node#cloneTree
* @see NodeComponent#setDuplicateOnCloneTree
*/
@Override
void duplicateAttributes(Node originalNode, boolean forceDuplicate) {
super.duplicateAttributes(originalNode, forceDuplicate);
((ExponentialFogRetained) retained).initDensity(
((ExponentialFogRetained) originalNode.retained).getDensity());
}
}
|
