JvAnimatedImage.dtx

##Package: MM
##Status: Completed, Needs review
----------------------------------------------------------------------------------------------------
@@JvAnimatedImage.pas
Summary
    Contains the TJvAnimatedImage component.
Author
  Fedor Koshevnikov
  Igor Pavluk
  Serge Korolev
----------------------------------------------------------------------------------------------------
@@TGlyphOrientation
<TITLE TGlyphOrientation type>
Summary
  Indicates the orientation of a glyph in a TJvAnimatedImage component
Description
  By orientation, we mean the direction in which the Glyph is cut according to the NumGlpyhs property
See Also
  TJvAnimatedImage.Glyph, TJvAnimatedImage.NumGlyphs

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.Stretch
Summary
  If true, the image is stretched to fit in the control size
Description
  Write here a description
See Also
  <DELPHILINK TControl.AutoSize>

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.Orientation
Summary
  The orientation used to create the frames from Glyph
Description
  If orientation is goHorizontal, the Glyph property will be cut along its width If orientation is
  goVertical, the Glyph property will be cut along its height
See Also
  TJvAnimatedImage.Glyph, TJvAnimatedImage.NumGlyphs

----------------------------------------------------------------------------------------------------
@@TJvImageControl
Summary
  This is a control that displays an image using buffered painting
Description
  Write here a description

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.Transparent
Summary
  If True the background of the image is transparent.
Description
  Write here a description

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.TransparentColor
Summary
  Indicate which color is to be considered transparent in the glyph
Description
  Write here a description

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.OnFrameChanged
Summary
  Event triggered when the current frame has been changed
Description
  Write here a description

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.OnStart
Summary
  Even triggered when the animation starts (by setting Active to True)
Description
  Write here a description
See Also
  TJvAnimatedImage.OnStop

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.OnStop
Summary
  Event triggered when the animation stops (by setting Active to False)
Description
  Write here a description
See Also
  TJvAnimatedImage.OnStart

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.Interval
Summary
  The interval in milliseconds between each frame
Description
  Write here a description

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.NumGlyphs
Summary
  The number of frames in the Glyph property
Description
  The sub-glyphs (frames) will be cut according to the orientation
See Also
  TJvAnimatedImage.Glyph, TJvAnimatedImage.Orientation

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.AsyncDrawing
Summary
  Determines if the drawing thread is synchronized to the main VCL thread
Description
  If true, the drawing thread is not synchronized to the main VCL thread. This leads to a risk of
  exception and should not be used.
See Also
  TJvTimer.SyncEvent

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.Center
Summary
  Determines if the animation is drawn centered in the control
Description
  For Center to have an impact, you must set AutoSize and Stretch to False
See Also
  <DELPHILINK TControl.AutoSize>

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.GlyphNum
Summary
  Indicate which sub-glyph in Glyph is to be displayed at the start of the animation
Description
  At runtime, this value is updated to indicate which glyph is being displayed
See Also
  TJvAnimatedImage.Glyph, TJvAnimatedImage.InactiveGlyph, TJvAnimatedImage.NumGlyphs

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.InactiveGlyph
Summary
  The sub-glyph to display when the image is inactive
Description
  Write here a description
See Also
  TJvAnimatedImage.Active, TJvAnimatedImage.GlyphNum

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.Glyph
Summary
  The glyph to use for the animation
Description
  Depending on the value of Orientation, the glyph will be cut along its width or its height to
  determine the frames to use for the animation.
See Also
  TJvAnimatedImage.GlyphNum, TJvAnimatedImage.NumGlyphs, TJvAnimatedImage.Orientation

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage.Active
Summary
  If true, the animation is being performed.
Description
  Write here a description

----------------------------------------------------------------------------------------------------
@@TGlyphOrientation.goHorizontal
The Glyph will be cut horizontally

----------------------------------------------------------------------------------------------------
@@TGlyphOrientation.goVertical
The glyph will be cut vertically

----------------------------------------------------------------------------------------------------
@@TJvAnimatedImage
<TITLEIMG TJvAnimatedImage>
#JVCLInfo
<GROUP JVCL.Graphics.Animations>
<FLAG Component>
Summary
  A component that takes a glyph, cuts it along one direction to create frames to be displayed as an
  animation.
Description
  The Glyph property is cut according to the NumGlyph property and each sub-glyph is considered as a
  frame for the animation to be performed