Package gov.nasa.worldwind.util.glu

Class GLU

  • public class GLU
extends java.lang.Object
    Provides access to the OpenGL Utility Library (GLU). This library provides standard methods for setting up view volumes, building mipmaps and performing other common operations. The GLU NURBS routines are not currently exposed.
    Notes from the Reference Implementation for this class: Thanks to the contributions of many individuals, this class is a pure Java port of SGI's original C sources. All of the projection, mipmap, scaling, and tessellation routines that are exposed are compatible with the GLU 1.3 specification. The GLU NURBS routines are not currently exposed.

    • Constructor Detail

      • GLU

        public GLU()

    • Method Detail

      • gluErrorString

        public static java.lang.String gluErrorString​(int errorCode)

      • gluNewTess

        public static GLUtessellator gluNewTess()
        gluNewTess creates and returns a new tessellation object. This object must be referred to when calling tesselation methods. A return value of null means that there was not enough memeory to allocate the object.
        Returns:
        A new tessellation object.
        See Also:
        gluTessBeginPolygon, gluDeleteTess, gluTessCallback

      • gluDeleteTess

        public static void gluDeleteTess​(GLUtessellator tessellator)
        gluDeleteTess destroys the indicated tessellation object (which was created with gluNewTess).
        Parameters:
        tessellator - Specifies the tessellation object to destroy.
        See Also:
        gluNewTess, gluTessCallback

      • gluTessProperty

        public static void gluTessProperty​(GLUtessellator tessellator,
                                   int which,
                                   double value)
        gluTessProperty is used to control properites stored in a tessellation object. These properties affect the way that the polygons are interpreted and rendered. The legal value for which are as follows:
        • GLU_TESS_WINDING_RULE
          Determines which parts of the polygon are on the "interior". value may be set to one of
          GLU_TESS_WINDING_ODD,
          GLU_TESS_WINDING_NONZERO,
          GLU_TESS_WINDING_POSITIVE, or
          GLU_TESS_WINDING_NEGATIVE, or
          GLU_TESS_WINDING_ABS_GEQ_TWO.
          To understand how the winding rule works, consider that the input contours partition the plane into regions. The winding rule determines which of these regions are inside the polygon.
          For a single contour C, the winding number of a point x is simply the signed number of revolutions we make around x as we travel once around C (where CCW is positive). When there are several contours, the individual winding numbers are summed. This procedure associates a signed integer value with each point x in the plane. Note that the winding number is the same for all points in a single region.
          The winding rule classifies a region as "inside" if its winding number belongs to the chosen category (odd, nonzero, positive, negative, or absolute value of at least two). The previous GLU tessellator (prior to GLU 1.2) used the "odd" rule. The "nonzero" rule is another common way to define the interior. The other three rules are useful for polygon CSG operations.
        • GLU_TESS_BOUNDARY_ONLY
          Is a boolean value ("value" should be set to GL_TRUE or GL_FALSE). When set to GL_TRUE, a set of closed contours separating the polygon interior and exterior are returned instead of a tessellation. Exterior contours are oriented CCW with respect to the normal; interior contours are oriented CW. The GLU_TESS_BEGIN and GLU_TESS_BEGIN_DATA callbacks use the type GL_LINE_LOOP for each contour.
        • GLU_TESS_TOLERANCE
          Specifies a tolerance for merging features to reduce the size of the output. For example, two vertices that are very close to each other might be replaced by a single vertex. The tolerance is multiplied by the largest coordinate magnitude of any input vertex; this specifies the maximum distance that any feature can move as the result of a single merge operation. If a single feature takes part in several merge operations, the toal distance moved could be larger.
          Feature merging is completely optional; the tolerance is only a hint. The implementation is free to merge in some cases and not in others, or to never merge features at all. The initial tolerance is 0.
          The current implementation merges vertices only if they are exactly coincident, regardless of the current tolerance. A vertex is spliced into an edge only if the implementation is unable to distinguish which side of the edge the vertex lies on. Two edges are merged only when both endpoints are identical.
        Parameters:
        tessellator - Specifies the tessellation object created with gluNewTess
        which - Specifies the property to be set. Valid values are GLU_TESS_WINDING_RULE, GLU_TESS_BOUNDARDY_ONLY, GLU_TESS_TOLERANCE.
        value - Specifices the value of the indicated property.
        See Also:
        gluGetTessProperty, gluNewTess

      • gluGetTessProperty

        public static void gluGetTessProperty​(GLUtessellator tessellator,
                                      int which,
                                      double[] value,
                                      int value_offset)
        gluGetTessProperty retrieves properties stored in a tessellation object. These properties affect the way that tessellation objects are interpreted and rendered. See the gluTessProperty reference page for information about the properties and what they do.
        Parameters:
        tessellator - Specifies the tessellation object (created with gluNewTess).
        which - Specifies the property whose value is to be fetched. Valid values are GLU_TESS_WINDING_RULE, GLU_TESS_BOUNDARY_ONLY, and GLU_TESS_TOLERANCES.
        value - Specifices an array into which the value of the named property is written.
        See Also:
        gluNewTess, gluTessProperty

      • gluTessNormal

        public static void gluTessNormal​(GLUtessellator tessellator,
                                 double x,
                                 double y,
                                 double z)
        gluTessNormal describes a normal for a polygon that the program is defining. All input data will be projected onto a plane perpendicular to the one of the three coordinate axes before tessellation and all output triangles will be oriented CCW with repsect to the normal (CW orientation can be obtained by reversing the sign of the supplied normal). For example, if you know that all polygons lie in the x-y plane, call gluTessNormal(tess, 0.0, 0.0, 0.0) before rendering any polygons.
        If the supplied normal is (0.0, 0.0, 0.0)(the initial value), the normal is determined as follows. The direction of the normal, up to its sign, is found by fitting a plane to the vertices, without regard to how the vertices are connected. It is expected that the input data lies approximately in the plane; otherwise, projection perpendicular to one of the three coordinate axes may substantially change the geometry. The sign of the normal is chosen so that the sum of the signed areas of all input contours is nonnegative (where a CCW contour has positive area).
        The supplied normal persists until it is changed by another call to gluTessNormal.
        Parameters:
        tessellator - Specifies the tessellation object (created by gluNewTess).
        x - Specifies the first component of the normal.
        y - Specifies the second component of the normal.
        z - Specifies the third component of the normal.
        See Also:
        gluTessBeginPolygon, gluTessEndPolygon

      • gluTessCallback

        public static void gluTessCallback​(GLUtessellator tessellator,
                                   int which,
                                   GLUtessellatorCallback aCallback)
        gluTessCallback is used to indicate a callback to be used by a tessellation object. If the specified callback is already defined, then it is replaced. If aCallback is null, then the existing callback becomes undefined.
        These callbacks are used by the tessellation object to describe how a polygon specified by the user is broken into triangles. Note that there are two versions of each callback: one with user-specified polygon data and one without. If both versions of a particular callback are specified, then the callback with user-specified polygon data will be used. Note that the polygonData parameter used by some of the methods is a copy of the reference that was specified when gluTessBeginPolygon was called. The legal callbacks are as follows:
        • GLU_TESS_BEGIN
          The begin callback is invoked like glBegin to indicate the start of a (triangle) primitive. The method takes a single argument of type int. If the GLU_TESS_BOUNDARY_ONLY property is set to GL_FALSE, then the argument is set to either GL_TRIANGLE_FAN, GL_TRIANGLE_STRIP, or GL_TRIANGLES. If the GLU_TESS_BOUNDARY_ONLY property is set to GL_TRUE, then the argument will be set to GL_LINE_LOOP. The method prototype for this callback is: 
          void begin(int type);
        • GLU_TESS_BEGIN_DATA
          The same as the GLU_TESS_BEGIN callback except that it takes an additional reference argument. This reference is identical to the opaque reference provided when gluTessBeginPolygon was called. The method prototype for this callback is: 
          void beginData(int type, Object polygonData);
        • GLU_TESS_EDGE_FLAG
          The edge flag callback is similar to glEdgeFlag. The method takes a single boolean boundaryEdge that indicates which edges lie on the polygon boundary. If the boundaryEdge is GL_TRUE, then each vertex that follows begins an edge that lies on the polygon boundary, that is, an edge that separates an interior region from an exterior one. If the boundaryEdge is GL_FALSE, then each vertex that follows begins an edge that lies in the polygon interior. The edge flag callback (if defined) is invoked before the first vertex callback.
          Since triangle fans and triangle strips do not support edge flags, the begin callback is not called with GL_TRIANGLE_FAN or GL_TRIANGLE_STRIP if a non-null edge flag callback is provided. (If the callback is initialized to null, there is no impact on performance). Instead, the fans and strips are converted to independent triangles. The method prototype for this callback is: 
          void edgeFlag(boolean boundaryEdge);
        • GLU_TESS_EDGE_FLAG_DATA
          The same as the GLU_TESS_EDGE_FLAG callback except that it takes an additional reference argument. This reference is identical to the opaque reference provided when gluTessBeginPolygon was called. The method prototype for this callback is: 
          void edgeFlagData(boolean boundaryEdge, Object polygonData);
        • GLU_TESS_VERTEX
          The vertex callback is invoked between the begin and end callbacks. It is similar to glVertex3f, and it defines the vertices of the triangles created by the tessellation process. The method takes a reference as its only argument. This reference is identical to the opaque reference provided by the user when the vertex was described (see gluTessVertex). The method prototype for this callback is: 
          void vertex(Object vertexData);
        • GLU_TESS_VERTEX_DATA
          The same as the GLU_TESS_VERTEX callback except that it takes an additional reference argument. This reference is identical to the opaque reference provided when gluTessBeginPolygon was called. The method prototype for this callback is: 
          void vertexData(Object vertexData, Object polygonData);
        • GLU_TESS_END
          The end callback serves the same purpose as glEnd. It indicates the end of a primitive and it takes no arguments. The method prototype for this callback is: 
          void end();
        • GLU_TESS_END_DATA
          The same as the GLU_TESS_END callback except that it takes an additional reference argument. This reference is identical to the opaque reference provided when gluTessBeginPolygon was called. The method prototype for this callback is: 
          void endData(Object polygonData);
        • GLU_TESS_COMBINE
          The combine callback is called to create a new vertex when the tessellation detects an intersection, or wishes to merge features. The method takes four arguments: an array of three elements each of type double, an array of four references, an array of four elements each of type float, and a reference to a reference. The prototype is: 
          void combine(double[] coords, Object[] data,
                      float[] weight, Object[] outData);
          The vertex is defined as a linear combination of up to four existing vertices, stored in data. The coefficients of the linear combination are given by weight; these weights always add up to 1. All vertex pointers are valid even when some of the weights are 0. coords gives the location of the new vertex.
          The user must allocate another vertex, interpolate parameters using data and weight, and return the new vertex pointer in outData. This handle is supplied during rendering callbacks. The user is responsible for freeing the memory some time after gluTessEndPolygon is called.
          For example, if the polygon lies in an arbitrary plane in 3-space, and a color is associated with each vertex, the GLU_TESS_COMBINE callback might look like this: 
                   void myCombine(double[] coords, Object[] data,
                        float[] weight, Object[] outData)
         {
            MyVertex newVertex = new MyVertex();

            newVertex.x = coords[0];
            newVertex.y = coords[1];
            newVertex.z = coords[2];
            newVertex.r = weight[0]*data[0].r +
                          weight[1]*data[1].r +
                          weight[2]*data[2].r +
                          weight[3]*data[3].r;
            newVertex.g = weight[0]*data[0].g +
                          weight[1]*data[1].g +
                          weight[2]*data[2].g +
                          weight[3]*data[3].g;
            newVertex.b = weight[0]*data[0].b +
                          weight[1]*data[1].b +
                          weight[2]*data[2].b +
                          weight[3]*data[3].b;
            newVertex.a = weight[0]*data[0].a +
                          weight[1]*data[1].a +
                          weight[2]*data[2].a +
                          weight[3]*data[3].a;
            outData = newVertex;
         }
          If the tessellation detects an intersection, then the GLU_TESS_COMBINE or GLU_TESS_COMBINE_DATA callback (see below) must be defined, and it must write a non-null reference into outData. Otherwise the GLU_TESS_NEED_COMBINE_CALLBACK error occurs, and no output is generated.
        • GLU_TESS_COMBINE_DATA
          The same as the GLU_TESS_COMBINE callback except that it takes an additional reference argument. This reference is identical to the opaque reference provided when gluTessBeginPolygon was called. The method prototype for this callback is: 
                   void combineData(double[] coords, Object[] data,
                              float[] weight, Object[] outData,
                              Object polygonData);
        • GLU_TESS_ERROR
          The error callback is called when an error is encountered. The one argument is of type int; it indicates the specific error that occurred and will be set to one of GLU_TESS_MISSING_BEGIN_POLYGON, GLU_TESS_MISSING_END_POLYGON, GLU_TESS_MISSING_BEGIN_CONTOUR, GLU_TESS_MISSING_END_CONTOUR, GLU_TESS_COORD_TOO_LARGE, GLU_TESS_NEED_COMBINE_CALLBACK or GLU_OUT_OF_MEMORY. Character strings describing these errors can be retrieved with the gluErrorString call. The method prototype for this callback is: 
                   void error(int errnum);
          The GLU library will recover from the first four errors by inserting the missing call(s). GLU_TESS_COORD_TOO_LARGE indicates that some vertex coordinate exceeded the predefined constant GLU_TESS_MAX_COORD in absolute value, and that the value has been clamped. (Coordinate values must be small enough so that two can be multiplied together without overflow.) GLU_TESS_NEED_COMBINE_CALLBACK indicates that the tessellation detected an intersection between two edges in the input data, and the GLU_TESS_COMBINE or GLU_TESS_COMBINE_DATA callback was not provided. No output is generated. GLU_OUT_OF_MEMORY indicates that there is not enough memory so no output is generated.
        • GLU_TESS_ERROR_DATA
          The same as the GLU_TESS_ERROR callback except that it takes an additional reference argument. This reference is identical to the opaque reference provided when gluTessBeginPolygon was called. The method prototype for this callback is: 
                   void errorData(int errnum, Object polygonData);
        Parameters:
        tessellator - Specifies the tessellation object (created with gluNewTess).
        which - Specifies the callback being defined. The following values are valid: GLU_TESS_BEGIN, GLU_TESS_BEGIN_DATA, GLU_TESS_EDGE_FLAG, GLU_TESS_EDGE_FLAG_DATA, GLU_TESS_VERTEX, GLU_TESS_VERTEX_DATA, GLU_TESS_END, GLU_TESS_END_DATA, GLU_TESS_COMBINE, GLU_TESS_COMBINE_DATA, GLU_TESS_ERROR, and GLU_TESS_ERROR_DATA.
        aCallback - Specifies the callback object to be called.
        See Also:
        gluNewTess, gluErrorString, gluTessVertex, gluTessBeginPolygon, gluTessBeginContour, gluTessProperty, gluTessNormal

      • gluTessVertex

        public static void gluTessVertex​(GLUtessellator tessellator,
                                 double[] coords,
                                 int coords_offset,
                                 java.lang.Object data)
        gluTessVertex describes a vertex on a polygon that the program defines. Successive gluTessVertex calls describe a closed contour. For example, to describe a quadrilateral gluTessVertex should be called four times. gluTessVertex can only be called between gluTessBeginContour and gluTessEndContour.
        data normally references to a structure containing the vertex location, as well as other per-vertex attributes such as color and normal. This reference is passed back to the user through the GLU_TESS_VERTEX or GLU_TESS_VERTEX_DATA callback after tessellation (see the gluTessCallback reference page).
        Parameters:
        tessellator - Specifies the tessellation object (created with gluNewTess).
        coords - Specifies the coordinates of the vertex.
        data - Specifies an opaque reference passed back to the program with the vertex callback (as specified by gluTessCallback).
        See Also:
        gluTessBeginPolygon, gluNewTess, gluTessBeginContour, gluTessCallback, gluTessProperty, gluTessNormal, gluTessEndPolygon