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

Class ModelIO

java.lang.Object

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

public final class ModelIO
extends Object

Utility class containing constants and static convenience methods related to 3D model input and output.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJ String representing the OBJ file format.

Method Summary

Modifier and Type	Method and Description
static ModelIOHandlerRegistry	getModelIOHandlerRegistry() Get the ModelIOHandlerRegistry singleton instance.
static BoundarySource3D	read(File in, DoublePrecisionContext precision) Read a 3D model from the given file, using the file extension as the model type.
static BoundarySource3D	read(String type, File in, DoublePrecisionContext precision) Read a 3D model of the given type from the file.
static BoundarySource3D	read(String type, InputStream in, DoublePrecisionContext precision) Read a 3D model of the given type from the input stream.
static void	write(BoundarySource3D model, File out) Write the model to the file.
static void	write(BoundarySource3D model, String type, File out) Write the model to the file using the specified file type.
static void	write(BoundarySource3D model, String type, OutputStream out) Write the model to the output stream using the specific file type.

Methods inherited from class java.lang.Object

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

Field Detail

OBJ

public static final String OBJ

String representing the OBJ file format.

See Also:

Wavefront .obj file, Constant Field Values

Method Detail

getModelIOHandlerRegistry

public static ModelIOHandlerRegistry getModelIOHandlerRegistry()

Get the ModelIOHandlerRegistry singleton instance.

Returns:

the ModelIOHandlerRegistry singleton instance

read

public static BoundarySource3D read(File in,
                                    DoublePrecisionContext precision)

Read a 3D model from the given file, using the file extension as the model type. The call is delegated to the ModelIOHandlerRegistry singleton.

Parameters:

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 does not have a file extension or the file extension does not indicate a supported model type

See Also:

getModelIOHandlerRegistry(), ModelIOHandlerRegistry.read(File, DoublePrecisionContext)

read

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

Read a 3D model of the given type from the file. The call is delegated to the ModelIOHandlerRegistry singleton.

Parameters:

type - model input type

in - input file

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 model input type is not supported

See Also:

getModelIOHandlerRegistry(), ModelIOHandler.read(String, File, DoublePrecisionContext)

read

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

Read a 3D model of the given type from the input stream. The call is delegated to the ModelIOHandlerRegistry singleton.

Parameters:

type - model input type

in - input stream to read from

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 model input type is not supported

See Also:

getModelIOHandlerRegistry(), ModelIOHandler.read(String, InputStream, DoublePrecisionContext)

write

public static void write(BoundarySource3D model,
                         File out)

Write the model to the file. The file type is determined by the file extension of the target file. The call is delegated to the ModelIOHandlerRegistry singleton.

Parameters:

model - model to write

out - output file

Throws:

UncheckedIOException - if an IO operation fails

IllegalArgumentException - if the file does not have a file extension or the file extension does not indicate a supported model type

See Also:

getModelIOHandlerRegistry(), ModelIOHandlerRegistry.write(BoundarySource3D, File)

write

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

Write the model to the file using the specified file type. The call is delegated to the ModelIOHandlerRegistry singleton.

Parameters:

model - model to write

type - model file type

out - output file

Throws:

UncheckedIOException - if an IO operation fails

IllegalArgumentException - if the file type is not supported

See Also:

getModelIOHandlerRegistry(), ModelIOHandler.write(BoundarySource3D, String, File)

write

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

Write the model to the output stream using the specific file type. The call is delegated to the ModelIOHandlerRegistry singleton.

Parameters:

model - model to write

type - model file type

out - output stream

Throws:

UncheckedIOException - if an IO operation fails

IllegalArgumentException - if the file type is not supported

See Also:

getModelIOHandlerRegistry(), ModelIOHandler.write(BoundarySource3D, String, OutputStream)