Package snap.gfx3d

Enum Class Side3D

java.lang.Object

java.lang.Enum<Side3D>

snap.gfx3d.Side3D

All Implemented Interfaces:

Serializable, Comparable<Side3D>, Constable

public enum Side3D
extends Enum<Side3D>

An enum to represent a side of rectanglular area: Left, right, top, bottom.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Side3D.Corner	This class describes the corners of a standard cube.
static enum	Side3D.Edge	This class describes the edges of the standard cube.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACK
BOTTOM
FRONT
LEFT
RIGHT
TOP

Method Summary

Modifier and Type	Method	Description
Side3D.Corner	getCornerForPos(Pos aPos)	Returns the Corner for given Pos.
Side3D.Corner[]	getCorners()	Returns the corners.
Side3D.Edge	getEdgeForPos(Pos aPos)	Returns the Edge for given Pos.
Side3D.Edge[]	getEdges()	Returns the edges.
Vector3D	getNormalInward()	Returns the side normal for a given side.
Pos	getPosForCorner(Side3D.Corner aCorner)	Returns the Corner for given Pos.
Pos	getPosForEdge(Side3D.Edge anEdge)	Returns the Edge for given Pos.
boolean	isFrontOrBack()	Returns whether side is FRONT or BACK.
boolean	isLeftOrRight()	Returns whether side is LEFT or RIGHT.
boolean	isTopOrBottom()	Returns whether side is TOP or BOTTOM.
static Side3D	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Side3D[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FRONT

public static final Side3D FRONT

BACK

public static final Side3D BACK

LEFT

public static final Side3D LEFT

RIGHT

public static final Side3D RIGHT

TOP

public static final Side3D TOP

BOTTOM

public static final Side3D BOTTOM

Method Details

values

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

isFrontOrBack

public boolean isFrontOrBack()

Returns whether side is FRONT or BACK.

isLeftOrRight

public boolean isLeftOrRight()

Returns whether side is LEFT or RIGHT.

isTopOrBottom

public boolean isTopOrBottom()

Returns whether side is TOP or BOTTOM.

getNormalInward

public Vector3D getNormalInward()

Returns the side normal for a given side.

getCorners

public Side3D.Corner[] getCorners()

Returns the corners.

getCornerForPos

public Side3D.Corner getCornerForPos(Pos aPos)

Returns the Corner for given Pos.

getPosForCorner

public Pos getPosForCorner(Side3D.Corner aCorner)

Returns the Corner for given Pos.

getEdges

public Side3D.Edge[] getEdges()

Returns the edges.

getEdgeForPos

public Side3D.Edge getEdgeForPos(Pos aPos)

Returns the Edge for given Pos.

getPosForEdge

public Pos getPosForEdge(Side3D.Edge anEdge)

Returns the Edge for given Pos.