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

Class ObjBoundaryWriteHandler3D

java.lang.Object

org.apache.commons.geometry.io.euclidean.threed.AbstractBoundaryWriteHandler3D

org.apache.commons.geometry.io.euclidean.threed.obj.ObjBoundaryWriteHandler3D

All Implemented Interfaces:

BoundaryWriteHandler<PlaneConvexSubset,BoundarySource3D>, BoundaryWriteHandler3D

public class ObjBoundaryWriteHandler3D
extends AbstractBoundaryWriteHandler3D

BoundaryWriteHandler3D implementation for writing OBJ content. Output is written using the UTF-8 charset by default.

Constructor Summary

Constructors

Constructor and Description
ObjBoundaryWriteHandler3D()

Method Summary

Modifier and Type	Method and Description
Charset	getDefaultCharset() Get the text output default charset, used if the output does not specify a charset.
DoubleFunction<String>	getDoubleFormat() Get the function used to convert double values to strings.
GeometryFormat	getFormat()
String	getLineSeparator() Get the line separator.
int	getMeshBufferBatchSize() Get the batch size when generating OBJ mesh content from facet sequences.
void	setDefaultCharset(Charset charset) Set the text output default charset, used if the output does not specify a charset.
void	setDoubleFormat(DoubleFunction<String> doubleFormat) Set the function used to convert double values to strings.
void	setLineSeparator(String lineSeparator) Set the line separator.
void	setMeshBufferBatchSize(int batchSize) Set the batch size when generating OBJ mesh content from facet sequences.
void	write(BoundarySource3D src, GeometryOutput out)
void	write(Stream<? extends PlaneConvexSubset> boundaries, GeometryOutput out) Write all boundaries in the stream to the given output using the data format supported by this instance.
void	writeFacets(Stream<? extends FacetDefinition> facets, GeometryOutput out) Write all facets in the stream to the output using the data format supported by this instance.

Methods inherited from class org.apache.commons.geometry.io.euclidean.threed.AbstractBoundaryWriteHandler3D

writeFacets

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjBoundaryWriteHandler3D

public ObjBoundaryWriteHandler3D()

Method Detail

getFormat

public GeometryFormat getFormat()

getDefaultCharset

public Charset getDefaultCharset()

Get the text output default charset, used if the output does not specify a charset.

Returns:

text output default charset

setDefaultCharset

public void setDefaultCharset(Charset charset)

Set the text output default charset, used if the output does not specify a charset.

Parameters:

charset - text output default charset

getLineSeparator

public String getLineSeparator()

Get the 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

getDoubleFormat

public DoubleFunction<String> getDoubleFormat()

Get the function used to convert double values to strings.

Returns:

double format function

setDoubleFormat

public void setDoubleFormat(DoubleFunction<String> doubleFormat)

Set the function used to convert double values to strings. The given function must be thread-safe if this handler is to be used in a multi-threaded context.

Parameters:

doubleFormat - double format function

getMeshBufferBatchSize

public int getMeshBufferBatchSize()

Get the batch size when generating OBJ mesh content from facet sequences. Larger batch sizes allow for reuse of vertex definitions but at the cost of more memory usage. The buffer size is unlimited if set to -1. Default value is .

Returns:

mesh buffer batch size

See Also:

ObjWriter.meshBuffer(int)

setMeshBufferBatchSize

public void setMeshBufferBatchSize(int batchSize)

Set the batch size when generating OBJ mesh content from facet sequences. Larger batch sizes allow for reuse of vertex definitions but at the cost of more memory usage. Set to -1 to allow unlimited buffer size. Default value is .

Parameters:

batchSize - mesh buffer batch size; set to -1 to allow unlimited buffer sizes

See Also:

ObjWriter.meshBuffer(int)

write

public void write(BoundarySource3D src,
                  GeometryOutput out)

Specified by:

write in interface BoundaryWriteHandler<PlaneConvexSubset,BoundarySource3D>

Overrides:

write in class AbstractBoundaryWriteHandler3D

write

public void write(Stream<? extends PlaneConvexSubset> boundaries,
                  GeometryOutput out)

Write all boundaries in the stream to the given output using the data format supported by this instance. The stream passed as an argument is not closed, meaning that callers are responsible for closing the stream if necessary (for example, if the stream fetches data from the file system).

Parameters:

boundaries - stream containing boundaries to write

out - output to write to

writeFacets

public void writeFacets(Stream<? extends FacetDefinition> facets,
                        GeometryOutput out)

Write all facets in the stream to the output using the data format supported by this instance. The stream passed as an argument is not closed, meaning that callers are responsible for closing the stream if necessary (for example, if the stream fetches data from the file system).

Parameters:

facets - stream containing facets to write

out - output to write to