agi.foundation.graphics.advanced

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

Enum Visibility

java.lang.Object

java.lang.Enum<Visibility>

agi.foundation.graphics.advanced.Visibility

All Implemented Interfaces:

Enumeration, Serializable, Comparable<Visibility>

public enum Visibility
extends Enum<Visibility>
implements Enumeration

Result of a visibility test, such as testing if a sphere intersects a frustum.

See Also:

Camera.visibilityTest(agi.foundation.geometry.ReferenceFrame,agi.foundation.graphics.advanced.BoundingSphere)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL The object is completely visible.
NONE The object is not visible.
PARTIAL The object is partially visible.

Method Summary

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

NONE

public static final Visibility NONE

The object is not visible.

PARTIAL

public static final Visibility PARTIAL

The object is partially visible.

ALL

public static final Visibility ALL

The object is completely visible.

Method Detail

values

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

Returns:

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

valueOf

public static Visibility 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 Visibility 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 Visibility getDefault()

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

Returns:

The default enum constant.