org.xith3d.scenegraph
Class ExponentialFog

java.lang.Object
  org.xith3d.scenegraph.SceneGraphObject
      org.xith3d.scenegraph.Node
          org.xith3d.scenegraph.Leaf
              org.xith3d.scenegraph.Fog
                  org.xith3d.scenegraph.ExponentialFog

All Implemented Interfaces:

org.jagatoo.datatypes.NamableObject, org.jagatoo.datatypes.NamedObject, org.openmali.spatial.SpatialNode

public class ExponentialFog
extends Fog

ExponentialFog extends the Fog leaf node by adding a fog density.

Nested Class Summary

static class

ExponentialFog.FogMode Chooses one of the available FogModes.

Field Summary

static ExponentialFog.FogMode	FOG_MODE_EXP
static ExponentialFog.FogMode	FOG_MODE_EXP2

Fields inherited from class org.xith3d.scenegraph.Node

bounds, boundsAutoCompute, boundsDirty, globalIgnoreBounds, instanceBoundsTypeHint, parent, transformGroup, untransformedBounds

Fields inherited from class org.xith3d.scenegraph.SceneGraphObject

XITH3D_USERDATAKEY_OLDUSERDATA

Constructor Summary

ExponentialFog()
Constructs a new ExponentialFog object with a default color of black and density of 1.0.

ExponentialFog(org.openmali.vecmath2.Colorf color)
Constructs a new ExponentialFog object with the specified color and density of 1.0 and FogMode.EXP.

ExponentialFog(org.openmali.vecmath2.Colorf color, ExponentialFog.FogMode fogMode)
Constructs a new ExponentialFog object with the specified color and density of 1.0.

ExponentialFog(org.openmali.vecmath2.Colorf color, float density)
Constructs a new ExponentialFog object with the specified color and density and FogMode.EXP.

ExponentialFog(org.openmali.vecmath2.Colorf color, float density, ExponentialFog.FogMode fogMode)
Constructs a new ExponentialFog object with the specified color and density.

Method Summary

float	getDensity() Gets the density for this object.
ExponentialFog.FogMode	getFogMode()
void	setDensity(float density) Sets the density for this object.
void	setFogMode(ExponentialFog.FogMode fogMode) Sets the FogMode for this Fog.

Methods inherited from class org.xith3d.scenegraph.Fog

freeOpenGLResources, getColor, getColor, getFogID, getInfluencingBoundingLeaf, getInfluencingBounds, setColor, setInfluencingBoundingLeaf, setInfluencingBounds, traverse

Methods inherited from class org.xith3d.scenegraph.Leaf

dump, getPickHost, setPickHost

Methods inherited from class org.xith3d.scenegraph.Node

absorbDetails, cloneNode, detach, duplicateNode, freeOpenGLResources, getBounds, getBoundsAutoCompute, getBoundsType, getBoundsTypeHint, getDefaultPickable, getIndentString, getInheritedNodeAttributes, getModListener, getOrderedChild, getOrderedState, getParent, getRoot, getShadowAttachment, getShowBounds, getTransformGroup, getTreeCell, getWorldBounds, getWorldTransform, getWorldTransform, isBillboard, isIgnoreBounds, isOccluder, isPickable, isRenderable, isUpdatableNode, mergeInheritedClipper, mergeInheritedNodes, mergeInheritedScissorRect, popGlobalIgnoreBounds, printBounds, pushGlobalIgnoreBounds, setBounds, setBoundsAutoCompute, setBoundsDirty, setBoundsDirtyUpward, setBoundsTypeHint, setDefaultPickable, setGlobalIgnoreBounds, setIgnoreBounds, setIsOccluder, setModListener, setOrderedChild, setParent, setPickable, setPickableRecursive, setPickableRecursive, setRenderable, setShadowAttachment, setShowBounds, setTransformGroup, setTreeCell, sharedCopy, sharedCopy, traverse, unmergeInheritedFog, unmergeInheritedLight, unmergeInheritedNodes, updateBounds, updateBoundsCheap, updateOrderedChild, updateTransformGroup, updateWorldTransform

Methods inherited from class org.xith3d.scenegraph.SceneGraphObject

getName, getUserData, getUserData, getUserDataMap, isLive, setLive, setName, setUserData, setUserData, setUserDataRecursive, setUserDataRecursive, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FOG_MODE_EXP

public static final ExponentialFog.FogMode FOG_MODE_EXP

See Also:

ExponentialFog.FogMode.EXP

FOG_MODE_EXP2

public static final ExponentialFog.FogMode FOG_MODE_EXP2

See Also:

ExponentialFog.FogMode.EXP2

Constructor Detail

ExponentialFog

public ExponentialFog()

Constructs a new ExponentialFog object with a default color of black and density of 1.0.

ExponentialFog

public ExponentialFog(org.openmali.vecmath2.Colorf color)

Constructs a new ExponentialFog object with the specified color and density of 1.0 and FogMode.EXP.

ExponentialFog

public ExponentialFog(org.openmali.vecmath2.Colorf color,
                      float density)

Constructs a new ExponentialFog object with the specified color and density and FogMode.EXP.

ExponentialFog

public ExponentialFog(org.openmali.vecmath2.Colorf color,
                      ExponentialFog.FogMode fogMode)

Constructs a new ExponentialFog object with the specified color and density of 1.0.

ExponentialFog

public ExponentialFog(org.openmali.vecmath2.Colorf color,
                      float density,
                      ExponentialFog.FogMode fogMode)

Constructs a new ExponentialFog object with the specified color and density.

Method Detail

setFogMode

public void setFogMode(ExponentialFog.FogMode fogMode)

Sets the FogMode for this Fog.

Parameters:

fogMode -

getFogMode

public final ExponentialFog.FogMode getFogMode()

Returns:

the FogMode for this Fog.

setDensity

public final void setDensity(float density)

Sets the density for this object.

getDensity

public final float getDensity()

Gets the density for this object.