math.bsp

Enum BspOccupation

java.lang.Object

java.lang.Enum<BspOccupation>

math.bsp.BspOccupation

All Implemented Interfaces:

Serializable, Comparable<BspOccupation>

public enum BspOccupation
extends Enum<BspOccupation>

Binary space partition occupation

Enumeration that tells what part of space divided by a boundary an entity occupies

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH
NEGATIVE
POSITIVE

Method Summary

Modifier and Type	Method and Description
static BspOccupation	get(boolean intersectsNegative, boolean intersectsPositive) Get occupation matching the parameters
boolean	intersectsNegative() Tell whether entity intersect negative part
boolean	intersectsPositive() Tell whether entity intersect positive part
static BspOccupation	valueOf(String name) Returns the enum constant of this type with the specified name.
static BspOccupation[]	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

NEGATIVE

public static final BspOccupation NEGATIVE

POSITIVE

public static final BspOccupation POSITIVE

BOTH

public static final BspOccupation BOTH

Method Detail

values

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

Returns:

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

valueOf

public static BspOccupation 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

get

public static BspOccupation get(boolean intersectsNegative,
                                boolean intersectsPositive)

Get occupation matching the parameters

Returns:

occupation

intersectsNegative

public boolean intersectsNegative()

Tell whether entity intersect negative part

intersectsPositive

public boolean intersectsPositive()

Tell whether entity intersect positive part