org.xith3d.scenegraph
Class LinearFog

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

All Implemented Interfaces:

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

public class LinearFog
extends Fog

LinearFog extends the Fog leaf node by adding a pair of distance values, in Z, at which fog should start obscuring the scene and should maximally obscure the scene.

Field Summary

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

LinearFog()
Constructs a new LinearFog object with a default color of black, front distance of 0.1 and back distance of 1.

LinearFog(org.openmali.vecmath2.Colorf color)
Constructs a new LinearFog object with the specified color, front distance of 0.1 and back distance of 1.

LinearFog(org.openmali.vecmath2.Colorf color, float front, float back)
Constructs a new LinearFog object with the specified color, front distance and back distance.

Method Summary

float	getBackDistance() Gets the back distance for this object.
float	getFrontDistance() Gets the front distance for this object.
void	setBackDistance(float distance) Sets the back distance for this object.
void	setFrontDistance(float distance) Sets the front distance for this object.

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

Constructor Detail

LinearFog

public LinearFog()

Constructs a new LinearFog object with a default color of black, front distance of 0.1 and back distance of 1.

LinearFog

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

Constructs a new LinearFog object with the specified color, front distance of 0.1 and back distance of 1.

LinearFog

public LinearFog(org.openmali.vecmath2.Colorf color,
                 float front,
                 float back)

Constructs a new LinearFog object with the specified color, front distance and back distance.

Method Detail

setFrontDistance

public final void setFrontDistance(float distance)

Sets the front distance for this object.

getFrontDistance

public final float getFrontDistance()

Gets the front distance for this object.

setBackDistance

public final void setBackDistance(float distance)

Sets the back distance for this object.

getBackDistance

public final float getBackDistance()

Gets the back distance for this object.