com.jme3.light

Enum Light.Type

java.lang.Object

java.lang.Enum<Light.Type>

com.jme3.light.Light.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Light.Type>

Enclosing class:

Light

public static enum Light.Type
extends java.lang.Enum<Light.Type>

Describes the light type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Ambient Ambient light
Directional Directional light
Point Point light
Probe Light probe
Spot Spot light.

Method Summary

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

Directional

public static final Light.Type Directional

Directional light

See Also:

DirectionalLight

Point

public static final Light.Type Point

Point light

See Also:

PointLight

Spot

public static final Light.Type Spot

Spot light.

See Also:

SpotLight

Ambient

public static final Light.Type Ambient

Ambient light

See Also:

AmbientLight

Probe

public static final Light.Type Probe

Light probe

See Also:

LightProbe

Method Detail

values

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

Returns:

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

valueOf

public static Light.Type 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

getId

public int getId()

Returns an index for the light type

Returns:

an index for the light type