de.javagl.obj

Interface ReadableObj

All Known Subinterfaces:

Obj

public interface ReadableObj

Interface for classes providing part of the data that may be stored in an OBJ file. The data represented by this interface is:

• Vertices
• Texture coordinates
• Normals
• Faces
• Groups
• Material groups

Method Summary

Modifier and Type	Method and Description
Set<String>	getActivatedGroupNames(ObjFace face) Returns an unmodifiable set containing the names of the groups that are activated with the given face.
String	getActivatedMaterialGroupName(ObjFace face) Returns the name of the material group that is activated with the given face.
ObjFace	getFace(int index) Returns the face with the given index.
ObjGroup	getGroup(int index) Returns the group with the given index.
ObjGroup	getGroup(String name) Returns the group with the given name, or null if there is no such group in this Obj.
ObjGroup	getMaterialGroup(int index) Returns the material group with the given index.
ObjGroup	getMaterialGroup(String name) Returns the material group with the given name, or null if there is no such group in this Obj.
List<String>	getMtlFileNames() Returns an unmodifiable list containing the names of the MTL file that are associated with this OBJ, as they have been read from the mtllib line.
FloatTuple	getNormal(int index) Returns the normal with the given index.
int	getNumFaces() Returns the number of faces in the Obj.
int	getNumGroups() Returns the number of groups in this Obj.
int	getNumMaterialGroups() Returns the number of material groups in this Obj.
int	getNumNormals() Returns the number of normals in the Obj.
int	getNumTexCoords() Returns the number of texture coordinates in the Obj.
int	getNumVertices() Returns the number of vertices in the Obj.
FloatTuple	getTexCoord(int index) Returns the texture coordinate with the given index.
FloatTuple	getVertex(int index) Returns the vertex with the given index.

Method Detail

getNumVertices

int getNumVertices()

Returns the number of vertices in the Obj.

Returns:

The number of vertices in the Obj.

getVertex

FloatTuple getVertex(int index)

Returns the vertex with the given index. Note that the index is 0-based, in contrast to the 1-based indices of the actual OBJ file.

Parameters:

index - The index of the vertex

Returns:

The vertex with the given index

Throws:

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

getNumTexCoords

int getNumTexCoords()

Returns the number of texture coordinates in the Obj.

Returns:

The number of texture coordinates in the Obj.

getTexCoord

FloatTuple getTexCoord(int index)

Returns the texture coordinate with the given index. Note that the is 0-based, in contrast to the 1-based indices of the actual OBJ file.

Parameters:

index - The index of the texture coordinate

Returns:

The texture coordinate with the given index

Throws:

IndexOutOfBoundsException - If the index is negative or not smaller than getNumTexCoords()

getNumNormals

int getNumNormals()

Returns the number of normals in the Obj.

Returns:

The number of normals in the Obj.

getNormal

FloatTuple getNormal(int index)

Returns the normal with the given index. Note that the index is 0-based, in contrast to the 1-based indices of the actual OBJ file.

Parameters:

index - The index of the normal

Returns:

The normal with the given index

Throws:

IndexOutOfBoundsException - If the index is negative or not smaller than getNumNormals()

getNumFaces

int getNumFaces()

Returns the number of faces in the Obj.

Returns:

The number of faces in the Obj.

getFace

ObjFace getFace(int index)

Returns the face with the given index.

Parameters:

index - The index of the face.

Returns:

The face with the given index

Throws:

IndexOutOfBoundsException - If the index is negative or not smaller than getNumFaces()

getActivatedGroupNames

Set<String> getActivatedGroupNames(ObjFace face)

Returns an unmodifiable set containing the names of the groups that are activated with the given face. If the groups that are activated with the given face are the same as for the previous face, then null will be returned.

Parameters:

face - The face

Returns:

The names of the groups that are activated with the given face

getActivatedMaterialGroupName

String getActivatedMaterialGroupName(ObjFace face)

Returns the name of the material group that is activated with the given face. If the material group that is activated with the given face is the same as for the previous face, then null will be returned.

Parameters:

face - The face

Returns:

The name of the material group that is activated with the given face

getNumGroups

int getNumGroups()

Returns the number of groups in this Obj.

Returns:

The number of groups in this Obj.

getGroup

ObjGroup getGroup(int index)

Returns the group with the given index.

Parameters:

index - The index of the group.

Returns:

The group with the given index.

Throws:

IndexOutOfBoundsException - If the index is negative or not smaller than getNumGroups()

getGroup

ObjGroup getGroup(String name)

Returns the group with the given name, or null if there is no such group in this Obj.

Parameters:

name - The name of the group.

Returns:

The group with the given name.

getNumMaterialGroups

int getNumMaterialGroups()

Returns the number of material groups in this Obj.

Returns:

The number of material groups in this Obj.

getMaterialGroup

ObjGroup getMaterialGroup(int index)

Returns the material group with the given index.

Parameters:

index - The index of the material group.

Returns:

The material group with the given index.

Throws:

IndexOutOfBoundsException - If the index is negative or not smaller than getNumMaterialGroups()

getMaterialGroup

ObjGroup getMaterialGroup(String name)

Returns the material group with the given name, or null if there is no such group in this Obj.

Parameters:

name - The name of the material group.

Returns:

The material group with the given name.

getMtlFileNames

List<String> getMtlFileNames()

Returns an unmodifiable list containing the names of the MTL file that are associated with this OBJ, as they have been read from the mtllib line. This may be an empty list, if no MTL file names have been read.

Returns:

The names of the MTL files.