com.jme3.scene

Enum Spatial.CullHint

java.lang.Object

java.lang.Enum<Spatial.CullHint>

com.jme3.scene.Spatial.CullHint

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Spatial.CullHint>

Enclosing class:

Spatial

public static enum Spatial.CullHint
extends java.lang.Enum<Spatial.CullHint>

Specifies how frustum culling should be handled by this spatial.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Always Always cull this from the view, throwing away this object and any children from rendering commands.
Dynamic Do not draw if we are not at least partially within the view frustum of the camera.
Inherit Do whatever our parent does.
Never Never cull this from view, always draw it.

Method Summary

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

Inherit

public static final Spatial.CullHint Inherit

Do whatever our parent does. If no parent, default to Dynamic.

Dynamic

public static final Spatial.CullHint Dynamic

Do not draw if we are not at least partially within the view frustum of the camera. This is determined via the defined Camera planes whether or not this Spatial should be culled.

Always

public static final Spatial.CullHint Always

Always cull this from the view, throwing away this object and any children from rendering commands.

Never

public static final Spatial.CullHint Never

Never cull this from view, always draw it. Note that we will still get culled if our parent is culled.

Method Detail

values

public static Spatial.CullHint[] 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.CullHint c : Spatial.CullHint.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.CullHint 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