org.cell2d.space

Enum SpaceState.DrawMode

java.lang.Object

java.lang.Enum<SpaceState.DrawMode>

org.cell2d.space.SpaceState.DrawMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SpaceState.DrawMode>

Enclosing class:

SpaceState<T extends CellGame,U extends SpaceState<T,U,V>,V extends SpaceThinker<T,U,V>>

public static enum SpaceState.DrawMode
extends java.lang.Enum<SpaceState.DrawMode>

A DrawMode is a procedure by which a SpaceState determines the order in which to draw SpaceObjects with the same draw priority over one another.

See Also:

SpaceObject

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLAT SpaceObjects with the same draw priority are drawn in an arbitrary order.
OVER SpaceObjects with the same draw priority are drawn with the ones with higher y-coordinates in front.
UNDER SpaceObjects with the same draw priority are drawn with the ones with lower y-coordinates in front.

Method Summary

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

FLAT

public static final SpaceState.DrawMode FLAT

SpaceObjects with the same draw priority are drawn in an arbitrary order. This is the most efficient DrawMode when the plane of the level is supposed to be perpendicular to the camera.

OVER

public static final SpaceState.DrawMode OVER

SpaceObjects with the same draw priority are drawn with the ones with higher y-coordinates in front. This creates the illusion that the camera is looking diagonally down from over the plane of the level.

UNDER

public static final SpaceState.DrawMode UNDER

SpaceObjects with the same draw priority are drawn with the ones with lower y-coordinates in front. This creates the illusion that the camera is looking diagonally up from under the plane of the level.

Method Detail

values

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

Returns:

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

valueOf

public static SpaceState.DrawMode 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