raster.html

java 3d帮助文档

<PRE>
public static final int <B>ALLOW_OFFSET_WRITE</B></PRE>
<DL>
<DD>Specifies that this Raster allows writing the source or
 destination offset.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_OFFSET_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_IMAGE_READ"><!-- --></A><H3>
ALLOW_IMAGE_READ</H3>
<PRE>
public static final int <B>ALLOW_IMAGE_READ</B></PRE>
<DL>
<DD>Specifies that this Raster allows reading the image.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_IMAGE_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_IMAGE_WRITE"><!-- --></A><H3>
ALLOW_IMAGE_WRITE</H3>
<PRE>
public static final int <B>ALLOW_IMAGE_WRITE</B></PRE>
<DL>
<DD>Specifies that this Raster allows writing the image.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_IMAGE_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_DEPTH_COMPONENT_READ"><!-- --></A><H3>
ALLOW_DEPTH_COMPONENT_READ</H3>
<PRE>
public static final int <B>ALLOW_DEPTH_COMPONENT_READ</B></PRE>
<DL>
<DD>Specifies that this Raster allows reading the depth component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_DEPTH_COMPONENT_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_DEPTH_COMPONENT_WRITE"><!-- --></A><H3>
ALLOW_DEPTH_COMPONENT_WRITE</H3>
<PRE>
public static final int <B>ALLOW_DEPTH_COMPONENT_WRITE</B></PRE>
<DL>
<DD>Specifies that this Raster allows writing the depth component.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_DEPTH_COMPONENT_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_SIZE_READ"><!-- --></A><H3>
ALLOW_SIZE_READ</H3>
<PRE>
public static final int <B>ALLOW_SIZE_READ</B></PRE>
<DL>
<DD>Specifies that this Raster allows reading the size.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_SIZE_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_SIZE_WRITE"><!-- --></A><H3>
ALLOW_SIZE_WRITE</H3>
<PRE>
public static final int <B>ALLOW_SIZE_WRITE</B></PRE>
<DL>
<DD>Specifies that this Raster allows writing the size.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_SIZE_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_TYPE_READ"><!-- --></A><H3>
ALLOW_TYPE_READ</H3>
<PRE>
public static final int <B>ALLOW_TYPE_READ</B></PRE>
<DL>
<DD>Specifies that this Raster allows reading the type.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_TYPE_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_CLIP_MODE_READ"><!-- --></A><H3>
ALLOW_CLIP_MODE_READ</H3>
<PRE>
public static final int <B>ALLOW_CLIP_MODE_READ</B></PRE>
<DL>
<DD>Specifies that this Raster allows reading the clip mode.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_CLIP_MODE_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_CLIP_MODE_WRITE"><!-- --></A><H3>
ALLOW_CLIP_MODE_WRITE</H3>
<PRE>
public static final int <B>ALLOW_CLIP_MODE_WRITE</B></PRE>
<DL>
<DD>Specifies that this Raster allows writing the clip mode.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Raster.ALLOW_CLIP_MODE_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="Raster()"><!-- --></A><H3>
Raster</H3>
<PRE>
public <B>Raster</B>()</PRE>
<DL>
<DD>Constructs a Raster object with default parameters.
 The default values are as follows:
 <ul>
 type : RASTER_COLOR<br>
 clipMode : CLIP_POSITION<br>
 position : (0,0,0)<br>
 srcOffset : (0,0)<br>
 size : (0,0)<br>
 dstOffset : (0,0)<br>
 image : null<br>
 depth component : null<br>
 </ul>
<P>
</DL>
<HR>

<A NAME="Raster(javax.vecmath.Point3f, int, int, int, int, int, javax.media.j3d.ImageComponent2D, javax.media.j3d.DepthComponent)"><!-- --></A><H3>
Raster</H3>
<PRE>
public <B>Raster</B>(<A HREF="../../../javax/vecmath/Point3f.html">Point3f</A>&nbsp;pos,
              int&nbsp;type,
              int&nbsp;xSrcOffset,
              int&nbsp;ySrcOffset,
              int&nbsp;width,
              int&nbsp;height,
              <A HREF="../../../javax/media/j3d/ImageComponent2D.html">ImageComponent2D</A>&nbsp;image,
              <A HREF="../../../javax/media/j3d/DepthComponent.html">DepthComponent</A>&nbsp;depthComponent)</PRE>
<DL>
<DD>Constructs a new Raster object with the specified values.
<P>
<DT><B>Parameters:</B><DD><CODE>pos</CODE> - the position in object coordinates of the upper-left
 corner of the raster<DD><CODE>type</CODE> - the type of raster object, one of: RASTER_COLOR,
 RASTER_DEPTH, or RASTER_COLOR_DEPTH<DD><CODE>xSrcOffset</CODE> - the x offset within the source array of pixels
 at which to start copying<DD><CODE>ySrcOffset</CODE> - the y offset within the source array of pixels
 at which to start copying<DD><CODE>width</CODE> - the number of columns of pixels to copy<DD><CODE>height</CODE> - the number of rows of pixels to copy<DD><CODE>image</CODE> - the ImageComponent2D object containing the
 color data</DL>
<HR>

<A NAME="Raster(javax.vecmath.Point3f, int, java.awt.Point, java.awt.Dimension, javax.media.j3d.ImageComponent2D, javax.media.j3d.DepthComponent)"><!-- --></A><H3>
Raster</H3>
<PRE>
public <B>Raster</B>(<A HREF="../../../javax/vecmath/Point3f.html">Point3f</A>&nbsp;pos,
              int&nbsp;type,
              java.awt.Point&nbsp;srcOffset,
              java.awt.Dimension&nbsp;size,
              <A HREF="../../../javax/media/j3d/ImageComponent2D.html">ImageComponent2D</A>&nbsp;image,
              <A HREF="../../../javax/media/j3d/DepthComponent.html">DepthComponent</A>&nbsp;depthComponent)</PRE>
<DL>
<DD>Constructs a new Raster object with the specified values.
<P>
<DT><B>Parameters:</B><DD><CODE>pos</CODE> - the position in object coordinates of the upper-left
 corner of the raster<DD><CODE>type</CODE> - the type of raster object, one of: RASTER_COLOR,
 RASTER_DEPTH, or RASTER_COLOR_DEPTH<DD><CODE>srcOffset</CODE> - the offset within the source array of pixels
 at which to start copying<DD><CODE>size</CODE> - the width and height of the image to be copied<DD><CODE>image</CODE> - the ImageComponent2D object containing the
 color data</DL>
<HR>

<A NAME="Raster(javax.vecmath.Point3f, int, int, java.awt.Point, java.awt.Dimension, java.awt.Point, javax.media.j3d.ImageComponent2D, javax.media.j3d.DepthComponent)"><!-- --></A><H3>
Raster</H3>
<PRE>
public <B>Raster</B>(<A HREF="../../../javax/vecmath/Point3f.html">Point3f</A>&nbsp;pos,
              int&nbsp;type,
              int&nbsp;clipMode,
              java.awt.Point&nbsp;srcOffset,
              java.awt.Dimension&nbsp;size,
              java.awt.Point&nbsp;dstOffset,
              <A HREF="../../../javax/media/j3d/ImageComponent2D.html">ImageComponent2D</A>&nbsp;image,
              <A HREF="../../../javax/media/j3d/DepthComponent.html">DepthComponent</A>&nbsp;depthComponent)</PRE>
<DL>
<DD>Constructs a new Raster object with the specified values.
<P>
<DT><B>Parameters:</B><DD><CODE>pos</CODE> - the position in object coordinates of the upper-left
 corner of the raster<DD><CODE>type</CODE> - the type of raster object, one of: RASTER_COLOR,
 RASTER_DEPTH, or RASTER_COLOR_DEPTH<DD><CODE>clipMode</CODE> - the clipping mode of the raster object, one of:
 CLIP_POSITION or CLIP_IMAGE<DD><CODE>srcOffset</CODE> - the offset within the source array of pixels
 at which to start copying<DD><CODE>size</CODE> - the width and height of the image to be copied<DD><CODE>dstOffset</CODE> - the destination pixel offset of the upper-left
 corner of the rendered image relative to the transformed position<DD><CODE>image</CODE> - the ImageComponent2D object containing the
 color data<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
</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="setPosition(javax.vecmath.Point3f)"><!-- --></A><H3>
setPosition</H3>
<PRE>
public void <B>setPosition</B>(<A HREF="../../../javax/vecmath/Point3f.html">Point3f</A>&nbsp;pos)</PRE>
<DL>
<DD>Sets the position in object coordinates of this raster.  This
 position is transformed into device coordinates and is used as
 the upper-left corner of the raster.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pos</CODE> - the new position of this raster
<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="getPosition(javax.vecmath.Point3f)"><!-- --></A><H3>
getPosition</H3>
<PRE>
public void <B>getPosition</B>(<A HREF="../../../javax/vecmath/Point3f.html">Point3f</A>&nbsp;pos)</PRE>
<DL>
<DD>Retrieves the current position in object coordinates of this raster.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pos</CODE> - the vector that will receive the current position
<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="setType(int)"><!-- --></A><H3>
setType</H3>
<PRE>
public void <B>setType</B>(int&nbsp;type)</PRE>
<DL>
<DD>Sets the type of this raster object to one of: RASTER_COLOR,
 RASTER_DEPTH, or RASTER_COLOR_DEPTH.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the new type of this raster
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/media/j3d/RestrictedAccessException.html">RestrictedAccessException</A></CODE> - if the method is called
 when this object is part of live or compiled scene graph.</DL>
</DD>
</DL>
<HR>

<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public int <B>getType</B>()</PRE>
<DL>
<DD>Retrieves the current type of this raster object, one of: RASTER_COLOR,
 RASTER_DEPTH, or RASTER_COLOR_DEPTH.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>type the type of this raster
<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="setClipMode(int)"><!-- --></A><H3>
setClipMode</H3>
<PRE>
public void <B>setClipMode</B>(int&nbsp;clipMode)</PRE>
<DL>
<DD>Sets the clipping mode of this raster object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>clipMode</CODE> - the new clipping mode of this raster,
 one of: CLIP_POSITION or CLIP_IMAGE.  The default mode
 is CLIP_POSITION.
<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<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getClipMode()"><!-- --></A><H3>
getClipMode</H3>
<PRE>
public int <B>getClipMode</B>()</PRE>
<DL>
<DD>Retrieves the current clipping mode of this raster object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>clipMode the clipping mode of this raster,
 one of: CLIP_POSITION or CLIP_IMAGE.
<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<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setOffset(int, int)"><!-- --></A><H3>
setOffset</H3>
<PRE>
public void <B>setOffset</B>(int&nbsp;xSrcOffset,
                      int&nbsp;ySrcOffset)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>As of Java 3D version 1.3, replaced by
 <code>setSrcOffset(int,int)</code></I>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setOffset(java.awt.Point)"><!-- --></A><H3>
setOffset</H3>
<PRE>
public void <B>setOffset</B>(java.awt.Point&nbsp;srcOffset)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>As of Java 3D version 1.3, replaced by
 <code>setSrcOffset(java.awt.Point)</code></I>