agi.foundation.graphics

(agi.foundation.graphics-2023r1.jar)

Enum StereoProjectionMode

java.lang.Object

java.lang.Enum<StereoProjectionMode>

agi.foundation.graphics.StereoProjectionMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StereoProjectionMode>

public enum StereoProjectionMode
extends Enum<StereoProjectionMode>
implements Enumeration

The stereoscopic projection mode used for the left and right eye scenes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
STEREO_PROJECTION_AUTOMATIC Automatic distance projection.
STEREO_PROJECTION_FIXED_DISTANCE Fixed distance projection.
STEREO_PROJECTION_PARALLEL Parallel projection.

Method Summary

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

STEREO_PROJECTION_PARALLEL

public static final StereoProjectionMode STEREO_PROJECTION_PARALLEL

Parallel projection. Parallel projection will ignore any projection distance that has been set and instead use a parallel projection for each eye. In parallel mode all objects will appear to go into the screen. Head mounted stereographic systems typically require a parallel projection.

STEREO_PROJECTION_FIXED_DISTANCE

public static final StereoProjectionMode STEREO_PROJECTION_FIXED_DISTANCE

Fixed distance projection. Objects at the fixed distance will appear to have no depth. Objects further than the distance will appear to go into the screen. Objects nearer than the distance will appear to pop out of the screen.

STEREO_PROJECTION_AUTOMATIC

public static final StereoProjectionMode STEREO_PROJECTION_AUTOMATIC

Automatic distance projection. Automatic distance projection will ignore any projection distance that has been set and instead automatically calculates the projection distance based on the distance between the camera and the center of the scene.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.