lineattributes.html

java 3d帮助文档

<HR>

<A NAME="LineAttributes(float, int, boolean)"><!-- --></A><H3>
LineAttributes</H3>
<PRE>
public <B>LineAttributes</B>(float&nbsp;lineWidth,
                      int&nbsp;linePattern,
                      boolean&nbsp;lineAntialiasing)</PRE>
<DL>
<DD>Constructs a LineAttributes object with specified values.
<P>
<DT><B>Parameters:</B><DD><CODE>lineWidth</CODE> - the width of lines in pixels<DD><CODE>linePattern</CODE> - the line pattern, one of PATTERN_SOLID,
 PATTERN_DASH, PATTERN_DOT, or PATTERN_DASH_DOT<DD><CODE>lineAntialiasing</CODE> - flag to set line antialising ON or OFF</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="setLineWidth(float)"><!-- --></A><H3>
setLineWidth</H3>
<PRE>
public void <B>setLineWidth</B>(float&nbsp;lineWidth)</PRE>
<DL>
<DD>Sets the line width for this LineAttributes component object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lineWidth</CODE> - the width, in pixels, of line primitives
<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="getLineWidth()"><!-- --></A><H3>
getLineWidth</H3>
<PRE>
public float <B>getLineWidth</B>()</PRE>
<DL>
<DD>Gets the line width for this LineAttributes component object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the width, in pixels, of line primitives
<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="setLinePattern(int)"><!-- --></A><H3>
setLinePattern</H3>
<PRE>
public void <B>setLinePattern</B>(int&nbsp;linePattern)</PRE>
<DL>
<DD>Sets the line pattern for this LineAttributes component object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>linePattern</CODE> - the line pattern to be used, one of:
 PATTERN_SOLID, PATTERN_DASH, PATTERN_DOT, PATTERN_DASH_DOT, or
 PATTERN_USER_DEFINED.
<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="getLinePattern()"><!-- --></A><H3>
getLinePattern</H3>
<PRE>
public int <B>getLinePattern</B>()</PRE>
<DL>
<DD>Gets the line pattern for this LineAttributes component object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the line pattern
<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="setPatternMask(int)"><!-- --></A><H3>
setPatternMask</H3>
<PRE>
public void <B>setPatternMask</B>(int&nbsp;mask)</PRE>
<DL>
<DD>Sets the line pattern mask to the specified value.  This is
 used when the linePattern attribute is set to
 PATTERN_USER_DEFINED.  In this mode, the pattern is specified
 using a 16-bit mask that specifies on and off segments.  Bit 0
 in the pattern mask corresponds to the first pixel of the line
 or line strip primitive.  A value of 1 for a bit in the pattern
 mask indicates that the corresponding pixel is drawn, while a
 value of 0 indicates that the corresponding pixel is not drawn.
 After all 16 bits in the pattern are used, the pattern is
 repeated.  For example, a mask of 0x00ff defines a dashed line
 with a repeating pattern of 8 pixels on followed by 8 pixels
 off.  A value of 0x0101 defines a a dotted line with a
 repeating pattern of 1 pixel on and 7 pixels off
 <p>
 The pattern continues around individual line segments of a line
 strip primitive.  It is restarted at the beginning of each new
 line strip.  For line array primitives, the pattern is
 restarted at the beginning of each line.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mask</CODE> - the new line pattern mask
<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<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/LineAttributes.html#setPatternScaleFactor(int)"><CODE>setPatternScaleFactor(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getPatternMask()"><!-- --></A><H3>
getPatternMask</H3>
<PRE>
public int <B>getPatternMask</B>()</PRE>
<DL>
<DD>Retrieves the line pattern mask.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the line pattern mask
<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<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setPatternScaleFactor(int)"><!-- --></A><H3>
setPatternScaleFactor</H3>
<PRE>
public void <B>setPatternScaleFactor</B>(int&nbsp;scaleFactor)</PRE>
<DL>
<DD>Sets the line pattern scale factor to the specified value.
 This is used in conjunction with the patternMask when the
 linePattern attribute is set to PATTERN_USER_DEFINED.  The
 pattern is multiplied by the scale factor such that each bit in
 the pattern mask corresponds to that many consecutive pixels.
 For example, a scale factor of 3 applied to a pattern mask of
 0x001f would produce a repeating pattern of 15 pixels on
 followed by 33 pixels off. The valid range for this attribute
 is [1,15].  Values outside this range are clamped.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scaleFactor</CODE> - the new line pattern scale factor
<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<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/LineAttributes.html#setPatternMask(int)"><CODE>setPatternMask(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getPatternScaleFactor()"><!-- --></A><H3>
getPatternScaleFactor</H3>
<PRE>
public int <B>getPatternScaleFactor</B>()</PRE>
<DL>
<DD>Retrieves the line pattern scale factor.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the line pattern scale factor
<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<DT><B>Since:</B><DD>Java 3D 1.2</DD>
</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setLineAntialiasingEnable(boolean)"><!-- --></A><H3>
setLineAntialiasingEnable</H3>
<PRE>
public void <B>setLineAntialiasingEnable</B>(boolean&nbsp;state)</PRE>
<DL>
<DD>Enables or disables line antialiasing
 for this LineAttributes component object.
 <p>
 If antialiasing is enabled, the lines are considered transparent
 for rendering purposes.  They are rendered with all the other 
 transparent objects and adhere to the other transparency settings 
 such as the View transparency sorting policy and the View depth buffer 
 freeze transparent enable.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - true or false to enable or disable line antialiasing
<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<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/View.html"><CODE>View</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getLineAntialiasingEnable()"><!-- --></A><H3>
getLineAntialiasingEnable</H3>
<PRE>
public boolean <B>getLineAntialiasingEnable</B>()</PRE>
<DL>
<DD>Retrieves the state of the line antialiasing flag.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if line antialiasing is enabled,
 false if line antialiasing 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="cloneNodeComponent()"><!-- --></A><H3>
cloneNodeComponent</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/NodeComponent.html">NodeComponent</A> <B>cloneNodeComponent</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>replaced with cloneNodeComponent(boolean forceDuplicate)</I>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../javax/media/j3d/NodeComponent.html#cloneNodeComponent()">cloneNodeComponent</A></CODE> in class <CODE><A HREF="../../../javax/media/j3d/NodeComponent.html">NodeComponent</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../javax/media/j3d/LineArray.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../javax/media/j3d/LineStripArray.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="LineAttributes.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>