modelclip.html

java 3d帮助文档

<HR>

<A NAME="ALLOW_SCOPE_WRITE"><!-- --></A><H3>
ALLOW_SCOPE_WRITE</H3>
<PRE>
public static final int <B>ALLOW_SCOPE_WRITE</B></PRE>
<DL>
<DD>Specifies that this ModelClip node allows write access to its scope
 information at runtime.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.ModelClip.ALLOW_SCOPE_WRITE">Constant Field Values</A></DL>
</DL>

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

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

<A NAME="ModelClip()"><!-- --></A><H3>
ModelClip</H3>
<PRE>
public <B>ModelClip</B>()</PRE>
<DL>
<DD>Constructs a ModelClip node with default parameters.  The default
 values are as follows:
 <ul>
 planes[0] : x <= 1 (1,0,0,-1)<br>
 planes[1] : -x <= 1 (-1,0,0,-1)<br>
 planes[2] : y <= 1 (0,1,0,-1)<br>
 planes[3] : -y <= 1 (0,-1,0,-1)<br>
 planes[4] : z <= 1 (0,0,1,-1)<br>
 planes[5] : -z <= 1 (0,0,-1,-1)<br>
 enables : all planes enabled<br>
 scope : empty (universe scope)<br>
 influencing bounds : null<br>
 influencing bounding leaf : null<br>
 </ul>
<P>
</DL>
<HR>

<A NAME="ModelClip(javax.vecmath.Vector4d[])"><!-- --></A><H3>
ModelClip</H3>
<PRE>
public <B>ModelClip</B>(<A HREF="../../../javax/vecmath/Vector4d.html">Vector4d</A>[]&nbsp;planes)</PRE>
<DL>
<DD>Constructs a ModelClip node using the specified planes.  The individual
 planes are copied into this node.  All planes are enabled.
<P>
<DT><B>Parameters:</B><DD><CODE>planes</CODE> - an array of 6 model clipping planes</DL>
<HR>

<A NAME="ModelClip(javax.vecmath.Vector4d[], boolean[])"><!-- --></A><H3>
ModelClip</H3>
<PRE>
public <B>ModelClip</B>(<A HREF="../../../javax/vecmath/Vector4d.html">Vector4d</A>[]&nbsp;planes,
                 boolean[]&nbsp;enables)</PRE>
<DL>
<DD>Constructs a ModelClip node using the specified planes and enable
 flags.  The individual
 planes and enable flags are copied into this node.
<P>
<DT><B>Parameters:</B><DD><CODE>planes</CODE> - an array of 6 model clipping planes<DD><CODE>enables</CODE> - an array of 6 enable flags</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="setInfluencingBounds(javax.media.j3d.Bounds)"><!-- --></A><H3>
setInfluencingBounds</H3>
<PRE>
public void <B>setInfluencingBounds</B>(<A HREF="../../../javax/media/j3d/Bounds.html">Bounds</A>&nbsp;region)</PRE>
<DL>
<DD>Set the ModelClip node's influencing region to the specified bounds.
 This is used when the influencing bounding leaf is set to null.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>region</CODE> - the bounds that contains the new influencing
 region.
<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="getInfluencingBounds()"><!-- --></A><H3>
getInfluencingBounds</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Bounds.html">Bounds</A> <B>getInfluencingBounds</B>()</PRE>
<DL>
<DD>Retrieves the ModelClip node's influencing bounds.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>this node's influencing bounds information
<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="setInfluencingBoundingLeaf(javax.media.j3d.BoundingLeaf)"><!-- --></A><H3>
setInfluencingBoundingLeaf</H3>
<PRE>
public void <B>setInfluencingBoundingLeaf</B>(<A HREF="../../../javax/media/j3d/BoundingLeaf.html">BoundingLeaf</A>&nbsp;region)</PRE>
<DL>
<DD>Set the ModelClip node's influencing region to the specified
 bounding leaf.
 When set to a value other than null, this overrides the influencing
 bounds object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>region</CODE> - the bounding leaf node used to specify the
 new influencing region.
<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="getInfluencingBoundingLeaf()"><!-- --></A><H3>
getInfluencingBoundingLeaf</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/BoundingLeaf.html">BoundingLeaf</A> <B>getInfluencingBoundingLeaf</B>()</PRE>
<DL>
<DD>Retrieves the ModelClip node's influencing bounding leaf.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>this node's influencing bounding leaf information
<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="setScope(javax.media.j3d.Group, int)"><!-- --></A><H3>
setScope</H3>
<PRE>
public void <B>setScope</B>(<A HREF="../../../javax/media/j3d/Group.html">Group</A>&nbsp;scope,
                     int&nbsp;index)</PRE>
<DL>
<DD>Replaces the node at the specified index in this ModelClip node's
 list of scopes with the specified Group node.
 By default, ModelClip nodes are scoped only by their influencing
 bounds.  This allows them to be further scoped by a list of
 nodes in the hierarchy.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scope</CODE> - the Group node to be stored at the specified index.<DD><CODE>index</CODE> - the index of the Group node to be replaced.
<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
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html">RestrictedAccessException</A></CODE> - if the specified group node
 is part of a compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="getScope(int)"><!-- --></A><H3>
getScope</H3>
<PRE>
public <A HREF="../../../javax/media/j3d/Group.html">Group</A> <B>getScope</B>(int&nbsp;index)</PRE>
<DL>
<DD>Retrieves the Group node at the specified index from this ModelClip node's
 list of scopes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the Group node to be returned.
<DT><B>Returns:</B><DD>the Group node at the specified index.
<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="insertScope(javax.media.j3d.Group, int)"><!-- --></A><H3>
insertScope</H3>
<PRE>
public void <B>insertScope</B>(<A HREF="../../../javax/media/j3d/Group.html">Group</A>&nbsp;scope,
                        int&nbsp;index)</PRE>
<DL>
<DD>Inserts the specified Group node into this ModelClip node's
 list of scopes at the specified index.
 By default, ModelClip nodes are scoped only by their influencing
 bounds.  This allows them to be further scoped by a list of
 nodes in the hierarchy.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scope</CODE> - the Group node to be inserted at the specified index.<DD><CODE>index</CODE> - the index at which the Group node is inserted.
<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
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html">RestrictedAccessException</A></CODE> - if the specified group node
 is part of a compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="removeScope(int)"><!-- --></A><H3>
removeScope</H3>
<PRE>
public void <B>removeScope</B>(int&nbsp;index)</PRE>
<DL>
<DD>Removes the node at the specified index from this ModelClip node's
 list of scopes.  If this operation causes the list of scopes to
 become empty, then this ModelClip will have universe scope: all nodes
 within the region of influence will be affected by this ModelClip node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the Group node to be removed.
<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
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html">RestrictedAccessException</A></CODE> - if the group node at the
 specified index is part of a compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="getAllScopes()"><!-- --></A><H3>
getAllScopes</H3>
<PRE>
public java.util.Enumeration <B>getAllScopes</B>()</PRE>
<DL>
<DD>Returns an enumeration of this ModelClip node's list of scopes.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an Enumeration object containing all nodes in this ModelClip node's
 list of scopes.
<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="addScope(javax.media.j3d.Group)"><!-- --></A><H3>
addScope</H3>
<PRE>
public void <B>addScope</B>(<A HREF="../../../javax/media/j3d/Group.html">Group</A>&nbsp;scope)</PRE>
<DL>
<DD>Appends the specified Group node to this ModelClip node's list of scopes.
 By default, ModelClip nodes are scoped only by their influencing
 bounds.  This allows them to be further scoped by a list of
 nodes in the hierarchy.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scope</CODE> - the Group node to be appended.
<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
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html">RestrictedAccessException</A></CODE> - if the specified group node
 is part of a compiled scene graph</DL>
</DD>
</DL>
<HR>

<A NAME="numScopes()"><!-- --></A><H3>
numScopes</H3>
<PRE>
public int <B>numScopes</B>()</PRE>
<DL>
<DD>Returns the number of nodes in this ModelClip node's list of scopes.
 If this number is 0, then the list of scopes is empty and this
 ModelClip node has universe scope: all nodes within the region of
 influence are affected by this ModelClip node.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the number of nodes in this ModelClip node's list of scopes.
<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="indexOfScope(javax.media.j3d.Group)"><!-- --></A><H3>
indexOfScope</H3>
<PRE>
public int <B>indexOfScope</B>(<A HREF="../../../javax/media/j3d/Group.html">Group</A>&nbsp;scope)</PRE>
<DL>
<DD>Retrieves the index of the specified Group node in this
 ModelClip node's list of scopes.