net.tridentsdk.base

Enum BlockDirection

java.lang.Object

java.lang.Enum<BlockDirection>

net.tridentsdk.base.BlockDirection

All Implemented Interfaces:

Serializable, Comparable<BlockDirection>

public enum BlockDirection
extends Enum<BlockDirection>

Represents an orientation towards a given direction set from a Vector

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM Facing down
EAST Facing east
NORTH Facing north
NORTH_EAST Facing north east
NORTH_WEST Facing north west
SELF The given component direction not leading anywhere
SOUTH Facing south
SOUTH_EAST Facing south east
SOUTH_WEST Facing south west
TOP Facing up
WEST Facing west

Method Summary

Modifier and Type	Method and Description
Position	apply(Position loc) Gets the position relative to the given direction
Vector	difference() The copy of the directional vector
static BlockDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static BlockDirection[]	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

NORTH

public static final BlockDirection NORTH

Facing north

SOUTH

public static final BlockDirection SOUTH

Facing south

EAST

public static final BlockDirection EAST

Facing east

WEST

public static final BlockDirection WEST

Facing west

NORTH_EAST

public static final BlockDirection NORTH_EAST

Facing north east

NORTH_WEST

public static final BlockDirection NORTH_WEST

Facing north west

SOUTH_EAST

public static final BlockDirection SOUTH_EAST

Facing south east

SOUTH_WEST

public static final BlockDirection SOUTH_WEST

Facing south west

TOP

public static final BlockDirection TOP

Facing up

BOTTOM

public static final BlockDirection BOTTOM

Facing down

SELF

public static final BlockDirection SELF

The given component direction not leading anywhere

Method Detail

values

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

Returns:

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

valueOf

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

difference

public Vector difference()

The copy of the directional vector

Returns:

the cloned vector pointing to the specified face

apply

public Position apply(Position loc)

Gets the position relative to the given direction

Parameters:

loc - the position to get relative to

Returns:

the relative position