Enum Class LightingManager.SymmetryMode

java.lang.Object

java.lang.Enum<LightingManager.SymmetryMode>

com.github.yellowstonegames.grid.LightingManager.SymmetryMode

All Implemented Interfaces:

LightingManager.FovFunction, Serializable, Comparable<LightingManager.SymmetryMode>, Constable

Enclosing class:

LightingManager

public static enum LightingManager.SymmetryMode
extends Enum<LightingManager.SymmetryMode>
implements LightingManager.FovFunction

Used to choose whether FOV calculations should be done as quickly as possible (without symmetry guarantees) or more precisely (and more slowly, but with a symmetry guarantee). If this is SYMMETRICAL, then if cell A lights up cell B, you could move the light from A to B without changing that both are lit up. That guarantee is not present if this is set to FAST.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAST
SYMMETRICAL

Method Summary

Modifier and Type	Method	Description
float[][]	getFov(float[][] resistanceMap, float[][] light, int startX, int startY, float radius, Radius radiusTechnique)
static LightingManager.SymmetryMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LightingManager.SymmetryMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FAST

public static final LightingManager.SymmetryMode FAST

SYMMETRICAL

public static final LightingManager.SymmetryMode SYMMETRICAL

Method Details

values

public static LightingManager.SymmetryMode[] 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 LightingManager.SymmetryMode 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

getFov

public float[][] getFov(float[][] resistanceMap,
 float[][] light,
 int startX,
 int startY,
 float radius,
 Radius radiusTechnique)

Specified by:

getFov in interface LightingManager.FovFunction