qteffect.html

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

<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../quicktime/app/image/QTEffect.html#setEffect(quicktime.std.movies.AtomContainer)">setEffect</A></B>(<A HREF="../../../quicktime/std/movies/AtomContainer.html">AtomContainer</A>&nbsp;effectParams)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method will take the incoming parameters and use this as the control parameters for the 
 effect.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../quicktime/app/image/QTEffect.html#setGraphicsMode(quicktime.std.image.GraphicsMode)">setGraphicsMode</A></B>(<A HREF="../../../quicktime/std/image/GraphicsMode.html">GraphicsMode</A>&nbsp;mode)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This sets the GraphicsMode for the Compositor when it draws its composited 
 contents to its destination QDGraphics (typically the QTCanvas).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../quicktime/app/image/QTEffect.html#setGWorld(quicktime.qd.QDGraphics)">setGWorld</A></B>(<A HREF="../../../quicktime/qd/QDGraphics.html">QDGraphics</A>&nbsp;cgp)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;QTCanvas calls this method to give the client the QDGraphics object it should 
 use to do its drawing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../quicktime/app/image/QTEffect.html#setLocation(int, int)">setLocation</A></B>(int&nbsp;x,
            int&nbsp;y)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A convenience method to set the position of a QTDrawable object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../quicktime/app/image/QTEffect.html#setMatrix(quicktime.std.image.Matrix)">setMatrix</A></B>(<A HREF="../../../quicktime/std/image/Matrix.html">Matrix</A>&nbsp;matrix)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method sets the current matrix of the Transformable object to
 the new matrix.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../quicktime/app/image/QTEffect.html#setRedrawing(boolean)">setRedrawing</A></B>(boolean&nbsp;redrawFlag)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true then the current frame of the effect is drawn on redraw.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../quicktime/app/image/QTEffect.html#setUpSequence()">setUpSequence</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is called by a number of other methods to create
 the DSequence that is used to render the QTEffect.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</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>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= 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="QTEffect()"><!-- --></A><H3>
QTEffect</H3>
<PRE>
public <B>QTEffect</B>()
         throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>Creates a QTEffect with kMultiFrame set with a default initial size of 0, 0.</DL>
<HR>

<A NAME="QTEffect(java.awt.Dimension)"><!-- --></A><H3>
QTEffect</H3>
<PRE>
public <B>QTEffect</B>(java.awt.Dimension&nbsp;d)
         throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>since QTJava 4.0</I>
<P>
<DD>Creates a QTEffect with kMultiFrame set and the specified initial size.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>d</CODE> - the initialSize of the effect.</DL>
</DD>
</DL>
<HR>

<A NAME="QTEffect(int)"><!-- --></A><H3>
QTEffect</H3>
<PRE>
public <B>QTEffect</B>(int&nbsp;multiFrameFlag)
         throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>Creates a QTEffect with kMultiFrame set with a default initial size of 0, 0.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>multiFrameFlag</CODE> - is normally set to kMultiFrame. The setting of this flag
 will also set the initial setting of the redrawing flag. QTEffects
 require redrawing so the default value is kMultiFrame. Typically the QTFilters do
 not require redrawing so their default value is kSingleFrame. QTTransitions are
 multiframes and so do require redrawing.</DL>
</DD>
</DL>
<HR>

<A NAME="QTEffect(int, java.awt.Dimension)"><!-- --></A><H3>
QTEffect</H3>
<PRE>
public <B>QTEffect</B>(int&nbsp;multiFrameFlag,
                java.awt.Dimension&nbsp;d)
         throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>since QTJava 4.0</I>
<P>
<DD>Creates a QTEffect. The specified multiFrameFlag parameter should
 be set to Redrawable.kMultiFrame as all of the existing QTEffects require
 redrawing for their visual effect to be apparent.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>multiFrameFlag</CODE> - is normally set to kMultiFrame. The setting of this flag
 will also set the initial setting of the redrawing flag. QTEffects
 require redrawing so the default value is kMultiFrame. Typically the QTFilters do
 not require redrawing so their default value is kSingleFrame. QTTransitions are
 multiframes and so do require redrawing.<DD><CODE>d</CODE> - the initialSize of the effect.<DT><B>See Also: </B><DD><CODE>()</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="QTEffect(int, quicktime.qd.QDDimension)"><!-- --></A><H3>
QTEffect</H3>
<PRE>
public <B>QTEffect</B>(int&nbsp;multiFrameFlag,
                <A HREF="../../../quicktime/qd/QDDimension.html">QDDimension</A>&nbsp;d)
         throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>Creates a QTEffect. The specified multiFrameFlag parameter should
 be set to Redrawable.kMultiFrame as all of the existing QTEffects require
 redrawing for their visual effect to be apparent.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>multiFrameFlag</CODE> - is normally set to kMultiFrame. The setting of this flag
 will also set the initial setting of the redrawing flag. QTEffects
 require redrawing so the default value is kMultiFrame. Typically the QTFilters do
 not require redrawing so their default value is kSingleFrame. QTTransitions are
 multiframes and so do require redrawing.<DD><CODE>d</CODE> - the initialSize of the effect.</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="setRedrawing(boolean)"><!-- --></A><H3>
setRedrawing</H3>
<PRE>
public void <B>setRedrawing</B>(boolean&nbsp;redrawFlag)</PRE>
<DL>
<DD>If true then the current frame of the effect is drawn on redraw. 
 If false then the effect is only applied when you explicitly apply it 
 For an effect or a filter the default setting for this flag is true - the effect
 is redrawn on redraw. For a Transition the default setting for this flag
 is false - the source of the effect only is redrawn.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/Redrawable.html#setRedrawing(boolean)">setRedrawing</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/Redrawable.html">Redrawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>redrawFlag</CODE> - boolean indicating redraw behaviour</DL>
</DD>
</DL>
<HR>

<A NAME="isRedrawing()"><!-- --></A><H3>
isRedrawing</H3>
<PRE>
public boolean <B>isRedrawing</B>()</PRE>
<DL>
<DD>Returns the state of the redraw flag<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/Redrawable.html#isRedrawing()">isRedrawing</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/Redrawable.html">Redrawable</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>boolean</DL>
</DD>
</DL>
<HR>

<A NAME="isSingleFrame()"><!-- --></A><H3>
isSingleFrame</H3>
<PRE>
public boolean <B>isSingleFrame</B>()</PRE>
<DL>
<DD>Returns true if the Redrawable only has a single frame to render and thus
 will never need to re-acquire or redraw its image. Certain Redrawable objects
 are able to optimise their resources knowing this constraint.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../quicktime/app/image/Redrawable.html#isSingleFrame()">isSingleFrame</A></CODE> in interface <CODE><A HREF="../../../quicktime/app/image/Redrawable.html">Redrawable</A></CODE></DL>
</DD>
<DD>Following copied from interface: <CODE>quicktime.app.image.Redrawable</CODE></DD>
<DD><DL>
<DT><B>Returns:</B><DD>a boolean</DL>
</DD>
</DL>
<HR>

<A NAME="setGraphicsMode(quicktime.std.image.GraphicsMode)"><!-- --></A><H3>
setGraphicsMode</H3>
<PRE>
public void <B>setGraphicsMode</B>(<A HREF="../../../quicktime/std/image/GraphicsMode.html">GraphicsMode</A>&nbsp;mode)
                     throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This sets the GraphicsMode for the Compositor when it draws its composited 
 contents to its destination QDGraphics (typically the QTCanvas).<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getGraphicsMode()"><!-- --></A><H3>
getGraphicsMode</H3>
<PRE>
public <A HREF="../../../quicktime/std/image/GraphicsMode.html">GraphicsMode</A> <B>getGraphicsMode</B>()</PRE>
<DL>
<DD>This gets the current GraphicsMode for the QTEffect.<DD><DL>
</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;r)
             throws <A HREF="../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>This will set the clipping of the effect - it defines the region of the source image
 that the effect will be applied to.<DD><DL>
<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>r</CODE> - 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 of the effect or null if the effect is not clipped<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>Following copied from interface: <CODE>quicktime.app.display.QTDrawable</CODE></DD>
<DD><DL>
<DT><B>Returns:</B><DD>the clipping region</DL>
</DD>
</DL>
<HR>

<A NAME="getEffect()"><!-- --></A><H3>
getEffect</H3>
<PRE>
public <A HREF="../../../quicktime/std/movies/AtomContainer.html">AtomContainer</A> <B>getEffect</B>()
                        throws <A HREF="../../../quicktime/std/StdQTException.html">StdQTException</A></PRE>
<DL>
<DD>This will return a copy of the AtomContainer that contains the 
 current effect settings. You can alter the values of this container but you
 must call setEffect for those new values to be used by the effect.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setEffect(quicktime.std.movies.AtomContainer)"><!-- --></A><H3>
setEffect</H3>
<PRE>
public void <B>setEffect</B>(<A HREF="../../../quicktime/std/movies/AtomContainer.html">AtomContainer</A>&nbsp;effectParams)
               throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method will take the incoming parameters and use this as the control parameters for the 
 effect. The container will be locked for the duration of the effect object's life or until 
 another effect is set.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>effectParams</CODE> - the parameters that determine the effect that is run</DL>
</DD>
</DL>
<HR>

<A NAME="setUpSequence()"><!-- --></A><H3>
setUpSequence</H3>
<PRE>
protected boolean <B>setUpSequence</B>()
                         throws <A HREF="../../../quicktime/QTException.html">QTException</A></PRE>
<DL>
<DD>This method is called by a number of other methods to create
 the DSequence that is used to render the QTEffect.
 When called the method will create a new DSequence if the required
 state has been established to enable the creation of the DSequence.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if a new DSequence was created, otherwise false.</DL>
</DD>
</DL>
<HR>

<A NAME="getFrames()"><!-- --></A><H3>
getFrames</H3>
<PRE>