text3d.html

JAVA多媒体开发类库说明

<DL>
<DD>Copies the character string used in the construction of the
 Text3D node into the supplied parameter.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a copy of the String object in this Text3D node.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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="setString(java.lang.String)"><!-- --></A><H3>
setString</H3>
<PRE>
public void <B>setString</B>(java.lang.String&nbsp;string)</PRE>
<DL>
<DD>Copies the character string from the supplied parameter into the
 Text3D node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>string</CODE> - the String object to recieve the Text3D node's string.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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="getPosition(javax.vecmath.Point3f)"><!-- --></A><H3>
getPosition</H3>
<PRE>
public void <B>getPosition</B>(<A HREF="../../../javax/vecmath/Point3f.html" title="class in javax.vecmath">Point3f</A>&nbsp;position)</PRE>
<DL>
<DD>Copies the node's <code>position</code> field into the supplied
 parameter.  The <code>position</code> is used to determine the
 initial placement of the Text3D string.  The position, combined with
 the path and alignment control how the text is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>position</CODE> - the point to position the text.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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/Text3D.html#getAlignment()"><CODE>getAlignment()</CODE></A>, 
<A HREF="../../../javax/media/j3d/Text3D.html#getPath()"><CODE>getPath()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setPosition(javax.vecmath.Point3f)"><!-- --></A><H3>
setPosition</H3>
<PRE>
public void <B>setPosition</B>(<A HREF="../../../javax/vecmath/Point3f.html" title="class in javax.vecmath">Point3f</A>&nbsp;position)</PRE>
<DL>
<DD>Sets the node's <code>position</code> field to the supplied
 parameter.  The <code>position</code> is used to determine the
 initial placement of the Text3D string.  The position, combined with
 the path and alignment control how the text is displayed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>position</CODE> - the point to position the text.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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/Text3D.html#getAlignment()"><CODE>getAlignment()</CODE></A>, 
<A HREF="../../../javax/media/j3d/Text3D.html#getPath()"><CODE>getPath()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getAlignment()"><!-- --></A><H3>
getAlignment</H3>
<PRE>
public int <B>getAlignment</B>()</PRE>
<DL>
<DD>Retrieves the text alignment policy for this Text3D NodeComponent
 object. The <code>alignment</code> is used to specify how
 glyphs in the string are placed in relation to the
 <code>position</code> field.  Valid values for this field
 are:
 <UL>
 <LI> ALIGN_CENTER - the center of the string is placed on the
  <code>position</code> point.
 <LI> ALIGN_FIRST - the first character of the string is placed on
   the <code>position</code> point.
 <LI> ALIGN_LAST - the last character of the string is placed on the
   <code>position</code> point.
 </UL>
 The default value of this field is <code>ALIGN_FIRST</code>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the current alingment policy for this node.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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/Text3D.html#getPosition(javax.vecmath.Point3f)"><CODE>getPosition(javax.vecmath.Point3f)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setAlignment(int)"><!-- --></A><H3>
setAlignment</H3>
<PRE>
public void <B>setAlignment</B>(int&nbsp;alignment)</PRE>
<DL>
<DD>Sets the text alignment policy for this Text3D NodeComponent
 object. The <code>alignment</code> is used to specify how
 glyphs in the string are placed in relation to the
 <code>position</code> field.  Valid values for this field
 are:
 <UL>
 <LI> ALIGN_CENTER - the center of the string is placed on the
  <code>position</code> point.
 <LI> ALIGN_FIRST - the first character of the string is placed on
   the <code>position</code> point.
 <LI> ALIGN_LAST - the last character of the string is placed on the
   <code>position</code> point.
 </UL>
 The default value of this field is <code>ALIGN_FIRST</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>alignment</CODE> - specifies how glyphs in the string are placed
 in relation to the position field
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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/Text3D.html#getPosition(javax.vecmath.Point3f)"><CODE>getPosition(javax.vecmath.Point3f)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getPath()"><!-- --></A><H3>
getPath</H3>
<PRE>
public int <B>getPath</B>()</PRE>
<DL>
<DD>Retrieves the node's <code>path</code> field.  This field
 is used  to specify how succeeding
 glyphs in the string are placed in relation to the previous glyph.
 Valid values for this field are:
 <UL>
 <LI> PATH_LEFT: - succeeding glyphs are placed to the left of the
  current glyph.
 <LI> PATH_RIGHT: - succeeding glyphs are placed to the right of the
  current glyph.
 <LI> PATH_UP: - succeeding glyphs are placed above the current glyph.
 <LI> PATH_DOWN: - succeeding glyphs are placed below the current glyph.
 </UL>
 The default value of this field is <code>PATH_RIGHT</code>.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the current alingment policy for this node.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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="setPath(int)"><!-- --></A><H3>
setPath</H3>
<PRE>
public void <B>setPath</B>(int&nbsp;path)</PRE>
<DL>
<DD>Sets the node's <code>path</code> field.  This field
 is used  to specify how succeeding
 glyphs in the string are placed in relation to the previous glyph.
 Valid values for this field are:
 <UL>
 <LI> PATH_LEFT - succeeding glyphs are placed to the left of the
  current glyph.
 <LI> PATH_RIGHT - succeeding glyphs are placed to the right of the
  current glyph.
 <LI> PATH_UP - succeeding glyphs are placed above the current glyph.
 <LI> PATH_DOWN - succeeding glyphs are placed below the current glyph.
 </UL>
 The default value of this field is <code>PATH_RIGHT</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the value to set the path to
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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="getBoundingBox(javax.media.j3d.BoundingBox)"><!-- --></A><H3>
getBoundingBox</H3>
<PRE>
public void <B>getBoundingBox</B>(<A HREF="../../../javax/media/j3d/BoundingBox.html" title="class in javax.media.j3d">BoundingBox</A>&nbsp;bounds)</PRE>
<DL>
<DD>Retrieves the 3D bounding box that encloses this Text3D object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bounds</CODE> - the object to copy the bounding information to.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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/BoundingBox.html" title="class in javax.media.j3d"><CODE>BoundingBox</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getCharacterSpacing()"><!-- --></A><H3>
getCharacterSpacing</H3>
<PRE>
public float <B>getCharacterSpacing</B>()</PRE>
<DL>
<DD>Retrieves the character spacing used to construct the Text3D string.
 This spacing is in addition to the regular spacing between glyphs as
 defined in the Font object.  1.0 in this space is measured as the
 width of the largest glyph in the 2D Font.  The default value is
 0.0.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the current character spacing value
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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="setCharacterSpacing(float)"><!-- --></A><H3>
setCharacterSpacing</H3>
<PRE>
public void <B>setCharacterSpacing</B>(float&nbsp;characterSpacing)</PRE>
<DL>
<DD>Sets the character spacing used when constructing the Text3D string.
 This spacing is in addition to the regular spacing between glyphs as
 defined in the Font object.  1.0 in this space is measured as the
 width of the largest glyph in the 2D Font.  The default value is
 0.0.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>characterSpacing</CODE> - the new character spacing value
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">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" title="class in javax.media.j3d">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" title="class in javax.media.j3d">NodeComponent</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <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/TexCoordGeneration.html" title="class in javax.media.j3d"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../javax/media/j3d/Texture.html" title="class in javax.media.j3d"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?javax/media/j3d/Text3D.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Text3D.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><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>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<font size="-1">Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to <a href="../../../LICENSE-SPEC.html">license terms</a>.
</BODY>
</HTML>