de.javagl.jgltf.model.v1

Class BinaryGltfV1

java.lang.Object

de.javagl.jgltf.model.v1.BinaryGltfV1

public class BinaryGltfV1
extends java.lang.Object

Utility methods related to the binary glTF extension of glTF 1.0

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getBinaryGltfBufferId() Returns unique ID of the binary glTF Buffer ("binary_glTF")
static java.lang.String	getBinaryGltfBufferViewId(GlTFProperty gltfProperty) Returns the value of the "bufferView" property in the "KHR_binary_glTF" extension object of the given GlTFProperty, or null if either the extension object or the property does not exist.
static java.lang.String	getBinaryGltfExtensionName() Returns the name of the Khronos binary glTF extension ("KHR_binary_glTF")
static boolean	hasBinaryGltfExtension(GlTFProperty gltfProperty) Returns whether the given GlTFProperty has the "KHR_binary_glTF" extension.
static boolean	isBinaryGltfBufferId(java.lang.String id) Returns whether the given ID is the unique ID of the binary glTF Buffer ("binary_glTF")
static void	setBinaryGltfBufferViewId(GlTFProperty gltfProperty, java.lang.String bufferViewId) Set the value of the "bufferView" property in the "KHR_binary_glTF" extension object of the given GlTFProperty.
static void	setBinaryGltfImageProperties(Image image, java.nio.ByteBuffer imageData) Set the properties for the given Image that is stored as a "KHR_binary_glTF" image.

Methods inherited from class java.lang.Object

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

Method Detail

hasBinaryGltfExtension

public static boolean hasBinaryGltfExtension(GlTFProperty gltfProperty)

Returns whether the given GlTFProperty has the "KHR_binary_glTF" extension. This is applicable to Image and Shader objects that may contain an extension object with a BufferView ID instead of a URI. The BufferView ID may be obtained with getBinaryGltfBufferViewId(GlTFProperty).

Parameters:

gltfProperty - The GlTFProperty

Returns:

Whether the extension exists

getBinaryGltfBufferViewId

public static java.lang.String getBinaryGltfBufferViewId(GlTFProperty gltfProperty)

Returns the value of the "bufferView" property in the "KHR_binary_glTF" extension object of the given GlTFProperty, or null if either the extension object or the property does not exist.

Parameters:

gltfProperty - The GlTFProperty

Returns:

The property value

setBinaryGltfBufferViewId

public static void setBinaryGltfBufferViewId(GlTFProperty gltfProperty,
                                             java.lang.String bufferViewId)

Set the value of the "bufferView" property in the "KHR_binary_glTF" extension object of the given GlTFProperty. If no (or an invalid) extension object already existed, it will be created or overwritten, respectively.

Parameters:

gltfProperty - The GlTFProperty

bufferViewId - The BufferView ID

setBinaryGltfImageProperties

public static void setBinaryGltfImageProperties(Image image,
                                                java.nio.ByteBuffer imageData)

Set the properties for the given Image that is stored as a "KHR_binary_glTF" image. These properties are

• The image width
• The image height
• The image mimeType

(Note that the buffer view ID is set explicitly with setBinaryGltfBufferViewId(GlTFProperty, String))

Parameters:

image - The image

imageData - The raw image data

Throws:

GltfException - If the image data cannot be analyzed to derive the required information

getBinaryGltfExtensionName

public static java.lang.String getBinaryGltfExtensionName()

Returns the name of the Khronos binary glTF extension ("KHR_binary_glTF")

Returns:

The name of the Khronos binary glTF extension

getBinaryGltfBufferId

public static java.lang.String getBinaryGltfBufferId()

Returns unique ID of the binary glTF Buffer ("binary_glTF")

Returns:

The binary glTF Buffer ID

isBinaryGltfBufferId

public static boolean isBinaryGltfBufferId(java.lang.String id)

Returns whether the given ID is the unique ID of the binary glTF Buffer ("binary_glTF")

Parameters:

id - The ID

Returns:

Whether the given ID is the binary glTF Buffer ID