All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.app.image.QTFilter

java.lang.Object
   |
   +----quicktime.app.image.QTEffect
           |
           +----quicktime.app.image.QTFilter

public class QTFilter
extends QTEffect
QTFilters are visual effects that are applied to a single source image. They inherit much of the characteristics of the QTEffect class.


Constructor Index

 o QTFilter()
Creates a QTFilter which is a singleFrame filter and an initialSize of 0, 0.
 o QTFilter(Dimension)
Creates a QTFilter which is a singleFrame filter and specified initialSize.
 o QTFilter(int)
Creates a QTFilter of specified frame setting and an initialSize of 0, 0.
 o QTFilter(int, Dimension)
Creates a QTFilter of specified frame setting and initSize.

Method Index

 o getInitialSize()
This method returns the original size before the transformations specified in the returned matrix are applied.
 o getSourceImage()
Returns the currently set source image of the QTFilter
 o setEffect(AtomContainer)
This method will take the incoming parameters and use this as the control parameters for the effect.
 o setSourceImage(ImageSpec)
This sets the QT source of the QTFilter, which is the image that the current filter will be applied to when doEffect is called.
 o setUpSequence()
This method is called by a number of other methods to create the DSequence that is used to render the QTEffect.

Constructors

 o QTFilter
 public QTFilter() throws QTException
Creates a QTFilter which is a singleFrame filter and an initialSize of 0, 0.

 o QTFilter
 public QTFilter(Dimension d) throws QTException
Creates a QTFilter which is a singleFrame filter and specified initialSize.

Parameters:
d - the initSize of the effect.
 o QTFilter
 public QTFilter(int isSingleFrame) throws QTException
Creates a QTFilter of specified frame setting and an initialSize of 0, 0.

Parameters:
multiFrameFlag - 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.
 o QTFilter
 public QTFilter(int isSingleFrame,
                 Dimension d) throws QTException
Creates a QTFilter of specified frame setting and initSize.

Parameters:
multiFrameFlag - 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.
d - the initSize of the effect.

Methods

 o setEffect
 public void setEffect(AtomContainer effectParams) throws QTException
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.

Parameters:
effectParams - the parameters that determine the effect that is run
Overrides:
setEffect in class QTEffect
 o getInitialSize
 public Dimension getInitialSize() throws QTException
This method returns the original size before the transformations specified in the returned matrix are applied. If the original size was not specified in the Constructor then the original size of the current sourceImage is returned. If the original size was specified then it is returned.

Returns:
a Dimension
Overrides:
getInitialSize in class QTEffect
 o setSourceImage
 public void setSourceImage(ImageSpec image) throws QTException
This sets the QT source of the QTFilter, which is the image that the current filter will be applied to when doEffect is called.

Parameters:
image - the image to use as the source of the filter
 o getSourceImage
 public ImageSpec getSourceImage()
Returns the currently set source image of the QTFilter

 o setUpSequence
 protected synchronized boolean setUpSequence() throws QTException
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.

Returns:
true if a new DSequence was created, otherwise false.
Overrides:
setUpSequence in class QTEffect

All Packages  Class Hierarchy  This Package  Previous  Next  Index