JOGLGeometry

java.lang.Object
- javax.media.j3d.SceneGraphObject
- - javax.media.j3d.NodeComponent
  - - javax.media.j3d.Geometry
    - - vona.j3d.JOGLGeometry

```
@ThreadSafe
public class JOGLGeometry
extends javax.media.j3d.Geometry
```
A container for OpenGL geometry.

This class implements Java3D GeometryArray-like functionality for standard OpenGL interleaved geometry. It extends the Java3D Geometry class and may be present in Java3D scenegraphs, and though the Java3D renderers do not know about it, the renderer in JOGLDisplay does. In fact, JOGLDisplay is best-optimized for JOGLGeometry; existing Java3D GeometryArray data (e.g. as returned from Java3D loaders) can be converted to JOGLGeometry via extract(javax.media.j3d.GeometryArray, int, java.io.PrintStream).

This class is designed to be thread-safe. All state is either final or internally synchronized.

TBD
- test indexed geometry
- test texcoords
- support more complete set of JOGLGeometry.Formats
Copyright (C) 2008 Marsette A. Vona, III
Author:

Marsette A. Vona, III

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JOGLGeometry.Format
The supported set of OpenGL interleaved vertex formats.

Nested Classes
Modifier and Type	Class and Description
`static class`	`JOGLGeometry.Format` The supported set of OpenGL interleaved vertex formats.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_BUT_COLOR` Convenient bitmasks for `extract(GeometryArray, int, PrintStream)`.
`static int`	`ALL_BUT_NORMAL` Convenient bitmasks for `extract(GeometryArray, int, PrintStream)`.
`static int`	`ALL_BUT_TEXCOORD` Convenient bitmasks for `extract(GeometryArray, int, PrintStream)`.
`protected int[]`	`arrayCount` Array holding the array (or strip) lengths for this geometry.
`protected java.nio.IntBuffer`	`countBuffer` Temp storage for passing data to OpenGL.
`private static java.lang.String`	`cvsid`
`protected java.nio.IntBuffer`	`firstBuffer` Temp storage for passing data to OpenGL.
`JOGLGeometry.Format`	`format` The vertex format for this geometry.
`protected java.nio.IntBuffer`	`indexBuffer` Buffer holding the index data for this geometry, if any.
`protected com.jogamp.common.nio.PointerBuffer`	`indexBufferArray` Temp storage for passing data to OpenGL.
`static int`	`INITIAL_CAPACITY` initial capacity for resizable buffers
`static java.util.Map<java.lang.Class,java.lang.Integer>`	`j3dTypeToGLMode` Unmodifiable mapping from Java3D `GeometryArray` type to OpenGL drawing mode.
`int`	`mode` OpenGL drawing mode for this geometry.
`protected int`	`numArrays` Number of arrays (or strips) in this geometry.
`protected java.nio.FloatBuffer`	`vertexBuffer` Buffer holding the interleaved vertex data for this geometry, if any.
`int`	`vertsPerPrim` Number of vertices per primitive for this geometry.
`int`	`vertsPerStripPrim` For stripped geometry, this is the number of vertices in each prim in a strip after the first.

Fields inherited from class javax.media.j3d.Geometry
ALLOW_INTERSECT

Constructor Summary

Constructors
Constructor and Description
`JOGLGeometry(int mode, JOGLGeometry.Format format, int numVertices)` makes a new empty geometry, not indexed, one array
`JOGLGeometry(int mode, JOGLGeometry.Format format, int numVertices, int numArrays)` makes a new empty geometry, not indexed
`JOGLGeometry(int mode, JOGLGeometry.Format format, int numVertices, int numIndices, int numArrays)` Makes a new empty geometry.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`draw(javax.media.opengl.GL2 gl)` `draw(GL2, boolean)`, with low-level drawing always enabled
`void`	`draw(javax.media.opengl.GL2 gl, boolean glDrawingEnabled)` Draw this geometry.
`void`	`dump()` `dump(PrintStream)`, to System.out
`void`	`dump(java.io.PrintStream s)` `dump(String, PrintStream)`, prefixed by the class name
`void`	`dump(java.lang.String prefix, java.io.PrintStream s)` dump format data for this geometry
`void`	`dumpVertices()` `dumpVertices(String, boolean, PrintStream)`, no prefix, unindex, to System.out.
`void`	`dumpVertices(boolean unindex, java.io.PrintStream s)` `dumpVertices(String, boolean, PrintStream)`, no prefix
`void`	`dumpVertices(java.io.PrintStream s)` `dumpVertices(String, boolean, PrintStream)`, no prefix, unindex.
`void`	`dumpVertices(java.lang.String prefix, boolean unindex, java.io.PrintStream s)` dump vertex data for this geometry
`static JOGLGeometry`	`extract(javax.media.j3d.GeometryArray geometryArray)` Covers `extract(GeometryArray, int, PrintStream)`, no error stream, extract all vertex components.
`static JOGLGeometry`	`extract(javax.media.j3d.GeometryArray geometryArray, int formatMask)` Covers `extract(GeometryArray, int, PrintStream)`, no error stream.
`static JOGLGeometry`	`extract(javax.media.j3d.GeometryArray geometryArray, int j3dFormatMask, java.io.PrintStream errorStream)` Extract the data from an existing Java3D `GeometryArray` into a new `JOGLGeometry`.
`int[]`	`getArrayCountArray()` Get a ref to the `arrayCount` array.
`int`	`getCount(int countIndex)` convenience synchronized accessor to `arrayCount` array
`java.nio.IntBuffer`	`getIndexBuffer()` Get a ref to the `indexBuffer`.
`int`	`getNumArrays()` get `numArrays`
`int`	`getNumEnabledArrays()` Get the number of enabled arrays.
`int`	`getNumEnabledVertices()` Get the total number of enabled vertices in this geometry.
`int`	`getNumIndices()` get the capacity of the index buffer (0 if not indexed)
`int`	`getNumValidVertices()` Get the total number of valid vertices in this geometry.
`int`	`getNumVertices()` get the capacity of the vertex buffer
`java.nio.FloatBuffer`	`getVertexBuffer()` Get a ref to the `vertexBuffer`.
`boolean`	`hasAlpha()` check if this geometry has any alpha component
`boolean`	`hasColors()` check if this geometry has any color components
`boolean`	`isIndexed()` check whether this geometry is indexed
`static JOGLGeometry.Format`	`j3dFormatToJOGLFormat(int j3dFormat)` map a Java3D vertex format to a `JOGLGeometry.Format`
`static java.lang.Integer`	`j3dTypeToGLMode(java.lang.Class type)` map a Java3D `GeometryArray` type to an OpenGL drawing mode
`int`	`numPrims()` Compute the total number of primitives in this geometry.
`void`	`resizeCountArray(int newSize)` Resize the `arrayCount` array.
`void`	`resizeIndexBuffer(int newSize)` `J3DUtils.resizeBuffer(IntBuffer, int)` the index buffer.
`void`	`resizeVertexBuffer(int newSize)` `J3DUtils.resizeBuffer(FloatBuffer, int)` the vertex buffer.
`void`	`scaleGeometry(float scale)` Apply a scale factor to the coordinates of all valid vertices.
`void`	`setCount(int countIndex, int count)` convenience synchronized accessor to `arrayCount` array
`void`	`setNumArrays(int numArrays)` Set `numArrays`.
`static java.lang.String`	`textGLMode(int mode)` map an OpenGL drawing mode to the corresponding string
`static int`	`vertsPerPrim(int mode)` Get the number of vertices per (full) primitive for the given OpenGL drawing mode.
`static int`	`vertsPerStripPrim(int mode)` Get the number of vertices per primitive after the first in a strip for the given OpenGL drawing mode.

Methods inherited from class javax.media.j3d.NodeComponent
cloneNodeComponent, cloneNodeComponent, duplicateNodeComponent, duplicateNodeComponent, getDuplicateOnCloneTree, setDuplicateOnCloneTree

Methods inherited from class javax.media.j3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString, updateNodeReferences

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - cvsid
```
private static final java.lang.String cvsid
```
    See Also:
    Constant Field Values
  - INITIAL_CAPACITY
```
public static final int INITIAL_CAPACITY
```
    initial capacity for resizable buffers
    
    See Also:
    Constant Field Values
  - ALL_BUT_COLOR
```
public static final int ALL_BUT_COLOR
```
    Convenient bitmasks for extract(GeometryArray, int, PrintStream).
    
    See Also:
    Constant Field Values
  - ALL_BUT_NORMAL
```
public static final int ALL_BUT_NORMAL
```
    Convenient bitmasks for extract(GeometryArray, int, PrintStream).
    
    See Also:
    Constant Field Values
  - ALL_BUT_TEXCOORD
```
public static final int ALL_BUT_TEXCOORD
```
    Convenient bitmasks for extract(GeometryArray, int, PrintStream).
    
    See Also:
    Constant Field Values
  - j3dTypeToGLMode
```
public static final java.util.Map<java.lang.Class,java.lang.Integer> j3dTypeToGLMode
```
    Unmodifiable mapping from Java3D GeometryArray type to OpenGL drawing mode.
    
    Used by j3dTypeToGLMode(Class).
  - mode
```
public final int mode
```
    OpenGL drawing mode for this geometry.
    
    One of GL_POINTS GL_LINES GL_LINE_STRIP GL_LINE_LOOP* GL_TRIANGLES GL_TRIANGLE_STRIP GL_TRIANGLE_FAN GL_POLYGON* GL_QUADS GL_QUADS_STRIP*, where modes marked with * have no corresponding Java3D type.
    
    Also see j3dTypeToGLMode.
  - vertsPerPrim
```
public final int vertsPerPrim
```
    Number of vertices per primitive for this geometry.
    
    For stripped geometry, this is the number of vertices in the first prim in a strip.
  - vertsPerStripPrim
```
public final int vertsPerStripPrim
```
    For stripped geometry, this is the number of vertices in each prim in a strip after the first.
    
    For un-stripped geometry, this equals vertsPerPrim.
  - format
```
public final JOGLGeometry.Format format
```
    The vertex format for this geometry.
    
    A subset of the OpenGL interleaved vertex formats are allowed, see JOGLGeometry.Format.
    
    Also see j3dFormatToJOGLFormat(int).
  - numArrays
```
protected int numArrays
```
    Number of arrays (or strips) in this geometry.
    
    More precisely, this is the length of the initial part of the arrayCount array that will be considered, though any non-positive counts therein do not actually generate geometry.
  - vertexBuffer
```
protected java.nio.FloatBuffer vertexBuffer
```
    Buffer holding the interleaved vertex data for this geometry, if any.
    
    Both the size (see resizeVertexBuffer(int)) and the existence (see same) of this buffer are mutable.
    
    Note that the capacity of the vertex buffer can be both greater and less (in the case of indexed geometry) than getNumValidVertices().
  - indexBuffer
```
protected java.nio.IntBuffer indexBuffer
```
    Buffer holding the index data for this geometry, if any.
    
    This geometry is indexed iff the index buffer is non-null (see isIndexed()).
    
    Both the size (see resizeIndexBuffer(int)) and the existence (see same) of this buffer are mutable.
  - arrayCount
```
protected int[] arrayCount
```
    Array holding the array (or strip) lengths for this geometry.
    
    The capacity of this array must be at least numArrays, but may be greater. Additionally, non-positive counts c within the first numArrays elements are taken as indication to skip rather than draw -c vertices.
  - countBuffer
```
protected java.nio.IntBuffer countBuffer
```
    Temp storage for passing data to OpenGL.
    
    Confined to the thread that calls draw(GL2).
  - firstBuffer
```
protected java.nio.IntBuffer firstBuffer
```
    Temp storage for passing data to OpenGL.
    
    Confined to the thread that calls draw(GL2).
  - indexBufferArray
```
protected com.jogamp.common.nio.PointerBuffer indexBufferArray
```
    Temp storage for passing data to OpenGL.
    
    Confined to the thread that calls draw(GL2).
- Constructor Detail
  - JOGLGeometry
```
public JOGLGeometry(int mode,
            JOGLGeometry.Format format,
            int numVertices,
            int numIndices,
            int numArrays)
```
    Makes a new empty geometry.
    
    Parameters:
    mode - the OpenGL drawing mode, see mode (immutable)
    format - the OpenGL vertex format, see format (immutable)
    numVertices - the initial capacity of vertexBuffer (mutable)
    numIndices - the initial capacity of indexBuffer, or negative if not indexed (mutable)
    numArrays - the initial number of arrays (or strips) (mutable)
  - JOGLGeometry
```
public JOGLGeometry(int mode,
            JOGLGeometry.Format format,
            int numVertices,
            int numArrays)
```
    makes a new empty geometry, not indexed
  - JOGLGeometry
```
public JOGLGeometry(int mode,
            JOGLGeometry.Format format,
            int numVertices)
```
    makes a new empty geometry, not indexed, one array
- Method Detail
  - extract
```
public static JOGLGeometry extract(javax.media.j3d.GeometryArray geometryArray,
                   int j3dFormatMask,
                   java.io.PrintStream errorStream)
```
    Extract the data from an existing Java3D GeometryArray into a new JOGLGeometry.
    
    The returned JOGLGeometry will be indexed iff the passed geometryArray is indexed. The geometry mode and vertex format will correspond to the passed geometryArray.
    
    Parameters:
    j3dFormatMask - bitmask of allowed J3D vertex format flags. Vertex components that are masked will not be extracted.
    errorStream - if not null then any warnings or errors are printed here
    
    Returns:
    the extracted JOGLGeometry or null on failure
  - extract
```
public static JOGLGeometry extract(javax.media.j3d.GeometryArray geometryArray,
                   int formatMask)
```
    Covers extract(GeometryArray, int, PrintStream), no error stream.
  - extract
```
public static JOGLGeometry extract(javax.media.j3d.GeometryArray geometryArray)
```
    Covers extract(GeometryArray, int, PrintStream), no error stream, extract all vertex components.
  - vertsPerPrim
```
public static int vertsPerPrim(int mode)
```
    Get the number of vertices per (full) primitive for the given OpenGL drawing mode.
    
    GL_POLYGON is treated the same as GL_TRIANGLE_FAN.
  - vertsPerStripPrim
```
public static int vertsPerStripPrim(int mode)
```
    Get the number of vertices per primitive after the first in a strip for the given OpenGL drawing mode.
    
    GL_POLYGON is treated the same as GL_TRIANGLE_FAN.
  - j3dTypeToGLMode
```
public static java.lang.Integer j3dTypeToGLMode(java.lang.Class type)
```
    map a Java3D GeometryArray type to an OpenGL drawing mode
  - textGLMode
```
public static java.lang.String textGLMode(int mode)
```
    map an OpenGL drawing mode to the corresponding string
  - j3dFormatToJOGLFormat
```
public static JOGLGeometry.Format j3dFormatToJOGLFormat(int j3dFormat)
```
    map a Java3D vertex format to a JOGLGeometry.Format
  - dump
```
public void dump(java.lang.String prefix,
        java.io.PrintStream s)
```
    dump format data for this geometry
  - dump
```
public void dump(java.io.PrintStream s)
```
    dump(String, PrintStream), prefixed by the class name
  - dump
```
public void dump()
```
    dump(PrintStream), to System.out
  - dumpVertices
```
public void dumpVertices(java.lang.String prefix,
                boolean unindex,
                java.io.PrintStream s)
```
    dump vertex data for this geometry
  - dumpVertices
```
public void dumpVertices(boolean unindex,
                java.io.PrintStream s)
```
    dumpVertices(String, boolean, PrintStream), no prefix
  - dumpVertices
```
public void dumpVertices(java.io.PrintStream s)
```
    dumpVertices(String, boolean, PrintStream), no prefix, unindex.
  - dumpVertices
```
public void dumpVertices()
```
    dumpVertices(String, boolean, PrintStream), no prefix, unindex, to System.out.
  - numPrims
```
public int numPrims()
```
    Compute the total number of primitives in this geometry.
    
    The computation is based on getNumValidVertices() and depends on vertsPerPrim, vertsPerStripPrim, numArrays, and whether the geometry is an OpenGL GL_LINE_LOOP, which has an extra implied loop-closure.
    
    GL_POLYGON is treated the same as GL_TRIANGLE_FAN.
  - getNumArrays
```
public int getNumArrays()
```
    get numArrays
  - getNumEnabledArrays
```
public int getNumEnabledArrays()
```
    Get the number of enabled arrays.
    
    This may be less than numArrays because arrays with non-positive arrayCount are considered disabled.
  - setNumArrays
```
public void setNumArrays(int numArrays)
```
    Set numArrays.
    
    If numArrays is greater than the current capacity of arrayCount then the capacity will be doubled until it is greater than or equal to the requested numArrays.
  - hasColors
```
public boolean hasColors()
```
    check if this geometry has any color components
  - hasAlpha
```
public boolean hasAlpha()
```
    check if this geometry has any alpha component
  - getNumVertices
```
public int getNumVertices()
```
    get the capacity of the vertex buffer
  - getNumIndices
```
public int getNumIndices()
```
    get the capacity of the index buffer (0 if not indexed)
  - getNumValidVertices
```
public int getNumValidVertices()
```
    Get the total number of valid vertices in this geometry.
    
    This is not necessarily the same as the vertex buffer capacity as returned by getNumVertices(); rather it is the sum of the absolute values of the first numArrays arrayCounts. The result may be less than the vertex buffer capacity or it may be greater in the case of indexed geometry.
  - getNumEnabledVertices
```
public int getNumEnabledVertices()
```
    Get the total number of enabled vertices in this geometry.
    
    This is like getNumValidVertices() but does not include vertices in arrays with non-postive arrayCount.
  - isIndexed
```
public boolean isIndexed()
```
    check whether this geometry is indexed
  - resizeVertexBuffer
```
public void resizeVertexBuffer(int newSize)
```
    J3DUtils.resizeBuffer(FloatBuffer, int) the vertex buffer.
    
    Parameters:
    newSize - the new buffer capacity, or negative to free the vertex buffer
  - resizeIndexBuffer
```
public void resizeIndexBuffer(int newSize)
```
    J3DUtils.resizeBuffer(IntBuffer, int) the index buffer.
    
    Parameters:
    newSize - the new buffer capacity, or negative to go unindexed
  - resizeCountArray
```
public void resizeCountArray(int newSize)
```
    Resize the arrayCount array.
    
    The old contents are copied to the new array up to the length of the shorter of the two.
  - getVertexBuffer
```
public java.nio.FloatBuffer getVertexBuffer()
```
    Get a ref to the vertexBuffer.
    
    External access to the buffer contents can synchronize on this JOGLGeometry for thread safety.
  - getIndexBuffer
```
public java.nio.IntBuffer getIndexBuffer()
```
    Get a ref to the indexBuffer.
    
    External access to the buffer contents can synchronize on this JOGLGeometry for thread safety.
  - getArrayCountArray
```
public int[] getArrayCountArray()
```
    Get a ref to the arrayCount array.
    
    External access to the array contents can synchronize on this JOGLGeometry for thread safety.
  - setCount
```
public void setCount(int countIndex,
            int count)
```
    convenience synchronized accessor to arrayCount array
  - getCount
```
public int getCount(int countIndex)
```
    convenience synchronized accessor to arrayCount array
  - draw
```
public void draw(javax.media.opengl.GL2 gl,
        boolean glDrawingEnabled)
```
    Draw this geometry.
    
    The buffer positions may be modified by this call.
    
    Note that this call may return before the underlying OGL implementation has finished accessing the buffers, so external code should not modify them until a glFinish() has been done.
    
    Parameters:
    gl - the OGL context, if null then drawing is aborted
    glDrawingEnabled - whether to enable or disable the lowest-level drawing calls, can be useful in measuring overhead vs actual drawing time
  - draw
```
public void draw(javax.media.opengl.GL2 gl)
```
    draw(GL2, boolean), with low-level drawing always enabled
  - scaleGeometry
```
public void scaleGeometry(float scale)
```
    Apply a scale factor to the coordinates of all valid vertices.

Class JOGLGeometry

TBD

Nested Class Summary

Field Summary

Fields inherited from class javax.media.j3d.Geometry

Constructor Summary

Method Summary

Methods inherited from class javax.media.j3d.NodeComponent

Methods inherited from class javax.media.j3d.SceneGraphObject

Methods inherited from class java.lang.Object

Field Detail

cvsid

INITIAL_CAPACITY

ALL_BUT_COLOR

ALL_BUT_NORMAL

ALL_BUT_TEXCOORD

j3dTypeToGLMode

mode

vertsPerPrim

vertsPerStripPrim

format

numArrays

vertexBuffer

indexBuffer

arrayCount

countBuffer

firstBuffer

indexBufferArray

Constructor Detail

JOGLGeometry

JOGLGeometry

JOGLGeometry

Method Detail

extract

extract

extract

vertsPerPrim

vertsPerStripPrim

j3dTypeToGLMode

textGLMode

j3dFormatToJOGLFormat

dump

dump

dump

dumpVertices

dumpVertices

dumpVertices

dumpVertices

numPrims

getNumArrays

getNumEnabledArrays

setNumArrays

hasColors

hasAlpha

getNumVertices

getNumIndices

getNumValidVertices

getNumEnabledVertices

isIndexed

resizeVertexBuffer

resizeIndexBuffer

resizeCountArray

getVertexBuffer

getIndexBuffer

getArrayCountArray

setCount

getCount

draw

draw

scaleGeometry