Enum Class Modifier

java.lang.Object

java.lang.Enum<Modifier>

fr.fidorial.world.environment.Modifier

All Implemented Interfaces:

Serializable, Comparable<Modifier>, Constable

public enum Modifier
extends Enum<Modifier>

How an environment attribute value combines with the value provided by a lower-priority source.

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD	Floats: adds.
ALPHA_BLEND	Colors only: traditional alpha blending; the argument is an ARGB color.
AND	Booleans only.
MAXIMUM	Floats only: keeps the larger of the two values.
MINIMUM	Floats only: keeps the smaller of the two values.
MULTIPLY	Floats: multiplies.
NAND	Booleans only.
NOR	Booleans only.
OR	Booleans only.
OVERRIDE	Replaces the previous value outright.
SUBTRACT	Floats: subtracts.
XNOR	Booleans only.
XOR	Booleans only.

Method Summary

Modifier and Type	Method	Description
String	id()	Returns the identifier expected on the wire.
static Modifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Modifier[]	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

OVERRIDE

public static final Modifier OVERRIDE

Replaces the previous value outright. The default and the only form written bare.

ADD

public static final Modifier ADD

Floats: adds. Colors: component-wise additive blending.

SUBTRACT

public static final Modifier SUBTRACT

Floats: subtracts. Colors: component-wise subtractive blending.

MULTIPLY

public static final Modifier MULTIPLY

Floats: multiplies. Colors: component-wise multiplicative blending.

MINIMUM

public static final Modifier MINIMUM

Floats only: keeps the smaller of the two values.

MAXIMUM

public static final Modifier MAXIMUM

Floats only: keeps the larger of the two values.

ALPHA_BLEND

public static final Modifier ALPHA_BLEND

Colors only: traditional alpha blending; the argument is an ARGB color.

AND

public static final Modifier AND

Booleans only.

NAND

public static final Modifier NAND

Booleans only.

OR

public static final Modifier OR

Booleans only.

NOR

public static final Modifier NOR

Booleans only.

XOR

public static final Modifier XOR

Booleans only.

XNOR

public static final Modifier XNOR

Booleans only.

Method Details

values

public static Modifier[] 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 Modifier 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

id

public String id()

Returns the identifier expected on the wire.

Returns:

the identifier expected on the wire