org.apache.commons.geometry.examples.io.threed.obj

Class OBJWriter

java.lang.Object

org.apache.commons.geometry.examples.io.threed.obj.OBJWriter

All Implemented Interfaces:

AutoCloseable

public final class OBJWriter
extends Object
implements AutoCloseable

Class for writing OBJ files containing 3D mesh data.

Constructor Summary

Constructors

Constructor and Description
OBJWriter(File file) Create a new instance for writing to the given file.
OBJWriter(Writer writer) Create a new instance that writes output with the given writer.

Method Summary

Modifier and Type	Method and Description
void	close()
DecimalFormat	getDecimalFormat() Get the DecimalFormat instance used to format floating point output.
String	getLineSeparator() Get the current line separator.
void	setDecimalFormat(DecimalFormat decimalFormat) Set the DecimalFormat instance used to format floatin point output.
void	setLineSeparator(String lineSeparator) Set the line separator.
void	writeBoundaries(BoundarySource3D boundarySource) Write the boundaries present in the given boundary source.
void	writeComment(String comment) Write an OBJ comment with the given value.
void	writeFace(int... vertexIndices) Write a face with the given vertex indices, specified in the OBJ 1-based convention.
void	writeGroupName(String groupName) Write a group name to the output.
void	writeMesh(Mesh<?> mesh) Write a mesh to the output.
void	writeObjectName(String objectName) Write an object name to the output.
int	writeVertex(Vector3D vertex) Write a vertex to the output.

Methods inherited from class java.lang.Object

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

Constructor Detail

OBJWriter

public OBJWriter(File file)
          throws IOException

Create a new instance for writing to the given file.

Parameters:

file - file to write to

Throws:

IOException - if an IO operation fails

OBJWriter

public OBJWriter(Writer writer)

Create a new instance that writes output with the given writer.

Parameters:

writer - writer used to write output

Method Detail

getLineSeparator

public String getLineSeparator()

Get the current line separator. This value defaults to .

Returns:

the current line separator

setLineSeparator

public void setLineSeparator(String lineSeparator)

Set the line separator.

Parameters:

lineSeparator - the line separator to use

getDecimalFormat

public DecimalFormat getDecimalFormat()

Get the DecimalFormat instance used to format floating point output.

Returns:

the decimal format instance

setDecimalFormat

public void setDecimalFormat(DecimalFormat decimalFormat)

Set the DecimalFormat instance used to format floatin point output.

Parameters:

decimalFormat - decimal format instance

writeComment

public void writeComment(String comment)
                  throws IOException

Write an OBJ comment with the given value.

Parameters:

comment - comment to write

Throws:

IOException - if an IO operation fails

writeObjectName

public void writeObjectName(String objectName)
                     throws IOException

Write an object name to the output. This is metadata for the file and does not affect the geometry, although it may affect how the file content is read by other programs.

Parameters:

objectName - the name to write

Throws:

IOException - if an IO operation fails

writeGroupName

public void writeGroupName(String groupName)
                    throws IOException

Write a group name to the output. This is metadata for the file and does not affect the geometry, although it may affect how the file content is read by other programs.

Parameters:

groupName - the name to write

Throws:

IOException - if an IO operation fails

writeVertex

public int writeVertex(Vector3D vertex)
                throws IOException

Write a vertex to the output. The OBJ 1-based index of the vertex is returned. This index can be used to reference the vertex in faces via writeFace(int...).

Parameters:

vertex - vertex to write

Returns:

the index of the written vertex in the OBJ 1-based convention

Throws:

IOException - if an IO operation fails

IOException - if an IO operation fails

writeFace

public void writeFace(int... vertexIndices)
               throws IOException

Write a face with the given vertex indices, specified in the OBJ 1-based convention. Callers are responsible for ensuring that the indices are valid.

Parameters:

vertexIndices - vertex indices for the face, in the 1-based OBJ convention

Throws:

IOException - if an IO operation fails

writeBoundaries

public void writeBoundaries(BoundarySource3D boundarySource)
                     throws IOException

Write the boundaries present in the given boundary source. If the argument is a Mesh, it is written using writeMesh(Mesh). Otherwise, each boundary is written to the output separately.

Parameters:

boundarySource - boundary source containing the boundaries to write to the output

Throws:

IllegalArgumentException - if any boundary in the argument is infinite

IOException - if an IO operation fails

writeMesh

public void writeMesh(Mesh<?> mesh)
               throws IOException

Write a mesh to the output.

Parameters:

mesh - the mesh to write

Throws:

IOException - if an IO operation fails

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException