twodsprite.html

这个是java的quicktime for java 的详细使用文档

<PRE>
public <B>TwoDSprite</B>(<A HREF="../../../quicktime/app/image/ImageSpec.html">ImageSpec</A>&nbsp;image,
                  <A HREF="../../../quicktime/std/image/Matrix.html">Matrix</A>&nbsp;matrix,
                  boolean&nbsp;visibility,
                  int&nbsp;layer,
                  <A HREF="../../../quicktime/std/image/GraphicsMode.html">GraphicsMode</A>&nbsp;graphicsMode)
           throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This constructor
 provides all of the state which will be used by the TwoDSprite object to create itself
 when it is attached to a SpriteWorld.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>image</CODE> - the image data and description that describes the image of the sprite<DD><CODE>matrix</CODE> - the display matrix of the sprite<DD><CODE>visibility</CODE> - whether the sprite will be visible (true) or not (false) when created<DD><CODE>layer</CODE> - the layer of the SpriteWorld where the Sprite will be drawn<DD><CODE>graphicsMode</CODE> - the GraphicsMode that is applied to the rendering of the 
 image data, this can be null</DL>
</DD>
</DL>
<HR>

<A NAME="TwoDSprite(quicktime.app.image.ImageDataSequence, int, quicktime.std.image.Matrix, boolean, int)"><!-- --></A><H3>
TwoDSprite</H3>
<PRE>
public <B>TwoDSprite</B>(<A HREF="../../../quicktime/app/image/ImageDataSequence.html">ImageDataSequence</A>&nbsp;images,
                  int&nbsp;frame,
                  <A HREF="../../../quicktime/std/image/Matrix.html">Matrix</A>&nbsp;matrix,
                  boolean&nbsp;visibility,
                  int&nbsp;layer)
           throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This constructor
 provides all of the state which will be used by the TwoDSprite object to create itself
 when it is attached to a SpriteWorld.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>images</CODE> - the image data and description that describes the images of the sprite<DD><CODE>frame</CODE> - the frame number within the images that will be used as the current image for
 the sprite when it is created<DD><CODE>matrix</CODE> - the display matrix of the sprite<DD><CODE>visibility</CODE> - whether the sprite will be visible (true) or not (false) when created<DD><CODE>layer</CODE> - the layer of the SpriteWorld where the Sprite will be drawn</DL>
</DD>
</DL>
<HR>

<A NAME="TwoDSprite(quicktime.app.image.ImageDataSequence, int, quicktime.std.image.Matrix, boolean, int, quicktime.std.image.GraphicsMode)"><!-- --></A><H3>
TwoDSprite</H3>
<PRE>
public <B>TwoDSprite</B>(<A HREF="../../../quicktime/app/image/ImageDataSequence.html">ImageDataSequence</A>&nbsp;images,
                  int&nbsp;frame,
                  <A HREF="../../../quicktime/std/image/Matrix.html">Matrix</A>&nbsp;matrix,
                  boolean&nbsp;visibility,
                  int&nbsp;layer,
                  <A HREF="../../../quicktime/std/image/GraphicsMode.html">GraphicsMode</A>&nbsp;graphicsMode)
           throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This constructor
 provides all of the state which will be used by the TwoDSprite object to create itself
 when it is attached to a SpriteWorld.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>images</CODE> - the image data and description that describes the images of the sprite<DD><CODE>frame</CODE> - the frame number within the images that will be used as the current image for
 the sprite when it is created<DD><CODE>matrix</CODE> - the display matrix of the sprite<DD><CODE>visibility</CODE> - whether the sprite will be visible (true) or not (false) when created<DD><CODE>layer</CODE> - the layer of the SpriteWorld where the Sprite will be drawn<DD><CODE>graphicsMode</CODE> - the GraphicsMode that is applied to the rendering of the 
 image data, this can be null</DL>
</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="setLabel(java.lang.String)"><!-- --></A><H3>
setLabel</H3>
<PRE>
public void <B>setLabel</B>(java.lang.String&nbsp;label)</PRE>
<DL>
<DD>You can set the label string for this TwoDSprite.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>label</CODE> - a string that is associated with this sprite.</DL>
</DD>
</DL>
<HR>

<A NAME="getLabel()"><!-- --></A><H3>
getLabel</H3>
<PRE>
public java.lang.String <B>getLabel</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the label that is associated with this TwoDSprite.</DL>
</DD>
</DL>
<HR>

<A NAME="setNotifier(quicktime.app.actions.Notifier)"><!-- --></A><H3>
setNotifier</H3>
<PRE>
public boolean <B>setNotifier</B>(<A HREF="../../../quicktime/app/actions/Notifier.html">Notifier</A>&nbsp;notifier)</PRE>
<DL>
<DD>This registers the deferred listener.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/actions/NotifyListener.html#setNotifier(quicktime.app.actions.Notifier)">setNotifier</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/actions/NotifyListener.html">NotifyListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dl</CODE> - the listener that the DeferredListener notifies when
 its listen source becomes valid<DT><B>Returns:</B><DD>true if the Notifier is an instanceof ImageSpec and thus is a valid Notifier
 for the TwoDSprite. Returns false if the Notifier is not an instanceof ImageSpec.</DL>
</DD>
</DL>
<HR>

<A NAME="notifyComplete()"><!-- --></A><H3>
notifyComplete</H3>
<PRE>
public void <B>notifyComplete</B>()</PRE>
<DL>
<DD>This method is called by the Notifier object when the image data that it is 
 supplying to the TwoDSprite is valid.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/actions/NotifyListener.html#notifyComplete()">notifyComplete</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/actions/NotifyListener.html">NotifyListener</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setImageData(quicktime.util.EncodedImage, quicktime.std.image.ImageDescription)"><!-- --></A><H3>
setImageData</H3>
<PRE>
public void <B>setImageData</B>(<A HREF="../../../quicktime/util/EncodedImage.html">EncodedImage</A>&nbsp;im,
                         <A HREF="../../../quicktime/std/image/ImageDescription.html">ImageDescription</A>&nbsp;id)
                  throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method can be used to change the image that is being presented by the Sprite
 and to ensure that the sprite is visible, if the specified image data is not null. 
 This method is also called internally when the
 Notifier of this class notifies the Sprite that the image data is valid.
 If valid image data is provided this method also requires an ImageDescription that 
 describes this image data.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/ImageSettable.html#setImageData(quicktime.util.EncodedImage, quicktime.std.image.ImageDescription)">setImageData</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/ImageSettable.html">ImageSettable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>im</CODE> - the EncodedImage image data<DD><CODE>id</CODE> - the ImageDescription that describes the format of the EncodedImage data.</DL>
</DD>
</DL>
<HR>

<A NAME="setImage(quicktime.util.EncodedImage)"><!-- --></A><H3>
setImage</H3>
<PRE>
public void <B>setImage</B>(<A HREF="../../../quicktime/util/EncodedImage.html">EncodedImage</A>&nbsp;image)
              throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method should make the object's current image the specified image.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageData</CODE> - the new image data that the object should make its current image.</DL>
</DD>
</DL>
<HR>

<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public <A HREF="../../../quicktime/app/anim/SWCompositor.html">SWCompositor</A> <B>getParent</B>()</PRE>
<DL>
<DD>Return the sprite world that this sprite belongs too. If the TwoDSprite
 is not currently attached to a SpriteWorld a SpriteInvalidException will
 be thrown.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the current SpriteWorld of a valid TwoDSprite</DL>
</DD>
</DL>
<HR>

<A NAME="isValid()"><!-- --></A><H3>
isValid</H3>
<PRE>
public boolean <B>isValid</B>()</PRE>
<DL>
<DD>Returns true if the Sprite being used by the TwoDSprite is valid and thus is constructed
 and present in a SpriteWorld. Returns false if not.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a boolean</DL>
</DD>
</DL>
<HR>

<A NAME="remove()"><!-- --></A><H3>
remove</H3>
<PRE>
public void <B>remove</B>()
            throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This will remove the sprite from the SpriteWorld it is contained in and destroy its 
 internal structures. The TwoDSprite must be reset after this call to recreate a 
 Sprite object to attach it to a sprite world.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also: </B><DD><CODE>createSprite</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getSpriteInfo()"><!-- --></A><H3>
getSpriteInfo</H3>
<PRE>
public <A HREF="../../../quicktime/app/anim/TwoDSpriteInfo.html">TwoDSpriteInfo</A> <B>getSpriteInfo</B>()
                             throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>Returns all of the pertinent information about the current sprite's state to
 recreate a sprite.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the TwoDSprite info object that contains all of the information that the Sprite
 is presenting.</DL>
</DD>
</DL>
<HR>

<A NAME="removeNotify()"><!-- --></A><H3>
removeNotify</H3>
<PRE>
protected void <B>removeNotify</B>()
                     throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This call should not be called by an application. It is used by the Compositor
 to notify the Sprite that it is no longer valid - generally done when the Compositor
 is recreating its internal SpriteWorld.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createSprite(quicktime.std.anim.SpriteWorld)"><!-- --></A><H3>
createSprite</H3>
<PRE>
public void <B>createSprite</B>(<A HREF="../../../quicktime/std/anim/SpriteWorld.html">SpriteWorld</A>&nbsp;sw)
                  throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This will create a sprite object that presents the specified image and display options
 as specified in the contained info object.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sw</CODE> - the Sprite world that the Sprite will appear in</DL>
</DD>
</DL>
<HR>

<A NAME="getMatrix()"><!-- --></A><H3>
getMatrix</H3>
<PRE>
public <A HREF="../../../quicktime/std/image/Matrix.html">Matrix</A> <B>getMatrix</B>()
                 throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method returns the current matrix of the Transformable object.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/Transformable.html#getMatrix()">getMatrix</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/Transformable.html">Transformable</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setMatrix(quicktime.std.image.Matrix)"><!-- --></A><H3>
setMatrix</H3>
<PRE>
public void <B>setMatrix</B>(<A HREF="../../../quicktime/std/image/Matrix.html">Matrix</A>&nbsp;matrix)
               throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method sets the current matrix of the Transformable object to
 the new matrix.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/Transformable.html#setMatrix(quicktime.std.image.Matrix)">setMatrix</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/Transformable.html">Transformable</A></CODE></DL>
</DD>
</DL>