scenegraphobject.html

JAVA多媒体开发类库说明

<HR>

<A NAME="setCapability(int)"><!-- --></A><H3>
setCapability</H3>
<PRE>
public final void <B>setCapability</B>(int&nbsp;bit)</PRE>
<DL>
<DD>Sets the specified capability bit.  Note that only one capability bit
 may be set per method invocation--capability bits cannot be ORed
 together.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bit</CODE> - the bit to set
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html" title="class in javax.media.j3d">RestrictedAccessException</A></CODE> - if this object is part of live
 or compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="clearCapability(int)"><!-- --></A><H3>
clearCapability</H3>
<PRE>
public final void <B>clearCapability</B>(int&nbsp;bit)</PRE>
<DL>
<DD>Clear the specified capability bit.  Note that only one capability bit
 may be cleared per method invocation--capability bits cannot be ORed
 together.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bit</CODE> - the bit to clear
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html" title="class in javax.media.j3d">RestrictedAccessException</A></CODE> - if this object is part of live
 or compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="getCapabilityIsFrequent(int)"><!-- --></A><H3>
getCapabilityIsFrequent</H3>
<PRE>
public final boolean <B>getCapabilityIsFrequent</B>(int&nbsp;bit)</PRE>
<DL>
<DD>Retrieves the isFrequent bit associated with the specified capability
 bit.

 Note that only one isFrequent bit, for a single capability
 bit, may be retrieved per method invocation--capability bits cannot
 be ORed together.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bit</CODE> - the bit whose value is returned
<DT><B>Returns:</B><DD>true if the isFrequent bit is set, false if the isFrequent
 bit is clear<DT><B>Since:</B></DT>
  <DD>Java 3D 1.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setCapabilityIsFrequent(int)"><!-- --></A><H3>
setCapabilityIsFrequent</H3>
<PRE>
public final void <B>setCapabilityIsFrequent</B>(int&nbsp;bit)</PRE>
<DL>
<DD>Sets the isFrequent bit associated with the specified
 capability bit.  Setting the isFrequent bit indicates that the
 application may frequently access or modify those attributes
 permitted by the associated capability bit.  This can be used
 by Java 3D as a hint to avoid certain optimizations that could
 cause those accesses or modifications to be expensive.  By
 default the isFrequent bit associated with each capability bit
 is set.

 <p>
 Unlike setCapability, this method may be called on a live scene
 graph object (but not on a compiled object).

 <p>
 Note that only one isFrequent bit, for a single capability bit,
 may be set per method invocation--capability bits cannot be ORed
 together.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bit</CODE> - the capability bit for which to set the associated
 isFrequent bit
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html" title="class in javax.media.j3d">RestrictedAccessException</A></CODE> - if this object is part of a
 compiled scene graph<DT><B>Since:</B></DT>
  <DD>Java 3D 1.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="clearCapabilityIsFrequent(int)"><!-- --></A><H3>
clearCapabilityIsFrequent</H3>
<PRE>
public final void <B>clearCapabilityIsFrequent</B>(int&nbsp;bit)</PRE>
<DL>
<DD>Clears the isFrequent bit associated with the specified
 capability bit.  Clearing the isFrequent bit indicates that the
 application will infrequently access or modify those attributes
 permitted by the associated capability bit.  This can be used
 by Java 3D as a hint to enable certain optimizations that it
 might otherwise avoid, for example, optimizations that could
 cause those accesses or modifications to be expensive.

 <p>
 Unlike clearCapability, this method may be called on a live scene
 graph object (but not on a compiled object).

 <p>
 Note that only one isFrequent bit, for a single capability bit,
 may be cleared per method invocation--capability bits cannot be ORed
 together.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bit</CODE> - the capability bit for which to clear the associated
 isFrequent bit
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html" title="class in javax.media.j3d">RestrictedAccessException</A></CODE> - if this object is part of a
 compiled scene graph<DT><B>Since:</B></DT>
  <DD>Java 3D 1.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="isCompiled()"><!-- --></A><H3>
isCompiled</H3>
<PRE>
public final boolean <B>isCompiled</B>()</PRE>
<DL>
<DD>Returns a flag indicating whether the node is part of a scene graph
 that has been compiled.  If so, then only those capabilities explicitly
 allowed by the object's capability bits are allowed.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if node is part of a compiled scene graph, else false</DL>
</DD>
</DL>
<HR>

<A NAME="isLive()"><!-- --></A><H3>
isLive</H3>
<PRE>
public final boolean <B>isLive</B>()</PRE>
<DL>
<DD>Returns a flag indicating whether the node is part of a live
 scene graph.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if node is part of a live scene graph, else false</DL>
</DD>
</DL>
<HR>

<A NAME="setUserData(java.lang.Object)"><!-- --></A><H3>
setUserData</H3>
<PRE>
public void <B>setUserData</B>(java.lang.Object&nbsp;userData)</PRE>
<DL>
<DD>Sets the userData field associated with this scene graph object.
 The userData field is a reference to an arbitrary object
 and may be used to store any user-specific data associated
 with this scene graph object--it is not used by the Java 3D API.
 If this object is cloned, the userData field is copied
 to the newly cloned object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>userData</CODE> - a reference to the new userData field</DL>
</DD>
</DL>
<HR>

<A NAME="getUserData()"><!-- --></A><H3>
getUserData</H3>
<PRE>
public java.lang.Object <B>getUserData</B>()</PRE>
<DL>
<DD>Retrieves the userData field from this scene graph object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the current userData field</DL>
</DD>
</DL>
<HR>

<A NAME="updateNodeReferences(javax.media.j3d.NodeReferenceTable)"><!-- --></A><H3>
updateNodeReferences</H3>
<PRE>
public void <B>updateNodeReferences</B>(<A HREF="../../../javax/media/j3d/NodeReferenceTable.html" title="class in javax.media.j3d">NodeReferenceTable</A>&nbsp;referenceTable)</PRE>
<DL>
<DD>Callback used to allow a node to check if any scene graph objects
 referenced by that node have been duplicated via a call to 
 <code>cloneTree</code>.
 This method is called by <code>cloneTree</code> after all nodes in
 the sub-graph have been duplicated. The cloned Leaf
 node and cloned NodeComponent's method
 will be called and the Leaf node/NodeComponent can then look up
 any object references
 by using the <code>getNewObjectReference</code> method found in the
 <code>NodeReferenceTable</code> object.  If a match is found, a
 reference to the corresponding object in the newly cloned sub-graph
 is returned.  If no corresponding reference is found, either a
 DanglingReferenceException is thrown or a reference to the original
 object is returned depending on the value of the
 <code>allowDanglingReferences</code> parameter passed in the
 <code>cloneTree</code> call.
 <p>
 NOTE: Applications should <i>not</i> call this method directly.
 It should only be called by the cloneTree method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>referenceTable</CODE> - a NodeReferenceTableObject that contains the
  <code>getNewObjectReference</code> method needed to search for
  new object instances.<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/NodeReferenceTable.html" title="class in javax.media.j3d"><CODE>NodeReferenceTable</CODE></A>, 
<A HREF="../../../javax/media/j3d/Node.html#cloneTree()"><CODE>Node.cloneTree()</CODE></A>, 
<A HREF="../../../javax/media/j3d/DanglingReferenceException.html" title="class in javax.media.j3d"><CODE>DanglingReferenceException</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setName(java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Sets the name of this object. Object names are for information
 only.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the new name of this object<DT><B>Since:</B></DT>
  <DD>Java 3D 1.4</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Returns the name of this object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the name of this object<DT><B>Since:</B></DT>
  <DD>Java 3D 1.4</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="duplicateSceneGraphObject(javax.media.j3d.SceneGraphObject)"><!-- --></A><H3>
duplicateSceneGraphObject</H3>
<PRE>
protected void <B>duplicateSceneGraphObject</B>(<A HREF="../../../javax/media/j3d/SceneGraphObject.html" title="class in javax.media.j3d">SceneGraphObject</A>&nbsp;originalNode)</PRE>
<DL>
<DD>Copies all SceneGraphObject information from
 <code>originalNode</code> into
 the current node.  This method is called from the
 <code>cloneNode</code> method which is, in turn, called by the
 <code>cloneTree</code> method.
 <P>
 NOTE: Applications should <i>not</i> call this method directly.
 It should only be called by the cloneNode method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>originalNode</CODE> - the original node to duplicate.<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/Group.html#cloneNode(boolean)"><CODE>Group.cloneNode(boolean)</CODE></A>, 
<A HREF="../../../javax/media/j3d/Node.html#duplicateNode(javax.media.j3d.Node, boolean)"><CODE>Node.duplicateNode(javax.media.j3d.Node, boolean)</CODE></A>, 
<A HREF="../../../javax/media/j3d/Node.html#cloneTree()"><CODE>Node.cloneTree()</CODE></A>, 
<A HREF="../../../javax/media/j3d/NodeComponent.html#setDuplicateOnCloneTree(boolean)"><CODE>NodeComponent.setDuplicateOnCloneTree(boolean)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Returns a String representation of this SceneGraphObject.
 If its name is non-null, then it is concatenated with
 super.toString().
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</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/SceneGraphCycleException.html" title="class in javax.media.j3d"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../javax/media/j3d/SceneGraphPath.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/SceneGraphObject.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="SceneGraphObject.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;FIELD&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;FIELD&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>