agi.foundation.graphics

(agi.foundation.graphics-2024r3.jar)

Enum SetHint

java.lang.Object

java.lang.Enum<SetHint>

agi.foundation.graphics.SetHint

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SetHint>

public enum SetHint
extends Enum<SetHint>
implements Enumeration

An optimization hint optionally provided to primitives to enhance performance for static or dynamic primitives. See the Set Hint topic for selecting an appropriate value.

See Also:

Set Hint Performance topic

Enum Constant Summary

Enum Constants

Enum Constant and Description
FREQUENT Rendering is optimized for streaming geometry.
INFREQUENT Rendering is optimized for static geometry.
PARTIAL Rendering is optimized for dynamic geometry.

Method Summary

Modifier and Type	Method and Description
static SetHint	getDefault() Get the enum constant that is considered to be the default.
static SetHint	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static SetHint	valueOf(String name) Returns the enum constant of this type with the specified name.
static SetHint[]	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

INFREQUENT

public static final SetHint INFREQUENT

Rendering is optimized for static geometry. The primitive's vertices are not going to be updated with Set() or SetPartial() calls. Calls to SetPartial() will fail. Calls to Set() are allowed but may not be as efficient as SetHintFrequent.

PARTIAL

public static final SetHint PARTIAL

Rendering is optimized for dynamic geometry. The primitive's vertices are expected to be updated with SetPartial() - some or all of the vertices will change but the number of vertices will not.

FREQUENT

public static final SetHint FREQUENT

Rendering is optimized for streaming geometry. The primitive's vertices are expected to be updated with Set() - all the vertices will change and/or the number of vertices will change. Calls to SetPartial() will fail.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static SetHint getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static SetHint getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.