j3d.org Aviatrix3D

org.j3d.aviatrix3d
Class TexCoordGeneration

java.lang.Object
  extended byorg.j3d.aviatrix3d.SceneGraphObject
      extended byorg.j3d.aviatrix3d.NodeComponent
          extended byorg.j3d.aviatrix3d.TexCoordGeneration
All Implemented Interfaces:
java.lang.Comparable

public class TexCoordGeneration
extends NodeComponent
implements java.lang.Comparable

Describes a texture's automatic texture coordinate generation.

Texture modes here directly correspond to the OpenGL constants of the same type. Either are acceptable as parameters.

Version:
$Revision: 1.8 $
Author:
Justin Couch

Field Summary
static int MAP_EYE_LINEAR
          Generate coordinates in a simple linear fashion on the eye position
static int MAP_NORMALS
          Generate coordinates using the normals at the vertex.
static int MAP_OBJECT_LINEAR
          Generate coordinates in a simple linear fashion on the object
static int MAP_REFLECTIONS
          Generate coordinates using the normals at the vertex.
static int MAP_SPHERICAL
          Generate coordinates in a spherical shape for env mapping
static int MODE_EYE_PLANE
          Generate reference plane is relative to the eye position
static int MODE_GENERIC
          Coordinate reference plane is user defined
static int MODE_OBJECT_PLANE
          Generate reference plane is relative to the object
static int TEXTURE_Q
          Generate coordinates for a texture's Q coordinate
static int TEXTURE_R
          Generate coordinates for a texture's R coordinate
static int TEXTURE_S
          Generate coordinates for a texture's S coordinate
static int TEXTURE_T
          Generate coordinates for a texture's T coordinate
 
Fields inherited from class org.j3d.aviatrix3d.NodeComponent
liveCount
 
Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject
alive, updateHandler, WRITE_TIMING_MSG
 
Constructor Summary
TexCoordGeneration()
          Constructs a TexCoordGeneration with default values, which is to say, do nothing.
TexCoordGeneration(int axis, int mode, int parameter, float[] value)
          Create automatic coordinate generation for one axis with the given set of abilities.
 
Method Summary
 int compareTo(java.lang.Object o)
          Compares this object with the specified object for order.
 int compareTo(TexCoordGeneration tcg)
          Compares this object with the specified object for order.
 void renderState(net.java.games.jogl.GL gl, net.java.games.jogl.GLU glu)
          Issue ogl commands needed for this component
 void restoreState(net.java.games.jogl.GL gl, net.java.games.jogl.GLU glu)
          Restore all openGL state to the given drawable
 void setParameter(int axis, int mode, int parameter, float[] value)
          Setup one of the axis parameters.
 
Methods inherited from class org.j3d.aviatrix3d.NodeComponent
addParent, getParents, hasChanged, numParents, removeParent
 
Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject
checkForCyclicChild, checkForCyclicParent, dataChanged, getUserData, isLive, setLive, setUpdateHandler, setUserData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TEXTURE_S

public static final int TEXTURE_S
Generate coordinates for a texture's S coordinate

See Also:
Constant Field Values

TEXTURE_T

public static final int TEXTURE_T
Generate coordinates for a texture's T coordinate

See Also:
Constant Field Values

TEXTURE_R

public static final int TEXTURE_R
Generate coordinates for a texture's R coordinate

See Also:
Constant Field Values

TEXTURE_Q

public static final int TEXTURE_Q
Generate coordinates for a texture's Q coordinate

See Also:
Constant Field Values

MODE_GENERIC

public static final int MODE_GENERIC
Coordinate reference plane is user defined

See Also:
Constant Field Values

MODE_OBJECT_PLANE

public static final int MODE_OBJECT_PLANE
Generate reference plane is relative to the object

See Also:
Constant Field Values

MODE_EYE_PLANE

public static final int MODE_EYE_PLANE
Generate reference plane is relative to the eye position

See Also:
Constant Field Values

MAP_OBJECT_LINEAR

public static final int MAP_OBJECT_LINEAR
Generate coordinates in a simple linear fashion on the object

See Also:
Constant Field Values

MAP_EYE_LINEAR

public static final int MAP_EYE_LINEAR
Generate coordinates in a simple linear fashion on the eye position

See Also:
Constant Field Values

MAP_SPHERICAL

public static final int MAP_SPHERICAL
Generate coordinates in a spherical shape for env mapping

See Also:
Constant Field Values

MAP_NORMALS

public static final int MAP_NORMALS
Generate coordinates using the normals at the vertex. Used principly by cubic environment mapping.

See Also:
Constant Field Values

MAP_REFLECTIONS

public static final int MAP_REFLECTIONS
Generate coordinates using the normals at the vertex. Used principly by cubic environment mapping.

See Also:
Constant Field Values
Constructor Detail

TexCoordGeneration

public TexCoordGeneration()
Constructs a TexCoordGeneration with default values, which is to say, do nothing.


TexCoordGeneration

public TexCoordGeneration(int axis,
                          int mode,
                          int parameter,
                          float[] value)
Create automatic coordinate generation for one axis with the given set of abilities.

Throws:
java.lang.IllegalArgumentException - Invalid axis, mode or parameter
Method Detail

renderState

public void renderState(net.java.games.jogl.GL gl,
                        net.java.games.jogl.GLU glu)
Issue ogl commands needed for this component

Overrides:
renderState in class NodeComponent
Parameters:
gl - The gl context to draw with
glu - The utility context to draw with

restoreState

public void restoreState(net.java.games.jogl.GL gl,
                         net.java.games.jogl.GLU glu)
Restore all openGL state to the given drawable

Overrides:
restoreState in class NodeComponent
Parameters:
gl - The gl context to draw with
glu - The utility context to draw with

compareTo

public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Derived classes should extend this one to add the extra comparisons needed.

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
o - The object to be compared
Returns:
-1, 0 or 1 depending on order
Throws:
java.lang.ClassCastException - The specified object's type prevents it from being compared to this Object

setParameter

public void setParameter(int axis,
                         int mode,
                         int parameter,
                         float[] value)
                  throws InvalidWriteTimingException
Setup one of the axis parameters.

Parameters:
axis - One of the TEXTURE_x values
mode - One of the MODE_x values
parameter - The type of parameter you're modifying
value - Optional values, dependent on the parameter type
Throws:
InvalidWriteTimingException - An attempt was made to write outside of the NodeUpdateListener callback method

compareTo

public int compareTo(TexCoordGeneration tcg)
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Derived classes should extend this one to add the extra comparisons needed.

Parameters:
tcg - The generator instance to be compared
Returns:
-1, 0 or 1 depending on order

j3d.org Aviatrix3D

Latest Info from http://aviatrix3d.j3d.org/
Copyright © 2003 - j3d.org