| java.lang.Object
 javax.media.j3d.IndexedObject
javax.media.j3d.SceneGraphObjectRetained
javax.media.j3d.NodeComponentRetained
javax.media.j3d.RenderingAttributesRetained
| RenderingAttributesRetained | | class RenderingAttributesRetained extends NodeComponentRetained (Code) | | The RenderingAttributes object defines all rendering state that can be set
as a component object of a Shape3D node.
|
| Method Summary | |
| synchronized void | createMirrorObject()
| | boolean | equivalent(RenderingAttributesRetained rr)
| | final int | getAlphaTestFunction()
Retrieves current alpha test function. | | final float | getAlphaTestValue()
Retrieves the alpha test value. | | final boolean | getDepthBufferEnable()
| | final boolean | getDepthBufferWriteEnable()
| | final int | getDepthTestFunction()
Retrieves current depth test function. | | final boolean | getIgnoreVertexColors()
| | final int | getRasterOp()
Retrieves the current raster op value. | | final boolean | getRasterOpEnable()
Retrieves the current raster op enable flag. | | final boolean | getStencilEnable()
Retrieves the current stencil enable state. | | final void | getStencilFunction(int[] params)
Retrieves the current stencil op. | | final void | getStencilOp(int[] stencilOps)
Retrieves the current stencil op. | | final int | getStencilWriteMask()
| | final boolean | getVisible()
Retrieves the visibility flag for this RenderingAttributes object. | | void | handleFrequencyChange(int bit)
| | final void | initAlphaTestFunction(int function)
Set alpha test function. | | final void | initAlphaTestValue(float value)
Set alpha test value used by alpha test function. | | final void | initDepthBufferEnable(boolean state)
Enables or disables depth buffer mode for this RenderAttributes
component object. | | final void | initDepthBufferWriteEnable(boolean state)
Enables or disables writing the depth buffer for this object. | | final void | initDepthTestFunction(int function)
Set depth test function. | | final void | initIgnoreVertexColors(boolean state)
Enables or disables vertex colors for this RenderAttributes
component object. | | synchronized void | initMirrorObject()
| | final void | initRasterOp(int op)
| | final void | initRasterOpEnable(boolean flag)
| | final void | initStencilEnable(boolean state)
| | final void | initStencilFunction(int function, int refValue, int compareMask)
| | final void | initStencilOp(int failOp, int zFailOp, int zPassOp)
Initialize the stencil op. | | final void | initStencilWriteMask(int mask)
| | final void | initVisible(boolean state)
Sets the visibility flag for this RenderingAttributes component object. | | final void | sendMessage(int attrMask, Object attr)
| | protected void | set(RenderingAttributesRetained ra)
| | final void | setAlphaTestFunction(int function)
Set alpha test function and sends a
message notifying the interested structures of the change.
This function is used to compare the
alpha test value with each per-pixel alpha value. | | final void | setAlphaTestValue(float value)
Set alpha test value used by alpha test function and sends a
message notifying the interested structures of the change. | | final void | setDepthBufferEnable(boolean state)
Enables or disables depth buffer mode for this RenderAttributes
component object and sends a
message notifying the interested structures of the change. | | final void | setDepthBufferWriteEnable(boolean state)
Enables or disables writing the depth buffer for this object and sends
a message notifying the interested structures of the change. | | final void | setDepthTestFunction(int function)
Set depth test function. | | final void | setIgnoreVertexColors(boolean state)
Enables or disables vertex colors for this RenderAttributes
component object and sends a
message notifying the interested structures of the change. | | final void | setRasterOp(int op)
| | final void | setRasterOpEnable(boolean flag)
| | final void | setStencilEnable(boolean state)
| | final void | setStencilFunction(int function, int refValue, int compareMask)
| | final void | setStencilOp(int failOp, int zFailOp, int zPassOp)
Set the stencil op. | | final void | setStencilWriteMask(int mask)
| | final void | setVisible(boolean state)
Sets the visibility flag for this RenderingAttributes
component object. | | synchronized void | updateMirrorObject(int component, Object value)
| | void | updateNative(Canvas3D c3d, boolean depthBufferWriteEnableOverride, boolean depthBufferEnableOverride)
Updates the native context. |
| ALPHA_TEST_FUNC | | final static int ALPHA_TEST_FUNC(Code) | | |
| ALPHA_TEST_VALUE | | final static int ALPHA_TEST_VALUE(Code) | | |
| DEPTH_ENABLE | | final static int DEPTH_ENABLE(Code) | | |
| DEPTH_TEST_FUNC | | final static int DEPTH_TEST_FUNC(Code) | | |
| DEPTH_WRITE_ENABLE | | final static int DEPTH_WRITE_ENABLE(Code) | | |
| IGNORE_VCOLOR | | final static int IGNORE_VCOLOR(Code) | | |
| LEQUAL | | final static int LEQUAL(Code) | | |
| LESS | | final static int LESS(Code) | | |
| RASTER_OP_ENABLE | | final static int RASTER_OP_ENABLE(Code) | | |
| RASTER_OP_VALUE | | final static int RASTER_OP_VALUE(Code) | | |
| STENCIL_ENABLE | | final static int STENCIL_ENABLE(Code) | | |
| STENCIL_FUNC | | final static int STENCIL_FUNC(Code) | | |
| STENCIL_OP_VALUES | | final static int STENCIL_OP_VALUES(Code) | | |
| STENCIL_WRITE_MASK | | final static int STENCIL_WRITE_MASK(Code) | | |
| VISIBLE | | final static int VISIBLE(Code) | | |
| alphaTestFunction | | int alphaTestFunction(Code) | | |
| alphaTestValue | | float alphaTestValue(Code) | | |
| depthBufferEnable | | boolean depthBufferEnable(Code) | | |
| depthBufferWriteEnable | | boolean depthBufferWriteEnable(Code) | | |
| depthTestFunction | | int depthTestFunction(Code) | | |
| ignoreVertexColors | | boolean ignoreVertexColors(Code) | | |
| rasterOpEnable | | boolean rasterOpEnable(Code) | | |
| stencilCompareMask | | int stencilCompareMask(Code) | | |
| stencilEnable | | boolean stencilEnable(Code) | | |
| stencilFailOp | | int stencilFailOp(Code) | | |
| stencilFunction | | int stencilFunction(Code) | | |
| stencilReferenceValue | | int stencilReferenceValue(Code) | | |
| stencilWriteMask | | int stencilWriteMask(Code) | | |
| stencilZFailOp | | int stencilZFailOp(Code) | | |
| stencilZPassOp | | int stencilZPassOp(Code) | | |
| createMirrorObject | | synchronized void createMirrorObject()(Code) | | Creates and initializes a mirror object, point the mirror object
to the retained object if the object is not editable
|
| getAlphaTestFunction | | final int getAlphaTestFunction()(Code) | | Retrieves current alpha test function.
the current alpha test function |
| getAlphaTestValue | | final float getAlphaTestValue()(Code) | | Retrieves the alpha test value.
the alpha test value. |
| getDepthBufferEnable | | final boolean getDepthBufferEnable()(Code) | | Retrieves the state of zBuffer Enable flag
true if depth buffer mode is enabled, falseif depth buffer mode is disabled |
| getDepthBufferWriteEnable | | final boolean getDepthBufferWriteEnable()(Code) | | Retrieves the state of Depth Buffer Write Enable flag
true if depth buffer is writable, falseif depth buffer is read-only |
| getDepthTestFunction | | final int getDepthTestFunction()(Code) | | Retrieves current depth test function.
the current depth test function
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
| getIgnoreVertexColors | | final boolean getIgnoreVertexColors()(Code) | | Retrieves the state of vertex color Enable flag
true if vertex colors are enabled, falseif vertex colors are disabled |
| getRasterOp | | final int getRasterOp()(Code) | | Retrieves the current raster op value.
|
| getRasterOpEnable | | final boolean getRasterOpEnable()(Code) | | Retrieves the current raster op enable flag.
|
| getStencilEnable | | final boolean getStencilEnable()(Code) | | Retrieves the current stencil enable state.
|
| getStencilFunction | | final void getStencilFunction(int[] params)(Code) | | Retrieves the current stencil op. value
|
| getStencilOp | | final void getStencilOp(int[] stencilOps)(Code) | | Retrieves the current stencil op. value
|
| getStencilWriteMask | | final int getStencilWriteMask()(Code) | | Retrieves the current stencil write mask
|
| getVisible | | final boolean getVisible()(Code) | | Retrieves the visibility flag for this RenderingAttributes object.
true if the object is visible; falseif the object is invisible.
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph |
| handleFrequencyChange | | void handleFrequencyChange(int bit)(Code) | | |
| initAlphaTestFunction | | final void initAlphaTestFunction(int function)(Code) | | Set alpha test function. This function is used to compare the
alpha test value with each per-pixel alpha value. If the test
passes, then the pixel is written otherwise the pixel is not
written.
Parameters:
function - the new alpha test function. One of:ALWAYS, NEVER, EQUAL, NOT_EQUAL, LESS, LESS_OR_EQUAL, GREATER,GREATER_OR_EQUAL. |
| initAlphaTestValue | | final void initAlphaTestValue(float value)(Code) | | Set alpha test value used by alpha test function. This value is
compared to the alpha value of each rendered pixel.
Parameters:
value - the alpha value |
| initDepthBufferEnable | | final void initDepthBufferEnable(boolean state)(Code) | | Enables or disables depth buffer mode for this RenderAttributes
component object.
Parameters:
state - true or false to enable or disable depth buffer mode |
| initDepthBufferWriteEnable | | final void initDepthBufferWriteEnable(boolean state)(Code) | | Enables or disables writing the depth buffer for this object.
During the transparent rendering pass,
this attribute can be overridden by
the depthBufferFreezeTransparent attribute in the View object.
Parameters:
state - true or false to enable or disable depth buffer Write mode
See Also: View.setDepthBufferFreezeTransparent |
| initDepthTestFunction | | final void initDepthTestFunction(int function)(Code) | | Set depth test function. This function is used to compare the
depth test value with each per-pixel alpha value. If the test
passes, then the pixel is written otherwise the pixel is not
written.
Parameters:
function - the new depth test function. One of:ALWAYS, NEVER, EQUAL, NOT_EQUAL, LESS, LESS_OR_EQUAL, GREATER,GREATER_OR_EQUAL.Default value is LESS_OR_EQUAL |
| initIgnoreVertexColors | | final void initIgnoreVertexColors(boolean state)(Code) | | Enables or disables vertex colors for this RenderAttributes
component object.
Parameters:
state - true or false to enable or disable vertex colors |
| initMirrorObject | | synchronized void initMirrorObject()(Code) | | Initializes a mirror object, point the mirror object to the retained
object if the object is not editable
|
| initRasterOp | | final void initRasterOp(int op)(Code) | | Initialize the raster op value
|
| initRasterOpEnable | | final void initRasterOpEnable(boolean flag)(Code) | | Initialize the raster op enable flag
|
| initStencilEnable | | final void initStencilEnable(boolean state)(Code) | | Initialize the stencil enable state
|
| initStencilFunction | | final void initStencilFunction(int function, int refValue, int compareMask)(Code) | | Initialize the stencil function value
|
| initStencilOp | | final void initStencilOp(int failOp, int zFailOp, int zPassOp)(Code) | | Initialize the stencil op. value
|
| initStencilWriteMask | | final void initStencilWriteMask(int mask)(Code) | | Initialize the stencil write mask
|
| initVisible | | final void initVisible(boolean state)(Code) | | Sets the visibility flag for this RenderingAttributes component object.
Parameters:
visible - true or false to enable or disable visibility
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
See Also: View.setVisibilityPolicy |
| sendMessage | | final void sendMessage(int attrMask, Object attr)(Code) | | |
| setAlphaTestFunction | | final void setAlphaTestFunction(int function)(Code) | | Set alpha test function and sends a
message notifying the interested structures of the change.
This function is used to compare the
alpha test value with each per-pixel alpha value. If the test
passes, then the pixel is written otherwise the pixel is not
written.
Parameters:
function - the new alpha test function. One of:ALWAYS, NEVER, EQUAL, NOT_EQUAL, LESS, LESS_OR_EQUAL, GREATER,GREATER_OR_EQUAL. |
| setAlphaTestValue | | final void setAlphaTestValue(float value)(Code) | | Set alpha test value used by alpha test function and sends a
message notifying the interested structures of the change.
This value is compared to the alpha value of each rendered pixel.
Parameters:
value - the alpha value |
| setDepthBufferEnable | | final void setDepthBufferEnable(boolean state)(Code) | | Enables or disables depth buffer mode for this RenderAttributes
component object and sends a
message notifying the interested structures of the change.
Parameters:
state - true or false to enable or disable depth buffer mode |
| setDepthBufferWriteEnable | | final void setDepthBufferWriteEnable(boolean state)(Code) | | Enables or disables writing the depth buffer for this object and sends
a message notifying the interested structures of the change.
During the transparent rendering pass,
this attribute can be overridden by
the depthBufferFreezeTransparent attribute in the View object.
Parameters:
state - true or false to enable or disable depth buffer Write mode
See Also: View.setDepthBufferFreezeTransparent |
| setDepthTestFunction | | final void setDepthTestFunction(int function)(Code) | | Set depth test function. This function is used to compare the
depth test value with each per-pixel depth value. If the test
passes, the pixel is written otherwise the pixel is not
written.
Parameters:
function - the new depth test function. One ofALWAYS, NEVER, EQUAL, NOT_EQUAL, LESS, LESS_OR_EQUAL, GREATER,GREATER_OR_EQUALDefault value is LESS_OR_EQUAL |
| setIgnoreVertexColors | | final void setIgnoreVertexColors(boolean state)(Code) | | Enables or disables vertex colors for this RenderAttributes
component object and sends a
message notifying the interested structures of the change.
Parameters:
state - true or false to enable or disable depth vertex colors |
| setRasterOp | | final void setRasterOp(int op)(Code) | | Set the raster op value
|
| setRasterOpEnable | | final void setRasterOpEnable(boolean flag)(Code) | | Set the raster op enable flag
|
| setStencilEnable | | final void setStencilEnable(boolean state)(Code) | | Set the stencil enable state
|
| setStencilFunction | | final void setStencilFunction(int function, int refValue, int compareMask)(Code) | | Set the stencil function value
|
| setStencilOp | | final void setStencilOp(int failOp, int zFailOp, int zPassOp)(Code) | | Set the stencil op. value
|
| setStencilWriteMask | | final void setStencilWriteMask(int mask)(Code) | | Set the stencil write mask
|
| setVisible | | final void setVisible(boolean state)(Code) | | Sets the visibility flag for this RenderingAttributes
component object. Invisible objects are not rendered (subject to
the visibility policy for the current view), but they can be picked
or collided with.
Parameters:
visible - true or false to enable or disable visibility
exception:
CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
See Also: View.setVisibilityPolicy |
| updateMirrorObject | | synchronized void updateMirrorObject(int component, Object value)(Code) | | Update the "component" field of the mirror object with the
given "value"
|
| updateNative | | void updateNative(Canvas3D c3d, boolean depthBufferWriteEnableOverride, boolean depthBufferEnableOverride)(Code) | | Updates the native context.
|
| Fields inherited from javax.media.j3d.IndexedObject | int[][] listIdx(Code)(Java Doc)
|
|
|