Package arc.graphics

Enum Class Cubemap.CubemapSide

java.lang.Object

java.lang.Enum<Cubemap.CubemapSide>

arc.graphics.Cubemap.CubemapSide

All Implemented Interfaces:

Serializable, Comparable<Cubemap.CubemapSide>, Constable

Enclosing class:

Cubemap

public static enum Cubemap.CubemapSide
extends Enum<Cubemap.CubemapSide>

Enum to identify each side of a Cubemap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
negativeX	The negative X and second side of the cubemap
negativeY	The negative Y and fourth side of the cubemap
negativeZ	The negative Z and sixth side of the cubemap
positiveX	The positive X and first side of the cubemap
positiveY	The positive Y and third side of the cubemap
positiveZ	The positive Z and fifth side of the cubemap

Field Summary

Fields

Modifier and Type	Field	Description
final Vec3	direction	The direction vector to target the side.
final int	glEnum	The OpenGL target (used for glTexImage2D) of the side.
final int	index	The zero based index of the side in the cubemap
final Vec3	up	The up vector to target the side.

Method Summary

Modifier and Type	Method	Description
Vec3	getDirection(Vec3 out)
int	getGLEnum()
Vec3	getUp(Vec3 out)
static Cubemap.CubemapSide	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Cubemap.CubemapSide[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

positiveX

public static final Cubemap.CubemapSide positiveX

The positive X and first side of the cubemap

negativeX

public static final Cubemap.CubemapSide negativeX

The negative X and second side of the cubemap

positiveY

public static final Cubemap.CubemapSide positiveY

The positive Y and third side of the cubemap

negativeY

public static final Cubemap.CubemapSide negativeY

The negative Y and fourth side of the cubemap

positiveZ

public static final Cubemap.CubemapSide positiveZ

The positive Z and fifth side of the cubemap

negativeZ

public static final Cubemap.CubemapSide negativeZ

The negative Z and sixth side of the cubemap

Field Details

index

public final int index

The zero based index of the side in the cubemap

glEnum

public final int glEnum

The OpenGL target (used for glTexImage2D) of the side.

up

public final Vec3 up

The up vector to target the side.

direction

public final Vec3 direction

The direction vector to target the side.

Method Details

values

public static Cubemap.CubemapSide[] values()

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

Returns:

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

valueOf

public static Cubemap.CubemapSide valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getGLEnum

public int getGLEnum()

Returns:

The OpenGL target (used for glTexImage2D) of the side.

getUp

public Vec3 getUp(Vec3 out)

Returns:

The up vector of the side.

getDirection

public Vec3 getDirection(Vec3 out)

Returns:

The direction vector of the side.