|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--quicktime.app.image.QTEffect
QTEffect forms the base class for visual effects that can be applied to images. Depending on the effect itself, visual effects can be applied over a length of time, or once only. They can be applied to no source images, a single image or multiple images.
The QTEffect class itself forms a base class that given a rectangular region will apply some visual effect (like fire/ripples). to its destination graphics. There are two subclasses - QTFilter which is an effect that is applied to a single source image and QTTransition which is an effect that is applied to two images, transitioning from the source image to the destination image.
Fields inherited from interface quicktime.app.image.Redrawable |
kMultiFrame, kSingleFrame |
Constructor Summary | |
QTEffect()
Creates a QTEffect with kMultiFrame set with a default initial size of 0, 0. |
|
QTEffect(java.awt.Dimension d)
Deprecated. since QTJava 4.0 |
|
QTEffect(int multiFrameFlag)
Creates a QTEffect with kMultiFrame set with a default initial size of 0, 0. |
|
QTEffect(int multiFrameFlag,
java.awt.Dimension d)
Deprecated. since QTJava 4.0 |
|
QTEffect(int multiFrameFlag,
QDDimension d)
Creates a QTEffect. |
Method Summary | |
void |
addedTo(java.lang.Object interest)
This method is called by the specified object when the instance of the class that implements this interface is added to the object that is the source of the interest. |
void |
checkForEffect(int effectType)
This will make sure the component (effect) is there and can set its parameter list for display. |
Region |
getClip()
Returns the current clipping region of the effect or null if the effect is not clipped |
int |
getCurrentFrame()
This returns the current frame that the effect is rendering. |
ImageDescription |
getDescription()
This method should return an ImageDescription that describes the image data that the class contains. |
QDRect |
getDisplayBounds()
QTCanvas calls this method when it needs to ask the client for its boundary. |
DSequence |
getDSequence()
Returns the DSequence that is used by the QTEffect. |
AtomContainer |
getEffect()
This will return a copy of the AtomContainer that contains the current effect settings. |
int |
getFrames()
Returns the current maximum number of frames that an effect will run for |
GraphicsMode |
getGraphicsMode()
This gets the current GraphicsMode for the QTEffect. |
QDGraphics |
getGWorld()
QTCanvas calls this method to get the destination QDGraphics of its client. |
EncodedImage |
getImage()
This method returns the actual image data - in this case the effect's atom container. |
java.awt.Dimension |
getInitialSize()
Deprecated. since QTJava 4.0 |
Matrix |
getMatrix()
This will return the client's current display transformations |
QDDimension |
getOriginalSize()
This method returns the original size before the transformations specified in the returned matrix are applied. |
boolean |
isRedrawing()
Returns the state of the redraw flag |
boolean |
isSingleFrame()
Returns true if the Redrawable only has a single frame to render and thus will never need to re-acquire or redraw its image. |
void |
redraw(Region invalidRgn)
QTCanvas calls this method when the client should redraw itself. |
void |
removedFrom(java.lang.Object interest)
This method is called by the specified object when the instance of the class that implements this interface is removed from the object that is the source of the interest. |
void |
setClip(Region r)
This will set the clipping of the effect - it defines the region of the source image that the effect will be applied to. |
void |
setDisplayBounds(QDRect bounds)
QTCanvas calls this method when it needs to tell the client to adjust its location, width and/or height. |
void |
setEffect(AtomContainer effectParams)
This method will take the incoming parameters and use this as the control parameters for the effect. |
void |
setGraphicsMode(GraphicsMode mode)
This sets the GraphicsMode for the Compositor when it draws its composited contents to its destination QDGraphics (typically the QTCanvas). |
void |
setGWorld(QDGraphics cgp)
QTCanvas calls this method to give the client the QDGraphics object it should use to do its drawing. |
void |
setLocation(int x,
int y)
A convenience method to set the position of a QTDrawable object. |
void |
setMatrix(Matrix matrix)
This method sets the current matrix of the Transformable object to the new matrix. |
void |
setRedrawing(boolean redrawFlag)
If true then the current frame of the effect is drawn on redraw. |
protected boolean |
setUpSequence()
This method is called by a number of other methods to create the DSequence that is used to render the QTEffect. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public QTEffect() throws QTException
public QTEffect(java.awt.Dimension d) throws QTException
d
- the initialSize of the effect.public QTEffect(int multiFrameFlag) throws QTException
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.public QTEffect(int multiFrameFlag, java.awt.Dimension d) throws QTException
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 initialSize of the effect.()
public QTEffect(int multiFrameFlag, QDDimension d) throws QTException
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 initialSize of the effect.Method Detail |
public void setRedrawing(boolean redrawFlag)
setRedrawing
in interface Redrawable
redrawFlag
- boolean indicating redraw behaviourpublic boolean isRedrawing()
isRedrawing
in interface Redrawable
public boolean isSingleFrame()
isSingleFrame
in interface Redrawable
quicktime.app.image.Redrawable
public void setGraphicsMode(GraphicsMode mode) throws QTException
public GraphicsMode getGraphicsMode()
public void setClip(Region r) throws StdQTException
setClip
in interface QTDrawable
r
- the clipping regionpublic Region getClip()
getClip
in interface QTDrawable
quicktime.app.display.QTDrawable
public AtomContainer getEffect() throws StdQTException
public void setEffect(AtomContainer effectParams) throws QTException
effectParams
- the parameters that determine the effect that is runprotected boolean setUpSequence() throws QTException
public int getFrames()
public int getCurrentFrame()
public void checkForEffect(int effectType) throws QTException
effectType
- the effect type to check forpublic void addedTo(java.lang.Object interest)
addedTo
in interface Listener
interest
- the object that is to be the source of interest for the
the object that implements this interface.public void removedFrom(java.lang.Object interest)
removedFrom
in interface Listener
interest
- the object that was the source of interest for the
the object that implements this interface.public void setGWorld(QDGraphics cgp) throws QTException
setGWorld
in interface QTDrawable
cgp
- a QDGraphics objectpublic QDGraphics getGWorld() throws QTException
getGWorld
in interface QTDrawable
public void setDisplayBounds(QDRect bounds) throws QTException
setDisplayBounds
in interface Drawable
bounds
- the new size and location.public void setLocation(int x, int y) throws QTException
setLocation
in interface QTDrawable
x
- the new x locationy
- the new y locationpublic QDRect getDisplayBounds() throws QTException
getDisplayBounds
in interface Drawable
public DSequence getDSequence()
public EncodedImage getImage()
public ImageDescription getDescription() throws QTException
public java.awt.Dimension getInitialSize() throws QTException
()
public QDDimension getOriginalSize() throws QTException
getOriginalSize
in interface Transformable
public Matrix getMatrix() throws QTException
getMatrix
in interface Transformable
public void setMatrix(Matrix matrix) throws QTException
setMatrix
in interface Transformable
public void redraw(Region invalidRgn) throws QTException
redraw
in interface Drawable
invalidRgn
- the invalidRgn that the client should redraw
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |