| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.NodeComponent
javax.media.j3d.PolygonAttributes
| PolygonAttributes | | public class PolygonAttributes extends NodeComponent (Code) | | The PolygonAttributes object defines attributes for rendering polygon
primitives.
Polygon primitives include triangles, triangle strips, triangle fans,
and quads.
The polygon attributes that can be defined are:
- Rasterization mode - defines how the polygon is drawn: as points,
outlines, or filled.
- POLYGON_POINT - the polygon is rendered as points
drawn at the vertices.
- POLYGON_LINE - the polygon is rendered as lines
drawn between consecutive vertices.
- POLYGON_FILL - the polygon is rendered by filling the interior
between the vertices. The default mode.
- Face culling - defines which polygons are culled (discarded)
before they are converted to screen coordinates.
- CULL_NONE - disables face culling.
- CULL_BACK - culls all back-facing polygons. The default.
- CULL_FRONT - culls all front-facing polygons.
- Back-face normal flip - specifies whether vertex normals of
back-facing polygons are flipped (negated) prior to lighting. The
setting is either true, meaning to flip back-facing normals, or
false. The default is false.
- Offset - the depth values of all pixels generated by polygon
rasterization can be offset by a value that is computed for that
polygon. Two values are used to specify the offset:
- Offset bias - the constant polygon offset that is added to
the final device coordinate Z value of polygon primitives.
- Offset factor - the factor to be multiplied by the
slope of the polygon and then added to the final, device coordinate
Z value of the polygon primitives.
These values can be either positive or negative. The default
for both of these values is 0.0.
See Also: Appearance |
| Field Summary | |
| final public static int | ALLOW_CULL_FACE_READ
Specifies that this PolygonAttributes object allows reading its
cull face information. | | final public static int | ALLOW_CULL_FACE_WRITE
Specifies that this PolygonAttributes object allows writing its
cull face information. | | final public static int | ALLOW_MODE_READ
Specifies that this PolygonAttributes object allows reading its
polygon mode information. | | final public static int | ALLOW_MODE_WRITE
Specifies that this PolygonAttributes object allows writing its
polygon mode information. | | final public static int | ALLOW_NORMAL_FLIP_READ
Specifies that this PolygonAttributes object allows reading its
back face normal flip flag. | | final public static int | ALLOW_NORMAL_FLIP_WRITE
Specifies that this PolygonAttributes object allows writing its
back face normal flip flag. | | final public static int | ALLOW_OFFSET_READ
Specifies that this PolygonAttributes object allows reading its
polygon offset information. | | final public static int | ALLOW_OFFSET_WRITE
Specifies that this PolygonAttributes object allows writing its
polygon offset information. | | final public static int | CULL_BACK
Cull all back-facing polygons. | | final public static int | CULL_FRONT
Cull all front-facing polygons. | | final public static int | CULL_NONE
Don't perform any face culling. | | final public static int | POLYGON_FILL
Render polygonal primitives by filling the interior of the polygon. | | final public static int | POLYGON_LINE
Render polygonal primitives as lines drawn between consecutive
vertices of the polygon. | | final public static int | POLYGON_POINT
Render polygonal primitives as points drawn at the vertices
of the polygon. |
| Constructor Summary | |
| public | PolygonAttributes()
Constructs a PolygonAttributes object with default parameters. | | public | PolygonAttributes(int polygonMode, int cullFace, float polygonOffset)
Constructs a PolygonAttributes object with specified values. | | public | PolygonAttributes(int polygonMode, int cullFace, float polygonOffset, boolean backFaceNormalFlip)
Constructs PolygonAttributes object with specified values. | | public | PolygonAttributes(int polygonMode, int cullFace, float polygonOffset, boolean backFaceNormalFlip, float polygonOffsetFactor)
Constructs PolygonAttributes object with specified values. |
| Method Summary | |
| public NodeComponent | cloneNodeComponent()
| | void | createRetained()
Creates a retained mode PolygonAttributesRetained object that this
PolygonAttributes component object will point to. | | void | duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)
Copies all node information from originalNodeComponent into
the current node. | | public boolean | getBackFaceNormalFlip()
Gets the back face normal flip flag. | | public int | getCullFace()
Gets the face culling for this
appearance component object. | | public int | getPolygonMode()
Gets the polygon rasterization mode for this
appearance component object. | | public float | getPolygonOffset()
Gets the constant polygon offset. | | public float | getPolygonOffsetFactor()
Gets the polygon offset factor. | | public void | setBackFaceNormalFlip(boolean backFaceNormalFlip)
Sets the back face normal flip flag to the specified value.
This flag indicates whether vertex normals of back facing polygons
should be flipped (negated) prior to lighting. | | public void | setCullFace(int cullFace)
Sets the face culling for this
appearance component object. | | public void | setPolygonMode(int polygonMode)
Sets the polygon rasterization mode for this
appearance component object. | | public void | setPolygonOffset(float polygonOffset)
Sets the constant polygon offset to the specified value. | | public void | setPolygonOffsetFactor(float polygonOffsetFactor)
Sets the polygon offset factor to the specified value. |
| ALLOW_CULL_FACE_READ | | final public static int ALLOW_CULL_FACE_READ(Code) | | Specifies that this PolygonAttributes object allows reading its
cull face information.
|
| ALLOW_CULL_FACE_WRITE | | final public static int ALLOW_CULL_FACE_WRITE(Code) | | Specifies that this PolygonAttributes object allows writing its
cull face information.
|
| ALLOW_MODE_READ | | final public static int ALLOW_MODE_READ(Code) | | Specifies that this PolygonAttributes object allows reading its
polygon mode information.
|
| ALLOW_MODE_WRITE | | final public static int ALLOW_MODE_WRITE(Code) | | Specifies that this PolygonAttributes object allows writing its
polygon mode information.
|
| ALLOW_NORMAL_FLIP_READ | | final public static int ALLOW_NORMAL_FLIP_READ(Code) | | Specifies that this PolygonAttributes object allows reading its
back face normal flip flag.
|
| ALLOW_NORMAL_FLIP_WRITE | | final public static int ALLOW_NORMAL_FLIP_WRITE(Code) | | Specifies that this PolygonAttributes object allows writing its
back face normal flip flag.
|
| ALLOW_OFFSET_READ | | final public static int ALLOW_OFFSET_READ(Code) | | Specifies that this PolygonAttributes object allows reading its
polygon offset information.
|
| ALLOW_OFFSET_WRITE | | final public static int ALLOW_OFFSET_WRITE(Code) | | Specifies that this PolygonAttributes object allows writing its
polygon offset information.
|
| CULL_BACK | | final public static int CULL_BACK(Code) | | Cull all back-facing polygons. This is the default mode.
|
| CULL_FRONT | | final public static int CULL_FRONT(Code) | | Cull all front-facing polygons.
|
| CULL_NONE | | final public static int CULL_NONE(Code) | | Don't perform any face culling.
|
| POLYGON_FILL | | final public static int POLYGON_FILL(Code) | | Render polygonal primitives by filling the interior of the polygon.
|
| POLYGON_LINE | | final public static int POLYGON_LINE(Code) | | Render polygonal primitives as lines drawn between consecutive
vertices of the polygon.
|
| POLYGON_POINT | | final public static int POLYGON_POINT(Code) | | Render polygonal primitives as points drawn at the vertices
of the polygon.
|
| PolygonAttributes | | public PolygonAttributes()(Code) | | Constructs a PolygonAttributes object with default parameters.
The default values are as follows:
cull face : CULL_BACK
back face normal flip : false
polygon mode : POLYGON_FILL
polygon offset : 0.0
polygon offset factor : 0.0
|
| PolygonAttributes | | public PolygonAttributes(int polygonMode, int cullFace, float polygonOffset)(Code) | | Constructs a PolygonAttributes object with specified values.
Parameters:
polygonMode - polygon rasterization mode; one of POLYGON_POINT,POLYGON_LINE, or POLYGON_FILL
Parameters:
cullFace - polygon culling mode; one of CULL_NONE,CULL_BACK, or CULL_FRONT
Parameters:
polygonOffset - constant polygon offset |
| PolygonAttributes | | public PolygonAttributes(int polygonMode, int cullFace, float polygonOffset, boolean backFaceNormalFlip)(Code) | | Constructs PolygonAttributes object with specified values.
Parameters:
polygonMode - polygon rasterization mode; one of POLYGON_POINT,POLYGON_LINE, or POLYGON_FILL
Parameters:
cullFace - polygon culling mode; one of CULL_NONE,CULL_BACK, or CULL_FRONT
Parameters:
polygonOffset - constant polygon offset
Parameters:
backFaceNormalFlip - back face normal flip flag; true or false |
| PolygonAttributes | | public PolygonAttributes(int polygonMode, int cullFace, float polygonOffset, boolean backFaceNormalFlip, float polygonOffsetFactor)(Code) | | Constructs PolygonAttributes object with specified values.
Parameters:
polygonMode - polygon rasterization mode; one of POLYGON_POINT,POLYGON_LINE, or POLYGON_FILL
Parameters:
cullFace - polygon culling mode; one of CULL_NONE,CULL_BACK, or CULL_FRONT
Parameters:
polygonOffset - constant polygon offset
Parameters:
backFaceNormalFlip - back face normal flip flag; true or false
Parameters:
polygonOffsetFactor - polygon offset factor for slope-based polygonoffset
since:
Java 3D 1.2 |
| createRetained | | void createRetained()(Code) | | Creates a retained mode PolygonAttributesRetained object that this
PolygonAttributes component object will point to.
|
| duplicateAttributes | | void duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)(Code) | | Copies all node information from originalNodeComponent into
the current node. This method is called from the
duplicateNode method. This routine does
the actual duplication of all "local data" (any data defined in
this object).
Parameters:
originalNodeComponent - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| getBackFaceNormalFlip | | public boolean getBackFaceNormalFlip()(Code) | | Gets the back face normal flip flag.
the back face normal flip flag
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getCullFace | | public int getCullFace()(Code) | | Gets the face culling for this
appearance component object.
the face to be culled
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getPolygonMode | | public int getPolygonMode()(Code) | | Gets the polygon rasterization mode for this
appearance component object.
the polygon rasterization mode
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getPolygonOffset | | public float getPolygonOffset()(Code) | | Gets the constant polygon offset.
the constant polygon offset
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getPolygonOffsetFactor | | public float getPolygonOffsetFactor()(Code) | | Gets the polygon offset factor.
the polygon offset factor.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
since:
Java 3D 1.2 |
| setBackFaceNormalFlip | | public void setBackFaceNormalFlip(boolean backFaceNormalFlip)(Code) | | Sets the back face normal flip flag to the specified value.
This flag indicates whether vertex normals of back facing polygons
should be flipped (negated) prior to lighting. When this flag
is set to true and back face culling is disabled, polygons are
rendered as if the polygon had two sides with opposing normals.
This feature is disabled by default.
Parameters:
backFaceNormalFlip - the back face normal flip flag
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setCullFace | | public void setCullFace(int cullFace)(Code) | | Sets the face culling for this
appearance component object.
Parameters:
cullFace - the face to be culled, one of:CULL_NONE, CULL_FRONT, or CULL_BACK
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setPolygonMode | | public void setPolygonMode(int polygonMode)(Code) | | Sets the polygon rasterization mode for this
appearance component object.
Parameters:
polygonMode - the polygon rasterization mode to be used; one ofPOLYGON_FILL, POLYGON_LINE, or POLYGON_POINT
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setPolygonOffset | | public void setPolygonOffset(float polygonOffset)(Code) | | Sets the constant polygon offset to the specified value.
This screen space
offset is added to the final, device coordinate Z value of polygon
primitives.
Parameters:
polygonOffset - the constant polygon offset
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setPolygonOffsetFactor | | public void setPolygonOffsetFactor(float polygonOffsetFactor)(Code) | | Sets the polygon offset factor to the specified value.
This factor is multiplied by the slope of the polygon, and
then added to the final, device coordinate Z value of polygon
primitives.
Parameters:
polygonOffsetFactor - the polygon offset factor
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph
since:
Java 3D 1.2 |
| Fields inherited from javax.media.j3d.NodeComponent | boolean forceDuplicate(Code)(Java Doc)
|
|
|