quicktime.app.image
Class QTTransition

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

All Implemented Interfaces:

Drawable, Listener, QTDrawable, Redrawable, Transformable

Deprecated. since QTJava 6.1

public class QTTransition

extends QTFilter

QTTransistions are visual effects that are applied to a two images, transitioning from the source image to the destination image. Upon completion of the transition the source and destination images are swapped, so you can also transition back to the original source image or set a new desintation image.

The QTTransition can run in two modes - in time mode the doTransition method will run the effect in as close as time as possible to the time specified. In frames mode the effect will be run for the number of frames that are specified.

The doTransition method is provided as a means of running the transition according to the time or frames setting. The transition will run as effectively as possible from start to finish - it is a call that blocks the thread of execution that made this call whilst the transition is running.

If a transition should be run with more application control then the application can control the setting of the current frame of the transition and call redraw after setting each frame. The redraw method will redraw the current frame of the transition.

Field Summary

Fields inherited from interface quicktime.app.image.Redrawable

kMultiFrame, kSingleFrame

Constructor Summary

QTTransition()
Deprecated. since QTJava 6.1

QTTransition(java.awt.Dimension d)
Deprecated. since QTJava 4.0

QTTransition(QDDimension d)
Deprecated. since QTJava 6.1

Method Summary

void	doTime(boolean flag) Deprecated. since QTJava 6.1
void	doTransition() Deprecated. since QTJava 6.1
ImageSpec	getDestinationImage() Deprecated. Returns the current destination image * @deprecated since QTJava 6.1
int	getFramesPerSecond() Deprecated. since QTJava 6.1
int	getTime() Deprecated. since QTJava 6.1
boolean	isProfiled() Deprecated. since QTJava 6.1
boolean	isTime() Deprecated. since QTJava 6.1
int	profileDuration() Deprecated. since QTJava 6.1
int	profileFramesRendered() Deprecated. since QTJava 6.1
void	setCurrentFrame(int frame) Deprecated. since QTJava 6.1
void	setDestinationImage(ImageSpec image) Deprecated. Sets the destination image of the Transition - the image that the transition will transition to.
void	setEffect(AtomContainer effectParams) Deprecated. since QTJava 6.1
void	setFrames(int frames) Deprecated. Sets the maximum number of frames that an effect can run for.* @deprecated since QTJava 6.1
void	setFramesPerSecond(int frames) Deprecated. since QTJava 6.1
void	setProfiled(boolean flag) Deprecated. since QTJava 6.1
void	setTime(int time) Deprecated. since QTJava 6.1
protected boolean	setUpSequence() Deprecated. since QTJava 6.1
void	swapImages() Deprecated. since QTJava 6.1

Methods inherited from class quicktime.app.image.QTFilter

getOriginalSize, getSourceImage, setSourceImage

Methods inherited from class quicktime.app.image.QTEffect

addedTo, checkForEffect, getClip, getCurrentFrame, getDescription, getDisplayBounds, getDSequence, getEffect, getFrames, getGraphicsMode, getGWorld, getImage, getInitialSize, getMatrix, isRedrawing, isSingleFrame, redraw, removedFrom, setClip, setDisplayBounds, setGraphicsMode, setGWorld, setLocation, setMatrix, setRedrawing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QTTransition

public QTTransition()
             throws QTException

Deprecated. since QTJava 6.1

Creates a QTTransition with default settings of a time-specified duration of 2000 msecs, an effect fps of 20, a redraw setting as kMultiFrame and an initialSize of 0, 0.

QTTransition

public QTTransition(java.awt.Dimension d)
             throws QTException

Deprecated. since QTJava 4.0

Creates a QTTransition with default settings of a time-specified duration of 2000 msecs, an effect fps of 20, a redraw setting as kMultiFrame and the specified initialSize.

QTTransition

public QTTransition(QDDimension d)
             throws QTException

Deprecated. since QTJava 6.1

Creates a QTTransition with default settings of a time-specified duration of 2000 msecs, an effect fps of 20, a redraw setting as kMultiFrame and the specified initialSize.

Method Detail

setEffect

public void setEffect(AtomContainer effectParams)
               throws QTException

Deprecated. since QTJava 6.1

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.

Overrides:

setEffect in class QTFilter

Parameters:

effectParams - the parameters that determine the effect that is run

QTException

setDestinationImage

public void setDestinationImage(ImageSpec image)
                         throws QTException

Deprecated.

Sets the destination image of the Transition - the image that the transition will transition to. * @deprecated since QTJava 6.1

QTException

getDestinationImage

public ImageSpec getDestinationImage()

Deprecated.

Returns the current destination image * @deprecated since QTJava 6.1

setUpSequence

protected boolean setUpSequence()
                         throws QTException

Deprecated. since QTJava 6.1

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.

Overrides:

setUpSequence in class QTFilter

Returns:

true if a new DSequence was created, otherwise false.

QTException

doTransition

public void doTransition()
                  throws QTException

Deprecated. since QTJava 6.1

This will run the currently selected effect on the visual rectangle that is defined by the display bounds of this object. After the effect is run the destination image of the transition is now the visible image in the effect's display space

QTException

swapImages

public void swapImages()
                throws QTException

Deprecated. since QTJava 6.1

This swaps the source and destination images.

QTException

setFrames

public void setFrames(int frames)
               throws QTException

Deprecated.

Sets the maximum number of frames that an effect can run for.* @deprecated since QTJava 6.1

QTException

setFramesPerSecond

public void setFramesPerSecond(int frames)
                        throws QTException

Deprecated. since QTJava 6.1

Sets the maximum frames per second that the effect will attempt to render

QTException

getFramesPerSecond

public int getFramesPerSecond()

Deprecated. since QTJava 6.1

Returns the current frames per second that the effect draws in if the effect is rendered using the time constraint

Returns:

the fps of the effect

setCurrentFrame

public void setCurrentFrame(int frame)

Deprecated. since QTJava 6.1

This sets the current frame of the effect. A value of zero means to draw the source image of the transition.

Parameters:

frame - the frame to be rendered

setTime

public void setTime(int time)
             throws QTException

Deprecated. since QTJava 6.1

Sets the duration of the effect when it is run if the effect is run in time mode

Parameters:

time - the time in milliseconds for the effect to run for in time mode

QTException

getTime

public int getTime()

Deprecated. since QTJava 6.1

Returns the time that an effect will run for in milliseconds

Returns:

milliseconds

doTime

public void doTime(boolean flag)

Deprecated. since QTJava 6.1

If true then the effect will run in the time alloted. If false then the effect will run for the specified frames.

Parameters:

flag - a boolean

isTime

public boolean isTime()

Deprecated. since QTJava 6.1

Returns true if the effect is running for a specified duration or false if the effect is running for a specified number of frames

Returns:

true if the doEffect method runs the effect in time mode, false if in frame mode.

setProfiled

public void setProfiled(boolean flag)

Deprecated. since QTJava 6.1

Set this to true if you wish to profile the actual running of the effect, or false to not collect. Once profiling your application can determine the amount of time it took to render a transition and how many frames were actually rendered. These values are generated and reset from each call of the doTransition() method.

Parameters:

flag - if true will profile

isProfiled

public boolean isProfiled()

Deprecated. since QTJava 6.1

Returns the current profiling status.

Returns:

a boolean indicating the profiling status of the transition

profileFramesRendered

public int profileFramesRendered()

Deprecated. since QTJava 6.1

If profiling this returns the number of frames that were rendered in the last time that the doTransition() method was called. If profiling is disabled this method returns 0.

Returns:

an int

profileDuration

public int profileDuration()

Deprecated. since QTJava 6.1

If profiling this returns the total time it took to run the doTransition method. If profiling is disabled this method returns 0.

Returns:

an int