: Class GeometryArray

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.media.j3d
Class GeometryArray

java.lang.Object
  |
  +--javax.media.j3d.SceneGraphObject
        |
        +--javax.media.j3d.NodeComponent
              |
              +--javax.media.j3d.Geometry
                    |
                    +--javax.media.j3d.GeometryArray

Direct Known Subclasses:: GeometryStripArray, IndexedGeometryArray, LineArray, PointArray, QuadArray, TriangleArray

public abstract class GeometryArray
extends Geometry

The GeometryArray object contains separate arrays of positional coordinates, colors, normals, and texture coordinates that describe point, line, or polygon geometry. This class is extended to create the various primitive types (e.g., lines, triangle strips, etc.). Vertex data may be passed to this geometry array in one of two ways: by copying the data into the array using the existing methods, or by passing a reference to the data.

By Copying: The existing methods for setting positional coordinates, colors, normals, and texture coordinates (e.g., setCoordinate, setColors, etc.) copy the data into this GeometryArray. This is appropriate for many applications and offers an application much flexibility in organizing its data. This is the default mode.
By Reference: A new set of methods in Java 3D version 1.2 allows data to be accessed by reference, directly from the user's arrays. To use this feature, set the BY_REFERENCE bit in the vertexFormat field of the constructor for this GeometryArray. In this mode, the various set methods for coordinates, normals, colors, and texture coordinates are not used. Instead, new methods are used to set a reference to user-supplied coordinate, color, normal, and texture coordinate arrays (e.g., setCoordRefFloat, setColorRefFloat, etc.). Data in any array that is referenced by a live or compiled GeometryArray object may only be modified via the updateData method (subject to the ALLOW_REF_DATA_WRITE capability bit). Applications must exercise care not to violate this rule. If any referenced geometry data is modified outside of the updateData method, the results are undefined.

All colors used in the geometry array object must be in the range [0.0,1.0]. Values outside this range will cause undefined results. All normals used in the geometry array object must be unit length vectors. That is their geometric length must be 1.0. Normals that are not unit length vectors will cause undefined results.

Note that the term coordinate, as used in the method names and method descriptions, actually refers to a set of x, y, and z coordinates representing the position of a single vertex. The term coordinates (plural) is used to indicate sets of x, y, and z coordinates for multiple vertices. This is somewhat at odds with the mathematical definition of a coordinate, but is used as a convenient shorthand. Similarly, the term texture coordinate is used to indicate a set of texture coordinates for a single vertex, while the term texture coordinates (plural) is used to indicate sets of texture coordinates for multiple vertices.

Field Summary

static int ALLOW_COLOR_READ
          Specifies that this GeometryArray allows reading the array of colors.

static int ALLOW_COLOR_WRITE
          Specifies that this GeometryArray allows writing the array of colors.

static int ALLOW_COORDINATE_READ
          Specifies that this GeometryArray allows reading the array of coordinates.

static int ALLOW_COORDINATE_WRITE
          Specifies that this GeometryArray allows writing the array of coordinates.

static int ALLOW_COUNT_READ
          Specifies that this GeometryArray allows reading the count or initial index information for this object.

static int ALLOW_COUNT_WRITE
          Specifies that this GeometryArray allows writing the count or initial index information for this object.

static int ALLOW_FORMAT_READ
          Specifies that this GeometryArray allows reading the vertex format information for this object.

static int ALLOW_NORMAL_READ
          Specifies that this GeometryArray allows reading the array of normals.

static int ALLOW_NORMAL_WRITE
          Specifies that this GeometryArray allows writing the array of normals.

static int ALLOW_REF_DATA_READ
          Specifies that this GeometryArray allows reading the geometry data reference information for this object.

static int ALLOW_REF_DATA_WRITE
          Specifies that this GeometryArray allows writing the geometry data reference information for this object.

static int ALLOW_TEXCOORD_READ
          Specifies that this GeometryArray allows reading the array of texture coordinates.

static int ALLOW_TEXCOORD_WRITE
          Specifies that this GeometryArray allows writing the array of texture coordinates.

static int BY_REFERENCE
          Specifies that the position, color, normal, and texture coordinate data for this GeometryArray are accessed by reference.

static int COLOR_3
          Specifies that this GeometryArray contains an array of colors without alpha.

static int COLOR_4
          Specifies that this GeometryArray contains an array of colors with alpha.

static int COORDINATES
          Specifies that this GeometryArray contains an array of coordinates.

static int INTERLEAVED
          Specifies that the position, color, normal, and texture coordinate data for this GeometryArray are accessed via a single interleaved, floating-point array reference.

static int NORMALS
          Specifies that this GeometryArray contains an array of normals.

static int TEXTURE_COORDINATE_2
          Specifies that this GeometryArray contains one or more arrays of 2D texture coordinates.

static int TEXTURE_COORDINATE_3
          Specifies that this GeometryArray contains one or more arrays of 3D texture coordinates.

Fields inherited from class javax.media.j3d.Geometry

ALLOW_INTERSECT

Constructor Summary

GeometryArray(int vertexCount, int vertexFormat)
          Constructs an empty GeometryArray object with the specified number of vertices and vertex format.

GeometryArray(int vertexCount, int vertexFormat, int texCoordSetCount, int[] texCoordSetMap)
          Constructs an empty GeometryArray object with the specified number of vertices, vertex format, number of texture coordinate sets, and texture coordinate mapping array.

Method Summary

void getColor(int index, byte[] color)
          Gets the color associated with the vertex at the specified index for this object.

void getColor(int index, Color3b color)
          Gets the color associated with the vertex at the specified index for this object.

void getColor(int index, Color3f color)
          Gets the color associated with the vertex at the specified index for this object.

void getColor(int index, Color4b color)
          Gets the color associated with the vertex at the specified index for this object.

void getColor(int index, Color4f color)
          Gets the color associated with the vertex at the specified index for this object.

void getColor(int index, float[] color)
          Gets the color associated with the vertex at the specified index for this object.

Color3b[] getColorRef3b()
          Gets the Color3b color array reference.

Color3f[] getColorRef3f()
          Gets the Color3f color array reference.

Color4b[] getColorRef4b()
          Gets the Color4b color array reference.

Color4f[] getColorRef4f()
          Gets the Color4f color array reference.

byte[] getColorRefByte()
          Gets the byte color array reference.

float[] getColorRefFloat()
          Gets the float color array reference.

void getColors(int index, byte[] colors)
          Gets the colors associated with the vertices starting at the specified index for this object.

void getColors(int index, Color3b[] colors)
          Gets the colors associated with the vertices starting at the specified index for this object.

void getColors(int index, Color3f[] colors)
          Gets the colors associated with the vertices starting at the specified index for this object.

void getColors(int index, Color4b[] colors)
          Gets the colors associated with the vertices starting at the specified index for this object.

void getColors(int index, Color4f[] colors)
          Gets the colors associated with the vertices starting at the specified index for this object.

void getColors(int index, float[] colors)
          Gets the colors associated with the vertices starting at the specified index for this object.

void getCoordinate(int index, double[] coordinate)
          Gets the coordinate associated with the vertex at the specified index for this object.

void getCoordinate(int index, float[] coordinate)
          Gets the coordinate associated with the vertex at the specified index for this object using data in texCoords

void getCoordinate(int index, Point3d coordinate)
          Gets the coordinate associated with the vertex at the specified index for this object.

void getCoordinate(int index, Point3f coordinate)
          Gets the coordinate associated with the vertex at the specified index for this object.

void getCoordinates(int index, double[] coordinates)
          Gets the coordinates associated with the vertices starting at the specified index for this object.

void getCoordinates(int index, float[] coordinates)
          Gets the coordinates associated with the vertices starting at the specified index for this object.

void getCoordinates(int index, Point3d[] coordinates)
          Gets the coordinates associated with the vertices starting at the specified index for this object.

void getCoordinates(int index, Point3f[] coordinates)
          Gets the coordinates associated with the vertices starting at the specified index for this object.

Point3d[] getCoordRef3d()
          Gets the Point3d coordinate array reference.

Point3f[] getCoordRef3f()
          Gets the Point3f coordinate array reference.

double[] getCoordRefDouble()
          Gets the double coordinate array reference.

float[] getCoordRefFloat()
          Gets the float coordinate array reference.

int getInitialColorIndex()
          Gets the initial color index for this GeometryArray object.

int getInitialCoordIndex()
          Gets the initial coordinate index for this GeometryArray object.

int getInitialNormalIndex()
          Gets the initial normal index for this GeometryArray object.

int getInitialTexCoordIndex(int texCoordSet)
          Gets the initial texture coordinate index for the specified texture coordinate set for this GeometryArray object.

int getInitialVertexIndex()
          Gets the initial vertex index for this GeometryArray object.

float[] getInterleavedVertices()
          Gets the interleaved vertices array reference.

void getNormal(int index, float[] normal)
          Gets the normal associated with the vertex at the specified index for this object.

void getNormal(int index, Vector3f normal)
          Gets the normal associated with the vertex at the specified index for this object.

Vector3f[] getNormalRef3f()
          Gets the Vector3f normal array reference.

float[] getNormalRefFloat()
          Gets the float normal array reference.

void getNormals(int index, float[] normals)
          Gets the normals associated with the vertices starting at the specified index for this object.

void getNormals(int index, Vector3f[] normals)
          Gets the normals associated with the vertices starting at the specified index for this object.

TexCoord2f[] getTexCoordRef2f(int texCoordSet)
          Gets the TexCoord2f texture coordinate array reference for the specified texture coordinate set.

TexCoord3f[] getTexCoordRef3f(int texCoordSet)
          Gets the TexCoord3f texture coordinate array reference for the specified texture coordinate set.

float[] getTexCoordRefFloat(int texCoordSet)
          Gets the float texture coordinate array reference for the specified texture coordinate set.

int getTexCoordSetCount()
          Retrieves the number of texture coordinate sets in this GeometryArray object.

void getTexCoordSetMap(int[] texCoordSetMap)
          Retrieves the texture coordinate set mapping array from this GeometryArray object.

int getTexCoordSetMapLength()
          Retrieves the length of the texture coordinate set mapping array of this GeometryArray object.

void getTextureCoordinate(int index, float[] texCoord)
          Deprecated. As of Java 3D version 1.2, replaced by getTextureCoordinate(int texCoordSet, ...)

void getTextureCoordinate(int texCoordSet, int index, float[] texCoord)
          Gets the texture coordinate associated with the vertex at the specified index in the specified texture coordinate set for this object.

void getTextureCoordinate(int texCoordSet, int index, TexCoord2f texCoord)
          Gets the texture coordinate associated with the vertex at the specified index in the specified texture coordinate set for this object.

void getTextureCoordinate(int texCoordSet, int index, TexCoord3f texCoord)
          Gets the texture coordinate associated with the vertex at the specified index in the specified texture coordinate set for this object.

void getTextureCoordinate(int index, Point2f texCoord)
          Deprecated. As of Java 3D version 1.2, replaced by getTextureCoordinate(int texCoordSet, TexCoord2f texCoord)

void getTextureCoordinate(int index, Point3f texCoord)
          Deprecated. As of Java 3D version 1.2, replaced by getTextureCoordinate(int texCoordSet, TexCoord3f texCoord)

void getTextureCoordinates(int index, float[] texCoords)
          Deprecated. As of Java 3D version 1.2, replaced by getTextureCoordinates(int texCoordSet, ...)

void getTextureCoordinates(int texCoordSet, int index, float[] texCoords)
          Gets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object.

void getTextureCoordinates(int texCoordSet, int index, TexCoord2f[] texCoords)
          Gets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object.

void getTextureCoordinates(int texCoordSet, int index, TexCoord3f[] texCoords)
          Gets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object.

void getTextureCoordinates(int index, Point2f[] texCoords)
          Deprecated. As of Java 3D version 1.2, replaced by getTextureCoordinates(int texCoordSet, TexCoord2f texCoords[])

void getTextureCoordinates(int index, Point3f[] texCoords)
          Deprecated. As of Java 3D version 1.2, replaced by getTextureCoordinates(int texCoordSet, TexCoord3f texCoords[])

int getValidVertexCount()
          Gets the valid vertex count for this GeometryArray object.

int getVertexCount()
          Retrieves the number of vertices in this GeometryArray

int getVertexFormat()
          Retrieves the vertexFormat of this GeometryArray

void setColor(int index, byte[] color)
          Sets the color associated with the vertex at the specified index for this object.

void setColor(int index, Color3b color)
          Sets the color associated with the vertex at the specified index for this object.

void setColor(int index, Color3f color)
          Sets the color associated with the vertex at the specified index for this object.

void setColor(int index, Color4b color)
          Sets the color associated with the vertex at the specified index for this object.

void setColor(int index, Color4f color)
          Sets the color associated with the vertex at the specified index for this object.

void setColor(int index, float[] color)
          Sets the color associated with the vertex at the specified index for this object.

void setColorRef3b(Color3b[] colors)
          Sets the Color3b color array reference to the specified array.

void setColorRef3f(Color3f[] colors)
          Sets the Color3f color array reference to the specified array.

void setColorRef4b(Color4b[] colors)
          Sets the Color4b color array reference to the specified array.

void setColorRef4f(Color4f[] colors)
          Sets the Color4f color array reference to the specified array.

void setColorRefByte(byte[] colors)
          Sets the byte color array reference to the specified array.

void setColorRefFloat(float[] colors)
          Sets the float color array reference to the specified array.

void setColors(int index, byte[] colors)
          Sets the colors associated with the vertices starting at the specified index for this object.

void setColors(int index, byte[] colors, int start, int length)
          Sets the colors associated with the vertices starting at the specified index for this object using data in colors starting at index start for length colors.

void setColors(int index, Color3b[] colors)
          Sets the colors associated with the vertices starting at the specified index for this object.

void setColors(int index, Color3b[] colors, int start, int length)
          Sets the colors associated with the vertices starting at the specified index for this object using data in colors starting at index start for length colors.

void setColors(int index, Color3f[] colors)
          Sets the colors associated with the vertices starting at the specified index for this object.

void setColors(int index, Color3f[] colors, int start, int length)
          Sets the colors associated with the vertices starting at the specified index for this object using data in colors starting at index start for length colors.

void setColors(int index, Color4b[] colors)
          Sets the colors associated with the vertices starting at the specified index for this object.

void setColors(int index, Color4b[] colors, int start, int length)
          Sets the colors associated with the vertices starting at the specified index for this object using data in colors starting at index start for length colors.

void setColors(int index, Color4f[] colors)
          Sets the colors associated with the vertices starting at the specified index for this object.

void setColors(int index, Color4f[] colors, int start, int length)
          Sets the colors associated with the vertices starting at the specified index for this object using data in colors starting at index start for length colors.

void setColors(int index, float[] colors)
          Sets the colors associated with the vertices starting at the specified index for this object.

void setColors(int index, float[] colors, int start, int length)
          Sets the colors associated with the vertices starting at the specified index for this object using data in colors starting at index start for length colors.

void setCoordinate(int index, double[] coordinate)
          Sets the coordinate associated with the vertex at the specified index.

void setCoordinate(int index, float[] coordinate)
          Sets the coordinate associated with the vertex at the specified index for this object.

void setCoordinate(int index, Point3d coordinate)
          Sets the coordinate associated with the vertex at the specified index for this object.

void setCoordinate(int index, Point3f coordinate)
          Sets the coordinate associated with the vertex at the specified index for this object.

void setCoordinates(int index, double[] coordinates)
          Sets the coordinates associated with the vertices starting at the specified index for this object.

void setCoordinates(int index, double[] coordinates, int start, int length)
          Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

void setCoordinates(int index, float[] coordinates)
          Sets the coordinates associated with the vertices starting at the specified index for this object.

void setCoordinates(int index, float[] coordinates, int start, int length)
          Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

void setCoordinates(int index, Point3d[] coordinates)
          Sets the coordinates associated with the vertices starting at the specified index for this object.

void setCoordinates(int index, Point3d[] coordinates, int start, int length)
          Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

void setCoordinates(int index, Point3f[] coordinates)
          Sets the coordinates associated with the vertices starting at the specified index for this object.

void setCoordinates(int index, Point3f[] coordinates, int start, int length)
          Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

void setCoordRef3d(Point3d[] coords)
          Sets the Point3d coordinate array reference to the specified array.

void setCoordRef3f(Point3f[] coords)
          Sets the Point3f coordinate array reference to the specified array.

void setCoordRefDouble(double[] coords)
          Sets the double coordinate array reference to the specified array.

void setCoordRefFloat(float[] coords)
          Sets the float coordinate array reference to the specified array.

void setInitialColorIndex(int initialColorIndex)
          Sets the initial color index for this GeometryArray object.

void setInitialCoordIndex(int initialCoordIndex)
          Sets the initial coordinate index for this GeometryArray object.

void setInitialNormalIndex(int initialNormalIndex)
          Sets the initial normal index for this GeometryArray object.

void setInitialTexCoordIndex(int texCoordSet, int initialTexCoordIndex)
          Sets the initial texture coordinate index for the specified texture coordinate set for this GeometryArray object.

void setInitialVertexIndex(int initialVertexIndex)
          Sets the initial vertex index for this GeometryArray object.

void setInterleavedVertices(float[] vertexData)
          Sets the interleaved vertices array reference to the specified array.

void setNormal(int index, float[] normal)
          Sets the normal associated with the vertex at the specified index for this object.

void setNormal(int index, Vector3f normal)
          Sets the normal associated with the vertex at the specified index for this object.

void setNormalRef3f(Vector3f[] normals)
          Sets the Vector3f normal array reference to the specified array.

void setNormalRefFloat(float[] normals)
          Sets the float normal array reference to the specified array.

void setNormals(int index, float[] normals)
          Sets the normals associated with the vertices starting at the specified index for this object.

void setNormals(int index, float[] normals, int start, int length)
          Sets the normals associated with the vertices starting at the specified index for this object using data in normals starting at index start and ending at index start+length.

void setNormals(int index, Vector3f[] normals)
          Sets the normals associated with the vertices starting at the specified index for this object.

void setNormals(int index, Vector3f[] normals, int start, int length)
          Sets the normals associated with the vertices starting at the specified index for this object using data in normals starting at index start and ending at index start+length.

void setTexCoordRef2f(int texCoordSet, TexCoord2f[] texCoords)
          Sets the TexCoord2f texture coordinate array reference for the specified texture coordinate set to the specified array.

void setTexCoordRef3f(int texCoordSet, TexCoord3f[] texCoords)
          Sets the TexCoord3f texture coordinate array reference for the specified texture coordinate set to the specified array.

void setTexCoordRefFloat(int texCoordSet, float[] texCoords)
          Sets the float texture coordinate array reference for the specified texture coordinate set to the specified array.

void setTextureCoordinate(int index, float[] texCoord)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinate(int texCoordSet, ...)

void setTextureCoordinate(int texCoordSet, int index, float[] texCoord)
          Sets the texture coordinate associated with the vertex at the specified index in the specified texture coordinate set for this object.

void setTextureCoordinate(int texCoordSet, int index, TexCoord2f texCoord)
          Sets the texture coordinate associated with the vertex at the specified index in the specified texture coordinate set for this object.

void setTextureCoordinate(int texCoordSet, int index, TexCoord3f texCoord)
          Sets the texture coordinate associated with the vertex at the specified index in the specified texture coordinate set for this object.

void setTextureCoordinate(int index, Point2f texCoord)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinate(int texCoordSet, TexCoord2f texCoord)

void setTextureCoordinate(int index, Point3f texCoord)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinate(int texCoordSet, TexCoord3f texCoord)

void setTextureCoordinates(int index, float[] texCoords)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinates(int texCoordSet, ...)

void setTextureCoordinates(int index, float[] texCoords, int start, int length)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinates(int texCoordSet, ...)

void setTextureCoordinates(int texCoordSet, int index, float[] texCoords)
          Sets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object.

void setTextureCoordinates(int texCoordSet, int index, float[] texCoords, int start, int length)
          Sets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object using data in texCoords starting at index start and ending at index start+length.

void setTextureCoordinates(int texCoordSet, int index, TexCoord2f[] texCoords)
          Sets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object.

void setTextureCoordinates(int texCoordSet, int index, TexCoord2f[] texCoords, int start, int length)
          Sets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object using data in texCoords starting at index start and ending at index start+length.

void setTextureCoordinates(int texCoordSet, int index, TexCoord3f[] texCoords)
          Sets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object.

void setTextureCoordinates(int texCoordSet, int index, TexCoord3f[] texCoords, int start, int length)
          Sets the texture coordinates associated with the vertices starting at the specified index in the specified texture coordinate set for this object.

void setTextureCoordinates(int index, Point2f[] texCoords)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinates(int texCoordSet, TexCoord2f texCoords[])

void setTextureCoordinates(int index, Point2f[] texCoords, int start, int length)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinates(int texCoordSet, TexCoord2f texCoords[], ...)

void setTextureCoordinates(int index, Point3f[] texCoords)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinates(int texCoordSet, TexCoord3f texCoords[])

void setTextureCoordinates(int index, Point3f[] texCoords, int start, int length)
          Deprecated. As of Java 3D version 1.2, replaced by setTextureCoordinates(int texCoordSet, TexCoord3f texCoords[], ...)

void setValidVertexCount(int validVertexCount)
          Sets the valid vertex count for this GeometryArray object.

void updateData(GeometryUpdater updater)
          Updates geometry array data that is accessed by reference.

Methods inherited from class javax.media.j3d.NodeComponent

cloneNodeComponent, cloneNodeComponent, duplicateNodeComponent, duplicateNodeComponent, getDuplicateOnCloneTree, setDuplicateOnCloneTree

Methods inherited from class javax.media.j3d.SceneGraphObject

clearCapability, duplicateSceneGraphObject, getCapability, getUserData, isCompiled, isLive, setCapability, setUserData, updateNodeReferences

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_COORDINATE_READ

public static final int ALLOW_COORDINATE_READ

Specifies that this GeometryArray allows reading the array of coordinates.

ALLOW_COORDINATE_WRITE

public static final int ALLOW_COORDINATE_WRITE

Specifies that this GeometryArray allows writing the array of coordinates.

ALLOW_COLOR_READ

public static final int ALLOW_COLOR_READ

Specifies that this GeometryArray allows reading the array of colors.

ALLOW_COLOR_WRITE

public static final int ALLOW_COLOR_WRITE

Specifies that this GeometryArray allows writing the array of colors.

ALLOW_NORMAL_READ

public static final int ALLOW_NORMAL_READ

Specifies that this GeometryArray allows reading the array of normals.

ALLOW_NORMAL_WRITE

public static final int ALLOW_NORMAL_WRITE

Specifies that this GeometryArray allows writing the array of normals.

ALLOW_TEXCOORD_READ

public static final int ALLOW_TEXCOORD_READ

Specifies that this GeometryArray allows reading the array of texture coordinates.

ALLOW_TEXCOORD_WRITE

public static final int ALLOW_TEXCOORD_WRITE

Specifies that this GeometryArray allows writing the array of texture coordinates.

ALLOW_COUNT_READ

public static final int ALLOW_COUNT_READ

Specifies that this GeometryArray allows reading the count or initial index information for this object.

ALLOW_COUNT_WRITE

public static final int ALLOW_COUNT_WRITE

Specifies that this GeometryArray allows writing the count or initial index information for this object.

Since:: Java 3D 1.2

ALLOW_FORMAT_READ

public static final int ALLOW_FORMAT_READ

Specifies that this GeometryArray allows reading the vertex format information for this object.

ALLOW_REF_DATA_READ

public static final int ALLOW_REF_DATA_READ

Specifies that this GeometryArray allows reading the geometry data reference information for this object. This is only used in by-reference geometry mode.

Since:: Java 3D 1.2

ALLOW_REF_DATA_WRITE

public static final int ALLOW_REF_DATA_WRITE

Specifies that this GeometryArray allows writing the geometry data reference information for this object. It also enables writing the referenced data itself, via the GeometryUpdater interface. This is only used in by-reference geometry mode.

Since:: Java 3D 1.2

COORDINATES

public static final int COORDINATES

Specifies that this GeometryArray contains an array of coordinates. This bit must be set.

NORMALS

public static final int NORMALS

Specifies that this GeometryArray contains an array of normals.

COLOR_3

public static final int COLOR_3

Specifies that this GeometryArray contains an array of colors without alpha.

COLOR_4

public static final int COLOR_4

Specifies that this GeometryArray contains an array of colors with alpha. This takes precedence over COLOR_3.

TEXTURE_COORDINATE_2

public static final int TEXTURE_COORDINATE_2

Specifies that this GeometryArray contains one or more arrays of 2D texture coordinates.

TEXTURE_COORDINATE_3

public static final int TEXTURE_COORDINATE_3

Specifies that this GeometryArray contains one or more arrays of 3D texture coordinates. This takes precedence over TEXTURE_COORDINATE_2.

BY_REFERENCE

public static final int BY_REFERENCE

Specifies that the position, color, normal, and texture coordinate data for this GeometryArray are accessed by reference.

Since:: Java 3D 1.2

INTERLEAVED

public static final int INTERLEAVED

Specifies that the position, color, normal, and texture coordinate data for this GeometryArray are accessed via a single interleaved, floating-point array reference. All of the data values for each vertex are stored in consecutive memory locations. This is only valid in conjunction with the BY_REFERENCE flag.

Since:: Java 3D 1.2

Constructor Detail

GeometryArray

public GeometryArray(int vertexCount,
                     int vertexFormat)

Constructs an empty GeometryArray object with the specified number of vertices and vertex format. Defaults are used for all other parameters. The default values are as follows:

Parameters:: vertexCount - the number of vertex elements in this GeometryArray; vertexFormat - a mask indicating which components are present in each vertex. This is specified as one or more individual flags that are bitwise "OR"ed together to describe the per-vertex data. The flags include: COORDINATES, to signal the inclusion of vertex positions--always present; NORMALS, to signal the inclusion of per vertex normals; one of COLOR_3 or COLOR_4, to signal the inclusion of per vertex colors (without or with alpha information); one of TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3, to signal the inclusion of per-vertex texture coordinates (2D or 3D); BY_REFERENCE, to indicate that the data is passed by reference rather than by copying; INTERLEAVED, to indicate that the referenced data is interleaved in a single array.
Throws:: java.lang.IllegalArgumentException - if vertexCount < 0, if vertexFormat does NOT include COORDINATES, or if the INTERLEAVED bit is set without the BY_REFERENCE bit being set.

GeometryArray

public GeometryArray(int vertexCount,
                     int vertexFormat,
                     int texCoordSetCount,
                     int[] texCoordSetMap)

Constructs an empty GeometryArray object with the specified number of vertices, vertex format, number of texture coordinate sets, and texture coordinate mapping array. Defaults are used for all other parameters.

Parameters:

vertexCount - the number of vertex elements in this GeometryArray

vertexFormat - a mask indicating which components are present in each vertex. This is specified as one or more individual flags that are bitwise "OR"ed together to describe the per-vertex data. The flags include: COORDINATES, to signal the inclusion of vertex positions--always present; NORMALS, to signal the inclusion of per vertex normals; one of COLOR_3 or COLOR_4, to signal the inclusion of per vertex colors (without or with alpha information); one of TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3, to signal the inclusion of per-vertex texture coordinates (2D or 3D); BY_REFERENCE, to indicate that the data is passed by reference rather than by copying; INTERLEAVED, to indicate that the referenced data is interleaved in a single array.

texCoordSetCount - the number of texture coordinate sets in this GeometryArray object. If vertexFormat does not include one of TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3, the texCoordSetCount parameter is not used.

texCoordSetMap - an array that maps texture coordinate sets to texture units. The array is indexed by texture unit number for each texture unit in the associated Appearance object. The values in the array specify the texture coordinate set within this GeometryArray object that maps to the corresponding texture unit. All elements within the array must be less than texCoordSetCount. A negative value specifies that no texture coordinate set maps to the texture unit corresponding to the index. If there are more texture units in any associated Appearance object than elements in the mapping array, the extra elements are assumed to be -1. The same texture coordinate set may be used for more than one texture unit. Each texture unit in every associated Appearance must have a valid source of texture coordinates: either a non-negative texture coordinate set must be specified in the mapping array or texture coordinate generation must be enabled. Texture coordinate generation will take precedence for those texture units for which a texture coordinate set is specified and texture coordinate generation is enabled. If vertexFormat does not include one of TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3, the texCoordSetMap array is not used. The following example illustrates the use of the texCoordSetMap array.

Index	Element	Description
0	1	Use tex coord set 1 for tex unit 0
1	-1	Use no tex coord set for tex unit 1
2	0	Use tex coord set 0 for tex unit 2
3	1	Reuse tex coord set 1 for tex unit 3

Throws:

java.lang.IllegalArgumentException - if vertexCount < 0, if vertexFormat does NOT include COORDINATES, if the INTERLEAVED bit is set without the BY_REFERENCE bit being set, if texCoordSetCount < 0, or if any element in texCoordSetMap[] >= texCoordSetCount.

Since:

Java 3D 1.2

Method Detail

getVertexCount

public int getVertexCount()

Retrieves the number of vertices in this GeometryArray

Returns:: number of vertices in this GeometryArray
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph

getVertexFormat

public int getVertexFormat()

Retrieves the vertexFormat of this GeometryArray

Returns:: format of vertices in this GeometryArray
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph

getTexCoordSetCount

public int getTexCoordSetCount()

Retrieves the number of texture coordinate sets in this GeometryArray object.

Returns:: the number of texture coordinate sets in this GeometryArray object
Since:: Java 3D 1.2

getTexCoordSetMapLength

public int getTexCoordSetMapLength()

Retrieves the length of the texture coordinate set mapping array of this GeometryArray object.

Returns:: the length of the texture coordinate set mapping array of this GeometryArray object
Since:: Java 3D 1.2

getTexCoordSetMap

public void getTexCoordSetMap(int[] texCoordSetMap)

Retrieves the texture coordinate set mapping array from this GeometryArray object.

Parameters:: texCoordSetMap - an array that will receive a copy of the texture coordinate set mapping array. The array must be large enough to hold all entries of the texture coordinate set mapping array.
Since:: Java 3D 1.2

updateData

public void updateData(GeometryUpdater updater)

Updates geometry array data that is accessed by reference. This method calls the updateData method of the specified GeometryUpdater object to synchronize updates to vertex data that is referenced by this GeometryArray object. Applications that wish to modify such data must perform all updates via this method.

This method may also be used to atomically set multiple references (e.g., to coordinate and color arrays) or atomically change multiple data values through the geometry data copying methods.

Parameters:: updater - object whose updateData callback method will be called to update the data referenced by this GeometryArray.
Throws:: CapabilityNotSetException - if the appropriate capability is not set, the vertex data mode is BY_REFERENCE, and this object is part of a live or compiled scene graph
Since:: Java 3D 1.2

setValidVertexCount

public void setValidVertexCount(int validVertexCount)

Sets the valid vertex count for this GeometryArray object. This count specifies the number of vertices actually used in rendering or other operations such as picking and collision. This attribute is initialized to vertexCount.

Parameters:

validVertexCount - the new valid vertex count.

Throws:

CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph

java.lang.IllegalArgumentException - if any of the following are true:

validVertexCount < 0

initialVertexIndex + validVertexCount > vertexCount

initialCoordIndex + validVertexCount > vertexCount

initialColorIndex + validVertexCount > vertexCount

initialNormalIndex + validVertexCount > vertexCount

initialTexCoordIndex + validVertexCount > vertexCount

Since:

Java 3D 1.2

getValidVertexCount

public int getValidVertexCount()

Gets the valid vertex count for this GeometryArray object.

Returns:: the current valid vertex count for this GeometryArray object.
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph
Since:: Java 3D 1.2

setInitialVertexIndex

public void setInitialVertexIndex(int initialVertexIndex)

Sets the initial vertex index for this GeometryArray object. This index specifies the first vertex within this geometry array that is actually used in rendering or other operations such as picking and collision. This attribute is initialized to 0. This attribute is only used when the data mode for this geometry array object is not BY_REFERENCE.

Parameters:: initialVertexIndex - the new initial vertex index.
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalArgumentException - if initialVertexIndex < 0 or initialVertexIndex + validVertexCount > vertexCount; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.
Since:: Java 3D 1.2

getInitialVertexIndex

public int getInitialVertexIndex()

Gets the initial vertex index for this GeometryArray object. This attribute is only used when the data mode for this geometry array object is not BY_REFERENCE.

Returns:: the current initial vertex index for this GeometryArray object.
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph
Since:: Java 3D 1.2

setCoordinate

public void setCoordinate(int index,
                          float[] coordinate)

Sets the coordinate associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; coordinate - source array of 3 values containing the new coordinate
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinate

public void setCoordinate(int index,
                          double[] coordinate)

Sets the coordinate associated with the vertex at the specified index.

Parameters:: index - destination vertex index in this geometry array; coordinate - source array of 3 values containing the new coordinate
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinate

public void setCoordinate(int index,
                          Point3f coordinate)

Sets the coordinate associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; coordinate - a point containing the new coordinate
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinate

public void setCoordinate(int index,
                          Point3d coordinate)

Sets the coordinate associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; coordinate - a point containing the new coordinate
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           float[] coordinates)

Sets the coordinates associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of 3*n values containing n new coordinates
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           double[] coordinates)

Sets the coordinates associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of 3*n values containing n new coordinates
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           Point3f[] coordinates)

Sets the coordinates associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of points containing new coordinates
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           Point3d[] coordinates)

Sets the coordinates associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of points containing new coordinates
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           float[] coordinates,
                           int start,
                           int length)

Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of 3*n values containing n new coordinates; start - starting source vertex index in coordinates array.; length - number of vertices to be copied.
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           double[] coordinates,
                           int start,
                           int length)

Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of 3*n values containing n new coordinates; start - starting source vertex index in coordinates array.; length - number of vertices to be copied.
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           Point3f[] coordinates,
                           int start,
                           int length)

Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of points containing new coordinates; start - starting source vertex index in coordinates array.; length - number of vertices to be copied.
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setCoordinates

public void setCoordinates(int index,
                           Point3d[] coordinates,
                           int start,
                           int length)

Sets the coordinates associated with the vertices starting at the specified index for this object using coordinate data starting from vertex index start for length vertices.

Parameters:: index - starting destination vertex index in this geometry array; coordinates - source array of points containing new coordinates; start - starting source vertex index in coordinates array.; length - number of vertices to be copied.
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setColor

public void setColor(int index,
                     float[] color)

Sets the color associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; color - source array of 3 or 4 values containing the new color
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setColor

public void setColor(int index,
                     byte[] color)

Sets the color associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; color - source array of 3 or 4 values containing the new color
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setColor

public void setColor(int index,
                     Color3f color)

Sets the color associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; color - a Color3f containing the new color
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_4 is specified in the vertex format

setColor

public void setColor(int index,
                     Color4f color)

Sets the color associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; color - a Color4f containing the new color
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_3 is specified in the vertex format

setColor

public void setColor(int index,
                     Color3b color)

Sets the color associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; color - a Color3b containing the new color
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_4 is specified in the vertex format

setColor

public void setColor(int index,
                     Color4b color)

Sets the color associated with the vertex at the specified index for this object.

Parameters:: index - destination vertex index in this geometry array; color - a Color4b containing the new color
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_3 is specified in the vertex format

setColors

public void setColors(int index,
                      float[] colors)

Sets the colors associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; colors - source array of 3*n or 4*n values containing n new colors
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setColors

public void setColors(int index,
                      byte[] colors)

Sets the colors associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; colors - source array of 3*n or 4*n values containing n new colors
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.

setColors

public void setColors(int index,
                      Color3f[] colors)

Sets the colors associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; colors - source array of Color3f objects containing new colors
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_4 is specified in vertex format

setColors

public void setColors(int index,
                      Color4f[] colors)

Sets the colors associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; colors - source array of Color4f objects containing new colors
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_3 is specified in vertex format

setColors

public void setColors(int index,
                      Color3b[] colors)

Sets the colors associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; colors - source array of Color3b objects containing new colors
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_4 is specified in vertex format

setColors

public void setColors(int index,
                      Color4b[] colors)

Sets the colors associated with the vertices starting at the specified index for this object. The entire source array is copied to this geometry array.

Parameters:: index - starting destination vertex index in this geometry array; colors - source array of Color4b objects containing new colors
Throws:: CapabilityNotSetException - if the appropriate capability is not set and this object is part of a live or compiled scene graph; ArrayIndexOutOfBoundsException - if COLOR bit NOT set in constructor vertexFormat or array index for element is out of bounds.; java.lang.IllegalStateException - if the data mode for this geometry array object is BY_REFERENCE.; java.lang.IllegalStateException - if COLOR_3 is specified in vertex format