com.jme.scene.state
Enum FogState.DensityFunction

java.lang.Object
  extended by java.lang.Enum<FogState.DensityFunction>
      extended by com.jme.scene.state.FogState.DensityFunction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FogState.DensityFunction>
Enclosing class:
FogState

public static enum FogState.DensityFunction
extends java.lang.Enum<FogState.DensityFunction>


Enum Constant Summary
Exponential
          The fog blending function defined as: e^-(density*z)
ExponentialSquared
          The fog blending function defined as: e^((-density*z)^2)
Linear
          The fog blending function defined as: (end - z) / (end - start).
 
Method Summary
static FogState.DensityFunction valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FogState.DensityFunction[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Linear

public static final FogState.DensityFunction Linear
The fog blending function defined as: (end - z) / (end - start).


Exponential

public static final FogState.DensityFunction Exponential
The fog blending function defined as: e^-(density*z)


ExponentialSquared

public static final FogState.DensityFunction ExponentialSquared
The fog blending function defined as: e^((-density*z)^2)

Method Detail

values

public static FogState.DensityFunction[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (FogState.DensityFunction c : FogState.DensityFunction.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static FogState.DensityFunction valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null