de.javagl.obj

Interface WritableObj

All Known Subinterfaces:

Obj

All Known Implementing Classes:

AbstractWritableObj, BasicWritableObj

public interface WritableObj

Interface for all classes that may receive the data that is read from an OBJ file by an ObjReader

Method Summary

Modifier and Type	Method and Description
void	addFace(int... v) Add the specified face with the given vertex indices, but without texture- or normal indices.
void	addFace(int[] v, int[] vt, int[] vn) Add the specified face.
void	addFace(ObjFace face) Add the given face.
void	addFaceWithAll(int... v) Add the specified face with the given vertex, texture coordinate and normal indices.
void	addFaceWithNormals(int... v) Add the specified face with the given vertex and normal indices, but without texture coordinate indices.
void	addFaceWithTexCoords(int... v) Add the specified face with the given vertex and texture coordinate indices, but without normal indices.
void	addNormal(float x, float y, float z) Add the given normal
void	addNormal(FloatTuple normal) Add the given normal
void	addTexCoord(float x) Add the given texture coordinate
void	addTexCoord(float x, float y) Add the given texture coordinate
void	addTexCoord(float x, float y, float z) Add the given texture coordinate
void	addTexCoord(FloatTuple texCoord) Add the given texture coordinate
void	addVertex(float x, float y, float z) Add the given vertex
void	addVertex(FloatTuple vertex) Add the given vertex
void	setActiveGroupNames(Collection<? extends String> groupNames) Set the groups with the given names to be active right now.
void	setActiveMaterialGroupName(String materialGroupName) Set the material group with the given names to be active right now Faces that are added subsequently will be added to the active material group, creating this material group if necessary.
void	setMtlFileNames(Collection<? extends String> mtlFileNames) Set the given MTL file names.

Method Detail

addVertex

void addVertex(FloatTuple vertex)

Add the given vertex

Parameters:

vertex - The vertex to add.

Throws:

NullPointerException - If the vertex is null

addVertex

void addVertex(float x,
               float y,
               float z)

Add the given vertex

Parameters:

x - The x-coordinate

y - The y-coordinate

z - The z-coordinate

addTexCoord

void addTexCoord(FloatTuple texCoord)

Add the given texture coordinate

Parameters:

texCoord - The texture coordinate to add.

Throws:

NullPointerException - If the texture coordinate is null

addTexCoord

void addTexCoord(float x)

Add the given texture coordinate

Parameters:

x - The x-coordinate

addTexCoord

void addTexCoord(float x,
                 float y)

Add the given texture coordinate

Parameters:

x - The x-coordinate

y - The y-coordinate

addTexCoord

void addTexCoord(float x,
                 float y,
                 float z)

Add the given texture coordinate

Parameters:

x - The x-coordinate

y - The y-coordinate

z - The z-coordinate

addNormal

void addNormal(FloatTuple normal)

Add the given normal

Parameters:

normal - The normal to add.

Throws:

NullPointerException - If the normal is null

addNormal

void addNormal(float x,
               float y,
               float z)

Add the given normal

Parameters:

x - The x-coordinate

y - The y-coordinate

z - The z-coordinate

setActiveGroupNames

void setActiveGroupNames(Collection<? extends String> groupNames)

Set the groups with the given names to be active right now. Faces that are added subsequently will be added to all active groups, creating these groups if necessary. If the given collection is null, then this call will have no effect. If the given collection is empty, then the default group (named "default") will be activated.

Parameters:

groupNames - The group names

Throws:

NullPointerException - If the given collection contains null elements

setActiveMaterialGroupName

void setActiveMaterialGroupName(String materialGroupName)

Set the material group with the given names to be active right now Faces that are added subsequently will be added to the active material group, creating this material group if necessary. If the given name is null, then this call will have no effect.

Parameters:

materialGroupName - The material group name

addFace

void addFace(ObjFace face)

Add the given face. The indices in the given face are absolute (non-negative) and 0-based. The implementation is free to store a reference to the given face.

Parameters:

face - The face to add.

Throws:

NullPointerException - If the face is null

addFace

void addFace(int... v)

Add the specified face with the given vertex indices, but without texture- or normal indices. The given indices are absolute (non-negative) and 0-based. The implementation is free to store a reference to the given array. So the array should not be modified after this method has been called.

Parameters:

v - The vertex indices

Throws:

IllegalArgumentException - If one of the given indices is negative or not smaller than the number of vertices that have been added until now.

addFaceWithTexCoords

void addFaceWithTexCoords(int... v)

Add the specified face with the given vertex and texture coordinate indices, but without normal indices. The given indices are absolute (non-negative) and 0-based. The implementation is free to store a reference to the given array. So the array should not be modified after this method has been called.

Parameters:

v - The vertex- and texture coordinate indices

Throws:

IllegalArgumentException - If one of the given indices is negative or not smaller than the number of vertices or texture coordinates that have been added until now.

addFaceWithNormals

void addFaceWithNormals(int... v)

Add the specified face with the given vertex and normal indices, but without texture coordinate indices. The given indices are absolute (non-negative) and 0-based. The implementation is free to store a reference to the given array. So the array should not be modified after this method has been called.

Parameters:

v - The vertex- and normal indices

Throws:

IllegalArgumentException - If one of the given indices is negative or not smaller than the number of vertices or normals that have been added until now.

addFaceWithAll

void addFaceWithAll(int... v)

Add the specified face with the given vertex, texture coordinate and normal indices. The given indices are absolute (non-negative) and 0-based. The implementation is free to store a reference to the given array. So the array should not be modified after this method has been called.

Parameters:

v - The vertex- texture coordinate and normal indices

Throws:

IllegalArgumentException - If one of the given indices is negative or not smaller than the number of vertices, texture coordinates or normals that have been added until now.

addFace

void addFace(int[] v,
             int[] vt,
             int[] vn)

Add the specified face. The given indices are absolute (non-negative) and 0-based. The implementation is free to store a reference to the given arrays. So the arrays should not be modified after this method has been called.

Parameters:

v - The vertex indices

vt - The texture coordinate indices. May be null.

vn - The normal indices. May be null

Throws:

NullPointerException - If the vertex indices array is null

IllegalArgumentException - If one of the given indices is negative or not smaller than the number of corresponding vertices, texture coordinates or normals that have been added until now, respectively.

IllegalArgumentException - If the given (non-null) arrays have different lengths

setMtlFileNames

void setMtlFileNames(Collection<? extends String> mtlFileNames)

Set the given MTL file names. A copy of the given collection will be stored.

Parameters:

mtlFileNames - The names of the MTL file