All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.app.image.CompositableEffect 

java.lang.Object
   |
   +----quicktime.app.image.QTEffect
           |
           +----quicktime.app.image.CompositableEffect
public class CompositableEffect
extends QTEffect
implements DynamicImage, Redrawable
This class is used to directly add an effect to a SWCompositor. Only effects of zero source (such as fire, ripple) can be added directly. Filters and Transitions act on one or two sources and must be added to a SWCompositor using the QTEffectPresenter.

See Also:
QTEffectPresenter

Constructor Index

o CompositableEffect()
Creates a CompositableEffect.
o CompositableEffect(int)
Creates a CompositableEffect.

Method Index

o addedToCompositor(SWCompositor, TwoDSprite)
Returns an object that invalidates a sprite.
o removedFromCompositor(SWCompositor)
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.

Constructors

o CompositableEffect 
 public CompositableEffect() throws QTException
Creates a CompositableEffect.

o CompositableEffect 
 public CompositableEffect(int multiFrameFlag) throws QTException
Creates a CompositableEffect. The specified multiFrameFlag parameter should be set to Redrawable.kMultiFrame as all of the existing QTEffects require redrawing (and thus Invalidation) for their visual effect to be apparent.

Parameters:
multiFrameFlag - is normally set to kMultiFrame

Methods

o addedToCompositor 
 public Invalidator addedToCompositor(SWCompositor c,
                                      TwoDSprite s)
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).

The Invalidators provided with objects that implement the DynamicImage interface will execute at the scale and period of the Compositor when they are created.

Parameters:
c - the Compositor in which the DynamicImage is a member
s - the TwoDSprite that is presenting the DynamicImage's image in the Compositor. This is the sprite that must be invalidated.
Returns:
an Invalidator or null if invalidation is not required
See Also:
SWCompositor
o removedFromCompositor 
 public void removedFromCompositor(SWCompositor c)
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.

Parameters:
c - the SWCompositor it is being removed from 
All Packages  Class Hierarchy  This Package  Previous  Next  Index