transeff.htm

formContainer for delphi,是一个delphi form动画现实的组件

  <dd><font size="2"><b>Description:</b> This method has to be overriden in derived classes to
    effectively perform the transition.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#Execute">Execute</a></font></dd>
</dl>

<p><a name="Execute"><font size="2"><b>Execute</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> procedure Execute;</font></dd>
  <dd><font size="2"><b>Description:</b> This method executes the transition if it has been
    correctly <a href="#Prepared">prepared</a>.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#Prepare">Prepare</a> <a href="#Prepare2ndPass">Prepare2ndPass</a>
    <a href="#Prepared">Prepared</a></font></dd>
</dl>

<p><a name="Freeze"><font size="2"><b>Freeze</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function Freeze(Ctrl: TControl; R: TRect): Boolean;</font></dd>
  <dd><font size="2"><b>Description:</b> It really &#145;freezes&#146; the <i>R</i> area of
    the <a href="ctrlref.htm">reference control</a>&nbsp; <i>Ctrl</i> (<i>R</i> coordinates
    depend on the <a href="#ClientCoordinates">ClientCoordinates</a> value). Once frozen, any
    modification that is made to this area is not actualized on the screen, until the
    transition executes or <a href="#UnPrepare"><i>UnPrepare</i></a> or <a href="#Defrost"><i>Defrost</i></a>
    are called. If everything does well then it returns <i>True</i>. <a href="#Prepare"><i>Prepare</i></a>
    automatically calls it if you haven't done it, so you will rarely need to call it
    directly.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#ClientCoordinates">ClientCoordinates</a> <a
    href="#Defrost">Defrost</a> <a href="#Prepare">Prepare</a> <a href="#UnPrepare">UnPrepare</a></font></dd>
</dl>

<p><a name="GetPixelFormat"><font size="2"><b>GetPixelFormat</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> </font><small>function GetPixelFormat: TPixelFormat;
    virtual;</small></dd>
  <dd><font size="2"><b>Description:</b> It returns the desired pixel format for the
    transition bitmaps. By default, it returns the screen pixel format.</font></dd>
</dl>

<p><a name="NeedDstImage"><font size="2"><b>NeedDstImage</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function NeedDstImage: Boolean; virtual;</font></dd>
  <dd><font size="2"><b>Description:</b> If <em>False</em>, the destination image will not be
    initialized. By default, it returns <em>True</em>, but it can be overriden in derived
    classes.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#NeedSrcImage">NeedSrcImage</a> <a
    href="tedata.htm#DstBmp">TTETransitionData.DstBmp</a></font></dd>
</dl>

<p><a name="NeedSrcImage"><font size="2"><b>NeedSrcImage</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function NeedSrcImage: Boolean; virtual;</font></dd>
  <dd><font size="2"><b>Description:</b> If <em>False</em>, the source image will not be
    initialized. By default, it returns <em>True</em>, but it can be overriden in derived
    classes.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#NeedDstImage">NeedDstImage</a> <a
    href="tedata.htm#SrcBmp">TTETransitionData.SrcBmp</a></font></dd>
</dl>

<p><a name="Passes"><font size="2"><b>Passes</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function Passes: Integer;</font></dd>
  <dd><font size="2"><b>Description:</b> Returns the number of passes to use. If <a
    href="#PassSetting"><i>PassSetting</i></a> is <a href="passet.htm#teOnePass"><i>teOnePass</i></a>
    then it returns 1. If it is <a href="passet.htm#teTwoPasses"><i>teTwoPasses</i></a> and <a
    href="#TwoPassesCapable"><em>TwoPassesCapable</em></a> is <em>True</em> then returns 2.
    Finally if it&#146;s <a href="passet.htm#tePaletteDependent"><i>tePaletteDependent</i></a>
    then the video mode is checked (if the video mode uses a 256 colors palette then it
    returns 2, if possible, else returns 1). This is usefull if the transition has to deal
    with different palettes, because a one pass transition will show wrong colors in 256
    colors video mode.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#PassSetting">PassSetting</a> <a
    href="passet.htm">TTEPassSettingType</a></font></dd>
</dl>

<p><a name="Prepare"><font size="2"><b>Prepare</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function Prepare(Ctrl: TControl; R: TRect): Boolean;</font></dd>
  <dd><font size="2"><b>Description:</b> This function calls <a href="#Freeze"><i>Freeze</i></a>(Ctrl,
    R) if necessary and then optionally obtains the source image for the transition. You
    can&#146;t execute a transition without preparing it first. If everything does well then
    it returns <i>True</i>.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#ClientCoordinates">ClientCoordinates</a> <a
    href="#Freeze">Freeze</a> <a href="#Prepared">Prepared</a> <a href="#UnPrepare">UnPrepare</a>
    <a href="#Execute">Execute</a></font></dd>
</dl>

<p><a name="Prepare2ndPass"><font size="2"><b>Prepare2ndPass</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> procedure Prepare2ndPass;</font></dd>
  <dd><font size="2"><b>Description:</b> If <a href="#Passes"><i>Passes</i></a> returns 2 then
    it obtains the intermediate image to use as destination image for the first pass and as
    source image for the second one. If <a href="#Passes"><i>Passes</i></a> returns 1 then
    nothing is done.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#Prepare">Prepare</a> <a href="#UnPrepare">UnPrepare</a>
    <a href="#Execute">Execute</a> <a href="#PassSetting">PassSetting</a></font></dd>
</dl>

<p><a name="RenderWhenClipped"><font size="2"><b>RenderWhenClipped</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function RenderWhenClipped: Boolean; virtual;</font></dd>
  <dd><font size="2"><b>Description:</b> If <em>False</em>, the destination image will not be
    rendered when the area where the transition will take place is clipped for some reason. By
    default, it returns <em>True</em>, but it can be overriden in derived classes. You should
    only override this if the transition doesn't change the position of any of the pixels of
    the source image. For example, a FuseTransition can safely return <em>True</em>, but a
    PushTransition can't.</font></dd>
</dl>

<p><a name="ReversedToUse"><font size="2"><b>ReversedToUse</b></font></a>

<dl>
  <dd><font size="2"><b>Declaration:</b> function ReversedToUse: Boolean;</font></dd>
  <dd><font size="2"><b>Description:</b> If it returns <i>True</i>, then the transition will
    try to use completely opposed settings in the execution (for example, if it has a left to
    right direction, then it will make a right to left effect).</font></dd>
  <dd><font size="2"><strong>See also:</strong> <a href="#Reversed">Reversed</a></font></dd>
</dl>

<p><a name="TwoPassesCapable"><b><font size="2">TwoPassesCapable</font></b></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function TwoPassesPossible: Boolean; virtual;</font></dd>
  <dd><font size="2"><b>Description:</b> If a derived transition (like <a href="drip.htm">DripTransition</a>,
    for example) returns <i>False</i> in this function, then for the first pass a <a
    href="flicker.htm">FlickerFreeTransition</a> will be used. By default it returns <em>True</em>.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#Passes">Passes</a> <a href="#PassSetting">PassSetting</a></font></dd>
</dl>

<p><a name="UnPrepare"><font size="2"><b>UnPrepare</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> procedure UnPrepare;</font></dd>
  <dd><font size="2"><b>Description:</b> Frees all resources allocated by <a href="#Freeze"><i>Freeze</i></a>,
    <a href="#Prepare"><i>Prepare</i></a> and <a href="#Prepare2ndPass"><i>Prepare2ndPass</i></a>.
    It is automatically invoked by <a href="#Execute"><i>Execute</i></a> and <i>Destroy</i>.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#Freeze">Freeze</a> <a href="#Prepare">Prepare</a>
    <a href="#Prepare2ndPass">Prepare2ndPass</a> <a href="#Prepared">Prepared</a> <a
    href="#Execute">Execute</a></font></dd>
</dl>

<p><a name="UpdateScreen"><font size="2"><b>UpdateScreen</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> procedure UpdateScreen(FullUpdate: Boolean);</font></dd>
  <dd><font size="2"><b>Description:</b> Updates the screen with the contents of the offscreen
    bitmap (if an offscreen bitmap is used). If <em>FullUpdate</em> is <em>False</em>, only
    the <a href="#UpdateRect">UpdateRect</a> area is updated. After that, the <a
    href="#UpdateRect">UpdateRect</a> is emptied.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#UpdateRect">UpdateRect</a> <a
    href="#UseOffScreenBmp">UseOffscreenBmp</a></font></dd>
</dl>

<p><a name="UseOffScreenBmp"><font size="2"><b>UseOffScreenBmp</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> function UseOffScreenBmp: Boolean; virtual;</font></dd>
  <dd><font size="2"><b>Description:</b> If <em>True</em>, the transition will use an
    offscreen bitmap. By default, it returns <em>False</em>, but it can be overriden in
    derived classes.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#UpdateRect">UpdateRect</a> <a
    href="#UpdateScreen">UpdateScreen</a></font></dd>
  <dd>&nbsp;</dd>
</dl>

<p><a name="Events"><font face="Arial">Events</font></a></p>

<p><a name="OnStartTransition"><font size="2"><b>OnStartTransition</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> </font><small>property OnStartTransition:
    TNotifyEvent read FOnStartTransition write FOnStartTransition;</small></dd>
  <dd><font size="2"><b>Description:</b> It is fired each time the transition starts to
    execute, but only if the transition is <a href="#Enabled">Enabled</a> and it isn't a <a
    href="flicker.htm">FlickeFreeTransition</a>.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#OnEndTransition">OnEndTransition</a></font></dd>
</dl>

<p><a name="OnEndTransition"><font size="2"><b>OnEndTransition</b></font></a> 

<dl>
  <dd><font size="2"><b>Declaration:</b> </font><small>property OnEndTransition: TNotifyEvent
    read FOnEndTransition write FOnEndTransition;</small></dd>
  <dd><font size="2"><b>Description:</b> It is fired each time the transition finalizes, but
    only if the transition is <a href="#Enabled">Enabled</a> and it isn't a <a
    href="flicker.htm">FlickeFreeTransition</a>.</font></dd>
  <dd><font size="2"><b>See also:</b> <a href="#OnStartTransition">OnStartTransition</a></font></dd>
</dl>
</body>
</html>