branchgroup.html

JAVA多媒体开发类库说明

<DL>
<DD>Returns an array referencing all the items that are pickable below this
 <code>BranchGroup</code> that intersect with PickShape.
 The resultant array is unordered.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pickShape</CODE> - the PickShape object
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if BranchGroup is not live.<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/SceneGraphPath.html" title="class in javax.media.j3d"><CODE>SceneGraphPath</CODE></A>, 
<A HREF="../../../javax/media/j3d/Locale.html#pickAll(javax.media.j3d.PickShape)"><CODE>Locale.pickAll(javax.media.j3d.PickShape)</CODE></A>, 
<A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d"><CODE>PickShape</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="pickAll(int, int, javax.media.j3d.PickShape)"><!-- --></A><H3>
pickAll</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/PickInfo.html" title="class in javax.media.j3d">PickInfo</A>[] <B>pickAll</B>(int&nbsp;mode,
                          int&nbsp;flags,
                          <A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d">PickShape</A>&nbsp;pickShape)</PRE>
<DL>
<DD>Returns an array unsorted references to all the PickInfo objects that are 
 pickable  below this <code>BranchGroup</code> that intersect with PickShape.
 The accuracy of the pick is set by the pick mode. The mode include : 
 PickInfo.PICK_BOUNDS and PickInfo.PICK_GEOMETRY. The amount of information returned 
 is specified via a masked variable, flags, indicating which components are 
 present in each returned PickInfo object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mode</CODE> - picking mode, one of <code>PickInfo.PICK_BOUNDS</code> or <code>PickInfo.PICK_GEOMETRY</code>.<DD><CODE>flags</CODE> - a mask indicating which components are present in each PickInfo object.  
 This is specified as one or more individual bits that are bitwise "OR"ed together to 
 describe the PickInfo data. The flags include :
 <ul>
 <code>PickInfo.SCENEGRAPHPATH</code> - request for computed SceneGraphPath.<br>    
 <code>PickInfo.NODE</code> - request for computed intersected Node.<br>
 <code>PickInfo.LOCAL_TO_VWORLD</code> - request for computed local to virtual world transform.<br>
 <code>PickInfo.CLOSEST_INTERSECTION_POINT</code> - request for closest intersection point.<br>
 <code>PickInfo.CLOSEST_DISTANCE</code> - request for the distance of closest intersection.<br>
 <code>PickInfo.CLOSEST_GEOM_INFO</code> - request for only the closest intersection geometry information.<br>
 <code>PickInfo.ALL_GEOM_INFO</code> - request for all intersection geometry information.<br>
 </ul><DD><CODE>pickShape</CODE> - the description of this picking volume or area.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if flags contains both CLOSEST_GEOM_INFO and 
 ALL_GEOM_INFO.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pickShape is a PickPoint and pick mode
 is set to PICK_GEOMETRY.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pick mode is neither PICK_BOUNDS 
 nor PICK_GEOMETRY.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pick mode is PICK_BOUNDS 
 and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
 CLOSEST_GEOM_INFO or ALL_GEOM_INFO.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pickShape is PickBounds 
 and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
 CLOSEST_GEOM_INFO or ALL_GEOM_INFO.
<DD><CODE>java.lang.IllegalStateException</CODE> - if BranchGroup is not live.
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">CapabilityNotSetException</A></CODE> - if the mode is
 PICK_GEOMETRY and the Geometry.ALLOW_INTERSECT capability bit
 is not set in any Geometry objects referred to by any shape
 node whose bounds intersects the PickShape.
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">CapabilityNotSetException</A></CODE> - if flags contains any of
 CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE, CLOSEST_GEOM_INFO
 or ALL_GEOM_INFO, and the capability bits that control reading of
 coordinate data are not set in any GeometryArray object referred
 to by any shape node that intersects the PickShape.
 The capability bits that must be set to avoid this exception are as follows :
 <ul> 
 <li>By-copy geometry : GeometryArray.ALLOW_COORDINATE_READ</li>
 <li>By-reference geometry : GeometryArray.ALLOW_REF_DATA_READ</li>
 <li>Indexed geometry : IndexedGeometryArray.ALLOW_COORDINATE_INDEX_READ
 (in addition to one of the above)</li>
 </ul><DT><B>Since:</B></DT>
  <DD>Java 3D 1.4</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/Locale.html#pickAll(int, int, javax.media.j3d.PickShape)"><CODE>Locale.pickAll(int,int,javax.media.j3d.PickShape)</CODE></A>, 
<A HREF="../../../javax/media/j3d/PickInfo.html" title="class in javax.media.j3d"><CODE>PickInfo</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="pickAllSorted(javax.media.j3d.PickShape)"><!-- --></A><H3>
pickAllSorted</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/SceneGraphPath.html" title="class in javax.media.j3d">SceneGraphPath</A>[] <B>pickAllSorted</B>(<A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d">PickShape</A>&nbsp;pickShape)</PRE>
<DL>
<DD>Returns a sorted array of references to all the Pickable items that 
 intersect with the pickShape. Element [0] references the item closest 
 to <i>origin</i> of PickShape successive array elements are further 
 from the <i>origin</i>

 Note: If pickShape is of type PickBounds, the resulting array 
 is unordered.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pickShape</CODE> - the PickShape object
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if BranchGroup is not live.<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/SceneGraphPath.html" title="class in javax.media.j3d"><CODE>SceneGraphPath</CODE></A>, 
<A HREF="../../../javax/media/j3d/Locale.html#pickAllSorted(javax.media.j3d.PickShape)"><CODE>Locale.pickAllSorted(javax.media.j3d.PickShape)</CODE></A>, 
<A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d"><CODE>PickShape</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="pickAllSorted(int, int, javax.media.j3d.PickShape)"><!-- --></A><H3>
pickAllSorted</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/PickInfo.html" title="class in javax.media.j3d">PickInfo</A>[] <B>pickAllSorted</B>(int&nbsp;mode,
                                int&nbsp;flags,
                                <A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d">PickShape</A>&nbsp;pickShape)</PRE>
<DL>
<DD>Returns a sorted array of PickInfo references to all the pickable
 items that intersect with the pickShape. Element [0] references 
 the item closest to <i>origin</i> of PickShape successive array
 elements are further from the <i>origin</i>
 The accuracy of the pick is set by the pick mode. The mode include : 
 PickInfo.PICK_BOUNDS and PickInfo.PICK_GEOMETRY. The amount of information returned 
 is specified via a masked variable, flags, indicating which components are 
 present in each returned PickInfo object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mode</CODE> - picking mode, one of <code>PickInfo.PICK_BOUNDS</code> or <code>PickInfo.PICK_GEOMETRY</code>.<DD><CODE>flags</CODE> - a mask indicating which components are present in each PickInfo object.  
 This is specified as one or more individual bits that are bitwise "OR"ed together to 
 describe the PickInfo data. The flags include :
 <ul>
 <code>PickInfo.SCENEGRAPHPATH</code> - request for computed SceneGraphPath.<br>    
 <code>PickInfo.NODE</code> - request for computed intersected Node.<br>
 <code>PickInfo.LOCAL_TO_VWORLD</code> - request for computed local to virtual world transform.<br>
 <code>PickInfo.CLOSEST_INTERSECTION_POINT</code> - request for closest intersection point.<br>
 <code>PickInfo.CLOSEST_DISTANCE</code> - request for the distance of closest intersection.<br>
 <code>PickInfo.CLOSEST_GEOM_INFO</code> - request for only the closest intersection geometry information.<br>
 <code>PickInfo.ALL_GEOM_INFO</code> - request for all intersection geometry information.<br>
 </ul><DD><CODE>pickShape</CODE> - the description of this picking volume or area.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if flags contains both CLOSEST_GEOM_INFO and 
 ALL_GEOM_INFO.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pickShape is a PickPoint and pick mode
 is set to PICK_GEOMETRY.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pick mode is neither PICK_BOUNDS 
 nor PICK_GEOMETRY.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pick mode is PICK_BOUNDS 
 and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
 CLOSEST_GEOM_INFO or ALL_GEOM_INFO.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if pickShape is PickBounds 
 and flags includes any of CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE,
 CLOSEST_GEOM_INFO or ALL_GEOM_INFO.
<DD><CODE>java.lang.IllegalStateException</CODE> - if BranchGroup is not live.
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">CapabilityNotSetException</A></CODE> - if the mode is
 PICK_GEOMETRY and the Geometry.ALLOW_INTERSECT capability bit
 is not set in any Geometry objects referred to by any shape
 node whose bounds intersects the PickShape.
<DD><CODE><A HREF="../../../javax/media/j3d/CapabilityNotSetException.html" title="class in javax.media.j3d">CapabilityNotSetException</A></CODE> - if flags contains any of
 CLOSEST_INTERSECTION_POINT, CLOSEST_DISTANCE, CLOSEST_GEOM_INFO
 or ALL_GEOM_INFO, and the capability bits that control reading of
 coordinate data are not set in any GeometryArray object referred
 to by any shape node that intersects the PickShape.
 The capability bits that must be set to avoid this exception are as follows :
 <ul> 
 <li>By-copy geometry : GeometryArray.ALLOW_COORDINATE_READ</li>
 <li>By-reference geometry : GeometryArray.ALLOW_REF_DATA_READ</li>
 <li>Indexed geometry : IndexedGeometryArray.ALLOW_COORDINATE_INDEX_READ
 (in addition to one of the above)</li>
 </ul><DT><B>Since:</B></DT>
  <DD>Java 3D 1.4</DD>
<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/Locale.html#pickAllSorted(int, int, javax.media.j3d.PickShape)"><CODE>Locale.pickAllSorted(int,int,javax.media.j3d.PickShape)</CODE></A>, 
<A HREF="../../../javax/media/j3d/PickInfo.html" title="class in javax.media.j3d"><CODE>PickInfo</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="pickClosest(javax.media.j3d.PickShape)"><!-- --></A><H3>
pickClosest</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/SceneGraphPath.html" title="class in javax.media.j3d">SceneGraphPath</A> <B>pickClosest</B>(<A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d">PickShape</A>&nbsp;pickShape)</PRE>
<DL>
<DD>Returns a SceneGraphPath that references the pickable item 
 closest to the origin of <code>pickShape</code>.

 Note: If pickShape is of type PickBounds, the return is any pickable node
 below this BranchGroup.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pickShape</CODE> - the PickShape object
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if BranchGroup is not live.<DT><B>See Also:</B><DD><A HREF="../../../javax/media/j3d/SceneGraphPath.html" title="class in javax.media.j3d"><CODE>SceneGraphPath</CODE></A>, 
<A HREF="../../../javax/media/j3d/Locale.html#pickClosest(javax.media.j3d.PickShape)"><CODE>Locale.pickClosest(javax.media.j3d.PickShape)</CODE></A>, 
<A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d"><CODE>PickShape</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="pickClosest(int, int, javax.media.j3d.PickShape)"><!-- --></A><H3>
pickClosest</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/PickInfo.html" title="class in javax.media.j3d">PickInfo</A> <B>pickClosest</B>(int&nbsp;mode,
                            int&nbsp;flags,
                            <A HREF="../../../javax/media/j3d/PickShape.html" title="class in javax.media.j3d">PickShape</A>&nbsp;pickShape)</PRE>
<DL>
<DD>Returns a PickInfo which references the pickable item
 which is closest to the origin of <code>pickShape</code>.
 The accuracy of the pick is set by the pick mode. The mode include : 
 PickInfo.PICK_BOUNDS and PickInfo.PICK_GEOMETRY. The amount of information returned 
 is specified via a masked variable, flags, indicating which components are 
 present in each returned PickInfo object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mode</CODE> - picking mode, one of <code>PickInfo.PICK_BOUNDS</code> or <code>PickInfo.PICK_GEOMETRY</code>.<DD><CODE>flags</CODE> - a mask indicating which components are present in each PickInfo object.  
 This is specified as one or more individual bits that are bitwise "OR"ed together to 
 describe the PickInfo data. The flags include :
 <ul>
 <code>PickInfo.SCENEGRAPHPATH</code> - request for computed SceneGraphPath.<br>    
 <code>PickInfo.NODE</code> - request for computed intersected Node.<br>
 <code>PickInfo.LOCAL_TO_VWORLD</code> - request for computed local to virtual world transform.<br>