de.javagl.jgltf.model.io

Class GltfAssetReader

java.lang.Object

de.javagl.jgltf.model.io.GltfAssetReader

public final class GltfAssetReader
extends java.lang.Object

A class for reading a glTF asset in a version-agnostic form.

The read(URI) method allows reading the asset from a URI. The external references of the asset will be resolved against the parent of the given URI, and loaded automatically. The respective data may then be obtained with GltfAsset.getReferenceData(String).

The readWithoutReferences(URI) and readWithoutReferences(InputStream) methods allow reading an asset from a URI or an input stream, without resolving external references. This is mainly intended for binary- or embedded glTF assets that do not have external references, or for cases where the external references should be resolved manually.

In addition to returning the GltfAsset that was read, the major version of the read asset may be queried. Depending on the version, the asset may be obtained as a glTF 1.0 asset or a glTF 2.0 asset.

Such a GltfAsset may then be processed further, for example, by creating a GltfModel using GltfModels.create(GltfAsset).

Constructor Summary

Constructors

Constructor and Description
GltfAssetReader() Creates a new instance

Method Summary

Modifier and Type	Method and Description
GltfAsset	read(java.net.URI uri) Read the GltfAsset from the given URI
GltfAsset	readWithoutReferences(java.io.InputStream inputStream) Read the glTF asset from the given input stream.
GltfAsset	readWithoutReferences(java.net.URI uri) Read the GltfAsset 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

GltfAssetReader

public GltfAssetReader()

Creates a new instance

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 GltfAsset read(java.net.URI uri)
               throws java.io.IOException

Read the GltfAsset from the given URI

Parameters:

uri - The URI

Returns:

The GltfModel

Throws:

java.io.IOException - If an IO error occurs

readWithoutReferences

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

Read the GltfAsset from the given URI.

In contrast to the read(URI) method, this method will not resolve any external references.

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 GltfAsset readWithoutReferences(java.io.InputStream inputStream)
                                throws java.io.IOException

Read the glTF asset from the given input stream. The caller is responsible for closing the given stream. After this method has been called, the version of the glTF may be obtained with getMajorVersion(), and the actual asset may be obtained with getAsGltfAssetV1() or getAsGltfAssetV2().

In contrast to the read(URI) method, this method will not resolve any external references.

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

Parameters:

inputStream - The input stream

Returns:

The GltfAsset

Throws:

java.io.IOException - If an IO error occurred