imagecomponent3d.html

JAVA多媒体开发类库说明

<PRE>
public <B>ImageComponent3D</B>(int&nbsp;format,
                        java.awt.image.BufferedImage[]&nbsp;images)</PRE>
<DL>
<DD>Constructs a 3D image component object using the specified format,
 and the BufferedImage array.
 The image class is set to ImageClass.BUFFERED_IMAGE.
 Default values are used for all other parameters.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - the image component format, one of: FORMAT_RGB,
 FORMAT_RGBA etc.<DD><CODE>images</CODE> - an array of BufferedImage objects.  The
 first image in the array determines the width and height of this
 ImageComponent3D.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if format is invalid, or if
 the width or height of the first image are not positive.</DL>
</DL>
<HR>

<A NAME="ImageComponent3D(int, java.awt.image.RenderedImage[])"><!-- --></A><H3>
ImageComponent3D</H3>
<PRE>
public <B>ImageComponent3D</B>(int&nbsp;format,
                        java.awt.image.RenderedImage[]&nbsp;images)</PRE>
<DL>
<DD>Constructs a 3D image component object using the specified format,
 and the RenderedImage array.
 The image class is set to ImageClass.BUFFERED_IMAGE.
 Default values are used for all other parameters.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - the image component format, one of: FORMAT_RGB,
 FORMAT_RGBA etc.<DD><CODE>images</CODE> - an array of RenderedImage objects.  The
 first image in the array determines the width and height of this
 ImageComponent3D.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if format is invalid, or if
 the width or height of the first image are not positive.<DT><B>Since:</B></DT>
  <DD>Java 3D 1.2</DD>
</DL>
</DL>
<HR>

<A NAME="ImageComponent3D(int, int, int, int, boolean, boolean)"><!-- --></A><H3>
ImageComponent3D</H3>
<PRE>
public <B>ImageComponent3D</B>(int&nbsp;format,
                        int&nbsp;width,
                        int&nbsp;height,
                        int&nbsp;depth,
                        boolean&nbsp;byReference,
                        boolean&nbsp;yUp)</PRE>
<DL>
<DD>Constructs a 3D image component object using the specified
 format, width, height, depth, byReference flag, and yUp flag.
 Default values are used for all other parameters.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - the image component format, one of: FORMAT_RGB,
 FORMAT_RGBA, etc.<DD><CODE>width</CODE> - the number of columns of pixels in this image component
 object<DD><CODE>height</CODE> - the number of rows of pixels in this image component
 object<DD><CODE>depth</CODE> - the number of 2D slices in this image component object<DD><CODE>byReference</CODE> - a flag that indicates whether the data is copied
 into this image component object or is accessed by reference.<DD><CODE>yUp</CODE> - a flag that indicates the y-orientation of this image
 component.  If yUp is set to true, the origin of the image is
 the lower left; otherwise, the origin of the image is the upper
 left.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if format is invalid, or if
 any of width, height, or depth are not positive.<DT><B>Since:</B></DT>
  <DD>Java 3D 1.2</DD>
</DL>
</DL>
<HR>

<A NAME="ImageComponent3D(int, java.awt.image.BufferedImage[], boolean, boolean)"><!-- --></A><H3>
ImageComponent3D</H3>
<PRE>
public <B>ImageComponent3D</B>(int&nbsp;format,
                        java.awt.image.BufferedImage[]&nbsp;images,
                        boolean&nbsp;byReference,
                        boolean&nbsp;yUp)</PRE>
<DL>
<DD>Constructs a 3D image component object using the specified format,
 BufferedImage array, byReference flag, and yUp flag.
 The image class is set to ImageClass.BUFFERED_IMAGE.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - the image component format, one of: FORMAT_RGB,
 FORMAT_RGBA etc.<DD><CODE>images</CODE> - an array of BufferedImage objects.  The
 first image in the array determines the width and height of this
 ImageComponent3D.<DD><CODE>byReference</CODE> - a flag that indicates whether the data is copied
 into this image component object or is accessed by reference.<DD><CODE>yUp</CODE> - a flag that indicates the y-orientation of this image
 component.  If yUp is set to true, the origin of the image is
 the lower left; otherwise, the origin of the image is the upper
 left.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if format is invalid, or if
 the width or height of the first image are not positive.<DT><B>Since:</B></DT>
  <DD>Java 3D 1.2</DD>
</DL>
</DL>
<HR>

<A NAME="ImageComponent3D(int, java.awt.image.RenderedImage[], boolean, boolean)"><!-- --></A><H3>
ImageComponent3D</H3>
<PRE>
public <B>ImageComponent3D</B>(int&nbsp;format,
                        java.awt.image.RenderedImage[]&nbsp;images,
                        boolean&nbsp;byReference,
                        boolean&nbsp;yUp)</PRE>
<DL>
<DD>Constructs a 3D image component object using the specified format,
 RenderedImage array, byReference flag, and yUp flag.
 The image class is set to ImageClass.RENDERED_IMAGE if the byReference
 flag is true and any of the specified RenderedImages is <i>not</i> an
 instance of BufferedImage. In all other cases, the image class is set to
 ImageClass.BUFFERED_IMAGE.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - the image component format, one of: FORMAT_RGB,
 FORMAT_RGBA etc.<DD><CODE>images</CODE> - an array of RenderedImage objects.  The
 first image in the array determines the width and height of this
 ImageComponent3D.<DD><CODE>byReference</CODE> - a flag that indicates whether the data is copied
 into this image component object or is accessed by reference.<DD><CODE>yUp</CODE> - a flag that indicates the y-orientation of this image
 component.  If yUp is set to true, the origin of the image is
 the lower left; otherwise, the origin of the image is the upper
 left.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if format is invalid, or if
 the width or height of the first image are not positive.<DT><B>Since:</B></DT>
  <DD>Java 3D 1.2</DD>
</DL>
</DL>
<HR>

<A NAME="ImageComponent3D(int, javax.media.j3d.NioImageBuffer[], boolean, boolean)"><!-- --></A><H3>
ImageComponent3D</H3>
<PRE>
public <B>ImageComponent3D</B>(int&nbsp;format,
                        <A HREF="../../../javax/media/j3d/NioImageBuffer.html" title="class in javax.media.j3d">NioImageBuffer</A>[]&nbsp;images,
                        boolean&nbsp;byReference,
                        boolean&nbsp;yUp)</PRE>
<DL>
<DD>Constructs a 3D image component object using the specified format,
 NioImageBuffer array, byReference flag, and yUp flag.
 The image class is set to ImageClass.NIO_IMAGE_BUFFER.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - the image component format, one of: FORMAT_RGB,
 FORMAT_RGBA etc.<DD><CODE>images</CODE> - an array of NioImageBuffer objects.  The
 first image in the array determines the width and height of this
 ImageComponent3D.<DD><CODE>byReference</CODE> - a flag that indicates whether the data is copied
 into this image component object or is accessed by reference.<DD><CODE>yUp</CODE> - a flag that indicates the y-orientation of this image
 component.  If yUp is set to true, the origin of the image is
 the lower left; otherwise, the origin of the image is the upper
 left.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if format is invalid, or if
 the width or height of the first image are not positive.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the byReference flag is false.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the yUp flag is false.
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - this method is not supported
 for Java 3D 1.5.<DT><B>Since:</B></DT>
  <DD>Java 3D 1.5</DD>
</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="getDepth()"><!-- --></A><H3>
getDepth</H3>
<PRE>
public int <B>getDepth</B>()</PRE>
<DL>
<DD>Retrieves the depth of this 3D image component object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the depth of this 3D image component 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="set(java.awt.image.BufferedImage[])"><!-- --></A><H3>
set</H3>
<PRE>
public void <B>set</B>(java.awt.image.BufferedImage[]&nbsp;images)</PRE>
<DL>
<DD>Sets the array of images in this image component to the
 specified array of BufferedImage objects.  If the data access
 mode is not by-reference, then the BufferedImage data is copied
 into this object.  If the data access mode is by-reference,
 then a shallow copy of the array of references to the
 BufferedImage objects is made, but the BufferedImage
 data is not necessarily copied.
 <p>
 The image class is set to ImageClass.BUFFERED_IMAGE.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>images</CODE> - array of BufferedImage objects containing the image.
 The size (width and height) of each image must be the same as the
 size of the image component, and the length of the images array
 must equal the depth of the image component.
<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>java.lang.IllegalArgumentException</CODE> - if the length of the images array is
 not equal to the depth of this ImageComponent object.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the width and height of each
 image in the images array is not equal to the width and height of this
 ImageComponent object.</DL>
</DD>
</DL>
<HR>

<A NAME="set(java.awt.image.RenderedImage[])"><!-- --></A><H3>
set</H3>
<PRE>
public void <B>set</B>(java.awt.image.RenderedImage[]&nbsp;images)</PRE>
<DL>
<DD>Sets the array of images in this image component to the
 specified array of RenderedImage objects.  If the data access
 mode is not by-reference, then the RenderedImage data is copied
 into this object.  If the data access mode is by-reference,
 then a shallow copy of the array of references to the
 RenderedImage objects is made, but the RenderedImage
 data is not necessarily copied.
 <p>
 The image class is set to ImageClass.RENDERED_IMAGE if the data access
 mode is by-reference and any of the specified RenderedImages
 is <i>not</i> an instance of BufferedImage. In all other cases,
 the image class is set to ImageClass.BUFFERED_IMAGE.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>images</CODE> - array of RenderedImage objects containing the image.
 The size (width and height) of each image must be the same as the