All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.TexCoordGeneration

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.NodeComponent
                   |
                   +----java.media.j3d.TexCoordGeneration

public class TexCoordGeneration
extends NodeComponent
The TexCoordGeneration object contains all parameters needed for texture coordinate generation. It is included as part of an Appearance component object.


Variable Index

 o EYE_LINEAR
Generates texture coordinates as a linear function in eye coordinates.
 o OBJECT_LINEAR
Generates texture coordinates as a linear function in object coordinates.
 o SPHERE_MAP
Generates texture coordinates using a spherical reflection mapping in eye coordinates.
 o TEXTURE_COORDINATE_2
Generates 2D texture coordinates (S and T).
 o TEXTURE_COORDINATE_3
Generates 3D texture coordinates (S, T, and R).

Constructor Index

 o TexCoordGeneration()
Constructs a TexCoordGeneration object using defaults for all state variables.
 o TexCoordGeneration(int, int)
Constructs a TexCoordGeneration object with the specified genMode and format.
 o TexCoordGeneration(int, int, Vector4f)
Constructs a TexCoordGeneration object with the specified genMode, format, and the S coordinate plane equation.
 o TexCoordGeneration(int, int, Vector4f, Vector4f)
Constructs a TexCoordGeneration object with the specified genMode, format, and the S and T coordinate plane equations.
 o TexCoordGeneration(int, int, Vector4f, Vector4f, Vector4f)
Constructs a TexCoordGeneration object with the specified genMode, format, and the S, T, and R coordinate plane equations.

Method Index

 o getEnable()
Retrieves the state of the texCoordGeneration enable flag.
 o getFormat()
Retrieves the current TexCoordGeneration format.
 o getGenMode()
Retrieves the current TexCoordGeneration generation mode.
 o getPlaneR(Vector4f)
Retrieves a copy of the plane equation used to generate the R coordinate.
 o getPlaneS(Vector4f)
Retrieves a copy of the plane equation used to generate the S coordinate.
 o getPlaneT(Vector4f)
Retrieves a copy of the plane equation used to generate the T coordinate.
 o setEnable(boolean)
Enables or disables texture coordinate generation for this appearance component object.
 o setFormat(int)
Sets the TexCoordGeneration format to the specified value.
 o setGenMode(int)
Sets the TexCoordGeneration generation mode to the specified value.
 o setPlaneR(Vector4f)
Sets the R coordinate plane equation.
 o setPlaneS(Vector4f)
Sets the S coordinate plane equation.
 o setPlaneT(Vector4f)
Sets the T coordinate plane equation.

Variables

 o OBJECT_LINEAR
 public static final int OBJECT_LINEAR
Generates texture coordinates as a linear function in object coordinates.

 o EYE_LINEAR
 public static final int EYE_LINEAR
Generates texture coordinates as a linear function in eye coordinates.

 o SPHERE_MAP
 public static final int SPHERE_MAP
Generates texture coordinates using a spherical reflection mapping in eye coordinates.

 o TEXTURE_COORDINATE_2
 public static final int TEXTURE_COORDINATE_2
Generates 2D texture coordinates (S and T).

 o TEXTURE_COORDINATE_3
 public static final int TEXTURE_COORDINATE_3
Generates 3D texture coordinates (S, T, and R).

Constructors

 o TexCoordGeneration
 public TexCoordGeneration()
Constructs a TexCoordGeneration object using defaults for all state variables. Texture coordinate generation is enabled by default.

 o TexCoordGeneration
 public TexCoordGeneration(int genMode,
                           int format)
Constructs a TexCoordGeneration object with the specified genMode and format. Defaults will be used for the rest of the state variables.

Parameters:
genMode - texture generation mode, one of: OBJECT_LINEAR, EYE_LINEAR, or SPHERE_MAP
format - texture format, one of: TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3
 o TexCoordGeneration
 public TexCoordGeneration(int genMode,
                           int format,
                           Vector4f planeS)
Constructs a TexCoordGeneration object with the specified genMode, format, and the S coordinate plane equation. Defaults will be used for the rest of the state variables.

Parameters:
genMode - texture generation mode, one of: OBJECT_LINEAR, EYE_LINEAR, or SPHERE_MAP
format - texture format, one of: TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3
planeS - plane equation for the S coordinate
 o TexCoordGeneration
 public TexCoordGeneration(int genMode,
                           int format,
                           Vector4f planeS,
                           Vector4f planeT)
Constructs a TexCoordGeneration object with the specified genMode, format, and the S and T coordinate plane equations. Defaults will be used for the rest of the state variables.

Parameters:
genMode - texture generation mode, one of: OBJECT_LINEAR, EYE_LINEAR, or SPHERE_MAP
format - texture format, one of: TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3
planeS - plane equation for the S coordinate
planeT - plane equation for the T coordinate
 o TexCoordGeneration
 public TexCoordGeneration(int genMode,
                           int format,
                           Vector4f planeS,
                           Vector4f planeT,
                           Vector4f planeR)
Constructs a TexCoordGeneration object with the specified genMode, format, and the S, T, and R coordinate plane equations.

Parameters:
genMode - texture generation mode, one of: OBJECT_LINEAR, EYE_LINEAR, or SPHERE_MAP
format - texture format, one of: TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3
planeS - plane equation for the S coordinate
planeT - plane equation for the T coordinate
planeR - plane equation for the R coordinate

Methods

 o setEnable
 public final void setEnable(boolean state)
Enables or disables texture coordinate generation for this appearance component object.

Parameters:
state - true or false to enable or disable texture coordinate generation
 o getEnable
 public final boolean getEnable()
Retrieves the state of the texCoordGeneration enable flag.

Returns:
true if texture coordinate generation is enabled, false if texture coordinate generation is disabled
 o setFormat
 public final void setFormat(int format)
Sets the TexCoordGeneration format to the specified value.

Parameters:
format - texture format, one of: TEXTURE_COORDINATE_2 or TEXTURE_COORDINATE_3
 o getFormat
 public final int getFormat()
Retrieves the current TexCoordGeneration format.

Returns:
the texture format
 o setGenMode
 public final void setGenMode(int genMode)
Sets the TexCoordGeneration generation mode to the specified value.

Parameters:
genMode - texture generation mode, one of: OBJECT_LINEAR, EYE_LINEAR, or SPHERE_MAP
 o getGenMode
 public final int getGenMode()
Retrieves the current TexCoordGeneration generation mode.

Returns:
the texture generation mode
 o setPlaneS
 public final void setPlaneS(Vector4f planeS)
Sets the S coordinate plane equation. This plane equation is used to generate the S coordinate in OBJECT_LINEAR and EYE_LINEAR texture generation modes.

Parameters:
planeS - plane equation for the S coordinate
 o getPlaneS
 public final void getPlaneS(Vector4f planeS)
Retrieves a copy of the plane equation used to generate the S coordinate.

Parameters:
planeS - the S coordinate plane equation
 o setPlaneT
 public final void setPlaneT(Vector4f planeT)
Sets the T coordinate plane equation. This plane equation is used to generate the T coordinate in OBJECT_LINEAR and EYE_LINEAR texture generation modes.

Parameters:
planeT - plane equation for the T coordinate
 o getPlaneT
 public final void getPlaneT(Vector4f planeT)
Retrieves a copy of the plane equation used to generate the T coordinate.

Parameters:
planeT - the T coordinate plane equation
 o setPlaneR
 public final void setPlaneR(Vector4f planeR)
Sets the R coordinate plane equation. This plane equation is used to generate the R coordinate in OBJECT_LINEAR and EYE_LINEAR texture generation modes.

Parameters:
planeR - plane equation for the R coordinate
 o getPlaneR
 public final void getPlaneR(Vector4f planeR)
Retrieves a copy of the plane equation used to generate the R coordinate.

Parameters:
planeR - the R coordinate plane equation

All Packages  Class Hierarchy  This Package  Previous  Next  Index