com.aspose.threed

Enum CompareFunction

java.lang.Object

java.lang.Enum<CompareFunction>

com.aspose.threed.CompareFunction

All Implemented Interfaces:

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

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

The compare function used in depth/stencil testing.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always passes
EQUAL Pass if the incoming value is equal to the stored value.
G_EQUAL Pass if the incoming value is greater than or equal to the stored value.
GREATER Pass if the incoming value is greater than the stored value.
L_EQUAL Pass if the incoming value is less than or equal to the stored value.
LESS Pass if the incoming value is less than the stored value.
NEVER Never passes
NOT_EQUAL Pass if the incoming value is not equal to the stored value.

Method Summary

Modifier and Type	Method and Description
static CompareFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CompareFunction[]	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

NEVER

public static final CompareFunction NEVER

Never passes

LESS

public static final CompareFunction LESS

Pass if the incoming value is less than the stored value.

EQUAL

public static final CompareFunction EQUAL

Pass if the incoming value is equal to the stored value.

L_EQUAL

public static final CompareFunction L_EQUAL

Pass if the incoming value is less than or equal to the stored value.

GREATER

public static final CompareFunction GREATER

Pass if the incoming value is greater than the stored value.

NOT_EQUAL

public static final CompareFunction NOT_EQUAL

Pass if the incoming value is not equal to the stored value.

G_EQUAL

public static final CompareFunction G_EQUAL

Pass if the incoming value is greater than or equal to the stored value.

ALWAYS

public static final CompareFunction ALWAYS

Always passes

Method Detail

values

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

Returns:

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

valueOf

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