| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.Fog
javax.media.j3d.LinearFog
| LinearFog | | public class LinearFog extends Fog (Code) | | The LinearFog leaf node defines fog distance parameters for
linear fog.
LinearFog extends the Fog node by adding a pair of distance values,
in Z, at which the fog should start obscuring the scene and should maximally
obscure the scene.
The front and back fog distances are defined in the local coordinate system of
the node, but the actual fog equation will ideally take place in eye
coordinates.
The linear fog blending factor, f, is computed as follows:
f = (backDistance - z) / (backDistance - frontDistance)
where:
z is the distance from the viewpoint.
frontDistance is the distance at which fog starts obscuring objects.
backDistance is the distance at which fog totally obscurs objects.
|
| Field Summary | |
| final public static int | ALLOW_DISTANCE_READ
Specifies that this LinearFog node allows read access to its distance
information. | | final public static int | ALLOW_DISTANCE_WRITE
Specifies that this LinearFog node allows write access to its distance
information. |
| Constructor Summary | |
| public | LinearFog()
Constructs a LinearFog node with default parameters. | | public | LinearFog(Color3f color)
Constructs a LinearFog node with the specified fog color. | | public | LinearFog(Color3f color, double frontDistance, double backDistance)
Constructs a LinearFog node with the specified fog color and distances. | | public | LinearFog(float r, float g, float b)
Constructs a LinearFog node with the specified fog color. | | public | LinearFog(float r, float g, float b, double frontDistance, double backDistance)
Constructs a LinearFog node with the specified fog color and distances. |
| Method Summary | |
| public Node | cloneNode(boolean forceDuplicate)
Used to create a new instance of the node. | | void | createRetained()
Creates the retained mode LinearFogRetained object that this
LinearFog node will point to. | | void | duplicateAttributes(Node originalNode, boolean forceDuplicate)
Copies all LinearFog information from
originalNode into
the current node. | | public double | getBackDistance()
Gets back distance for fog. | | public double | getFrontDistance()
Gets front distance for fog. | | public void | setBackDistance(double backDistance)
Sets back distance for fog. | | public void | setFrontDistance(double frontDistance)
Sets front distance for fog. |
| ALLOW_DISTANCE_READ | | final public static int ALLOW_DISTANCE_READ(Code) | | Specifies that this LinearFog node allows read access to its distance
information.
|
| ALLOW_DISTANCE_WRITE | | final public static int ALLOW_DISTANCE_WRITE(Code) | | Specifies that this LinearFog node allows write access to its distance
information.
|
| LinearFog | | public LinearFog()(Code) | | Constructs a LinearFog node with default parameters.
The default values are as follows:
front distance : 0.1
back distance : 1.0
|
| LinearFog | | public LinearFog(Color3f color)(Code) | | Constructs a LinearFog node with the specified fog color.
Parameters:
color - the fog color |
| LinearFog | | public LinearFog(Color3f color, double frontDistance, double backDistance)(Code) | | Constructs a LinearFog node with the specified fog color and distances.
Parameters:
color - the fog color
Parameters:
frontDistance - the front distance for the fog
Parameters:
backDistance - the back distance for the fog |
| LinearFog | | public LinearFog(float r, float g, float b)(Code) | | Constructs a LinearFog node with the specified fog color.
Parameters:
r - the red component of the fog color
Parameters:
g - the green component of the fog color
Parameters:
b - the blue component of the fog color |
| LinearFog | | public LinearFog(float r, float g, float b, double frontDistance, double backDistance)(Code) | | Constructs a LinearFog node with the specified fog color and distances.
Parameters:
r - the red component of the fog color
Parameters:
g - the green component of the fog color
Parameters:
b - the blue component of the fog color
Parameters:
frontDistance - the front distance for the fog
Parameters:
backDistance - the back distance for the fog |
| cloneNode | | public Node cloneNode(boolean forceDuplicate)(Code) | | Used to create a new instance of the node. This routine is called
by cloneTree to duplicate the current node.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
See Also: Node.cloneTree
See Also: Node.cloneNode
See Also: Node.duplicateNode
See Also: NodeComponent.setDuplicateOnCloneTree |
| createRetained | | void createRetained()(Code) | | Creates the retained mode LinearFogRetained object that this
LinearFog node will point to.
|
| duplicateAttributes | | void duplicateAttributes(Node originalNode, boolean forceDuplicate)(Code) | | Copies all LinearFog information from
originalNode into
the current node. This method is called from the
cloneNode method which is, in turn, called by the
cloneTree method.
Parameters:
originalNode - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
exception:
RestrictedAccessException - if this object is part of a liveor compiled scenegraph.
See Also: Node.duplicateNode
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| getBackDistance | | public double getBackDistance()(Code) | | Gets back distance for fog.
the distance at which fog totally obscurs objects
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getFrontDistance | | public double getFrontDistance()(Code) | | Gets front distance for fog.
the distance at which fog starts obscuring objects
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setBackDistance | | public void setBackDistance(double backDistance)(Code) | | Sets back distance for fog.
Parameters:
backDistance - the distance at which fog totally obscurs objects
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setFrontDistance | | public void setFrontDistance(double frontDistance)(Code) | | Sets front distance for fog.
Parameters:
frontDistance - the distance at which fog starts obscuring objects
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
|
|