Enum EAxisPolarity

java.lang.Object

java.lang.Enum<EAxisPolarity>

de.xima.fc.common.geometry.EAxisPolarity

All Implemented Interfaces:

Serializable, Comparable<EAxisPolarity>

public enum EAxisPolarity
extends Enum<EAxisPolarity>

The polarity or direction of an axis in a coordinate system.

Since:

8.4.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
NEGATIVE	The negative polarity or direction, going from positive to negative values.
POSITIVE	The positive polarity or direction, going from negative to positive values.

Method Summary

Modifier and Type	Method	Description
EAxisPolarity	inverse()	Returns the opposite polarity of this axis polarity.
int	signum()	The signum of this axis polarity, i.e. +1 for POSITIVE and -1 for NEGATIVE.
static EAxisPolarity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EAxisPolarity[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEGATIVE

public static final EAxisPolarity NEGATIVE

The negative polarity or direction, going from positive to negative values.

POSITIVE

public static final EAxisPolarity POSITIVE

The positive polarity or direction, going from negative to positive values.

Method Details

values

public static EAxisPolarity[] values()

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

Returns:

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

valueOf

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

inverse

public EAxisPolarity inverse()

Returns the opposite polarity of this axis polarity.

Returns:

The opposite polarity of this axis polarity.

signum

public int signum()

The signum of this axis polarity, i.e. +1 for POSITIVE and -1 for NEGATIVE.

Returns:

The signum of this axis polarity.