node.html

JAVA多媒体开发类库说明

<DD>Specifies that this Node allows read access to its parent Group node.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>Java 3D 1.4</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Node.ALLOW_PARENT_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_LOCALE_READ"><!-- --></A><H3>
ALLOW_LOCALE_READ</H3>
<PRE>
public static final int <B>ALLOW_LOCALE_READ</B></PRE>
<DL>
<DD>Specifies that this Node allows read access to its Locale.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>Java 3D 1.4</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Node.ALLOW_LOCALE_READ">Constant Field Values</A></DL>
</DL>

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

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

<A NAME="Node()"><!-- --></A><H3>
Node</H3>
<PRE>
public <B>Node</B>()</PRE>
<DL>
<DD>Constructs a Node object with default parameters.  The default
 values are as follows:
 <ul>
 pickable : true<br>
 collidable : true<br>
 bounds auto compute : true<br>
 bounds : N/A (automatically computed)<br>
 </ul>
<P>
</DL>

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

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

<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Node.html" title="class in javax.media.j3d">Node</A> <B>getParent</B>()</PRE>
<DL>
<DD><DL>

<DT><B>Returns:</B><DD>the parent of this node, or null if this node has no parent
<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="setBounds(javax.media.j3d.Bounds)"><!-- --></A><H3>
setBounds</H3>
<PRE>
public void <B>setBounds</B>(<A HREF="../../../javax/media/j3d/Bounds.html" title="class in javax.media.j3d">Bounds</A>&nbsp;bounds)</PRE>
<DL>
<DD>Sets the geometric bounds of a node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bounds</CODE> - the bounding object for a 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="getBounds()"><!-- --></A><H3>
getBounds</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Bounds.html" title="class in javax.media.j3d">Bounds</A> <B>getBounds</B>()</PRE>
<DL>
<DD>Returns the bounding object of a node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the node's bounding object
<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
<DD><CODE><A HREF="../../../javax/media/j3d/SceneGraphCycleException.html" title="class in javax.media.j3d">SceneGraphCycleException</A></CODE> - if there is a cycle in the
 scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="getCollidable()"><!-- --></A><H3>
getCollidable</H3>
<PRE>
public boolean <B>getCollidable</B>()</PRE>
<DL>
<DD>Returns the collidable value; this value determines whether this node
 and it's children, if a group node, can be considered for collision
 purposes; if it is set to false, then neither this node nor any 
 children nodes will be traversed for collision purposes; the default
 value is true.   The collidable setting is the way that an 
 application can perform collision culling.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the present collidable value for this node</DL>
</DD>
</DL>
<HR>

<A NAME="setCollidable(boolean)"><!-- --></A><H3>
setCollidable</H3>
<PRE>
public void <B>setCollidable</B>(boolean&nbsp;collidable)</PRE>
<DL>
<DD>Sets the collidable value; determines whether this node and any of its 
 children, if a group node, can be considered for collision purposes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>collidable</CODE> - the new collidable value for this node</DL>
</DD>
</DL>
<HR>

<A NAME="setBoundsAutoCompute(boolean)"><!-- --></A><H3>
setBoundsAutoCompute</H3>
<PRE>
public void <B>setBoundsAutoCompute</B>(boolean&nbsp;autoCompute)</PRE>
<DL>
<DD>Turns the automatic calcuation of geometric bounds of a node on/off.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>autoCompute</CODE> - indicates if the node's bounding object is
 automatically computed.
<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="getBoundsAutoCompute()"><!-- --></A><H3>
getBoundsAutoCompute</H3>
<PRE>
public boolean <B>getBoundsAutoCompute</B>()</PRE>
<DL>
<DD>Gets the value indicating if the automatic calcuation of geometric bounds of a node is on/off.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the node's auto compute flag for the geometric bounding object
<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="getLocalToVworld(javax.media.j3d.Transform3D)"><!-- --></A><H3>
getLocalToVworld</H3>
<PRE>
public void <B>getLocalToVworld</B>(<A HREF="../../../javax/media/j3d/Transform3D.html" title="class in javax.media.j3d">Transform3D</A>&nbsp;t)</PRE>
<DL>
<DD>Retrieves the local coordinates to virtual world coordinates
 transform for this node in the scene graph.  This is the composite
 of all transforms in the scene graph from the root down to
 <code>this</code> node.  It is only valid
 for nodes that are part of a live scene graph.
 If the node is not part of a live scene graph then the coordinates are
 calculated as if the graph was attached at the origin of a locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>t</CODE> - the object that will receive the local coordinates to
 Vworld coordinates transform.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html" title="class in javax.media.j3d">RestrictedAccessException</A></CODE> - if the node is compiled but not 
 part of a live scene graph
<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 node is part of live or compiled scene graph
<DD><CODE><A HREF="../../../javax/media/j3d/IllegalSharingException.html" title="class in javax.media.j3d">IllegalSharingException</A></CODE> - if the node is a descendant
 of a SharedGroup node.</DL>
</DD>
</DL>
<HR>

<A NAME="getLocalToVworld(javax.media.j3d.SceneGraphPath, javax.media.j3d.Transform3D)"><!-- --></A><H3>
getLocalToVworld</H3>
<PRE>
public void <B>getLocalToVworld</B>(<A HREF="../../../javax/media/j3d/SceneGraphPath.html" title="class in javax.media.j3d">SceneGraphPath</A>&nbsp;path,
                             <A HREF="../../../javax/media/j3d/Transform3D.html" title="class in javax.media.j3d">Transform3D</A>&nbsp;t)</PRE>
<DL>
<DD>Retrieves the local coordinates to virtual world coordinates
 transform for the particular path in the scene graph ending with
 this node.  This is the composite
 of all transforms in the scene graph from the root down to
 <code>this</code> node via the specified Link nodes.  It is
 only valid for nodes that are part of a live scene graph.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the specific path from the node to the Locale<DD><CODE>t</CODE> - the object that will receive the local coordinates to
 Vworld coordinates transform.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html" title="class in javax.media.j3d">RestrictedAccessException</A></CODE> - if the node is <em>not</em>
 part of a live scene graph
<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 node is part of live scene graph
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the specified path does
 not contain a valid Locale, or if the last node in the path is
 different from this node
<DD><CODE><A HREF="../../../javax/media/j3d/IllegalSharingException.html" title="class in javax.media.j3d">IllegalSharingException</A></CODE> - if the node is not a descendant
 of a SharedGroup node.</DL>
</DD>
</DL>
<HR>

<A NAME="getLocale()"><!-- --></A><H3>
getLocale</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Locale.html" title="class in javax.media.j3d">Locale</A> <B>getLocale</B>()</PRE>
<DL>
<DD>Retrieves the locale to which this node is attached. If the
 node is not part of a live scene graph, null is returned.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the locale to which this node is attached.
<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 node is part of live scene graph
<DD><CODE><A HREF="../../../javax/media/j3d/IllegalSharingException.html" title="class in javax.media.j3d">IllegalSharingException</A></CODE> - if the node is a descendant
 of a SharedGroup node.<DT><B>Since:</B></DT>
  <DD>Java 3D 1.4</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="cloneTree()"><!-- --></A><H3>
cloneTree</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Node.html" title="class in javax.media.j3d">Node</A> <B>cloneTree</B>()</PRE>
<DL>
<DD>Duplicates all the nodes of the specified sub-graph.  For Group Nodes
 the group node is duplicated via a call to <code>cloneNode</code>
 and then <code>cloneTree</code>
 is called for each child node.  For Leaf Nodes, component
 data can either be duplicated or be made a reference to the original
 data.  Leaf Node cloneTree behavior is determined by the
 <code>duplicateOnCloneTree</code> flag found in every Leaf Node's
 component data class and by the <code>forceDuplicate</code> paramter.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a reference to the cloned sub-graph.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/DanglingReferenceException.html" title="class in javax.media.j3d">DanglingReferenceException</A></CODE> - When a dangling reference is
  discovered during the cloneTree operation.
<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
<DD><CODE><A HREF="../../../javax/media/j3d/SceneGraphCycleException.html" title="class in javax.media.j3d">SceneGraphCycleException</A></CODE> - if there is a cycle in the
 scene graph<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/NodeComponent.html#setDuplicateOnCloneTree(boolean)"><CODE>NodeComponent.setDuplicateOnCloneTree(boolean)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="cloneTree(boolean)"><!-- --></A><H3>
cloneTree</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Node.html" title="class in javax.media.j3d">Node</A> <B>cloneTree</B>(boolean&nbsp;forceDuplicate)</PRE>
<DL>
<DD>Duplicates all the nodes of the specified sub-graph.  For Group Nodes
 the group node is duplicated via a call to <code>cloneNode</code>
 and then <code>cloneTree</code> is called for each child node.
 For Leaf Nodes, component
 data can either be duplicated or be made a reference to the original
 data.  Leaf Node cloneTree behavior is determined by the
 <code>duplicateOnCloneTree</code> flag found in every Leaf Node's
 component data class and by the <code>forceDuplicate</code> paramter.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>forceDuplicate</CODE> - when set to <code>true</code>, causes the
  <code>duplicateOnCloneTree</code> flag to be ignored.  When
  <code>false</code>, the value of each node's
  <code>duplicateOnCloneTree</code> determines whether data is
  duplicated or copied.
<DT><B>Returns:</B><DD>a reference to the cloned scene graph.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/DanglingReferenceException.html" title="class in javax.media.j3d">DanglingReferenceException</A></CODE> - When a dangling reference is
  discovered during the cloneTree operation.
<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
<DD><CODE><A HREF="../../../javax/media/j3d/SceneGraphCycleException.html" title="class in javax.media.j3d">SceneGraphCycleException</A></CODE> - if there is a cycle in the
 scene graph<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/NodeComponent.html#setDuplicateOnCloneTree(boolean)"><CODE>NodeComponent.setDuplicateOnCloneTree(boolean)</CODE></A></DL>
</DD>
</DL>
<HR>