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

Interface ModelIOHandler

All Known Implementing Classes:

AbstractModelIOHandler, DefaultModelIOHandlerRegistry, ModelIOHandlerRegistry, OBJModelIOHandler

public interface ModelIOHandler

Interface for classes that handle reading and writing of 3D model files types. For convenience and better compatibility with streams and functional programming, all IO methods throw UncheckedIOException instead of IOException.

Implementations of this interface are expected to be thread-safe.

Method Summary

Modifier and Type	Method and Description
boolean	handlesType(String type) Return true if this instance handles 3D model files of the given type.
BoundarySource3D	read(String type, File in, DoublePrecisionContext precision) Read a 3D model represented as a BoundarySource3D from the given file.
BoundarySource3D	read(String type, InputStream in, DoublePrecisionContext precision) Read a 3D model represented as a BoundarySource3D from the given input stream.
void	write(BoundarySource3D model, String type, File out) Write the model to the file using the specified file type.
void	write(BoundarySource3D model, String type, OutputStream out) Write the model to the given output stream, using the specified model type.

Method Detail

handlesType

boolean handlesType(String type)

Return true if this instance handles 3D model files of the given type.

Parameters:

type - type 3D model type, indicated by file extension

Returns:

true if this instance can handle the 3D model file type

read

BoundarySource3D read(String type,
                      File in,
                      DoublePrecisionContext precision)

Read a 3D model represented as a BoundarySource3D from the given file.

Parameters:

type - the model file type

in - file to read

precision - precision context to use in model construction

Returns:

a 3D model represented as a boundary source

Throws:

UncheckedIOException - if an IO operation fails

IllegalArgumentException - if the file type is not supported

read

BoundarySource3D read(String type,
                      InputStream in,
                      DoublePrecisionContext precision)

Read a 3D model represented as a BoundarySource3D from the given input stream. The input stream is closed before method return.

Parameters:

type - the model input type

in - input stream

precision - precision context to use in model construction

Returns:

a 3D model represented as a boundary source

Throws:

UncheckedIOException - if an IO operation fails

IllegalArgumentException - if the file type is not supported

write

void write(BoundarySource3D model,
           String type,
           File out)

Write the model to the file using the specified file type.

Parameters:

model - model to write

type - the model file type

out - output file

Throws:

UncheckedIOException - if an IO operation fails

IllegalArgumentException - if the file type is not supported

write

void write(BoundarySource3D model,
           String type,
           OutputStream out)

Write the model to the given output stream, using the specified model type. The output stream is closed before method return.

Parameters:

model - model to write

type - the model file type

out - output stream

Throws:

UncheckedIOException - if an IO operation fails

IllegalArgumentException - if the file type is not supported