de.javagl.obj

Interface ObjFace

public interface ObjFace

A single face that is stored in an OBJ file

Method Summary

Modifier and Type	Method and Description
boolean	containsNormalIndices() Returns whether this face contains normal indices
boolean	containsTexCoordIndices() Returns whether this face contains texture coordinate indices
int	getNormalIndex(int number) Returns the index of the normal with the given number.
int	getNumVertices() Returns the number of vertices this face consists of.
int	getTexCoordIndex(int number) Returns the index of the texture coordinate with the given number.
int	getVertexIndex(int number) Returns the index of the vertex with the given number.

Method Detail

getNumVertices

int getNumVertices()

Returns the number of vertices this face consists of.

Returns:

The number of vertices this face consists of.

containsTexCoordIndices

boolean containsTexCoordIndices()

Returns whether this face contains texture coordinate indices

Returns:

Whether this face contains texture coordinate indices

containsNormalIndices

boolean containsNormalIndices()

Returns whether this face contains normal indices

Returns:

Whether this face contains normal indices

getVertexIndex

int getVertexIndex(int number)

Returns the index of the vertex with the given number. The index that is returned will be ZERO-based, in contrast to the ONE-based storage in the OBJ file.

Parameters:

number - The number of the vertex

Returns:

The index of the vertex.

Throws:

IndexOutOfBoundsException - If the given number is negative or not smaller than getNumVertices()

getTexCoordIndex

int getTexCoordIndex(int number)

Returns the index of the texture coordinate with the given number. The index that is returned will be ZERO-based, in contrast to the ONE-based storage in the OBJ file.

Parameters:

number - The number of the texture coordinate

Returns:

The index of the texture coordinate.

Throws:

IndexOutOfBoundsException - If the given number is negative or not smaller than getNumVertices()

getNormalIndex

int getNormalIndex(int number)

Returns the index of the normal with the given number. The index that is returned will be ZERO-based, in contrast to the ONE-based storage in the OBJ file.

Parameters:

number - The number of the normal

Returns:

The index of the normal.

Throws:

IndexOutOfBoundsException - If the given number is negative or not smaller than getNumVertices()