configcontainer.html

JAVA多媒体开发类库说明

<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sun/j3d/utils/universe/ConfigContainer.html#getViewPlatformTransformCount()">getViewPlatformTransformCount</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of TransformGroups with which ViewingPlatforms
 should be created.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= 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="ConfigContainer(java.net.URL)"><!-- --></A><H3>
ConfigContainer</H3>
<PRE>
public <B>ConfigContainer</B>(java.net.URL&nbsp;userConfig)</PRE>
<DL>
<DD>Creates a new ConfigContainer and loads the configuration file at the
 specified URL.  All ViewingPlatform instances are created with a single
 TransformGroup and all Viewer components are initially invisible.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>userConfig</CODE> - URL of the configuration file to load</DL>
</DL>
<HR>

<A NAME="ConfigContainer(java.net.URL, java.lang.ClassLoader)"><!-- --></A><H3>
ConfigContainer</H3>
<PRE>
public <B>ConfigContainer</B>(java.net.URL&nbsp;userConfig,
                       java.lang.ClassLoader&nbsp;classLoader)</PRE>
<DL>
<DD>Creates a new ConfigContainer and loads the configuration file at the
 specified URL.  All ViewingPlatform instances are created with a single
 TransformGroup and all Viewer components are initially invisible.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>userConfig</CODE> - URL of the configuration file to load<DD><CODE>classLoader</CODE> - the class loader to use to load classes specified
 in the config file.</DL>
</DL>
<HR>

<A NAME="ConfigContainer(java.net.URL, boolean, int)"><!-- --></A><H3>
ConfigContainer</H3>
<PRE>
public <B>ConfigContainer</B>(java.net.URL&nbsp;userConfig,
                       boolean&nbsp;setVisible,
                       int&nbsp;transformCount)</PRE>
<DL>
<DD>Creates a new ConfigContainer and loads the configuration file at the
 specified URL.  Any ViewingPlatform instantiated by the configuration
 file will be created with the specified number of transforms.  Viewer
 components may be set initially visible or invisible with the
 <code>setVisible</code> flag.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>userConfig</CODE> - URL of the configuration file to load<DD><CODE>setVisible</CODE> - if true, <code>setVisible(true)</code> is called on
  all Viewers<DD><CODE>transformCount</CODE> - number of transforms to be included in any
  ViewingPlatform created; must be greater than 0</DL>
</DL>
<HR>

<A NAME="ConfigContainer(java.net.URL, boolean, int, java.lang.ClassLoader)"><!-- --></A><H3>
ConfigContainer</H3>
<PRE>
public <B>ConfigContainer</B>(java.net.URL&nbsp;userConfig,
                       boolean&nbsp;setVisible,
                       int&nbsp;transformCount,
                       java.lang.ClassLoader&nbsp;classLoader)</PRE>
<DL>
<DD>Creates a new ConfigContainer and loads the configuration file at the
 specified URL.  Any ViewingPlatform instantiated by the configuration
 file will be created with the specified number of transforms.  Viewer
 components may be set initially visible or invisible with the
 <code>setVisible</code> flag.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>userConfig</CODE> - URL of the configuration file to load<DD><CODE>setVisible</CODE> - if true, <code>setVisible(true)</code> is called on
  all Viewers<DD><CODE>transformCount</CODE> - number of transforms to be included in any
  ViewingPlatform created; must be greater than 0<DD><CODE>classLoader</CODE> - the class loader to use to load classes specified
 in the config file.</DL>
</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="getPhysicalBodies()"><!-- --></A><H3>
getPhysicalBodies</H3>
<PRE>
public java.util.Set <B>getPhysicalBodies</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all configured PhysicalBody instances in the
 order they were defined in the configuration file.

 PhysicalBody instances are created with the following command:<p>
 <blockquote>
 (NewPhysicalBody <i>&lt;instance name&gt;</i>
 [Alias <i>&lt;alias name&gt;</i>])
 </blockquote>
 
 The PhysicalBody is configured through the following command:<p>
 <blockquote>
 (PhysicalBodyProperty <i>&lt;instance name&gt;
 &lt;property name&gt; &lt;property value&gt;</i>)
 </blockquote>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedPhysicalBodies()"><!-- --></A><H3>
getNamedPhysicalBodies</H3>
<PRE>
public java.util.Map <B>getNamedPhysicalBodies</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps PhysicalBody names to instances.
 Names may be aliases and if so will map to the original instances.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to PhysicalBody instances, or null if
  no instances</DL>
</DD>
</DL>
<HR>

<A NAME="getPhysicalEnvironments()"><!-- --></A><H3>
getPhysicalEnvironments</H3>
<PRE>
public java.util.Set <B>getPhysicalEnvironments</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all configured PhysicalEnvironment instances
 in the order they were defined in the configuration file.<p>
 
 PhysicalEnvironment instances are created with the following command:<p>
 <blockquote>
 (NewPhysicalEnvironment <i>&lt;instance name&gt;</i>
 [Alias <i>&lt;alias name&gt;</i>])
 </blockquote>
 
 The PhysicalEnvironment is configured through the following command:<p>
 <blockquote>
 (PhysicalEnvironmentProperty <i>&lt;instance name&gt;
 &lt;property name&gt; &lt;property value&gt;</i>)
 </blockquote>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedPhysicalEnvironments()"><!-- --></A><H3>
getNamedPhysicalEnvironments</H3>
<PRE>
public java.util.Map <B>getNamedPhysicalEnvironments</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps PhysicalEnvironment names to
 instances.  Names may be aliases and if so will map to the original
 instances.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to PhysicalEnvironment instances, or
  null if no instances</DL>
</DD>
</DL>
<HR>

<A NAME="getViewers()"><!-- --></A><H3>
getViewers</H3>
<PRE>
public java.util.Set <B>getViewers</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all configured Viewer instances in the order
 they were defined in the configuration file.  The Viewers will have
 incorporated any PhysicalEnvironment and PhysicalBody objects specfied
 for them in the configuration file, and will be attached to any
 ViewingPlatforms specified for them.<p>
 
 Viewer instances are created with the following command:<p>
 <blockquote>
 (NewView <i>&lt;instance name&gt;</i> [Alias <i>&lt;alias name&gt;</i>])
 </blockquote>
 
 The Viewer is configured through the following command:<p>
 <blockquote>
 (ViewProperty <i>&lt;instance name&gt;
 &lt;property name&gt; &lt;property value&gt;</i>)
 </blockquote>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedViewers()"><!-- --></A><H3>
getNamedViewers</H3>
<PRE>
public java.util.Map <B>getNamedViewers</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps Viewer names to instances.
 Names may be aliases and if so will map to the original instances.
 The Viewers will have incorporated any PhysicalEnvironment and
 PhysicalBody objects specfied for them in the configuration file, and
 will be attached to any ViewingPlatforms specified for them.<p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to Viewer instances, or
  null if no instances</DL>
</DD>
</DL>
<HR>

<A NAME="getInputDevices()"><!-- --></A><H3>
getInputDevices</H3>
<PRE>
public java.util.Set <B>getInputDevices</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all configured InputDevice instances in the
 order they were defined in the configuration file.  All InputDevice
 instances in the set are initialized and registered with any
 PhysicalEnvironments that reference them.<p>

 InputDevice instances are created with the following command:<p>
 <blockquote>
 (NewDevice <i>&lt;instanceName&gt; &lt;className&gt;</i>
 [Alias <i>&lt;alias name&gt;</i>])
 </blockquote>
 
 <i>className</i> must be the fully-qualified name of a class that
 implements the InputDevice interface.  The implementation
 must provide a parameterless constructor.<p>

 The InputDevice is configured through the DeviceProperty command:<p>
 <blockquote>
 (DeviceProperty <i>&lt;instanceName&gt; &lt;propertyName&gt;
  &lt;arg0&gt; ... &lt;argn&gt;</i>)
 </blockquote>
 
 <i>propertyName</i> must be the name of a input device method that
 takes an array of Objects as its only parameter; the array is populated
 with the values of <i>arg0</i> through <i>argn</i> when the method is
 invoked to set the property.  These additional requirements for
 configurable input devices can usually be fulfilled by extending or
 wrapping available InputDevice implementations.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedInputDevices()"><!-- --></A><H3>
getNamedInputDevices</H3>
<PRE>
public java.util.Map <B>getNamedInputDevices</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps InputDevice names to instances.
 Names may be aliases and if so will map to the original instances.  All
 InputDevice instances in the map are initialized and registered with
 any PhysicalEnvironments that reference them.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to InputDevice instances, or
  null if no instances<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/j3d/utils/universe/ConfigContainer.html#getInputDevices()"><CODE>getInputDevices()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSensors()"><!-- --></A><H3>
getSensors</H3>
<PRE>
public java.util.Set <B>getSensors</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all configured Sensor instances in the order
 they were defined in the configuration file.  The associated
 InputDevices are all initialized and registered with any
 PhysicalEnvironments that reference them.<p>
 
 Sensor instances are named with the following command:<p>
 <blockquote>
 (NewSensor <i>&lt;instance name&gt; &lt;device name&gt; 
 &lt;sensor index&gt;</i> [Alias <i>&lt;alias name&gt;</i>])
 </blockquote>
 
 <i>device name</i> is the instance name of a previously defined
 InputDevice, and <i>sensor index</i> is the index of the Sensor to be
 bound to <i>instance name</i>.  The InputDevice implementation is
 responsible for creating its own Sensor objects, so this command does
 not create any new instances.<p>

 The Sensor is configured through the SensorProperty command:<p>
 <blockquote>
 (SensorProperty <i>&lt;instance name&gt; &lt;property name&gt; 
 &lt;property value&gt;</i>)
 </blockquote>
 
 With the sole exception of the Sensor assigned to the head tracker,
 none of the Sensors defined in the configuration file are placed into
 the Sensor array maintained by a PhysicalEnvironment.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedSensors()"><!-- --></A><H3>
getNamedSensors</H3>
<PRE>
public java.util.Map <B>getNamedSensors</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps Sensor names to instances.  Names may
 be aliases and if so will map to the original instances.  The
 associated InputDevices are all initialized and registered with any
 PhysicalEnvironments that reference them.<p>
 
 With the sole exception of the Sensor assigned to the head tracker,
 none of the Sensors defined in the configuration file are placed into
 the Sensor array maintained by a PhysicalEnvironment.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to Sensor instances, or
  null if no instances</DL>
</DD>
</DL>
<HR>