com.bonzaiengine.light

Enum LightProperty

java.lang.Object

java.lang.Enum<LightProperty>

com.bonzaiengine.light.LightProperty

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ambient Ambient (R,G,B)
color (R,G,B)
diffuse Diffuse (R,G,B)
exponentialAttenuation (a,b,c) the attenuation parameters Attenuation formula: 1 / (a + b * d + c * d²) with d the distance
linearAttenuation (k) the attenuation parameter Attenuation formula: max(1 - k * d, 0) with d the distance
positionOrDirection (posX, posY, posZ, posW) in world space
positionOrDirectionMv (posX, posY, posZ, posW) in eye space
screenProj (screenXPos, screenYPos, screenWidth, screenHeight) The projection is updated in ILight.updateToView(com.bonzaiengine.camera.View)
shininess
specular Specular (R,G,B)
spotCutoff Spot cut off in degrees
spotDirection (dirX, dirY, dirZ) in world space
spotDirectionMv (dirX, dirY, dirZ) in eye space
spotExponent Spot exponent in range [0;128]

Method Summary

Modifier and Type	Method and Description
static LightProperty	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LightProperty[]	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

color

public static final LightProperty color

(R,G,B)

ambient

public static final LightProperty ambient

Ambient (R,G,B)

diffuse

public static final LightProperty diffuse

Diffuse (R,G,B)

specular

public static final LightProperty specular

Specular (R,G,B)

positionOrDirection

public static final LightProperty positionOrDirection

(posX, posY, posZ, posW) in world space

positionOrDirectionMv

public static final LightProperty positionOrDirectionMv

(posX, posY, posZ, posW) in eye space

spotCutoff

public static final LightProperty spotCutoff

Spot cut off in degrees

spotDirection

public static final LightProperty spotDirection

(dirX, dirY, dirZ) in world space

spotDirectionMv

public static final LightProperty spotDirectionMv

(dirX, dirY, dirZ) in eye space

spotExponent

public static final LightProperty spotExponent

Spot exponent in range [0;128]

shininess

public static final LightProperty shininess

exponentialAttenuation

public static final LightProperty exponentialAttenuation

(a,b,c) the attenuation parameters
Attenuation formula: 1 / (a + b * d + c * d²) with d the distance

linearAttenuation

public static final LightProperty linearAttenuation

(k) the attenuation parameter
Attenuation formula: max(1 - k * d, 0) with d the distance

screenProj

public static final LightProperty screenProj

(screenXPos, screenYPos, screenWidth, screenHeight)
The projection is updated in ILight.updateToView(com.bonzaiengine.camera.View)

Method Detail

values

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

Returns:

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

valueOf

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