swcompositor.html

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

<DD>QTCanvas calls this method when it needs to tell the client to adjust
 its location, width and/or height. All values are in pixels.
 <br><DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/display/Drawable.html#setDisplayBounds(quicktime.qd.QDRect)">setDisplayBounds</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/display/Drawable.html">Drawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bounds</CODE> - the new size and location.</DL>
</DD>
</DL>
<HR>

<A NAME="setLocation(int, int)"><!-- --></A><H3>
setLocation</H3>
<PRE>
public void <B>setLocation</B>(int&nbsp;x,
                        int&nbsp;y)
                 throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>A convenience method to set the position of a QTDrawable object.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/display/QTDrawable.html#setLocation(int, int)">setLocation</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/display/QTDrawable.html">QTDrawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>x</CODE> - the new x location<DD><CODE>y</CODE> - the new y location</DL>
</DD>
</DL>
<HR>

<A NAME="getDisplayBounds()"><!-- --></A><H3>
getDisplayBounds</H3>
<PRE>
public <A HREF="../../../quicktime/qd/QDRect.html">QDRect</A> <B>getDisplayBounds</B>()
                        throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>QTCanvas calls this method when it needs to get the client's
 location, width and/or height. All values are in pixels.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/display/Drawable.html#getDisplayBounds()">getDisplayBounds</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/display/Drawable.html">Drawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>bounds the new size and location.</DL>
</DD>
</DL>
<HR>

<A NAME="redraw(quicktime.qd.Region)"><!-- --></A><H3>
redraw</H3>
<PRE>
public final void <B>redraw</B>(<A HREF="../../../quicktime/qd/Region.html">Region</A>&nbsp;invalidRgn)
                  throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>QTCanvas calls this method when the client should redraw itself.
 If the canvas is able to discern that only a part of the client's 
 drawing area needs to be redrawn - then this area shall be passed in
 using the invalidRgn. Otherwise this will be null in which case the
 client should redraw itself entirely.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/display/Drawable.html#redraw(quicktime.qd.Region)">redraw</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/display/Drawable.html">Drawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>invalidRgn</CODE> - the invalidRgn that the client should redraw</DL>
</DD>
</DL>
<HR>

<A NAME="isAutoRedrawing()"><!-- --></A><H3>
isAutoRedrawing</H3>
<PRE>
public boolean <B>isAutoRedrawing</B>()</PRE>
<DL>
<DD>Returns the current state of the auto redrawing flag.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a boolean.<DT><B>See Also: </B><DD><CODE>(boolean)</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setAutoRedrawing(boolean)"><!-- --></A><H3>
setAutoRedrawing</H3>
<PRE>
public void <B>setAutoRedrawing</B>(boolean&nbsp;flag)</PRE>
<DL>
<DD>If a SWCompositor's time rate is equal to zero, changing a property of a member's sprite
 requires the SWCompositor to be redrawn to see this change. This is done automatically for
 you by the TwoDSprite class. However, if an application wishes to change a number of properties of
 a given sprite or sprites, redrawing the Compositor after each change can be an udesirable side-effect
 of this automatic redrawing capability. The application can temporarily turn or or off this capability of
 the SWCompositor, which is controlled by the TwoDSprite, by changing the setting of the auto redrawing flag.
 If this auto redrawing flag is false, the TwoDSprite will not automatically redraw its parent SWCompositor,
 if the flag is true then the TwoDSprite will redraw its parent.
 <P>
 Typically an application will set this flag to false, make the changes to its sprites, then reset the flag
 to true. The application will still have to redraw the SWCompositor after making the changes to its
 member sprites.	  
 <P>
 If the rate of the SWCompositor's TimeBase is not equal to zero, then this flag has no effect as the composite
 cycle is being controlled by the time-based rendering cycle.
 <P>
 Regardless of the value of this flag, the SWCompositor will still redraw itself when the redraw method
 is called. This flag only controls whether the SWCompositor's member sprites will automatically redraw their parents.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>flag</CODE> - controls the auto redrawing capability of a SWCompositor. By default the auto-redrawing is set to true.</DL>
</DD>
</DL>
<HR>

<A NAME="idle()"><!-- --></A><H3>
idle</H3>
<PRE>
protected void <B>idle</B>()
             throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method can be called to explicitly force the SWCompositor to
 redraw itself. It does not ticke the Compositor - so no ticklish or
 invalidate actions will be performed. It will just force the internal
 QuickTime SpriteWorld to do a composit cycle and redraw those areas
 of the SpriteWorld which are invalid.
 <P>
 In the normal course of operations an application does not need to call this method
 but it is particularly useful for profiling. It should only
 be called if the SpriteWorld that is presenting the SWCompositor is NOT null - otherwise
 a NullPointerException will be thrown.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="hitTest(int, int)"><!-- --></A><H3>
hitTest</H3>
<PRE>
public java.lang.Object <B>hitTest</B>(int&nbsp;x,
                                int&nbsp;y)
                         throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>Return the frontmost object that is located at the specified coordinates.
 Hit test coordinates will take into account the location of the space
 thus if the space is at 50, 50 and an object is located in the top,left
 of the space then the hit test coords for the first pixel of this object
 is 50, 50.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/display/QTDisplaySpace.html#hitTest(int, int)">hitTest</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/display/QTDisplaySpace.html">QTDisplaySpace</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>x</CODE> - the x coordinate<DD><CODE>y</CODE> - the y coordinate<DT><B>Returns:</B><DD>an Object at that coordinate or null if no object at specified coordinate</DL>
</DD>
</DL>
<HR>

<A NAME="setClip(quicktime.qd.Region)"><!-- --></A><H3>
setClip</H3>
<PRE>
public void <B>setClip</B>(<A HREF="../../../quicktime/qd/Region.html">Region</A>&nbsp;clipRgn)
             throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method sets the sprite world's clip.
	 <BR><BR><b> <a href="http://developer.apple.com/techpubs/quicktime/qtdevdocs/REF/refSpriteToolboxAPI.9.htm#35433">QuickTime::SetSpriteWorldClip()</a> </b><BR><BR>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/display/QTDrawable.html#setClip(quicktime.qd.Region)">setClip</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/display/QTDrawable.html">QTDrawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>clipRgn</CODE> - Specifies the clipping region.</DL>
</DD>
</DL>
<HR>

<A NAME="getClip()"><!-- --></A><H3>
getClip</H3>
<PRE>
public <A HREF="../../../quicktime/qd/Region.html">Region</A> <B>getClip</B>()</PRE>
<DL>
<DD>Returns the current clipping region used by the sprite world<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/display/QTDrawable.html#getClip()">getClip</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/display/QTDrawable.html">QTDrawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the current clip region.</DL>
</DD>
</DL>
<HR>

<A NAME="tickle(float, int)"><!-- --></A><H3>
tickle</H3>
<PRE>
public boolean <B>tickle</B>(float&nbsp;er,
                      int&nbsp;time)
               throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../quicktime/app/time/Ticklish.html">Ticklish</A></CODE></B></DD>
<DD>The Timer invokes the tickle method when the invocation constraints of 
 the Timer are reached.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/time/Ticklish.html#tickle(float, int)">tickle</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/time/Ticklish.html">Ticklish</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../quicktime/app/spaces/SimpleSpace.html#tickle(float, int)">tickle</A></CODE> in class <CODE><A HREF="../../../quicktime/app/spaces/SimpleSpace.html">SimpleSpace</A></CODE></DL>
</DD>
<DD>Following copied from interface: <CODE>quicktime.app.time.Ticklish</CODE></DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>er</CODE> - the effective rate of the Timer when the time condition matches<DD><CODE>time</CODE> - the time that the Timer invoked the tickle method.<DT><B>Returns:</B><DD>true if the Ticklish object should receive a consequent tickle, or false
 if the Ticklish object should not be tickled again.</DL>
</DD>
</DL>
<HR>

<A NAME="removedFromCompositor(quicktime.app.anim.SWCompositor)"><!-- --></A><H3>
removedFromCompositor</H3>
<PRE>
public void <B>removedFromCompositor</B>(<A HREF="../../../quicktime/app/anim/SWCompositor.html">SWCompositor</A>&nbsp;c)
                           throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>When a dynamic image class is removed from a SWCompositor this
 method is called to allow the class to cleanup any of the invalidation
 processes it had established in the addedToCompositor call.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/DynamicImage.html#removedFromCompositor(quicktime.app.anim.SWCompositor)">removedFromCompositor</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/DynamicImage.html">DynamicImage</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - the SWCompositor it is being removed from</DL>
</DD>
</DL>
<HR>

<A NAME="addedToCompositor(quicktime.app.anim.SWCompositor, quicktime.app.anim.TwoDSprite)"><!-- --></A><H3>
addedToCompositor</H3>
<PRE>
public <A HREF="../../../quicktime/app/actions/Invalidator.html">Invalidator</A> <B>addedToCompositor</B>(<A HREF="../../../quicktime/app/anim/SWCompositor.html">SWCompositor</A>&nbsp;c,
                                     <A HREF="../../../quicktime/app/anim/TwoDSprite.html">TwoDSprite</A>&nbsp;s)
                              throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>Returns an object that invalidates a sprite. When a DynamicImage
 is a member of a SWompositor and the DynamicImage presents a
 changing image (for example a movie), the TwoDSprite that presents
 that image in the SWCompositor must be invalidated so that it will
 redraw the Sprites image in the next composit cycle. The Invalidator
 object is used to perform this function by the SWCompositor if the object
 itself cannot perform the invalidation.
 Can return null if the DynamicImage does not require the SWCompositor
 to invalidate it (or the object is in a state where its image won't change).
 <P>
 The Invalidators provided with objects that implement the DynamicImage
 interface will execute at the scale and period of the Compositor
 when they are created.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/DynamicImage.html#addedToCompositor(quicktime.app.anim.SWCompositor, quicktime.app.anim.TwoDSprite)">addedToCompositor</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/DynamicImage.html">DynamicImage</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - the Compositor in which the