Package com.ardor3d.scenegraph.hint

Enum Class LightCombineMode

java.lang.Object

java.lang.Enum<LightCombineMode>

com.ardor3d.scenegraph.hint.LightCombineMode

All Implemented Interfaces:

Serializable, Comparable<LightCombineMode>, Constable

public enum LightCombineMode
extends Enum<LightCombineMode>

Describes how to combine lights from ancestor LightStates.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CombineClosest	Combine lights starting from the given Spatial and working up towards the root.
CombineClosestEnabled	Similar to CombineClosest, but if a disabled state is encountered, it will stop combining at that point.
CombineFirst	Combine lights starting from the root node and working towards the given Spatial.
Inherit	Inherit mode from parent.
Off	When updating render states, turn off lighting for this spatial.
Replace	Do not combine lights, just use the most recent light state.

Method Summary

Modifier and Type	Method	Description
static LightCombineMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LightCombineMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Off

public static final LightCombineMode Off

When updating render states, turn off lighting for this spatial.

CombineFirst

public static final LightCombineMode CombineFirst

Combine lights starting from the root node and working towards the given Spatial. Ignore disabled states. Stop combining when lights == MAX_LIGHTS_ALLOWED

CombineClosest

public static final LightCombineMode CombineClosest

Combine lights starting from the given Spatial and working up towards the root. Ignore disabled states. Stop combining when lights == MAX_LIGHTS_ALLOWED

CombineClosestEnabled

public static final LightCombineMode CombineClosestEnabled

Similar to CombineClosest, but if a disabled state is encountered, it will stop combining at that point. Stop combining when lights == MAX_LIGHTS_ALLOWED

Inherit

public static final LightCombineMode Inherit

Inherit mode from parent.

Replace

public static final LightCombineMode Replace

Do not combine lights, just use the most recent light state.

Method Details

values

public static LightCombineMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LightCombineMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null