| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.NodeComponent
javax.media.j3d.ColoringAttributes
| ColoringAttributes | | public class ColoringAttributes extends NodeComponent (Code) | | The ColoringAttributes object defines attributes used in
color selection and shading model.
Color
The setColor methods set the current intrinsic red, green, and
blue color values of this ColoringAttributes component object.
This color is only used for unlit geometry. If lighting is enabled,
the material colors are used in the lighting equation to produce
the final color. When vertex colors are present in unlit
geometry, those vertex colors are used in place of this
ColoringAttributes color, unless the vertex colors are ignored.
There are two variations on the setColor methods, one
that takes a Color3f and one that takes three floats. No alpha
value is allowed (it's automatically set to 1.0). The float values
range between 0.0 and 1.0, with 1.0 being full intensity of the
color. A color value of (1.0, 1.0, 1.0) is white.
Shading Model
The setShadeModel method sets the shade model for this
ColoringAttributes component object. The shade model may be one of
the following:
- FASTEST - use the fastest available method for shading. This
shading mode maps to whatever shading model the Java 3D implementor
defines as the "fastest," which may be hardware-dependent.
- NICEST - use the nicest (highest quality) available method
for shading. This shading mode maps to whatever shading model
the Java 3D implementor defines as the "nicest," shading
model, which may be hardware-dependent.
- SHADE_FLAT - use the flat shading model. This shading model
does not interpolate color across the primitive.
The primitive is drawn with a single color
and the color of one vertex of the primitive is duplicated
across all the vertices of the primitive.
- SHADE_GOURAUD - use the Gouraud (smooth) shading model.
This shading model smoothly interpolates the color at each vertex
across the primitive.
The primitive is drawn with many different colors
and the color at each vertex is treated individually. For lines,
the colors along the line segment are interpolated between
the vertex colors. This is the default shade model if no other
is specified.
See Also: Appearance |
| Field Summary | |
| final public static int | ALLOW_COLOR_READ
Specifies that this ColoringAttributes object allows
reading its color component information. | | final public static int | ALLOW_COLOR_WRITE
Specifies that this ColoringAttributes object allows
writing its color component information. | | final public static int | ALLOW_SHADE_MODEL_READ
Specifies that this ColoringAttributes object allows
reading its shade model component information. | | final public static int | ALLOW_SHADE_MODEL_WRITE
Specifies that this ColoringAttributes object allows
writing its shade model component information. | | final public static int | FASTEST
Use the fastest available method for shading. | | final public static int | NICEST
Use the nicest available method for shading. | | final public static int | SHADE_FLAT
Do not interpolate color across the primitive. | | final public static int | SHADE_GOURAUD
Smoothly interpolate the color at each vertex across the primitive. |
| Constructor Summary | |
| public | ColoringAttributes()
Constructs a ColoringAttributes node with default parameters. | | public | ColoringAttributes(Color3f color, int shadeModel)
Construct ColoringAttributes object with specified values. | | public | ColoringAttributes(float red, float green, float blue, int shadeModel)
Construct ColoringAttributes object with specified values. |
| Method Summary | |
| public NodeComponent | cloneNodeComponent()
| | void | createRetained()
Creates a retained mode ColoringAttributesRetained object that this
ColoringAttributes component object will point to. | | void | duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)
Copies all node information from originalNodeComponent into
the current node. | | public void | getColor(Color3f color)
Gets the intrinsic color of this ColoringAttributes
component object. | | public int | getShadeModel()
Gets the shade mode for this ColoringAttributes component object. | | public void | setColor(Color3f color)
Sets the intrinsic color of this ColoringAttributes
component object. | | public void | setColor(float r, float g, float b)
Sets the intrinsic color of this ColoringAttributes
component object. | | public void | setShadeModel(int shadeModel)
Sets the shade mode for this ColoringAttributes component object. | | public String | toString()
Returns a String representation of this ColoringAttributes object. |
| ALLOW_COLOR_READ | | final public static int ALLOW_COLOR_READ(Code) | | Specifies that this ColoringAttributes object allows
reading its color component information.
|
| ALLOW_COLOR_WRITE | | final public static int ALLOW_COLOR_WRITE(Code) | | Specifies that this ColoringAttributes object allows
writing its color component information.
|
| ALLOW_SHADE_MODEL_READ | | final public static int ALLOW_SHADE_MODEL_READ(Code) | | Specifies that this ColoringAttributes object allows
reading its shade model component information.
|
| ALLOW_SHADE_MODEL_WRITE | | final public static int ALLOW_SHADE_MODEL_WRITE(Code) | | Specifies that this ColoringAttributes object allows
writing its shade model component information.
|
| FASTEST | | final public static int FASTEST(Code) | | Use the fastest available method for shading.
|
| NICEST | | final public static int NICEST(Code) | | Use the nicest available method for shading.
|
| SHADE_FLAT | | final public static int SHADE_FLAT(Code) | | Do not interpolate color across the primitive.
|
| SHADE_GOURAUD | | final public static int SHADE_GOURAUD(Code) | | Smoothly interpolate the color at each vertex across the primitive.
|
| ColoringAttributes | | public ColoringAttributes()(Code) | | Constructs a ColoringAttributes node with default parameters.
The default values are as follows:
color = white (1,1,1)
shade model = SHADE_GOURAUD
|
| ColoringAttributes | | public ColoringAttributes(Color3f color, int shadeModel)(Code) | | Construct ColoringAttributes object with specified values.
Parameters:
color - the intrisic color
Parameters:
shadeModel - the shade model used; one of FASTEST, NICEST,SHADE_FLAT, or SHADE_GOURAUD |
| ColoringAttributes | | public ColoringAttributes(float red, float green, float blue, int shadeModel)(Code) | | Construct ColoringAttributes object with specified values.
Parameters:
red - red component of the intrisic color
Parameters:
green - green component of the intrisic color
Parameters:
blue - blue component of the intrisic color
Parameters:
shadeModel - the shade model used; one of FASTEST, NICEST,SHADE_FLAT, or SHADE_GOURAUD |
| createRetained | | void createRetained()(Code) | | Creates a retained mode ColoringAttributesRetained object that this
ColoringAttributes 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 |
| getColor | | public void getColor(Color3f color)(Code) | | Gets the intrinsic color of this ColoringAttributes
component object.
Parameters:
color - the vector that will receive color
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
| getShadeModel | | public int getShadeModel()(Code) | | Gets the shade mode for this ColoringAttributes component object.
shadeModel the shade mode
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
| setColor | | public void setColor(Color3f color)(Code) | | Sets the intrinsic color of this ColoringAttributes
component object. This color is only used for unlit geometry;
if lighting is enabled, then the material colors are used in the
lighting equation to produce the final color.
When vertex colors are present in unlit geometry, those
vertex colors are used in place of this ColoringAttributes color
unless the vertex colors are ignored.
Parameters:
color - the color that is used when lighting is disabledor when material is null
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
See Also: Material
See Also: RenderingAttributes.setIgnoreVertexColors |
| setColor | | public void setColor(float r, float g, float b)(Code) | | Sets the intrinsic color of this ColoringAttributes
component object. This color is only used for unlit geometry;
if lighting is enabled, then the material colors are used in the
lighting equation to produce the final color.
When vertex colors are present in unlit geometry, those
vertex colors are used in place of this ColoringAttributes color
unless the vertex colors are ignored.
Parameters:
r - the red component of the color
Parameters:
g - the green component of the color
Parameters:
b - the blue component of the color
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
See Also: Material
See Also: RenderingAttributes.setIgnoreVertexColors |
| setShadeModel | | public void setShadeModel(int shadeModel)(Code) | | Sets the shade mode for this ColoringAttributes component object.
Parameters:
shadeModel - the shade mode to be used; one of FASTEST,NICEST, SHADE_FLAT, or SHADE_GOURAUD
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
| toString | | public String toString()(Code) | | Returns a String representation of this ColoringAttributes object.
If the scene graph is live only those values with their
Capability read bit set will be displayed.
|
| Fields inherited from javax.media.j3d.NodeComponent | boolean forceDuplicate(Code)(Java Doc)
|
|
|