de.javagl.obj

Class BasicWritableObj

java.lang.Object

de.javagl.obj.BasicWritableObj

All Implemented Interfaces:

WritableObj

public class BasicWritableObj
extends Object
implements WritableObj

Basic implementation of a WritableObj that delegates all calls to consumer callbacks.

The consumers for the elements of an OBJ are null by default, causing the respective elements to be ignored. The callbacks may be set individually. For example, in order to print all vertices and faces that are read from an OBJ file, the following may be used:

 BasicWritableObj obj = new BasicWritableObj();
 obj.setVertexConsumer(t -> System.out.println(t));
 obj.setFaceConsumer(t -> System.out.println(t));
 ObjReader.read(inputStream, obj);
 

Constructor Summary

Constructors

Constructor and Description
BasicWritableObj() Default constructor

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	setFaceConsumer(java.util.function.Consumer<? super ObjFace> faceConsumer) Set the face consumer
void	setGroupNamesConsumer(java.util.function.Consumer<? super Collection<? extends String>> groupNamesConsumer) Set the group names consumer
void	setMaterialGroupNameConsumer(java.util.function.Consumer<? super String> materialGroupNameConsumer) Set the material group name consumer
void	setMtlFileNames(Collection<? extends String> mtlFileNames) Set the given MTL file names.
void	setMtlFileNamesConsumer(java.util.function.Consumer<? super Collection<? extends String>> mtlFileNamesConsumer) Set the MTL file names consumer
void	setNormalConsumer(java.util.function.Consumer<? super FloatTuple> normalConsumer) Set the normal consumer
void	setTexCoordConsumer(java.util.function.Consumer<? super FloatTuple> texCoordConsumer) Set the texture coordinate consumer
void	setVertexConsumer(java.util.function.Consumer<? super FloatTuple> vertexConsumer) Set the vertex consumer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicWritableObj

public BasicWritableObj()

Default constructor

Method Detail

setVertexConsumer

public void setVertexConsumer(java.util.function.Consumer<? super FloatTuple> vertexConsumer)

Set the vertex consumer

Parameters:

vertexConsumer - The consumer

setTexCoordConsumer

public void setTexCoordConsumer(java.util.function.Consumer<? super FloatTuple> texCoordConsumer)

Set the texture coordinate consumer

Parameters:

texCoordConsumer - The consumer

setNormalConsumer

public void setNormalConsumer(java.util.function.Consumer<? super FloatTuple> normalConsumer)

Set the normal consumer

Parameters:

normalConsumer - The consumer

setFaceConsumer

public void setFaceConsumer(java.util.function.Consumer<? super ObjFace> faceConsumer)

Set the face consumer

Parameters:

faceConsumer - The consumer

setGroupNamesConsumer

public void setGroupNamesConsumer(java.util.function.Consumer<? super Collection<? extends String>> groupNamesConsumer)

Set the group names consumer

Parameters:

groupNamesConsumer - The consumer

setMaterialGroupNameConsumer

public void setMaterialGroupNameConsumer(java.util.function.Consumer<? super String> materialGroupNameConsumer)

Set the material group name consumer

Parameters:

materialGroupNameConsumer - The consumer

setMtlFileNamesConsumer

public void setMtlFileNamesConsumer(java.util.function.Consumer<? super Collection<? extends String>> mtlFileNamesConsumer)

Set the MTL file names consumer

Parameters:

mtlFileNamesConsumer - The consumer

addVertex

public final void addVertex(FloatTuple vertex)

Description copied from interface: WritableObj

Add the given vertex

Specified by:

addVertex in interface WritableObj

Parameters:

vertex - The vertex to add.

addVertex

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

Description copied from interface: WritableObj

Add the given vertex

Specified by:

addVertex in interface WritableObj

Parameters:

x - The x-coordinate

y - The y-coordinate

z - The z-coordinate

addTexCoord

public final void addTexCoord(FloatTuple texCoord)

Description copied from interface: WritableObj

Add the given texture coordinate

Specified by:

addTexCoord in interface WritableObj

Parameters:

texCoord - The texture coordinate to add.

addTexCoord

public final void addTexCoord(float x)

Description copied from interface: WritableObj

Add the given texture coordinate

Specified by:

addTexCoord in interface WritableObj

Parameters:

x - The x-coordinate

addTexCoord

public final void addTexCoord(float x,
                              float y)

Description copied from interface: WritableObj

Add the given texture coordinate

Specified by:

addTexCoord in interface WritableObj

Parameters:

x - The x-coordinate

y - The y-coordinate

addTexCoord

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

Description copied from interface: WritableObj

Add the given texture coordinate

Specified by:

addTexCoord in interface WritableObj

Parameters:

x - The x-coordinate

y - The y-coordinate

z - The z-coordinate

addNormal

public final void addNormal(FloatTuple normal)

Description copied from interface: WritableObj

Add the given normal

Specified by:

addNormal in interface WritableObj

Parameters:

normal - The normal to add.

addNormal

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

Description copied from interface: WritableObj

Add the given normal

Specified by:

addNormal in interface WritableObj

Parameters:

x - The x-coordinate

y - The y-coordinate

z - The z-coordinate

setActiveGroupNames

public final void setActiveGroupNames(Collection<? extends String> groupNames)

Description copied from interface: WritableObj

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.

Specified by:

setActiveGroupNames in interface WritableObj

Parameters:

groupNames - The group names

setActiveMaterialGroupName

public final void setActiveMaterialGroupName(String materialGroupName)

Description copied from interface: WritableObj

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.

Specified by:

setActiveMaterialGroupName in interface WritableObj

Parameters:

materialGroupName - The material group name

addFace

public final void addFace(ObjFace face)

Description copied from interface: WritableObj

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.

Specified by:

addFace in interface WritableObj

Parameters:

face - The face to add.

addFace

public final void addFace(int... v)

Description copied from interface: WritableObj

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.

Specified by:

addFace in interface WritableObj

Parameters:

v - The vertex indices

addFaceWithTexCoords

public final void addFaceWithTexCoords(int... v)

Description copied from interface: WritableObj

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.

Specified by:

addFaceWithTexCoords in interface WritableObj

Parameters:

v - The vertex- and texture coordinate indices

addFaceWithNormals

public final void addFaceWithNormals(int... v)

Description copied from interface: WritableObj

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.

Specified by:

addFaceWithNormals in interface WritableObj

Parameters:

v - The vertex- and normal indices

addFaceWithAll

public final void addFaceWithAll(int... v)

Description copied from interface: WritableObj

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.

Specified by:

addFaceWithAll in interface WritableObj

Parameters:

v - The vertex- texture coordinate and normal indices

addFace

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

Description copied from interface: WritableObj

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.

Specified by:

addFace in interface WritableObj

Parameters:

v - The vertex indices

vt - The texture coordinate indices. May be null.

vn - The normal indices. May be null

setMtlFileNames

public final void setMtlFileNames(Collection<? extends String> mtlFileNames)

Description copied from interface: WritableObj

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

Specified by:

setMtlFileNames in interface WritableObj

Parameters:

mtlFileNames - The names of the MTL file