eu.printingin3d.javascad.vrl

Enum VertexPosition

java.lang.Object

java.lang.Enum<VertexPosition>

eu.printingin3d.javascad.vrl.VertexPosition

All Implemented Interfaces:

Serializable, Comparable<VertexPosition>

public enum VertexPosition
extends Enum<VertexPosition>

Enum to mark a vertex position relative to the plane of the splitting.

Author:

ivivan

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK The vertex is behind the plane.
COPLANAR The vertex is on the plane.
FRONT The vertex is in front of the plane.
SPANNING This is denotes the case when there are vertexes both in front and behind the plane.

Method Summary

Modifier and Type	Method and Description
VertexPosition	add(VertexPosition v) This method helps to calculate the position of the polygon by adding two vertex position enum and calculating the result of the two position.
static VertexPosition	fromSquareDistance(double dist) Determine the vertex position based on the squared distance from the plane.
static VertexPosition	valueOf(String name) Returns the enum constant of this type with the specified name.
static VertexPosition[]	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

COPLANAR

public static final VertexPosition COPLANAR

The vertex is on the plane.

FRONT

public static final VertexPosition FRONT

The vertex is in front of the plane.

BACK

public static final VertexPosition BACK

The vertex is behind the plane.

SPANNING

public static final VertexPosition SPANNING

This is denotes the case when there are vertexes both in front and behind the plane.

Method Detail

values

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

Returns:

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

valueOf

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

add

public VertexPosition add(VertexPosition v)

This method helps to calculate the position of the polygon by adding two vertex position enum and calculating the result of the two position.

This operation is commutative, so a.add(b) gives always the same result as b.add(a).

Parameters:

v - the vertex position to add

Returns:

the calculated polygon position

fromSquareDistance

public static VertexPosition fromSquareDistance(double dist)

Determine the vertex position based on the squared distance from the plane.

Parameters:

dist - the square distance from the plane

Returns:

the position of the vertex