All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.LinearFog 

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.Node
                   |
                   +----java.media.j3d.Leaf
                           |
                           +----java.media.j3d.Fog
                                   |
                                   +----java.media.j3d.LinearFog
public class LinearFog
extends Fog
The LinearFog leaf node defines fog distance parameters for linear fog.

Variable Index

o ALLOW_DISTANCE_READ
Specifies that this LinearFog node allows read access to its distance information.
o ALLOW_DISTANCE_WRITE
Specifies that this LinearFog node allows write access to its distance information.

Constructor Index

o LinearFog()
Constructs a LinearFog node with default fog parameters.
o LinearFog(Color3f)
Constructs a LinearFog node with the specified fog color.
o LinearFog(Color3f, float, float)
Constructs a LinearFog node with the specified fog color and distances.
o LinearFog(float, float, float)
Constructs a LinearFog node with the specified fog color.
o LinearFog(float, float, float, float, float)
Constructs a LinearFog node with the specified fog color and distances.

Method Index

o getBackDistance()
Gets back distance for fog
o getFrontDistance()
Gets front distance for fog
o setBackDistance(float)
Sets back distance for fog
o setFrontDistance(float)
Sets front distance for fog

Variables

o ALLOW_DISTANCE_READ 
 public static final int ALLOW_DISTANCE_READ
Specifies that this LinearFog node allows read access to its distance information.

o ALLOW_DISTANCE_WRITE 
 public static final int ALLOW_DISTANCE_WRITE
Specifies that this LinearFog node allows write access to its distance information.

Constructors

o LinearFog 
 public LinearFog()
Constructs a LinearFog node with default fog parameters.

o LinearFog 
 public LinearFog(Color3f color)
Constructs a LinearFog node with the specified fog color.

Parameters:
color - the fog color
o LinearFog 
 public LinearFog(Color3f color,
                  float frontDistance,
                  float backDistance)
Constructs a LinearFog node with the specified fog color and distances.

Parameters:
color - the fog color
frontDistance - the front distance for the fog
backDistance - the back distance for the fog
o LinearFog 
 public LinearFog(float r,
                  float g,
                  float b)
Constructs a LinearFog node with the specified fog color.

Parameters:
r - the red component of the fog color
g - the green component of the fog color
b - the blue component of the fog color
o LinearFog 
 public LinearFog(float r,
                  float g,
                  float b,
                  float frontDistance,
                  float backDistance)
Constructs a LinearFog node with the specified fog color and distances.

Parameters:
r - the red component of the fog color
g - the green component of the fog color
b - the blue component of the fog color
frontDistance - the front distance for the fog
backDistance - the back distance for the fog

Methods

o setFrontDistance 
 public final void setFrontDistance(float frontDistance)
Sets front distance for fog

Parameters:
frontDistance - the distance at which fog starts obscuring objects
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getFrontDistance 
 public final float getFrontDistance()
Gets front distance for fog

Returns:
the distance at which fog starts obscuring objects
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setBackDistance 
 public final void setBackDistance(float backDistance)
Sets back distance for fog

Parameters:
backDistance - the distance at which fog totally obscurs objects
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getBackDistance 
 public final float getBackDistance()
Gets back distance for fog

Returns:
the distance at which fog totally obscurs objects
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph 
All Packages  Class Hierarchy  This Package  Previous  Next  Index