ffp

Class FFPAUX

java.lang.Object

ffp.FFPAUX

All Implemented Interfaces:

FFPC

public final class FFPAUX
extends java.lang.Object
implements FFPC

An auxiliary class filled with utilities.

Field Summary

Fields inherited from interface ffp.FFPC

FFP_ACCUM, FFP_ACCUM_BUFFER, FFP_ADD, FFP_ALPHA_TEST, FFP_AMBIENT, FFP_AMBIENT_AND_DIFFUSE, FFP_ARGB, FFP_BACK, FFP_BILINEAR, FFP_CLIP_PLANE0, FFP_CLIP_PLANE1, FFP_CLIP_PLANE2, FFP_CLIP_PLANE3, FFP_CLIP_PLANE4, FFP_CLIP_PLANE5, FFP_COLOR_MATERIAL, FFP_COLORMAP, FFP_CONSTANT_ATTENUATION, FFP_COVERAGE_BUFFER, FFP_CULL_FACE, FFP_CURRENT_TEXTURES, FFP_DECAL, FFP_DEPTH_BUFFER, FFP_DEPTH_TEST, FFP_DIFFUSE, FFP_DITHER, FFP_DM_TEXTURE_2D, FFP_DM_TEXTURE_MATRIX, FFP_DM_TEXTURE_STACK_DEPTH, FFP_EMISSION, FFP_FALSE, FFP_FILL, FFP_FLAT, FFP_FOG, FFP_FRAME_POLYGON_COUNT, FFP_FRONT, FFP_FRONT_AND_BACK, FFP_GOURAUD, FFP_ID_BUFFER, FFP_INVALID_OPERATION, FFP_INVALID_PARAM, FFP_INVALID_VALUE, FFP_LIGHT_MODEL_AMBIENT, FFP_LIGHT_MODEL_LOCAL_VIEWER, FFP_LIGHT_MODEL_RGB, FFP_LIGHT_MODEL_TWO_SIDE, FFP_LIGHTING, FFP_LINE, FFP_LINE_LOOP, FFP_LINE_STIPPLE, FFP_LINE_STIPPLE_PATTERN, FFP_LINE_STIPPLE_REPEAT, FFP_LINE_STRIP, FFP_LINEAR_ATTENUATION, FFP_LINES, FFP_LOAD, FFP_MATRIX_MODE, FFP_MAX_ALLOCATED_TEXTURES, FFP_MAX_DM_TEXTURE_STACK_DEPTH, FFP_MAX_LIGHTS, FFP_MAX_MODELVIEW_STACK_DEPTH, FFP_MAX_PROJECTION_STACK_DEPTH, FFP_MAX_TEXTURE_SIZE, FFP_MAX_TEXTURE_STACK_DEPTH, FFP_MIX, FFP_MODELVIEW, FFP_MODELVIEW_MATRIX, FFP_MODELVIEW_STACK_DEPTH, FFP_MODULATE, FFP_MULT, FFP_MULTI_THREADED, FFP_NEAREST, FFP_NO_ERROR, FFP_NONE, FFP_NORMALIZE, FFP_NULL_POINTER, FFP_OUT_OF_MEMORY, FFP_PHONG, FFP_POINT, FFP_POINTS, FFP_POLYGON_MODE_BACK, FFP_POLYGON_MODE_FRONT, FFP_POLYGON_OFFSET_FILL, FFP_POLYGON_OFFSET_LINE, FFP_POLYGON_OFFSET_POINT, FFP_POLYGON_STIPPLE, FFP_POSITION, FFP_PROJECTION, FFP_PROJECTION_MATRIX, FFP_PROJECTION_STACK_DEPTH, FFP_QUAD_STRIP, FFP_QUADRATIC_ATTENUATION, FFP_QUADS, FFP_RENDER_EXCEPTION, FFP_RENDER_MODE_COVERAGE, FFP_RENDER_MODE_NORMAL, FFP_RENDER_TECHNIQUE_DEFERRED, FFP_RENDER_TECHNIQUE_FORWARD, FFP_RENDERED_POLYGON_COUNT, FFP_RENDERER, FFP_RETURN, FFP_RETURN_COLOR_VIDEO, FFP_RETURN_DEPTH_VIDEO, FFP_RGB, FFP_SHADE_MODEL, FFP_SHININESS, FFP_SINGLE_THREADED, FFP_SMOOTH, FFP_SMOOTH_MODEL, FFP_SPECULAR, FFP_SPOT_CUTOFF, FFP_SPOT_DIRECTION, FFP_SPOT_EXPONENT, FFP_STACK_OVERFLOW, FFP_STACK_UNDERFLOW, FFP_TEXTURE_2D, FFP_TEXTURE_BLOCK_FILTER, FFP_TEXTURE_ENV_MODE, FFP_TEXTURE_FILTER, FFP_TEXTURE_MATRIX, FFP_TEXTURE_SPHERE_MAP, FFP_TEXTURE_STACK_DEPTH, FFP_THREAD_COUNT_ALL, FFP_THREAD_COUNT_HALF, FFP_THREAD_COUNT_QUARTER, FFP_THREAD_COUNT_THREE_QUARTERS, FFP_TRIANGLE_FAN, FFP_TRIANGLE_STRIP, FFP_TRIANGLES, FFP_TRUE, FFP_VENDOR, FFP_VERSION, FFP_VIDEO_BLEND_STIPPLED_REGIONS, FFP_VIDEO_BUFFER, FFP_VIDEO_COLOR_DITHER, FFP_VIDEO_DITHER_MATRIX, FFP_VIDEO_DITHER_MATRIX0, FFP_VIDEO_DITHER_MATRIX1, FFP_VIDEO_DITHER_MATRIX2, FFP_VIDEO_DITHER_MATRIX3, FFP_VIDEO_GAMMA, FFP_VIDEO_THREAD_COUNT, FFP_VIEWPORT, FFPAUX_FALSE, FFPAUX_FILL, FFPAUX_FLAT, FFPAUX_INSIDE, FFPAUX_LINE, FFPAUX_NONE, FFPAUX_OUTSIDE, FFPAUX_POINT, FFPAUX_SILHOUETTE, FFPAUX_SMOOTH, FFPAUX_TRUE

Constructor Summary

Constructors

Constructor and Description
FFPAUX(FFP ffp)

Method Summary

Modifier and Type	Method and Description
void	auxCone(float baseRadius, float height, int slices, int stacks, int draw_param, int orientation_param, int shade_type_param, int tex_coords_param) Generates a cone.
void	auxCylinder(float baseRadius, float topRadius, float height, int slices, int stacks, int draw_param, int orientation_param, int shade_type_param, int tex_coords_param) Generates a cylinder.
void	auxDisk(float innerRadius, float outerRadius, int slices, int loops, int draw_param, int orientation_param, int shade_type_param, int tex_coords_param) Generates a full disk.
static float[]	auxFaceNormal333fv(float[] v1, float[] v2, float[] v3) Creates the normal of the plane defined by three vectors.
static void	auxFaceNormal333fv(float[] v1, float[] v2, float[] v3, float[] dest) Creates the normal of the plane defined by three vectors.
void	auxLookAt(float eyex, float eyey, float eyez, float centerx, float centery, float centerz, float upx, float upy, float upz) Multiply a viewing transformation onto the current matrix stack that is at the position (eyex,eyey,eyez), looking at (centerx,centery,centerz) with the up vector (upx,upy,upz)
void	auxOrtho2D(float left, float right, float bottom, float top) Defines a 2D orthographic projection.
void	auxPartialDisk(float innerRadius, float outerRadius, int slices, int loops, float startAngle, float sweepAngle, int draw_param, int orientation_param, int shade_type_param, int tex_coords_param) Generates a partial disk.
void	auxPerspective(float fov, float aspect, float zNear, float zFar) Defines a perspective projection matrix.
void	auxPickMatrix(float x, float y, float width, float height, int[] viewport) Defines a projection matrix that fills the entire viewport with the given rectangular region of the screen.
int	auxProject(float objx, float objy, float objz, float[] model, float[] proj, int[] viewport, float[] win) Projects a 3D point onto the window.
void	auxSolidCone(float baseRadius, float height, int slices, int stacks) Generates a solid cone.
void	auxSolidCube(float size) Generates a solid cube.
void	auxSolidDodecahedron() Generates a solid dodecahedron.
void	auxSolidIcosahedron() Generates a solid icosahedron.
void	auxSolidOctahedron() Generates a solid octahedron.
void	auxSolidSphere(float radius) Generates a solid sphere.
void	auxSolidSphere(float radius, int slices, int stacks) Generates a solid sphere.
void	auxSolidTetrahedron() Generates a solid tetrahedron.
void	auxSolidTorus(float innerRadius, float outerRadius) Generates a solid 3D torus.
void	auxSolidTorus(float innerRadius, float outerRadius, int nsides, int rings) Generates a solid 3D torus.
void	auxSphere(float radius, int slices, int stacks, int draw_param, int orientation_param, int shade_type_param, int tex_coords_param) Generates a sphere.
int	auxUnProject(float winx, float winy, float winz, float[] model, float[] proj, int[] viewport, float[] obj) Given a point on the window and a depth value, find out the 3D point in object coordinates that was mapped to that pixel.
void	auxWireCone(float baseRadius, float height, int slices, int stacks) Generates a wireframe cone.
void	auxWireCube(float size) Generates a wireframe cube.
void	auxWireDodecahedron() Generates a wireframe dodecahedron.
void	auxWireIcosahedron() Generates a wireframe icosahedron.
void	auxWireOctahedron() Generates a wireframe octahedron.
void	auxWireSphere(float radius) Generates a wireframe sphere.
void	auxWireSphere(float radius, int slices, int stacks) Generates a wireframe sphere.
void	auxWireTetrahedron() Generates a wireframe tetrahedron.
void	auxWireTorus(float innerRadius, float outerRadius) Generates a wireframe 3D torus.
void	auxWireTorus(float innerRadius, float outerRadius, int nsides, int rings) Generates a wireframe 3D torus.

Methods inherited from class java.lang.Object

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

Constructor Detail

FFPAUX

public FFPAUX(FFP ffp)

Method Detail

auxWireTorus

public void auxWireTorus(float innerRadius,
                         float outerRadius)

Generates a wireframe 3D torus.

Convenience method that calls auxSolidTorus(float, float, int, int) with default parameters.

Parameters:

innerRadius - the radius of the inner ring

outerRadius - the radius of the outer ring

Since:

1.0.4

auxSolidTorus

public void auxSolidTorus(float innerRadius,
                          float outerRadius)

Generates a solid 3D torus.

Convenience method that calls auxSolidTorus(float, float, int, int) with default parameters.

Parameters:

innerRadius - the radius of the inner ring

outerRadius - the radius of the outer ring

Since:

1.0.4

auxWireTorus

public void auxWireTorus(float innerRadius,
                         float outerRadius,
                         int nsides,
                         int rings)

Generates a wireframe 3D torus.

Parameters:

innerRadius - the radius of the inner ring

outerRadius - the radius of the outer ring

nsides - the number of sides

rings - the number of rings

Since:

1.0.0

auxSolidTorus

public void auxSolidTorus(float innerRadius,
                          float outerRadius,
                          int nsides,
                          int rings)

Generates a solid 3D torus.

Parameters:

innerRadius - the radius of the inner ring

outerRadius - the radius of the outer ring

nsides - the number of sides

rings - the number of rings

Since:

1.0.0

auxWireSphere

public void auxWireSphere(float radius)

Generates a wireframe sphere.

Convenience method that calls auxSphere() with default parameters.

Parameters:

radius - the radius of the sphere

Since:

1.0.0

See Also:

auxSphere(float, int, int, int, int, int, int)

auxSolidSphere

public void auxSolidSphere(float radius)

Generates a solid sphere.

Convenience method that calls auxSphere() with default parameters.

Parameters:

radius - the radius of the sphere

Since:

1.0.0

See Also:

auxSphere(float, int, int, int, int, int, int)

auxWireSphere

public void auxWireSphere(float radius,
                          int slices,
                          int stacks)

Generates a wireframe sphere.

Convenience method that calls auxSphere() with default parameters.

Parameters:

radius - the radius of the sphere

slices - the number of slices

stacks - the number of stacks

Since:

1.0.0

See Also:

auxSphere(float, int, int, int, int, int, int)

auxSolidSphere

public void auxSolidSphere(float radius,
                           int slices,
                           int stacks)

Generates a solid sphere.

Convenience method that calls auxSphere() with default parameters.

Parameters:

radius - the radius of the sphere

slices - the number of slices

stacks - the number of stacks

Since:

1.0.0

See Also:

auxSphere(float, int, int, int, int, int, int)

auxWireCone

public void auxWireCone(float baseRadius,
                        float height,
                        int slices,
                        int stacks)

Generates a wireframe cone.

Convenience method that calls auxCone(float, float, int, int, int, int, int, int) with default parameters.

Parameters:

baseRadius - the radius of the bottom of the cone

height - the height of the cone

slices - the number of slices

stacks - the number of stacks

Since:

1.0.0

See Also:

auxCone(float, float, int, int, int, int, int, int)

auxSolidCone

public void auxSolidCone(float baseRadius,
                         float height,
                         int slices,
                         int stacks)

Generates a solid cone.

Convenience method that calls auxCone(float, float, int, int, int, int, int, int) with default parameters.

Parameters:

baseRadius - the radius of the bottom of the cone

slices - the number of slices

height - the height of the cone

stacks - the number of stacks

Since:

1.0.0

See Also:

auxCone(float, float, int, int, int, int, int, int)

auxWireCube

public void auxWireCube(float size)

Generates a wireframe cube.

Parameters:

size - the size of the cube

Since:

1.0.0

auxSolidCube

public void auxSolidCube(float size)

Generates a solid cube.

Parameters:

size - the size of the cube

Since:

1.0.0

auxWireTetrahedron

public void auxWireTetrahedron()

Generates a wireframe tetrahedron.

Since:

1.0.0

auxSolidTetrahedron

public void auxSolidTetrahedron()

Generates a solid tetrahedron.

Since:

1.0.0

auxWireIcosahedron

public void auxWireIcosahedron()

Generates a wireframe icosahedron.

Since:

1.0.0

auxSolidIcosahedron

public void auxSolidIcosahedron()

Generates a solid icosahedron.

Since:

1.0.0

auxWireOctahedron

public void auxWireOctahedron()

Generates a wireframe octahedron.

Since:

1.0.0

auxSolidOctahedron

public void auxSolidOctahedron()

Generates a solid octahedron.

Since:

1.0.0

auxWireDodecahedron

public void auxWireDodecahedron()

Generates a wireframe dodecahedron.

Since:

1.0.0

auxSolidDodecahedron

public void auxSolidDodecahedron()

Generates a solid dodecahedron.

Since:

1.0.0

auxCone

public void auxCone(float baseRadius,
                    float height,
                    int slices,
                    int stacks,
                    int draw_param,
                    int orientation_param,
                    int shade_type_param,
                    int tex_coords_param)

Generates a cone.

Convenience method that calls auxCylinder() with default parameters.

Parameters:

baseRadius - radius of the base

height - height of the cylinder

slices - number of slices

stacks - number of stacks

draw_param - how to draw the object

orientation_param - how the normals should be oriented

shade_type_param - how the normals should be calculated

tex_coords_param - if texture coordinates should be calculated

Since:

1.0.0

See Also:

auxCylinder(float, float, float, int, int, int, int, int, int)

auxCylinder

public void auxCylinder(float baseRadius,
                        float topRadius,
                        float height,
                        int slices,
                        int stacks,
                        int draw_param,
                        int orientation_param,
                        int shade_type_param,
                        int tex_coords_param)

Generates a cylinder.

Parameters:

baseRadius - radius of the base

topRadius - radius of the top

height - height of the cylinder

slices - number of slices

stacks - number of stacks

draw_param - how to draw the object

orientation_param - how the normals should be oriented

shade_type_param - how the normals should be calculated

tex_coords_param - if texture coordinates should be calculated

Since:

1.0.0

auxSphere

public void auxSphere(float radius,
                      int slices,
                      int stacks,
                      int draw_param,
                      int orientation_param,
                      int shade_type_param,
                      int tex_coords_param)

Generates a sphere.

Parameters:

radius - radius of the sphere

slices - number of slices

stacks - number of stacks

draw_param - how to draw the object

orientation_param - how the normals should be oriented

shade_type_param - how the normals should be calculated

tex_coords_param - if texture coordinates should be calculated

Since:

1.0.0

auxDisk

public void auxDisk(float innerRadius,
                    float outerRadius,
                    int slices,
                    int loops,
                    int draw_param,
                    int orientation_param,
                    int shade_type_param,
                    int tex_coords_param)

Generates a full disk.

Parameters:

innerRadius - radius of the inner ring

outerRadius - radius of the outer ring

slices - number of slices

loops - number of loops

draw_param - how to draw the object

orientation_param - how the normals should be oriented

shade_type_param - how the normals should be calculated

tex_coords_param - if texture coordinates should be calculated

Since:

1.0.0

auxPartialDisk

public void auxPartialDisk(float innerRadius,
                           float outerRadius,
                           int slices,
                           int loops,
                           float startAngle,
                           float sweepAngle,
                           int draw_param,
                           int orientation_param,
                           int shade_type_param,
                           int tex_coords_param)

Generates a partial disk.

Parameters:

innerRadius - radius of the inner ring

outerRadius - radius of the outer ring

slices - number of slices

loops - number of loops

startAngle - the starting angle of the disk

sweepAngle - the sweep angle of the disk

draw_param - how to draw the object

orientation_param - how the normals should be oriented

shade_type_param - how the normals should be calculated

tex_coords_param - if texture coordinates should be calculated

Since:

1.0.0

auxFaceNormal333fv

public static float[] auxFaceNormal333fv(float[] v1,
                                         float[] v2,
                                         float[] v3)

Creates the normal of the plane defined by three vectors.

Parameters:

v1 - the 3D vector containing the first point on the plane

v2 - the 3D vector containing the second point on the plane

v3 - the 3D vector containing the third point on the plane

Returns:

a new 3D vector containing the normal created by the plane

Since:

1.0.0

auxFaceNormal333fv

public static void auxFaceNormal333fv(float[] v1,
                                      float[] v2,
                                      float[] v3,
                                      float[] dest)

Creates the normal of the plane defined by three vectors.

Parameters:

v1 - the 3D vector containing the first point on the plane

v2 - the 3D vector containing the second point on the plane

v3 - the 3D vector containing the third point on the plane

dest - the 3D output vector

Since:

1.0.0

auxOrtho2D

public void auxOrtho2D(float left,
                       float right,
                       float bottom,
                       float top)

Defines a 2D orthographic projection.

This function simply calls FFP.ffpOrtho(float, float, float, float, float, float) with -1 and 1 as the near and far parameters, respectively.

Parameters:

left - left vertical clipping plane

right - right vertical clipping plane

bottom - bottom horizontal clipping plane

top - top horizontal clipping plane

Since:

1.0.0

See Also:

FFP.ffpOrtho(float, float, float, float, float, float)

auxPerspective

public void auxPerspective(float fov,
                           float aspect,
                           float zNear,
                           float zFar)

Defines a perspective projection matrix.

Parameters:

fov - the vertical field of view, in degrees

aspect - the aspect ratio, normally defined as the ratio of the width and height

zNear - the distance of near clipping plane (must be positive)

zFar - the distance of the far clipping plane (must be positive)

Since:

1.0.0

See Also:

FFP.ffpFrustum(float, float, float, float, float, float)

auxPickMatrix

public void auxPickMatrix(float x,
                          float y,
                          float width,
                          float height,
                          int[] viewport)

Defines a projection matrix that fills the entire viewport with the given rectangular region of the screen.

Parameters:

x - the x coordinate of the rectangular region in window coordinates

y - the y coordinate of the rectangular region in window coordinates

width - the width of the rectangular region in window coordinates

height - the height of the rectangular region in window coordinates

viewport - the current viewport

Since:

1.0.0

auxProject

public int auxProject(float objx,
                      float objy,
                      float objz,
                      float[] model,
                      float[] proj,
                      int[] viewport,
                      float[] win)

Projects a 3D point onto the window.

Parameters:

objx - the x coordinate of the object

objy - the y coordinate of the object

objz - the z coordinate of the object

model - the current modelview matrix

proj - the current projection matrix

viewport - the current viewport

win - the array that is used to return the (x, y, z) values of the window coordinate

Returns:

FFP_TRUE if the projection was successful

Since:

1.0.0

auxUnProject

public int auxUnProject(float winx,
                        float winy,
                        float winz,
                        float[] model,
                        float[] proj,
                        int[] viewport,
                        float[] obj)

Given a point on the window and a depth value, find out the 3D point in object coordinates that was mapped to that pixel.

Parameters:

winx - the x coordinate of the window to be mapped

winy - the y coordinate of the window to be mapped

winz - the z coordinate of the window to be mapped (from depth buffer)

model - the current modelview matrix

proj - the current projection matrix

viewport - the current viewport

obj - the array that is used to return the (x, y, z) values of the object coordinate

Returns:

FFP_TRUE if the unprojection was successful

Since:

1.0.0

auxLookAt

public void auxLookAt(float eyex,
                      float eyey,
                      float eyez,
                      float centerx,
                      float centery,
                      float centerz,
                      float upx,
                      float upy,
                      float upz)

Multiply a viewing transformation onto the current matrix stack that is at the position (eyex,eyey,eyez), looking at (centerx,centery,centerz) with the up vector (upx,upy,upz)

Parameters:

eyex - the x coordinate of the position of the eye point

eyey - the y coordinate of the position of the eye point

eyez - the z coordinate of the position of the eye point

centerx - the x coordinate of the position to look at

centery - the y coordinate of the position to look at

centerz - the z coordinate of the position to look at

upx - the x coordinate of the direction of the up vector

upy - the y coordinate of the direction of the up vector

upz - the z coordinate of the direction of the up vector

Since:

1.0.0