de.javagl.jgltf.model.io

Class GltfModelWriter

java.lang.Object

de.javagl.jgltf.model.io.GltfModelWriter

public class GltfModelWriter
extends java.lang.Object

A class for writing a GltfModel. The model can be written as a default glTF, consisting of a JSON file and the files that are referred to via URIs, or as a binary file, or an embedded file where all external references are replaced by data URIs.

Constructor Summary

Constructors

Constructor and Description
GltfModelWriter() Default constructor

Method Summary

Modifier and Type	Method and Description
void	write(GltfModel gltfModel, java.io.File file) Write the given GltfModel to the given file.
void	write(GltfModel gltfModel, java.lang.String fileName) Write the given GltfModel to a file with the given name.
void	writeBinary(GltfModel gltfModel, java.io.File file) Write the given GltfModel as a binary glTF asset to the given file
void	writeBinary(GltfModel gltfModel, java.io.OutputStream outputStream) Write the given GltfModel as a binary glTF asset to the given output stream.
void	writeEmbedded(GltfModel gltfModel, java.io.File file) Write the given GltfModel as an embedded glTF asset to the given file
void	writeEmbedded(GltfModel gltfModel, java.io.OutputStream outputStream) Write the given GltfModel as an embedded glTF asset to the given output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

GltfModelWriter

public GltfModelWriter()

Default constructor

Method Detail

write

public void write(GltfModel gltfModel,
                  java.lang.String fileName)
           throws java.io.IOException

Write the given GltfModel to a file with the given name. External references of buffers or images that are given via the respective URI string will be resolved against the parent directory of the file, and the corresponding data will be written into the corresponding files.

Parameters:

gltfModel - The GltfModel

fileName - The file name

Throws:

java.io.IOException - If an IO error occurs

write

public void write(GltfModel gltfModel,
                  java.io.File file)
           throws java.io.IOException

Write the given GltfModel to the given file. External references of buffers or images that are given via the respective URI string will be resolved against the parent directory of the given file, and the corresponding data will be written into the corresponding files.

Parameters:

gltfModel - The GltfModel

file - The file

Throws:

java.io.IOException - If an IO error occurs

writeBinary

public void writeBinary(GltfModel gltfModel,
                        java.io.File file)
                 throws java.io.IOException

Write the given GltfModel as a binary glTF asset to the given file

Parameters:

gltfModel - The GltfModel

file - The file

Throws:

java.io.IOException - If an IO error occurs

writeBinary

public void writeBinary(GltfModel gltfModel,
                        java.io.OutputStream outputStream)
                 throws java.io.IOException

Write the given GltfModel as a binary glTF asset to the given output stream. The caller is responsible for closing the given stream.

Parameters:

gltfModel - The GltfModel

outputStream - The output stream

Throws:

java.io.IOException - If an IO error occurs

writeEmbedded

public void writeEmbedded(GltfModel gltfModel,
                          java.io.File file)
                   throws java.io.IOException

Write the given GltfModel as an embedded glTF asset to the given file

Parameters:

gltfModel - The GltfModel

file - The file

Throws:

java.io.IOException - If an IO error occurs

writeEmbedded

public void writeEmbedded(GltfModel gltfModel,
                          java.io.OutputStream outputStream)
                   throws java.io.IOException

Write the given GltfModel as an embedded glTF asset to the given output stream. The caller is responsible for closing the given stream.

Parameters:

gltfModel - The GltfModel

outputStream - The output stream

Throws:

java.io.IOException - If an IO error occurs