de.javagl.jgltf.model.io

Class GltfModelReader

java.lang.Object

de.javagl.jgltf.model.io.GltfModelReader

public final class GltfModelReader
extends java.lang.Object

A class for reading a GltfModel from a URI.

Constructor Summary

Constructors

Constructor and Description
GltfModelReader() Default constructor

Method Summary

Modifier and Type	Method and Description
GltfModel	read(java.nio.file.Path path) Read the GltfModel from the given path
GltfModel	read(java.net.URI uri) Read the GltfModel from the given URI
GltfModel	readWithoutReferences(java.io.InputStream inputStream) Read the GltfModel from the given input stream.
GltfModel	readWithoutReferences(java.net.URI uri) Read the GltfModel from the given URI.
void	setJsonErrorConsumer(java.util.function.Consumer<? super JsonError> jsonErrorConsumer) Set the given consumer to receive JsonErrors that may occur when a glTF is read

Methods inherited from class java.lang.Object

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

Constructor Detail

GltfModelReader

public GltfModelReader()

Default constructor

Method Detail

setJsonErrorConsumer

public void setJsonErrorConsumer(java.util.function.Consumer<? super JsonError> jsonErrorConsumer)

Set the given consumer to receive JsonErrors that may occur when a glTF is read

Parameters:

jsonErrorConsumer - The JsonError consumer

read

public GltfModel read(java.net.URI uri)
               throws java.io.IOException

Read the GltfModel from the given URI

Parameters:

uri - The URI

Returns:

The GltfModel

Throws:

java.io.IOException - If an IO error occurs

read

public GltfModel read(java.nio.file.Path path)
               throws java.io.IOException

Read the GltfModel from the given path

Parameters:

path - The path

Returns:

The GltfModel

Throws:

java.io.IOException - If an IO error occurs

readWithoutReferences

public GltfModel readWithoutReferences(java.net.URI uri)
                                throws java.io.IOException

Read the GltfModel from the given URI. In contrast to the read(URI) method, this method will not resolve any references that are contained in the GltfModel.

This is mainly intended for binary- or embedded glTF assets that do not have external references.

Parameters:

uri - The URI

Returns:

The GltfModel

Throws:

java.io.IOException - If an IO error occurs

readWithoutReferences

public GltfModel readWithoutReferences(java.io.InputStream inputStream)
                                throws java.io.IOException

Read the GltfModel from the given input stream. In contrast to the read(URI) method, this method will not resolve any references that are contained in the GltfAsset.

This is mainly intended for binary- or embedded glTF assets that do not have external references.

Parameters:

inputStream - The input stream to read from

Returns:

The GltfModel

Throws:

java.io.IOException - If an IO error occurs