com.bonzaiengine.light

Enum LightAttenuationFunction

java.lang.Object

java.lang.Enum<LightAttenuationFunction>

com.bonzaiengine.light.LightAttenuationFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LightAttenuationFunction>

public enum LightAttenuationFunction
extends java.lang.Enum<LightAttenuationFunction>

Enum Constant Summary

Enum Constants

Enum Constant and Description
exponential Exponential attenuationFactors (same as default OpenGL)
linear Linear attenuationFactors

Method Summary

Modifier and Type	Method and Description
float	getAttenuationAt(float distance, float[] attenuationFactors)
float	getDistanceAtAttenuation(float attenuation, float[] attenuationFactors)
static LightAttenuationFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LightAttenuationFunction[]	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 LightAttenuationFunction linear

Linear attenuationFactors

exponential

public static final LightAttenuationFunction exponential

Exponential attenuationFactors (same as default OpenGL)

Method Detail

values

public static LightAttenuationFunction[] 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 (LightAttenuationFunction c : LightAttenuationFunction.values())
    System.out.println(c);

Returns:

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

valueOf

public static LightAttenuationFunction 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

getAttenuationAt

public float getAttenuationAt(float distance,
                              float[] attenuationFactors)

getDistanceAtAttenuation

public float getDistanceAtAttenuation(float attenuation,
                                      float[] attenuationFactors)