| |
|
| java.lang.Object javax.media.j3d.SceneGraphObject javax.media.j3d.NodeComponent javax.media.j3d.Appearance
All known Subclasses: javax.media.j3d.ShaderAppearance,
Appearance | public class Appearance extends NodeComponent (Code) | | The Appearance object defines all rendering state that can be set
as a component object of a Shape3D node. The rendering state
consists of the following:
- Coloring attributes - defines attributes used in color selection
and shading. These attributes are defined in a ColoringAttributes
object.
- Line attributes - defines attributes used to define lines, including
the pattern, width, and whether antialiasing is to be used. These
attributes are defined in a LineAttributes object.
- Point attributes - defines attributes used to define points,
including the size and whether antialiasing is to be used. These
attributes are defined in a PointAttributes object.
- Polygon attributes - defines the attributes used to define
polygons, including culling, rasterization mode (filled, lines,
or points), constant offset, offset factor, and whether back
back facing normals are flipped. These attributes are defined
in a PolygonAttributes object.
- Rendering attributes - defines rendering operations,
including the alpha test function and test value, the raster
operation, whether vertex colors are ignored, whether invisible
objects are rendered, and whether the depth buffer is enabled.
These attributes are defined in a RenderingAttributes
object.
- Transparency attributes - defines the attributes that affect
transparency of the object, such as the transparency mode
(blended, screen-door), blending function (used in transparency
and antialiasing operations), and a blend value that defines
the amount of transparency to be applied to this Appearance
component object.
- Material - defines the appearance of an object under illumination,
such as the ambient color, diffuse color, specular color, emissive
color, and shininess. These attributes are defined in a Material
object.
- Texture - defines the texture image and filtering
parameters used when texture mapping is enabled. These attributes
are defined in a Texture object.
- Texture attributes - defines the attributes that apply to
texture mapping, such as the texture mode, texture transform,
blend color, and perspective correction mode. These attributes
are defined in a TextureAttributes object.
- Texture coordinate generation - defines the attributes
that apply to texture coordinate generation, such as whether
texture coordinate generation is enabled, coordinate format
(2D or 3D coordinates), coordinate generation mode (object
linear, eye linear, or spherical reflection mapping), and the
R, S, and T coordinate plane equations. These attributes
are defined in a TexCoordGeneration object.
- Texture unit state - array that defines texture state for each
of N separate texture units. This allows multiple textures
to be applied to geometry. Each TextureUnitState object contains a
Texture object, TextureAttributes, and TexCoordGeneration object
for one texture unit. If the length of the texture unit state
array is greater than 0, then the array is used for all texture
state; the individual Texture, TextureAttributes, and
TexCoordGeneration objects in this Appearance object are not used
and and must not be set by an application. If the length of the
texture unit state array is 0, the multi-texture is disabled and
the Texture, TextureAttributes, and TexCoordGeneration objects
in the Appearance object are used. If the application sets the
existing Texture, TextureAttributes, and TexCoordGeneration
objects to non-null values, they effectively define the state
for texture unit 0. If the TextureUnitState array is set to a
non-null, non-empty array, the individual TextureUnitState
objects define the state for texture units 0 through n
-1. If both the old and new values are set, an exception is thrown.
See Also: ColoringAttributes See Also: LineAttributes See Also: PointAttributes See Also: PolygonAttributes See Also: RenderingAttributes See Also: TransparencyAttributes See Also: Material See Also: Texture See Also: TextureAttributes See Also: TexCoordGeneration See Also: TextureUnitState |
Field Summary | |
final public static int | ALLOW_COLORING_ATTRIBUTES_READ Specifies that this Appearance object
allows reading its coloringAttributes component
information. | final public static int | ALLOW_COLORING_ATTRIBUTES_WRITE Specifies that this Appearance object
allows writing its coloringAttributes component
information. | final public static int | ALLOW_LINE_ATTRIBUTES_READ Specifies that this Appearance object
allows reading its line component
information. | final public static int | ALLOW_LINE_ATTRIBUTES_WRITE Specifies that this Appearance object
allows writing its line component
information. | final public static int | ALLOW_MATERIAL_READ Specifies that this Appearance object
allows reading its material component information. | final public static int | ALLOW_MATERIAL_WRITE Specifies that this Appearance object
allows writing its material component information. | final public static int | ALLOW_POINT_ATTRIBUTES_READ Specifies that this Appearance object
allows reading its point component
information. | final public static int | ALLOW_POINT_ATTRIBUTES_WRITE Specifies that this Appearance object
allows writing its point component
information. | final public static int | ALLOW_POLYGON_ATTRIBUTES_READ Specifies that this Appearance object
allows reading its polygon component
information. | final public static int | ALLOW_POLYGON_ATTRIBUTES_WRITE Specifies that this Appearance object
allows writing its polygon component
information. | final public static int | ALLOW_RENDERING_ATTRIBUTES_READ Specifies that this Appearance object
allows reading its rendering/rasterization component
information. | final public static int | ALLOW_RENDERING_ATTRIBUTES_WRITE Specifies that this Appearance object
allows writing its rendering/rasterization component
information. | final public static int | ALLOW_TEXGEN_READ Specifies that this Appearance object
allows reading its texture coordinate generation component
information. | final public static int | ALLOW_TEXGEN_WRITE Specifies that this Appearance object
allows writing its texture coordinate generation component
information. | final public static int | ALLOW_TEXTURE_ATTRIBUTES_READ Specifies that this Appearance object
allows reading its textureAttributes component
information. | final public static int | ALLOW_TEXTURE_ATTRIBUTES_WRITE Specifies that this Appearance object
allows writing its textureAttributes component
information. | final public static int | ALLOW_TEXTURE_READ Specifies that this Appearance object
allows reading its texture component information. | final public static int | ALLOW_TEXTURE_UNIT_STATE_READ Specifies that this Appearance object
allows reading its texture unit state component
information. | final public static int | ALLOW_TEXTURE_UNIT_STATE_WRITE Specifies that this Appearance object
allows writing its texture unit state component
information. | final public static int | ALLOW_TEXTURE_WRITE Specifies that this Appearance object
allows writing its texture component information. | final public static int | ALLOW_TRANSPARENCY_ATTRIBUTES_READ Specifies that this Appearance object
allows reading its transparency component
information. | final public static int | ALLOW_TRANSPARENCY_ATTRIBUTES_WRITE Specifies that this Appearance object
allows writing its transparency component
information. |
Constructor Summary | |
public | Appearance() Constructs an Appearance component object using defaults for all
state variables. |
ALLOW_COLORING_ATTRIBUTES_READ | final public static int ALLOW_COLORING_ATTRIBUTES_READ(Code) | | Specifies that this Appearance object
allows reading its coloringAttributes component
information.
|
ALLOW_COLORING_ATTRIBUTES_WRITE | final public static int ALLOW_COLORING_ATTRIBUTES_WRITE(Code) | | Specifies that this Appearance object
allows writing its coloringAttributes component
information.
|
ALLOW_LINE_ATTRIBUTES_READ | final public static int ALLOW_LINE_ATTRIBUTES_READ(Code) | | Specifies that this Appearance object
allows reading its line component
information.
|
ALLOW_LINE_ATTRIBUTES_WRITE | final public static int ALLOW_LINE_ATTRIBUTES_WRITE(Code) | | Specifies that this Appearance object
allows writing its line component
information.
|
ALLOW_MATERIAL_READ | final public static int ALLOW_MATERIAL_READ(Code) | | Specifies that this Appearance object
allows reading its material component information.
|
ALLOW_MATERIAL_WRITE | final public static int ALLOW_MATERIAL_WRITE(Code) | | Specifies that this Appearance object
allows writing its material component information.
|
ALLOW_POINT_ATTRIBUTES_READ | final public static int ALLOW_POINT_ATTRIBUTES_READ(Code) | | Specifies that this Appearance object
allows reading its point component
information.
|
ALLOW_POINT_ATTRIBUTES_WRITE | final public static int ALLOW_POINT_ATTRIBUTES_WRITE(Code) | | Specifies that this Appearance object
allows writing its point component
information.
|
ALLOW_POLYGON_ATTRIBUTES_READ | final public static int ALLOW_POLYGON_ATTRIBUTES_READ(Code) | | Specifies that this Appearance object
allows reading its polygon component
information.
|
ALLOW_POLYGON_ATTRIBUTES_WRITE | final public static int ALLOW_POLYGON_ATTRIBUTES_WRITE(Code) | | Specifies that this Appearance object
allows writing its polygon component
information.
|
ALLOW_RENDERING_ATTRIBUTES_READ | final public static int ALLOW_RENDERING_ATTRIBUTES_READ(Code) | | Specifies that this Appearance object
allows reading its rendering/rasterization component
information.
|
ALLOW_RENDERING_ATTRIBUTES_WRITE | final public static int ALLOW_RENDERING_ATTRIBUTES_WRITE(Code) | | Specifies that this Appearance object
allows writing its rendering/rasterization component
information.
|
ALLOW_TEXGEN_READ | final public static int ALLOW_TEXGEN_READ(Code) | | Specifies that this Appearance object
allows reading its texture coordinate generation component
information.
|
ALLOW_TEXGEN_WRITE | final public static int ALLOW_TEXGEN_WRITE(Code) | | Specifies that this Appearance object
allows writing its texture coordinate generation component
information.
|
ALLOW_TEXTURE_ATTRIBUTES_READ | final public static int ALLOW_TEXTURE_ATTRIBUTES_READ(Code) | | Specifies that this Appearance object
allows reading its textureAttributes component
information.
|
ALLOW_TEXTURE_ATTRIBUTES_WRITE | final public static int ALLOW_TEXTURE_ATTRIBUTES_WRITE(Code) | | Specifies that this Appearance object
allows writing its textureAttributes component
information.
|
ALLOW_TEXTURE_READ | final public static int ALLOW_TEXTURE_READ(Code) | | Specifies that this Appearance object
allows reading its texture component information.
|
ALLOW_TEXTURE_UNIT_STATE_READ | final public static int ALLOW_TEXTURE_UNIT_STATE_READ(Code) | | Specifies that this Appearance object
allows reading its texture unit state component
information.
since: Java 3D 1.2 |
ALLOW_TEXTURE_UNIT_STATE_WRITE | final public static int ALLOW_TEXTURE_UNIT_STATE_WRITE(Code) | | Specifies that this Appearance object
allows writing its texture unit state component
information.
since: Java 3D 1.2 |
ALLOW_TEXTURE_WRITE | final public static int ALLOW_TEXTURE_WRITE(Code) | | Specifies that this Appearance object
allows writing its texture component information.
|
ALLOW_TRANSPARENCY_ATTRIBUTES_READ | final public static int ALLOW_TRANSPARENCY_ATTRIBUTES_READ(Code) | | Specifies that this Appearance object
allows reading its transparency component
information.
|
ALLOW_TRANSPARENCY_ATTRIBUTES_WRITE | final public static int ALLOW_TRANSPARENCY_ATTRIBUTES_WRITE(Code) | | Specifies that this Appearance object
allows writing its transparency component
information.
|
Appearance | public Appearance()(Code) | | Constructs an Appearance component object using defaults for all
state variables. All component object references are initialized
to null.
|
createRetained | void createRetained()(Code) | | Creates the retained mode AppearanceRetained object that this
Appearance component object will point to.
|
duplicateAttributes | void duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)(Code) | | Copies all Appearance information from
originalNodeComponent into
the current node. This method is called from the
cloneNode method which is, in turn, called by the
cloneTree method.
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. exception: RestrictedAccessException - if this object is part of a liveor compiled scenegraph. See Also: Node.cloneTree See Also: NodeComponent.setDuplicateOnCloneTree |
duplicateChild | boolean duplicateChild()(Code) | | This function is called from getNodeComponent() to see if any of
the sub-NodeComponents duplicateOnCloneTree flag is true.
If it is the case, current NodeComponent needs to
duplicate also even though current duplicateOnCloneTree flag is false.
This should be overwrite by NodeComponent which contains sub-NodeComponent.
|
duplicateNodeComponent | public void duplicateNodeComponent(NodeComponent originalNodeComponent)(Code) | | NOTE: Applications should not call this method directly.
It should only be called by the cloneNode method.
|
getColoringAttributes | public ColoringAttributes getColoringAttributes()(Code) | | Retrieves the current coloringAttributes object.
the coloringAttributes object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getLineAttributes | public LineAttributes getLineAttributes()(Code) | | Retrieves the current lineAttributes object.
the lineAttributes object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getMaterial | public Material getMaterial()(Code) | | Retrieves the current material object.
the material object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getPointAttributes | public PointAttributes getPointAttributes()(Code) | | Retrieves the current pointAttributes object.
the pointAttributes object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getPolygonAttributes | public PolygonAttributes getPolygonAttributes()(Code) | | Retrieves the current polygonAttributes object.
the polygonAttributes object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getRenderingAttributes | public RenderingAttributes getRenderingAttributes()(Code) | | Retrieves the current renderingAttributes object.
the renderingAttributes object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getTexCoordGeneration | public TexCoordGeneration getTexCoordGeneration()(Code) | | Retrieves the current texCoordGeneration object.
the texCoordGeneration object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getTexture | public Texture getTexture()(Code) | | Retrieves the current texture object.
the texture object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getTextureAttributes | public TextureAttributes getTextureAttributes()(Code) | | Retrieves the current textureAttributes object.
the textureAttributes object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
getTextureUnitCount | public int getTextureUnitCount()(Code) | | Retrieves the length of the texture unit state array from
this appearance object. The length of this array specifies the
maximum number of texture units that will be used by this
appearance object. If the array is null, a count of 0 is
returned.
the length of the texture unit state array exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph since: Java 3D 1.2 |
getTextureUnitState | public TextureUnitState[] getTextureUnitState()(Code) | | Retrieves the array of texture unit state objects from this
Appearance object. A shallow copy of the array of references to
the TextureUnitState objects is returned.
the array of texture unit state objects exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph since: Java 3D 1.2 |
getTextureUnitState | public TextureUnitState getTextureUnitState(int index)(Code) | | Retrieves the texture unit state object at the specified
index within the texture unit state array. The index must be
within the range [0, stateArray.length-1] .
Parameters: index - the array index of the object to be retrieved the texture unit state object at the specified index exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph since: Java 3D 1.2 |
getTransparencyAttributes | public TransparencyAttributes getTransparencyAttributes()(Code) | | Retrieves the current transparencyAttributes object.
the transparencyAttributes object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
setColoringAttributes | public void setColoringAttributes(ColoringAttributes coloringAttributes)(Code) | | Sets the coloringAttributes object to the specified object.
Setting it to null will result in default attribute usage.
Parameters: coloringAttributes - object that specifies the desiredcoloringAttributes parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
setLineAttributes | public void setLineAttributes(LineAttributes lineAttributes)(Code) | | Sets the lineAttributes object to the specified object.
Setting it to null will result in default attribute usage.
Parameters: lineAttributes - object that specifies the desiredlineAttributes parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
setMaterial | public void setMaterial(Material material)(Code) | | Sets the material object to the specified object.
Setting it to null disables lighting.
Parameters: material - object that specifies the desired materialproperties exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
setPointAttributes | public void setPointAttributes(PointAttributes pointAttributes)(Code) | | Sets the pointAttributes object to the specified object.
Setting it to null will result in default attribute usage.
Parameters: pointAttributes - object that specifies the desiredpointAttributes parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
setPolygonAttributes | public void setPolygonAttributes(PolygonAttributes polygonAttributes)(Code) | | Sets the polygonAttributes object to the specified object.
Setting it to null will result in default attribute usage.
Parameters: polygonAttributes - object that specifies the desired polygonAttributes parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
setRenderingAttributes | public void setRenderingAttributes(RenderingAttributes renderingAttributes)(Code) | | Sets the renderingAttributes object to the specified object.
Setting it to null will result in default attribute usage.
Parameters: renderingAttributes - object that specifies the desiredrenderingAttributes parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
setTexCoordGeneration | public void setTexCoordGeneration(TexCoordGeneration texCoordGeneration)(Code) | | Sets the texCoordGeneration object to the specified object.
Setting it to null disables texture coordinate generation.
Applications must not set individual texture component objects
(texture, textureAttributes, or texCoordGeneration) and
the texture unit state array in the same Appearance object.
Doing so will result in an exception being thrown.
Parameters: texCoordGeneration - object that specifies the texture coordinategeneration parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph exception: IllegalStateException - if the specified texCoordGenerationobject is non-null and the texture unit state array in thisappearance object is already non-null. |
setTexture | public void setTexture(Texture texture)(Code) | | Sets the texture object to the specified object.
Setting it to null disables texture mapping.
Applications must not set individual texture component objects
(texture, textureAttributes, or texCoordGeneration) and
the texture unit state array in the same Appearance object.
Doing so will result in an exception being thrown.
Parameters: texture - object that specifies the desired texturemap and texture parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph exception: IllegalStateException - if the specified textureobject is non-null and the texture unit state array in thisappearance object is already non-null. exception: IllegalSharingException - if this Appearance is live andthe specified texture refers to an ImageComponent2D that is being usedby a Canvas3D as an off-screen buffer. exception: IllegalSharingException - if this Appearance isbeing used by an immediate mode context andthe specified texture refers to an ImageComponent2D that is being usedby a Canvas3D as an off-screen buffer. |
setTextureAttributes | public void setTextureAttributes(TextureAttributes textureAttributes)(Code) | | Sets the textureAttributes object to the specified object.
Setting it to null will result in default attribute usage.
Applications must not set individual texture component objects
(texture, textureAttributes, or texCoordGeneration) and
the texture unit state array in the same Appearance object.
Doing so will result in an exception being thrown.
Parameters: textureAttributes - object that specifies the desiredtextureAttributes map and textureAttributes parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph exception: IllegalStateException - if the specified textureAttributesobject is non-null and the texture unit state array in thisappearance object is already non-null. |
setTextureUnitState | public void setTextureUnitState(TextureUnitState[] stateArray)(Code) | | Sets the texture unit state array for this appearance object to the
specified array. A shallow copy of the array of references to
the TextureUnitState objects is made. If the specified array
is null or if the length of the array is 0, multi-texture is
disabled. Within the array, a null TextureUnitState element
disables the corresponding texture unit.
Applications must not set individual texture component objects
(texture, textureAttributes, or texCoordGeneration) and
the texture unit state array in the same Appearance object.
Doing so will result in an exception being thrown.
Parameters: stateArray - array of TextureUnitState objects thatspecify the desired texture state for each unit. The length ofthis array specifies the maximum number of texture units thatwill be used by this appearance object. The texture units arenumbered from 0 throughstateArray.length-1 . exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph exception: IllegalStateException - if the specified array isnon-null and any of the texture object, textureAttributesobject, or texCoordGeneration object in this appearance objectis already non-null. exception: IllegalSharingException - if this Appearance is live andany of the specified textures refers to an ImageComponent2D that isbeing used by a Canvas3D as an off-screen buffer. exception: IllegalSharingException - if this Appearance isbeing used by an immediate mode context andany of the specified textures refers to an ImageComponent2D that isbeing used by a Canvas3D as an off-screen buffer. since: Java 3D 1.2 |
setTextureUnitState | public void setTextureUnitState(int index, TextureUnitState state)(Code) | | Sets the texture unit state object at the specified index
within the texture unit state array to the specified object.
If the specified object is null, the corresponding texture unit
is disabled. The index must be within the range
[0, stateArray.length-1] .
Parameters: index - the array index of the object to be set Parameters: state - new texture unit state object exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph exception: NullPointerException - if the texture unit state array isnull. exception: ArrayIndexOutOfBoundsException - if index >=stateArray.length . exception: IllegalSharingException - if this Appearance is live andthe specified texture refers to an ImageComponent2D that is being usedby a Canvas3D as an off-screen buffer. exception: IllegalSharingException - if this Appearance isbeing used by an immediate mode context andthe specified texture refers to an ImageComponent2D that is being usedby a Canvas3D as an off-screen buffer. since: Java 3D 1.2 |
setTransparencyAttributes | public void setTransparencyAttributes(TransparencyAttributes transparencyAttributes)(Code) | | Sets the transparencyAttributes object to the specified object.
Setting it to null will result in default attribute usage.
Parameters: transparencyAttributes - object that specifies the desiredtransparencyAttributes parameters exception: CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
Fields inherited from javax.media.j3d.NodeComponent | boolean forceDuplicate(Code)(Java Doc)
|
|
|
|