de.javagl.jgltf.model

Class AccessorByteData

java.lang.Object

de.javagl.jgltf.model.AccessorByteData

All Implemented Interfaces:

AccessorData

public final class AccessorByteData
extends java.lang.Object
implements AccessorData

A class for accessing the data that is described by an accessor. It allows accessing the byte buffer of the buffer view of the accessor, depending on the accessor parameters.

This data consists of several elements (for example, 3D byte vectors), which consist of several components (for example, the 3 byte values).

Constructor Summary

Constructors

Constructor and Description
AccessorByteData(int componentType, java.nio.ByteBuffer bufferViewByteBuffer, int byteOffset, int numElements, ElementType elementType, java.lang.Integer byteStride) Creates a new instance for accessing the data in the given byte buffer, according to the rules described by the given accessor parameters.

Method Summary

Modifier and Type	Method and Description
byte[]	computeMax() Returns an array containing the maximum component values of all elements of this accessor data.
int[]	computeMaxInt() Returns an array containing the maximum component values of all elements of this accessor data.
byte[]	computeMin() Returns an array containing the minimum component values of all elements of this accessor data.
int[]	computeMinInt() Returns an array containing the minimum component values of all elements of this accessor data.
java.nio.ByteBuffer	createByteBuffer() Creates a new, direct byte buffer (with native byte order) that contains the data for the accessor, in a compact form, without any offset, and without any additional stride (that is, all elements will be tightly packed).
java.lang.String	createString(java.util.Locale locale, java.lang.String format, int elementsPerRow) Creates a (potentially large!)
byte	get(int globalComponentIndex) Returns the value of the specified component
byte	get(int elementIndex, int componentIndex) Returns the value of the specified component of the specified element
protected java.nio.ByteBuffer	getBufferViewByteBuffer() Returns the underlying byte buffer
protected int	getByteIndex(int elementIndex, int componentIndex) Returns the index of the byte in the byte buffer where the specified component starts
protected int	getByteStridePerElement() Returns the byte stride per element
java.lang.Class<?>	getComponentType() Returns the type of the components that this class provides access to.
int	getInt(int globalComponentIndex) Returns the value of the specified component, taking into account whether the data isUnsigned(): If the data is unsigned, the returned byte value will be converted into an unsigned integer value.
int	getInt(int elementIndex, int componentIndex) Returns the value of the specified component of the specified element, taking into account whether the data isUnsigned(): If the data is unsigned, the returned byte value will be converted into an unsigned integer value.
protected int	getNumBytesPerComponent() Returns the number of bytes per component
int	getNumComponentsPerElement() Returns the number of components per element (for example, 3 if the elements are 3D vectors)
int	getNumElements() Returns the number of elements in this data (for example, the number of 3D vectors)
int	getTotalNumComponents() Returns the total number of components (that is, the number of elements multiplied with the number of components per element)
boolean	isUnsigned() Returns whether the data should be interpreted as unsigned
void	set(int globalComponentIndex, byte value) Set the value of the specified component
void	set(int elementIndex, int componentIndex, byte value) Set the value of the specified component of the specified element

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.javagl.jgltf.model.AccessorData

getComponentType, getNumComponentsPerElement, getNumElements, getTotalNumComponents

Constructor Detail

AccessorByteData

public AccessorByteData(int componentType,
                        java.nio.ByteBuffer bufferViewByteBuffer,
                        int byteOffset,
                        int numElements,
                        ElementType elementType,
                        java.lang.Integer byteStride)

Creates a new instance for accessing the data in the given byte buffer, according to the rules described by the given accessor parameters.

Parameters:

componentType - The component type

bufferViewByteBuffer - The byte buffer of the buffer view

byteOffset - The byte offset in the buffer view

numElements - The number of elements

elementType - The ElementType

byteStride - The byte stride between two elements. If this is null or 0, then the stride will be the size of one element.

Throws:

java.lang.NullPointerException - If the bufferViewByteBuffer is null

java.lang.IllegalArgumentException - If the component type is not GL_BYTE or GL_UNSIGEND_BYTE

java.lang.IllegalArgumentException - If the given byte buffer does not have a sufficient capacity to provide the data for the accessor

Method Detail

isUnsigned

public boolean isUnsigned()

Returns whether the data should be interpreted as unsigned

Returns:

Whether the data should be interpreted as unsigned

get

public byte get(int elementIndex,
                int componentIndex)

Returns the value of the specified component of the specified element

Parameters:

elementIndex - The element index

componentIndex - The component index

Returns:

The value

Throws:

java.lang.IndexOutOfBoundsException - If the given indices cause the underlying buffer to be accessed out of bounds

get

public byte get(int globalComponentIndex)

Returns the value of the specified component

Parameters:

globalComponentIndex - The global component index

Returns:

The value

Throws:

java.lang.IndexOutOfBoundsException - If the given index causes the underlying buffer to be accessed out of bounds

set

public void set(int elementIndex,
                int componentIndex,
                byte value)

Set the value of the specified component of the specified element

Parameters:

elementIndex - The element index

componentIndex - The component index

value - The value

Throws:

java.lang.IndexOutOfBoundsException - If the given indices cause the underlying buffer to be accessed out of bounds

set

public void set(int globalComponentIndex,
                byte value)

Set the value of the specified component

Parameters:

globalComponentIndex - The global component index

value - The value

Throws:

java.lang.IndexOutOfBoundsException - If the given index causes the underlying buffer to be accessed out of bounds

getInt

public int getInt(int elementIndex,
                  int componentIndex)

Returns the value of the specified component of the specified element, taking into account whether the data isUnsigned(): If the data is unsigned, the returned byte value will be converted into an unsigned integer value.

Parameters:

elementIndex - The element index

componentIndex - The component index

Returns:

The value

Throws:

java.lang.IndexOutOfBoundsException - If the given indices cause the underlying buffer to be accessed out of bounds

getInt

public int getInt(int globalComponentIndex)

Returns the value of the specified component, taking into account whether the data isUnsigned(): If the data is unsigned, the returned byte value will be converted into an unsigned integer value.

Parameters:

globalComponentIndex - The global component index

Returns:

The value

Throws:

java.lang.IndexOutOfBoundsException - If the given index causes the underlying buffer to be accessed out of bounds

computeMin

public byte[] computeMin()

Returns an array containing the minimum component values of all elements of this accessor data. This will be an array whose length is the number of components per element.

Returns:

The minimum values

computeMax

public byte[] computeMax()

Returns an array containing the maximum component values of all elements of this accessor data. This will be an array whose length is the number of components per element.

Returns:

The minimum values

computeMinInt

public int[] computeMinInt()

Returns an array containing the minimum component values of all elements of this accessor data. This will be an array whose length is the number of components per element. These values are computed based on getInt(int, int).

Returns:

The minimum values

computeMaxInt

public int[] computeMaxInt()

Returns an array containing the maximum component values of all elements of this accessor data. This will be an array whose length is the number of components per element. These values are computed based on getInt(int, int).

Returns:

The minimum values

createByteBuffer

public java.nio.ByteBuffer createByteBuffer()

Description copied from interface: AccessorData

Creates a new, direct byte buffer (with native byte order) that contains the data for the accessor, in a compact form, without any offset, and without any additional stride (that is, all elements will be tightly packed).

Specified by:

createByteBuffer in interface AccessorData

Returns:

The byte buffer

createString

public java.lang.String createString(java.util.Locale locale,
                                     java.lang.String format,
                                     int elementsPerRow)

Creates a (potentially large!) string representation of the data

Parameters:

locale - The locale used for number formatting

format - The number format string

elementsPerRow - The number of elements per row. If this is not greater than 0, then all elements will be in a single row.

Returns:

The data string

getComponentType

public final java.lang.Class<?> getComponentType()

Description copied from interface: AccessorData

Returns the type of the components that this class provides access to. This will usually be a primitive type, like float.class or short.class.

Specified by:

getComponentType in interface AccessorData

Returns:

The component type

getNumElements

public final int getNumElements()

Description copied from interface: AccessorData

Returns the number of elements in this data (for example, the number of 3D vectors)

Specified by:

getNumElements in interface AccessorData

Returns:

The number of elements

getNumComponentsPerElement

public final int getNumComponentsPerElement()

Description copied from interface: AccessorData

Returns the number of components per element (for example, 3 if the elements are 3D vectors)

Specified by:

getNumComponentsPerElement in interface AccessorData

Returns:

The number of components per element

getTotalNumComponents

public final int getTotalNumComponents()

Description copied from interface: AccessorData

Returns the total number of components (that is, the number of elements multiplied with the number of components per element)

Specified by:

getTotalNumComponents in interface AccessorData

Returns:

The total number of components

getByteIndex

protected final int getByteIndex(int elementIndex,
                                 int componentIndex)

Returns the index of the byte in the byte buffer where the specified component starts

Parameters:

elementIndex - The element index

componentIndex - The component index

Returns:

The byte index

getBufferViewByteBuffer

protected final java.nio.ByteBuffer getBufferViewByteBuffer()

Returns the underlying byte buffer

Returns:

The byte buffer

getByteStridePerElement

protected final int getByteStridePerElement()

Returns the byte stride per element

Returns:

The byte stride

getNumBytesPerComponent

protected final int getNumBytesPerComponent()

Returns the number of bytes per component

Returns:

The number of bytes per component