renderingattributes.html

java 3d帮助文档

<HR>

<A NAME="ALLOW_VISIBLE_READ"><!-- --></A><H3>
ALLOW_VISIBLE_READ</H3>
<PRE>
public static final int <B>ALLOW_VISIBLE_READ</B></PRE>
<DL>
<DD>Specifies that this RenderingAttributes object
 allows reading its visibility information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ALLOW_VISIBLE_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_VISIBLE_WRITE"><!-- --></A><H3>
ALLOW_VISIBLE_WRITE</H3>
<PRE>
public static final int <B>ALLOW_VISIBLE_WRITE</B></PRE>
<DL>
<DD>Specifies that this RenderingAttributes object
 allows writing its visibility information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ALLOW_VISIBLE_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_IGNORE_VERTEX_COLORS_READ"><!-- --></A><H3>
ALLOW_IGNORE_VERTEX_COLORS_READ</H3>
<PRE>
public static final int <B>ALLOW_IGNORE_VERTEX_COLORS_READ</B></PRE>
<DL>
<DD>Specifies that this RenderingAttributes object
 allows reading its ignore vertex colors information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ALLOW_IGNORE_VERTEX_COLORS_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_IGNORE_VERTEX_COLORS_WRITE"><!-- --></A><H3>
ALLOW_IGNORE_VERTEX_COLORS_WRITE</H3>
<PRE>
public static final int <B>ALLOW_IGNORE_VERTEX_COLORS_WRITE</B></PRE>
<DL>
<DD>Specifies that this RenderingAttributes object
 allows writing its ignore vertex colors information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ALLOW_IGNORE_VERTEX_COLORS_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_RASTER_OP_READ"><!-- --></A><H3>
ALLOW_RASTER_OP_READ</H3>
<PRE>
public static final int <B>ALLOW_RASTER_OP_READ</B></PRE>
<DL>
<DD>Specifies that this RenderingAttributes object
 allows reading its raster operation information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ALLOW_RASTER_OP_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_RASTER_OP_WRITE"><!-- --></A><H3>
ALLOW_RASTER_OP_WRITE</H3>
<PRE>
public static final int <B>ALLOW_RASTER_OP_WRITE</B></PRE>
<DL>
<DD>Specifies that this RenderingAttributes object
 allows writing its raster operation information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ALLOW_RASTER_OP_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALWAYS"><!-- --></A><H3>
ALWAYS</H3>
<PRE>
public static final int <B>ALWAYS</B></PRE>
<DL>
<DD>Indicates pixels are always drawn irrespective of alpha value.
 This effectively disables alpha testing.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ALWAYS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="NEVER"><!-- --></A><H3>
NEVER</H3>
<PRE>
public static final int <B>NEVER</B></PRE>
<DL>
<DD>Indicates pixels are never drawn irrespective of alpha value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.NEVER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="EQUAL"><!-- --></A><H3>
EQUAL</H3>
<PRE>
public static final int <B>EQUAL</B></PRE>
<DL>
<DD>Indicates pixels are  drawn if pixel alpha value is equal 
 to alpha test value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.EQUAL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="NOT_EQUAL"><!-- --></A><H3>
NOT_EQUAL</H3>
<PRE>
public static final int <B>NOT_EQUAL</B></PRE>
<DL>
<DD>Indicates pixels are  drawn if pixel alpha value is not equal
 to alpha test value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.NOT_EQUAL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="LESS"><!-- --></A><H3>
LESS</H3>
<PRE>
public static final int <B>LESS</B></PRE>
<DL>
<DD>Indicates pixels are  drawn if pixel alpha value is less 
 than alpha test value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.LESS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="LESS_OR_EQUAL"><!-- --></A><H3>
LESS_OR_EQUAL</H3>
<PRE>
public static final int <B>LESS_OR_EQUAL</B></PRE>
<DL>
<DD>Indicates pixels are  drawn if pixel alpha value is less
 than or equal to alpha test value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.LESS_OR_EQUAL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="GREATER"><!-- --></A><H3>
GREATER</H3>
<PRE>
public static final int <B>GREATER</B></PRE>
<DL>
<DD>Indicates pixels are  drawn if pixel alpha value is greater
 than alpha test value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.GREATER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="GREATER_OR_EQUAL"><!-- --></A><H3>
GREATER_OR_EQUAL</H3>
<PRE>
public static final int <B>GREATER_OR_EQUAL</B></PRE>
<DL>
<DD>Indicates pixels are  drawn if pixel alpha value is greater
 than or equal to alpha test value.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.GREATER_OR_EQUAL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ROP_COPY"><!-- --></A><H3>
ROP_COPY</H3>
<PRE>
public static final int <B>ROP_COPY</B></PRE>
<DL>
<DD>Raster operation: <code>DST = SRC</code>.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/RenderingAttributes.html#setRasterOp(int)"><CODE>setRasterOp(int)</CODE></A>, 
<A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ROP_COPY">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ROP_XOR"><!-- --></A><H3>
ROP_XOR</H3>
<PRE>
public static final int <B>ROP_XOR</B></PRE>
<DL>
<DD>Raster operation: <code>DST = SRC ^ DST</code>.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/RenderingAttributes.html#setRasterOp(int)"><CODE>setRasterOp(int)</CODE></A>, 
<A HREF="../../../constant-values.html#javax.media.j3d.RenderingAttributes.ROP_XOR">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="RenderingAttributes()"><!-- --></A><H3>
RenderingAttributes</H3>
<PRE>
public <B>RenderingAttributes</B>()</PRE>
<DL>
<DD>Constructs a RenderingAttributes object with default parameters.
 The default values are as follows:
 <ul>
 depth buffer enable : true<br>
 depth buffer write enable : true<br>
 alpha test function : ALWAYS<br>
 alpha test value : 0.0<br>
 visible : true<br>
 ignore vertex colors : false<br>
 raster operation enable : false<br>
 raster operation : ROP_COPY<br>
 </ul>
<P>
</DL>
<HR>

<A NAME="RenderingAttributes(boolean, boolean, float, int)"><!-- --></A><H3>
RenderingAttributes</H3>
<PRE>
public <B>RenderingAttributes</B>(boolean&nbsp;depthBufferEnable,
                           boolean&nbsp;depthBufferWriteEnable,
                           float&nbsp;alphaTestValue,
                           int&nbsp;alphaTestFunction)</PRE>
<DL>
<DD>Constructs a RenderingAttributes object with specified values.
<P>
<DT><B>Parameters:</B><DD><CODE>depthBufferEnable</CODE> - a flag to turn depth buffer on/off<DD><CODE>depthBufferWriteEnable</CODE> - a flag to to make depth buffer
 read/write or read only<DD><CODE>alphaTestValue</CODE> - the alpha test reference value<DD><CODE>alphaTestFunction</CODE> - the function for comparing alpha values</DL>
<HR>

<A NAME="RenderingAttributes(boolean, boolean, float, int, boolean, boolean, boolean, int)"><!-- --></A><H3>
RenderingAttributes</H3>
<PRE>
public <B>RenderingAttributes</B>(boolean&nbsp;depthBufferEnable,
                           boolean&nbsp;depthBufferWriteEnable,
                           float&nbsp;alphaTestValue,
                           int&nbsp;alphaTestFunction,
                           boolean&nbsp;visible,
                           boolean&nbsp;ignoreVertexColors,
                           boolean&nbsp;rasterOpEnable,
                           int&nbsp;rasterOp)</PRE>
<DL>
<DD>Constructs a RenderingAttributes object with specified values
<P>
<DT><B>Parameters:</B><DD><CODE>depthBufferEnable</CODE> - a flag to turn depth buffer on/off<DD><CODE>depthBufferWriteEnable</CODE> - a flag to make depth buffer
 read/write or read only<DD><CODE>alphaTestValue</CODE> - the alpha test reference value<DD><CODE>alphaTestFunction</CODE> - the function for comparing alpha values<DD><CODE>visible</CODE> - a flag that specifies whether the object is visible<DD><CODE>ignoreVertexColors</CODE> - a flag to enable or disable
 the ignoring of per-vertex colors<DD><CODE>rasterOpEnable</CODE> - a flag that specifies whether logical
 raster operations are enabled for this RenderingAttributes object.
 This disables all alpha blending operations.<DD><CODE>rasterOp</CODE> - the logical raster operation, one of ROP_COPY or
 ROP_XOR.<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="setDepthBufferEnable(boolean)"><!-- --></A><H3>
setDepthBufferEnable</H3>
<PRE>
public void <B>setDepthBufferEnable</B>(boolean&nbsp;state)</PRE>
<DL>
<DD>Enables or disables depth buffer mode for this RenderingAttributes
 component object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - true or false to enable or disable depth buffer mode
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html">CapabilityNotSetException</A></CODE> - if appropriate capability is 
 not set and this object is part of live or compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="getDepthBufferEnable()"><!-- --></A><H3>
getDepthBufferEnable</H3>
<PRE>
public boolean <B>getDepthBufferEnable</B>()</PRE>
<DL>
<DD>Retrieves the state of zBuffer Enable flag
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if depth buffer mode is enabled, false
 if depth buffer mode is disabled
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html">CapabilityNotSetException</A></CODE> - if appropriate capability is 
 not set and this object is part of live or compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="setDepthBufferWriteEnable(boolean)"><!-- --></A><H3>
setDepthBufferWriteEnable</H3>
<PRE>
public void <B>setDepthBufferWriteEnable</B>(boolean&nbsp;state)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - true or false to enable or disable depth buffer Write mode
<DT><B>Throws:</B>