de.javagl.jgltf.model.structure

Class BufferStructureBuilder

java.lang.Object

de.javagl.jgltf.model.structure.BufferStructureBuilder

public final class BufferStructureBuilder
extends java.lang.Object

A class for creating BufferStructure instances.

The class offers methods to build the structure of accessors, buffer views and buffers that are part of a glTF asset. It allows to create these elements hierarchically: A sequence of accessors may be added, which are then combined into a buffer view. The sequence of buffer views that are created can then be combined into a buffer.

Note: Although the methods for creating the models always return the respective model, e.g. an AccessorModel instance, these instances will not be fully initialized until the build() method is called.

Constructor Summary

Constructors

Constructor and Description
BufferStructureBuilder() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addAccessorModel(java.lang.String idPrefix, DefaultAccessorModel accessorModel) Add the given AccessorModel in the BufferStructure that is currently being built.
void	addBufferModel(java.lang.String idPrefix, DefaultBufferModel bufferModel) Add the given BufferModel in the BufferStructure that is currently being built.
void	addBufferViewModel(java.lang.String idPrefix, DefaultBufferViewModel bufferViewModel) Add the given BufferViewModel in the BufferStructure that is currently being built.
BufferStructure	build() Return the BufferStructure instance that was created with this builder.
AccessorModel	createAccessorModel(java.lang.String idPrefix, byte[] data, java.lang.String type) Create an AccessorModel in the BufferStructure that is currently being built, using the component type GL_UNSIGNED_BYTE
AccessorModel	createAccessorModel(java.lang.String idPrefix, float[] data, java.lang.String type) Create an AccessorModel in the BufferStructure that is currently being built.
AccessorModel	createAccessorModel(java.lang.String idPrefix, int[] data, java.lang.String type) Create an AccessorModel in the BufferStructure that is currently being built, using the component type GL_UNSIGNED_INT
AccessorModel	createAccessorModel(java.lang.String idPrefix, int componentType, java.lang.String type, java.nio.ByteBuffer byteBuffer) Create an AccessorModel in the BufferStructure that is currently being built.
AccessorModel	createAccessorModel(java.lang.String idPrefix, short[] data, java.lang.String type) Create an AccessorModel in the BufferStructure that is currently being built, using the component type GL_UNSIGNED_SHORT
BufferViewModel	createArrayBufferViewModel(java.lang.String idPrefix) Create a BufferViewModel in the BufferStructure that is currently being built.
BufferViewModel	createArrayElementBufferViewModel(java.lang.String idPrefix) Create a BufferViewModel in the BufferStructure that is currently being built.
BufferModel	createBufferModel(java.lang.String idPrefix, java.lang.String uri) Create a BufferModel in the BufferStructure that is currently being built.
BufferViewModel	createBufferViewModel(java.lang.String idPrefix, java.lang.Integer target) Create a BufferViewModel in the BufferStructure that is currently being built.
BufferViewModel	createImageBufferViewModel(java.lang.String idPrefix, java.nio.ByteBuffer imageData) Create a BufferViewModel in the BufferStructure that is currently being built.
int	getNumAccessorModels() Returns the number of AccessorModel instances that have been created until now
int	getNumBufferModels() Returns the number of BufferModel instances that have been created until now
int	getNumBufferViewModels() Returns the number of BufferViewModel instances that have been created until now
int	getNumCurrentAccessorModels() Returns the number of AccessorModel instances that have been added, but for which no BufferViewModel has been created yet.
int	getNumCurrentBufferViewModels() Returns the number of BufferViewModel instances that have been added, but for which no BufferModel has been created yet.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferStructureBuilder

public BufferStructureBuilder()

Default constructor

Method Detail

getNumAccessorModels

public int getNumAccessorModels()

Returns the number of AccessorModel instances that have been created until now

Returns:

The number of AccessorModel instances

getNumBufferViewModels

public int getNumBufferViewModels()

Returns the number of BufferViewModel instances that have been created until now

Returns:

The number of BufferViewModel instances

getNumBufferModels

public int getNumBufferModels()

Returns the number of BufferModel instances that have been created until now

Returns:

The number of BufferModel instances

getNumCurrentAccessorModels

public int getNumCurrentAccessorModels()

Returns the number of AccessorModel instances that have been added, but for which no BufferViewModel has been created yet.

Returns:

The number of pending AccessorModel instances

getNumCurrentBufferViewModels

public int getNumCurrentBufferViewModels()

Returns the number of BufferViewModel instances that have been added, but for which no BufferModel has been created yet.

Returns:

The number of pending BufferViewModel instances

createAccessorModel

public AccessorModel createAccessorModel(java.lang.String idPrefix,
                                         float[] data,
                                         java.lang.String type)

Create an AccessorModel in the BufferStructure that is currently being built.

Parameters:

idPrefix - The ID prefix of the AccessorModel

data - The actual data

type - The type of the data, as a string corresponding to the ElementType of the accessor

Returns:

The AccessorModel

createAccessorModel

public AccessorModel createAccessorModel(java.lang.String idPrefix,
                                         int[] data,
                                         java.lang.String type)

Create an AccessorModel in the BufferStructure that is currently being built, using the component type GL_UNSIGNED_INT

Parameters:

idPrefix - The ID prefix of the AccessorModel

data - The actual data

type - The type of the data, as a string corresponding to the ElementType of the accessor

Returns:

The AccessorModel

createAccessorModel

public AccessorModel createAccessorModel(java.lang.String idPrefix,
                                         short[] data,
                                         java.lang.String type)

Create an AccessorModel in the BufferStructure that is currently being built, using the component type GL_UNSIGNED_SHORT

Parameters:

idPrefix - The ID prefix for the AccessorModel

data - The actual data

type - The type of the data, as a string corresponding to the ElementType of the accessor

Returns:

The AccessorModel

createAccessorModel

public AccessorModel createAccessorModel(java.lang.String idPrefix,
                                         byte[] data,
                                         java.lang.String type)

Create an AccessorModel in the BufferStructure that is currently being built, using the component type GL_UNSIGNED_BYTE

Parameters:

idPrefix - The ID prefix for the AccessorModel

data - The actual data

type - The type of the data, as a string corresponding to the ElementType of the accessor

Returns:

The AccessorModel

createAccessorModel

public AccessorModel createAccessorModel(java.lang.String idPrefix,
                                         int componentType,
                                         java.lang.String type,
                                         java.nio.ByteBuffer byteBuffer)

Create an AccessorModel in the BufferStructure that is currently being built.

Parameters:

idPrefix - The ID prefix of the AccessorModel

componentType - The component type, as a GL constant

type - The type of the data, as a string corresponding to the ElementType of the accessor

byteBuffer - The actual data

Returns:

The AccessorModel

addAccessorModel

public void addAccessorModel(java.lang.String idPrefix,
                             DefaultAccessorModel accessorModel)

Add the given AccessorModel in the BufferStructure that is currently being built.

Parameters:

idPrefix - The ID prefix of the AccessorModel

accessorModel - The AccessorModel

Throws:

GltfException - If the given accessor model already has an associated buffer view

createArrayBufferViewModel

public BufferViewModel createArrayBufferViewModel(java.lang.String idPrefix)

Create a BufferViewModel in the BufferStructure that is currently being built. The target will be the GL constant for GL_ARRAY_BUFFER.

Parameters:

idPrefix - The ID prefix for the BufferViewModel

Returns:

The BufferViewModel

createArrayElementBufferViewModel

public BufferViewModel createArrayElementBufferViewModel(java.lang.String idPrefix)

Create a BufferViewModel in the BufferStructure that is currently being built. The target will be the GL constant for GL_ELEMENT_ARRAY_BUFFER.

Parameters:

idPrefix - The ID prefix for the BufferViewModel

Returns:

The BufferViewModel

createBufferViewModel

public BufferViewModel createBufferViewModel(java.lang.String idPrefix,
                                             java.lang.Integer target)

Create a BufferViewModel in the BufferStructure that is currently being built.

Parameters:

idPrefix - The ID prefix for the BufferViewModel

target - The BufferViewModel.getTarget()

Returns:

The BufferViewModel

addBufferViewModel

public void addBufferViewModel(java.lang.String idPrefix,
                               DefaultBufferViewModel bufferViewModel)

Add the given BufferViewModel in the BufferStructure that is currently being built. All AccessorModel instances that have been created until now and not yet added to a BufferViewModel will be assigned to the given model.

Parameters:

idPrefix - The ID prefix for the BufferViewModel

bufferViewModel - The BufferViewModel to add

createImageBufferViewModel

public BufferViewModel createImageBufferViewModel(java.lang.String idPrefix,
                                                  java.nio.ByteBuffer imageData)

Create a BufferViewModel in the BufferStructure that is currently being built.

This is intended for buffer view models that do not have associated accessors (i.e. buffer view models that are used for images)

Parameters:

idPrefix - The ID prefix for the BufferViewModel

imageData - The iamge data

Returns:

The BufferViewModel

Throws:

java.lang.IllegalStateException - When there are pending accessor models

createBufferModel

public BufferModel createBufferModel(java.lang.String idPrefix,
                                     java.lang.String uri)

Create a BufferModel in the BufferStructure that is currently being built. If no buffer view models have been created (at all, or after this method has previously been called), then this call will not have any effect, and null will be returned.

Parameters:

idPrefix - The ID prefix for the BufferModel

uri - The BufferModel.getUri()

Returns:

The BufferModel

addBufferModel

public void addBufferModel(java.lang.String idPrefix,
                           DefaultBufferModel bufferModel)

Add the given BufferModel in the BufferStructure that is currently being built. All BufferViewModel instances that have been created until now and not yet added to a BufferModel will be assigned to the given model.

Parameters:

idPrefix - The ID prefix for the BufferModel

bufferModel - The BufferModel

build

public BufferStructure build()

Return the BufferStructure instance that was created with this builder.

Returns:

The BufferStructure

Throws:

java.lang.IllegalStateException - If there are buffer views that have not yet been combined into a buffer