li.cil.tis3d.api.machine

Enum Port

java.lang.Object

java.lang.Enum<Port>

li.cil.tis3d.api.machine.Port

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Port>

public enum Port
extends java.lang.Enum<Port>

The ports that can be available on a module.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN
LEFT
RIGHT
UP

Field Summary

Fields

Modifier and Type	Field and Description
static Port[]	CLOCKWISE List of ports in a clockwise fashion, starting at UP.
static Port[]	HORIZONTAL Mapping of EnumFacings to a horizontal Port equivalent.
static Port[]	OPPOSITES Mapping ports to their opposites (by ordinal()).
static Port[]	ROTATED Mapping of port to next port in clockwise order.
static int[]	ROTATION Mapping of port id to rotation relative to UP.
static Port[]	VALUES All possible enum values for quick indexing.

Method Summary

Modifier and Type	Method and Description
static Port	fromEnumFacing(net.minecraft.util.EnumFacing facing) Convert a facing from Forge's format to a port, assuming a top or bottom face.
static Port	fromUVQuadrant(net.minecraft.util.math.Vec3d uv) Convert a UV coordinate to the port on the side of the quadrant the UV coordinate falls into.
Port	getOpposite() The the opposite port to this one.
Port	rotated() Get the next port in clockwise rotation.
Port	rotated(int steps) Get the n-th next port in clockwise rotation.
static Port	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Port[]	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

LEFT

public static final Port LEFT

RIGHT

public static final Port RIGHT

UP

public static final Port UP

DOWN

public static final Port DOWN

Field Detail

VALUES

public static final Port[] VALUES

All possible enum values for quick indexing.

OPPOSITES

public static final Port[] OPPOSITES

Mapping ports to their opposites (by ordinal()).

ROTATED

public static final Port[] ROTATED

Mapping of port to next port in clockwise order.

CLOCKWISE

public static final Port[] CLOCKWISE

List of ports in a clockwise fashion, starting at UP.

ROTATION

public static final int[] ROTATION

Mapping of port id to rotation relative to UP.

HORIZONTAL

public static final Port[] HORIZONTAL

Mapping of EnumFacings to a horizontal Port equivalent.

Method Detail

values

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

Returns:

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

valueOf

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

getOpposite

public Port getOpposite()

The the opposite port to this one.

Returns:

the opposite port.

See Also:

OPPOSITES

rotated

public Port rotated()

Get the next port in clockwise rotation.

Returns:

the port right to this port.

rotated

public Port rotated(int steps)

Get the n-th next port in clockwise rotation.

Parameters:

steps - how many steps to make.

Returns:

the n-th right neighbor to this port.

fromEnumFacing

public static Port fromEnumFacing(net.minecraft.util.EnumFacing facing)

Convert a facing from Forge's format to a port, assuming a top or bottom face.

Parameters:

facing - the facing to convert.

Returns:

the Port representing that facing.

fromUVQuadrant

public static Port fromUVQuadrant(net.minecraft.util.math.Vec3d uv)

Convert a UV coordinate to the port on the side of the quadrant the UV coordinate falls into.

Parameters:

uv - the UV coordinate in (0,0,0) to (1,1,0).

Returns:

the port of the quadrant the coordinate lies in.