de.javagl.jgltf.model.creation

Class BufferStructure

java.lang.Object

de.javagl.jgltf.model.creation.BufferStructure

public final class BufferStructure
extends java.lang.Object

A class representing the structure of a set of AccessorModel instances that refer to BufferViewModel instances, which in turn refer to BufferModel instances.

Such a buffer structure may be created with a BufferStructureBuilder.

This class is only intended for internal use!

Constructor Summary

Constructors

Constructor and Description
BufferStructure() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addAccessorModel(DefaultAccessorModel accessorModel, java.lang.String idPrefix) Add the specified AccessorModel to this structure
void	addBufferModel(DefaultBufferModel bufferModel, java.lang.String idPrefix, java.util.Collection<? extends DefaultBufferViewModel> bufferViewModels) Add the given BufferModel to this structure
void	addBufferViewModel(DefaultBufferViewModel bufferViewModel, java.lang.String idPrefix, java.util.Collection<? extends DefaultAccessorModel> accessorModels) Add the given BufferViewModel to this structure
java.lang.String	getAccessorId(AccessorModel accessorModel) Returns the ID that was given to the given AccessorModel when it was added
java.lang.Integer	getAccessorIndex(AccessorModel accessorModel) Returns the index that was assigned to the given AccessorModel when it was added
java.util.List<DefaultAccessorModel>	getAccessorModels() Returns an unmodifiable list containing all AccessorModel instances that have been added to this structure
java.util.List<DefaultAccessorModel>	getAccessorModels(BufferViewModel bufferViewModel) Returns an unmodifiable list containing the AccessorModel instances that refer to the given BufferViewModel
java.lang.String	getBufferId(BufferModel bufferModel) Returns the ID that was given to the given BufferModel when it was added
java.lang.Integer	getBufferIndex(BufferModel bufferModel) Returns the index that was assigned to the given BufferModel when it was added
java.util.List<DefaultBufferModel>	getBufferModels() Returns an unmodifiable view on the list of all BufferModel instances that have been added to this structure
java.lang.String	getBufferViewId(BufferViewModel bufferViewModel) Returns the ID that was given to the given BufferViewModel when it was added
java.lang.Integer	getBufferViewIndex(BufferViewModel bufferViewModel) Returns the index that was assigned to the given BufferViewModel when it was added
java.util.List<DefaultBufferViewModel>	getBufferViewModels() Returns an unmodifiable view on the BufferViewModel instances that have been added to this structure
java.util.List<DefaultBufferViewModel>	getBufferViewModels(BufferModel bufferModel) Returns an unmodifiable list containing the BufferViewModel instances that refer to the given BufferModel
boolean	isPaddingByteIndex(BufferModel bufferModel, int index) Returns whether the given byte index was a padding byte index for the given BufferModel

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferStructure

public BufferStructure()

Default constructor

Method Detail

addAccessorModel

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

Add the specified AccessorModel to this structure

Parameters:

accessorModel - The AccessorModel

idPrefix - The ID prefix

addBufferViewModel

public void addBufferViewModel(DefaultBufferViewModel bufferViewModel,
                               java.lang.String idPrefix,
                               java.util.Collection<? extends DefaultAccessorModel> accessorModels)

Add the given BufferViewModel to this structure

Parameters:

bufferViewModel - The BufferViewModel to add

idPrefix - The ID prefix

accessorModels - The AccessorModel instances that refer to the given BufferViewModel. A copy of the given collection will be stored internally.

addBufferModel

public void addBufferModel(DefaultBufferModel bufferModel,
                           java.lang.String idPrefix,
                           java.util.Collection<? extends DefaultBufferViewModel> bufferViewModels)

Add the given BufferModel to this structure

Parameters:

bufferModel - The BufferModel to add

idPrefix - The ID prefix

bufferViewModels - The BufferViewModel instances that refer to the given BufferModel. A copy of the given collection will be stored internally.

getBufferModels

public java.util.List<DefaultBufferModel> getBufferModels()

Returns an unmodifiable view on the list of all BufferModel instances that have been added to this structure

Returns:

The BufferModel instances

getBufferId

public java.lang.String getBufferId(BufferModel bufferModel)

Returns the ID that was given to the given BufferModel when it was added

Parameters:

bufferModel - The BufferModel

Returns:

The ID

getBufferIndex

public java.lang.Integer getBufferIndex(BufferModel bufferModel)

Returns the index that was assigned to the given BufferModel when it was added

Parameters:

bufferModel - The BufferModel

Returns:

The index

getBufferViewModels

public java.util.List<DefaultBufferViewModel> getBufferViewModels(BufferModel bufferModel)

Returns an unmodifiable list containing the BufferViewModel instances that refer to the given BufferModel

Parameters:

bufferModel - The BufferModel

Returns:

The list

getBufferViewModels

public java.util.List<DefaultBufferViewModel> getBufferViewModels()

Returns an unmodifiable view on the BufferViewModel instances that have been added to this structure

Returns:

The BufferViewModel instances

getBufferViewId

public java.lang.String getBufferViewId(BufferViewModel bufferViewModel)

Returns the ID that was given to the given BufferViewModel when it was added

Parameters:

bufferViewModel - The BufferViewModel

Returns:

The ID

getBufferViewIndex

public java.lang.Integer getBufferViewIndex(BufferViewModel bufferViewModel)

Returns the index that was assigned to the given BufferViewModel when it was added

Parameters:

bufferViewModel - The BufferViewModel

Returns:

The index

getAccessorModels

public java.util.List<DefaultAccessorModel> getAccessorModels(BufferViewModel bufferViewModel)

Returns an unmodifiable list containing the AccessorModel instances that refer to the given BufferViewModel

Parameters:

bufferViewModel - The BufferViewModel

Returns:

The list

getAccessorModels

public java.util.List<DefaultAccessorModel> getAccessorModels()

Returns an unmodifiable list containing all AccessorModel instances that have been added to this structure

Returns:

The AccessorModel instances

getAccessorId

public java.lang.String getAccessorId(AccessorModel accessorModel)

Returns the ID that was given to the given AccessorModel when it was added

Parameters:

accessorModel - The AccessorModel

Returns:

The ID

getAccessorIndex

public java.lang.Integer getAccessorIndex(AccessorModel accessorModel)

Returns the index that was assigned to the given AccessorModel when it was added

Parameters:

accessorModel - The AccessorModel

Returns:

The index

isPaddingByteIndex

public boolean isPaddingByteIndex(BufferModel bufferModel,
                                  int index)

Returns whether the given byte index was a padding byte index for the given BufferModel

Parameters:

bufferModel - The BufferModel

index - The index

Returns:

Whether the index is a padding byte index