de.javagl.obj

Class ObjData

java.lang.Object

de.javagl.obj.ObjData

public class ObjData
extends Object

Methods to obtain the data from ReadableObjs as plain arrays or buffers

Method Summary

Modifier and Type	Method and Description
static ShortBuffer	convertToShortBuffer(IntBuffer intBuffer) Convert the given IntBuffer to a (direct) ShortBuffer, by casting all elements to short.
static IntBuffer	getFaceNormalIndices(ReadableObj obj) Returns the normal indices from the faces of the given ReadableObj as a direct IntBuffer.
static IntBuffer	getFaceNormalIndices(ReadableObj obj, int numVerticesPerFace) Returns the normal indices from the faces of the given ReadableObj as a direct IntBuffer.
static void	getFaceNormalIndices(ReadableObj obj, IntBuffer target) Stores the normal indices of the faces of the given ReadableObj in the given buffer.
static int[]	getFaceNormalIndicesArray(ReadableObj obj) Returns the normal indices from the faces of the given ReadableObj as an array.
static int[]	getFaceNormalIndicesArray(ReadableObj obj, int numVerticesPerFace) Returns the normal indices from the faces of the given ReadableObj as an array.
static IntBuffer	getFaceTexCoordIndices(ReadableObj obj) Returns the texCoord indices from the faces of the given ReadableObj as a direct IntBuffer.
static IntBuffer	getFaceTexCoordIndices(ReadableObj obj, int numVerticesPerFace) Returns the texCoord indices from the faces of the given ReadableObj as a direct IntBuffer.
static void	getFaceTexCoordIndices(ReadableObj obj, IntBuffer target) Stores the texCoord indices of the faces of the given ReadableObj in the given buffer.
static int[]	getFaceTexCoordIndicesArray(ReadableObj obj) Returns the texCoord indices from the faces of the given ReadableObj as an array.
static int[]	getFaceTexCoordIndicesArray(ReadableObj obj, int numVerticesPerFace) Returns the texCoord indices from the faces of the given ReadableObj as an array.
static IntBuffer	getFaceVertexIndices(ReadableObj obj) Returns the vertex indices from the faces of the given ReadableObj as direct IntBuffer.
static IntBuffer	getFaceVertexIndices(ReadableObj obj, int numVerticesPerFace) Returns the vertex indices from the faces of the given ReadableObj as direct IntBuffer.
static void	getFaceVertexIndices(ReadableObj obj, IntBuffer target) Stores the vertex indices of the faces of the given ReadableObj in the given buffer.
static int[]	getFaceVertexIndicesArray(ReadableObj obj) Returns the vertex indices from the faces of the given ReadableObj as an array.
static int[]	getFaceVertexIndicesArray(ReadableObj obj, int numVerticesPerFace) Returns the vertex indices from the faces of the given ReadableObj as an array.
static FloatBuffer	getNormals(ReadableObj obj) Returns all normals of the given ReadableObj as an array.
static void	getNormals(ReadableObj obj, FloatBuffer target) Stores the normals of the given ReadableObj in the given buffer.
static float[]	getNormalsArray(ReadableObj obj) Returns all normals of the given ReadableObj as an array.
static void	getTexCoords(ReadableObj obj, FloatBuffer target, int dimensions) Stores the texture coordinates of the given ReadableObj in the given buffer.
static void	getTexCoords(ReadableObj obj, FloatBuffer target, int dimensions, boolean flipY) Stores the texture coordinates of the given ReadableObj in the given buffer.
static FloatBuffer	getTexCoords(ReadableObj obj, int dimensions) Returns all texture coordinates of the given ReadableObj as direct FloatBuffer.
static FloatBuffer	getTexCoords(ReadableObj obj, int dimensions, boolean flipY) Returns all texture coordinates of the given ReadableObj as direct FloatBuffer.
static float[]	getTexCoordsArray(ReadableObj obj, int dimensions) Returns all texture coordinates of the given ReadableObj as an array.
static float[]	getTexCoordsArray(ReadableObj obj, int dimensions, boolean flipY) Returns all texture coordinates of the given ReadableObj as an array.
static int	getTotalNumFaceVertices(ReadableObj obj) Returns the sum of all numbers of vertices of all faces in the given ReadableObj.
static FloatBuffer	getVertices(ReadableObj obj) Returns all vertices of the given ReadableObj as a direct FloatBuffer.
static void	getVertices(ReadableObj obj, FloatBuffer target) Stores the vertices of the given ReadableObj in the given buffer.
static float[]	getVerticesArray(ReadableObj obj) Returns all vertices of the given ReadableObj as an array.

Methods inherited from class java.lang.Object

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

Method Detail

getTotalNumFaceVertices

public static int getTotalNumFaceVertices(ReadableObj obj)

Returns the sum of all numbers of vertices of all faces in the given ReadableObj. If the given ReadableObj only contains triangles, this will be the same as obj.getNumFaces() * 3.

Parameters:

obj - The ReadableObj

Returns:

The number of face vertex indices

getFaceVertexIndicesArray

public static int[] getFaceVertexIndicesArray(ReadableObj obj)

Returns the vertex indices from the faces of the given ReadableObj as an array.

This method will compute the number of face vertex indices and return an array with this size. If the number of vertices per face is known and equal for all faces, getFaceVertexIndices(ReadableObj,int) may be used instead.

Parameters:

obj - The obj

Returns:

The face vertex indices

getFaceVertexIndices

public static IntBuffer getFaceVertexIndices(ReadableObj obj)

Returns the vertex indices from the faces of the given ReadableObj as direct IntBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

This method will compute the number of face vertex indices and return a buffer with this size. If the number of vertices per face is known and equal for all faces, getFaceVertexIndices(ReadableObj,int) may be used instead.

Parameters:

obj - The obj

Returns:

The face vertex indices

getFaceVertexIndicesArray

public static int[] getFaceVertexIndicesArray(ReadableObj obj,
                                              int numVerticesPerFace)

Returns the vertex indices from the faces of the given ReadableObj as an array.

This method assumes that all faces have the given number of vertices

Parameters:

obj - The ReadableObj

numVerticesPerFace - The number of vertices per face

Returns:

The face vertex indices

getFaceVertexIndices

public static IntBuffer getFaceVertexIndices(ReadableObj obj,
                                             int numVerticesPerFace)

Returns the vertex indices from the faces of the given ReadableObj as direct IntBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

This method assumes that all faces have the given number of vertices

Parameters:

obj - The ReadableObj

numVerticesPerFace - The number of vertices per face

Returns:

The face vertex indices

getFaceVertexIndices

public static void getFaceVertexIndices(ReadableObj obj,
                                        IntBuffer target)

Stores the vertex indices of the faces of the given ReadableObj in the given buffer. The position of the given buffer will be advanced accordingly.

This method assumes that the given buffer is sufficiently large to store all indices. The required size may be computed with getTotalNumFaceVertices(ReadableObj), or, if the number of vertices per face is known and equal for all faces, with n = obj.getNumFaces() * numVerticesPerFace

Parameters:

obj - The ReadableObj

target - The buffer that will store the result

Throws:

BufferOverflowException - If the buffer can not store the result

getFaceTexCoordIndicesArray

public static int[] getFaceTexCoordIndicesArray(ReadableObj obj)

Returns the texCoord indices from the faces of the given ReadableObj as an array.

This method will compute the number of face vertices and return an array with this size. If the number of vertices per face is known and equal for all faces, getFaceTexCoordIndices(ReadableObj,int) may be used instead.

Parameters:

obj - The obj

Returns:

The face texCoord indices

getFaceTexCoordIndices

public static IntBuffer getFaceTexCoordIndices(ReadableObj obj)

Returns the texCoord indices from the faces of the given ReadableObj as a direct IntBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

This method will compute the number of face vertices and return a buffer with this size. If the number of vertices per face is known and equal for all faces, getFaceTexCoordIndices(ReadableObj,int) may be used instead.

Parameters:

obj - The obj

Returns:

The face texCoord indices

getFaceTexCoordIndicesArray

public static int[] getFaceTexCoordIndicesArray(ReadableObj obj,
                                                int numVerticesPerFace)

Returns the texCoord indices from the faces of the given ReadableObj as an array.

This method assumes that all faces have the given number of vertices.

This method assumes that the faces contain texture coordinate indices.

Parameters:

obj - The ReadableObj

numVerticesPerFace - The number of vertices per face

Returns:

The face texCoord indices

getFaceTexCoordIndices

public static IntBuffer getFaceTexCoordIndices(ReadableObj obj,
                                               int numVerticesPerFace)

Returns the texCoord indices from the faces of the given ReadableObj as a direct IntBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

This method assumes that all faces have the given number of vertices.

This method assumes that the faces contain texture coordinate indices.

Parameters:

obj - The ReadableObj

numVerticesPerFace - The number of vertices per face

Returns:

The face texCoord indices

getFaceTexCoordIndices

public static void getFaceTexCoordIndices(ReadableObj obj,
                                          IntBuffer target)

Stores the texCoord indices of the faces of the given ReadableObj in the given buffer. The position of the given buffer will be advanced accordingly.

This method assumes that the given buffer is sufficiently large to store all indices. The required size may be computed with getTotalNumFaceVertices(ReadableObj), or, if the number of vertices per face is known and equal for all faces, with n = obj.getNumFaces() * numVerticesPerFace.

This method assumes that the faces contain texture coordinate indices.

Parameters:

obj - The ReadableObj

target - The buffer that will store the result

Throws:

BufferOverflowException - If the buffer can not store the result

getFaceNormalIndicesArray

public static int[] getFaceNormalIndicesArray(ReadableObj obj)

Returns the normal indices from the faces of the given ReadableObj as an array.

This method will compute the number of face vertices and return an array with this size. If the number of vertices per face is known and equal for all faces, getFaceNormalIndices(ReadableObj,int) may be used instead.

Parameters:

obj - The ReadableObj

Returns:

The face normal indices

getFaceNormalIndices

public static IntBuffer getFaceNormalIndices(ReadableObj obj)

Returns the normal indices from the faces of the given ReadableObj as a direct IntBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

This method will compute the number of face vertices and return a buffer with this size. If the number of vertices per face is known and equal for all faces, getFaceNormalIndices(ReadableObj,int) may be used instead.

Parameters:

obj - The ReadableObj

Returns:

The face normal indices

getFaceNormalIndicesArray

public static int[] getFaceNormalIndicesArray(ReadableObj obj,
                                              int numVerticesPerFace)

Returns the normal indices from the faces of the given ReadableObj as an array.

This method assumes that all faces have the given number of vertices.

This method assumes that the faces contain normal indices.

Parameters:

obj - The ReadableObj

numVerticesPerFace - The number of vertices per face

Returns:

The face normal indices

getFaceNormalIndices

public static IntBuffer getFaceNormalIndices(ReadableObj obj,
                                             int numVerticesPerFace)

Returns the normal indices from the faces of the given ReadableObj as a direct IntBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

This method assumes that all faces have the given number of vertices.

This method assumes that the faces contain normal indices.

Parameters:

obj - The ReadableObj

numVerticesPerFace - The number of vertices per face

Returns:

The face normal indices

getFaceNormalIndices

public static void getFaceNormalIndices(ReadableObj obj,
                                        IntBuffer target)

Stores the normal indices of the faces of the given ReadableObj in the given buffer. The position of the given buffer will be advanced accordingly.

This method assumes that the given buffer is sufficiently large to store all indices. The required size may be computed with getTotalNumFaceVertices(ReadableObj), or, if the number of vertices per face is known and equal for all faces, with n = obj.getNumFaces() * numVerticesPerFace.

This method assumes that the faces contain texture coordinate indices.

Parameters:

obj - The ReadableObj

target - The buffer that will store the result

Throws:

BufferOverflowException - If the buffer can not store the result

getVerticesArray

public static float[] getVerticesArray(ReadableObj obj)

Returns all vertices of the given ReadableObj as an array. Three consecutive entries in the resulting array are the x,y,z coordinates of one vertex

Parameters:

obj - The ReadableObj

Returns:

The resulting array

getVertices

public static FloatBuffer getVertices(ReadableObj obj)

Returns all vertices of the given ReadableObj as a direct FloatBuffer. Three consecutive entries in the resulting buffer are the x,y,z coordinates of one vertex. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

Parameters:

obj - The ReadableObj

Returns:

The resulting buffer

getVertices

public static void getVertices(ReadableObj obj,
                               FloatBuffer target)

Stores the vertices of the given ReadableObj in the given buffer. The position of the target will be increased by obj.getNumVertices() * 3. The position of the given buffer will be advanced accordingly.

Parameters:

obj - The obj

target - The target that will store the result

Throws:

BufferOverflowException - If the target can not store the result

getTexCoordsArray

public static float[] getTexCoordsArray(ReadableObj obj,
                                        int dimensions)

Returns all texture coordinates of the given ReadableObj as an array.

Parameters:

obj - The ReadableObj

dimensions - The dimensions that are assumed for the coordinates

Returns:

The resulting array

getTexCoordsArray

public static float[] getTexCoordsArray(ReadableObj obj,
                                        int dimensions,
                                        boolean flipY)

Returns all texture coordinates of the given ReadableObj as an array.

Parameters:

obj - The ReadableObj

dimensions - The dimensions that are assumed for the coordinates

flipY - Whether the texture coordinates should be flipped vertically. This means that the y-coordinates (at dimension index 1) will be replaced with 1.0f - y. Most image loaders provide image data with the first pixel being the upper left pixel of the image. But OpenGL glTexImage2D calls expect the first pixel to be the lower left. Flipping the texture coordinates by passing flipY=true to this method allows to compensate for this mismatch.

Returns:

The resulting array

getTexCoords

public static FloatBuffer getTexCoords(ReadableObj obj,
                                       int dimensions)

Returns all texture coordinates of the given ReadableObj as direct FloatBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

Parameters:

obj - The ReadableObj

dimensions - The dimensions that are assumed for the coordinates

Returns:

The resulting buffer

getTexCoords

public static FloatBuffer getTexCoords(ReadableObj obj,
                                       int dimensions,
                                       boolean flipY)

Returns all texture coordinates of the given ReadableObj as direct FloatBuffer. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

Parameters:

obj - The ReadableObj

dimensions - The dimensions that are assumed for the coordinates

flipY - Whether the texture coordinates should be flipped vertically. This means that the y-coordinates (at dimension index 1) will be replaced with 1.0f - y. Most image loaders provide image data with the first pixel being the upper left pixel of the image. But OpenGL glTexImage2D calls expect the first pixel to be the lower left. Flipping the texture coordinates by passing flipY=true to this method allows to compensate for this mismatch.

Returns:

The resulting buffer

getTexCoords

public static void getTexCoords(ReadableObj obj,
                                FloatBuffer target,
                                int dimensions)

Stores the texture coordinates of the given ReadableObj in the given buffer. The position of the target will be increased by obj.getNumTexCoords() * dimensions. The position of the given buffer will be advanced accordingly.

Parameters:

obj - The ReadableObj

target - The target that will store the result

dimensions - The dimensions that are assumed for the coordinates

Throws:

BufferOverflowException - If the target can not store the result

getTexCoords

public static void getTexCoords(ReadableObj obj,
                                FloatBuffer target,
                                int dimensions,
                                boolean flipY)

Stores the texture coordinates of the given ReadableObj in the given buffer. The position of the target will be increased by obj.getNumTexCoords() * dimensions. The position of the given buffer will be advanced accordingly.

Parameters:

obj - The ReadableObj

target - The target that will store the result

dimensions - The dimensions that are assumed for the coordinates

flipY - Whether the texture coordinates should be flipped vertically. This means that the y-coordinates (at dimension index 1) will be replaced with 1.0f - y. Most image loaders provide image data with the first pixel being the upper left pixel of the image. But OpenGL glTexImage2D calls expect the first pixel to be the lower left. Flipping the texture coordinates by passing flipY=true to this method allows to compensate for this mismatch.

Throws:

BufferOverflowException - If the target can not store the result

getNormalsArray

public static float[] getNormalsArray(ReadableObj obj)

Returns all normals of the given ReadableObj as an array. Three consecutive entries in the resulting array are the x,y,z coordinates of one normal.

Parameters:

obj - The ReadableObj

Returns:

The resulting array

getNormals

public static FloatBuffer getNormals(ReadableObj obj)

Returns all normals of the given ReadableObj as an array. Three consecutive entries in the resulting buffer are the x,y,z coordinates of one normal. The position of the returned buffer will be 0, and its limit and capacity will match the stored data.

Parameters:

obj - The ReadableObj

Returns:

The resulting buffer

getNormals

public static void getNormals(ReadableObj obj,
                              FloatBuffer target)

Stores the normals of the given ReadableObj in the given buffer. The position of the target will be increased by obj.getNumNormals() * 3. The position of the given buffer will be advanced accordingly.

Parameters:

obj - The ReadableObj

target - The buffer that will store the result

Throws:

BufferOverflowException - If the target can not store the result

convertToShortBuffer

public static ShortBuffer convertToShortBuffer(IntBuffer intBuffer)

Convert the given IntBuffer to a (direct) ShortBuffer, by casting all elements to short.

Note that these casts will be unchecked. If there is any value in the input buffer that is larger than the maximum value that a signed short can represent, then the short value will become negative. The resulting buffer will then still be valid for passing the it to OpenGL when the index mode is GL_UNSIGNED_SHORT, because the bitwise representation is the same. When one of the integer values is larger than the value that can be represented with an unsigned short, then the resulting indices will be invalid and cause rendering artifacts.

Parameters:

intBuffer - The IntBuffer

Returns:

The ShortBuffer