com.jme.scene
Enum Spatial.LightCombineMode

java.lang.Object
  java.lang.Enum<Spatial.LightCombineMode>
      com.jme.scene.Spatial.LightCombineMode

All Implemented Interfaces:

Serializable, Comparable<Spatial.LightCombineMode>

Enclosing class:

Spatial

public static enum Spatial.LightCombineMode
extends Enum<Spatial.LightCombineMode>

Describes how to combine lights from ancestor lightstates when an updateRenderState is called on a Spatial.

Author:

Joshua Slack

Enum Constant Summary

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

static Spatial.LightCombineMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Spatial.LightCombineMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Off

public static final Spatial.LightCombineMode Off

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

CombineFirst

public static final Spatial.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 Spatial.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 Spatial.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 Spatial.LightCombineMode Inherit

Inherit mode from parent.

Replace

public static final Spatial.LightCombineMode Replace

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

Method Detail

values

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

Returns:

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

valueOf

public static Spatial.LightCombineMode valueOf(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:

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

NullPointerException - if the argument is null