Class FrameSequence

java.lang.Object
  FrameSequence

public class FrameSequence

extends java.lang.Object

Class to save frames in a movie to a directory. This class tracks the directory, base file name, current frame number, and whether this sequence is being shown. Copyright Georgia Institute of Technology 2004

Author:

Barbara Ericson

Constructor Summary

FrameSequence(java.lang.String directory)
Constructor that takes a directory name

FrameSequence(java.lang.String directory, java.lang.String baseName)
Constructor that takes a directory name and a base file name

Method Summary

void	addFrame(Picture picture) Method to add a picture to the frame sequence
java.lang.String	getBaseName() Method to get the base name
java.lang.String	getDirectory() Method to get the directory to write the frames to
int	getFrameNumber() Method to get the frame number
int	getNumFrames() Method to get the number of frames in this sequence
PictureFrame	getPictureFrame() Method to get the picture frame to use to show this sequence
boolean	isShown() Method to check if the frame sequence is being shown
void	replay(int sleepTime) Method to replay the frames (pictures) added so far
void	setBaseName(java.lang.String name) Method to set the base name
void	setDirectory(java.lang.String dir) Method to set the directory to write the frames to
void	setPictureFrame(PictureFrame frame) Method to set the picture frame to use to shown this
void	setShown(boolean value) Method to set the shown flag
void	show() Method to show the frame sequence

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameSequence

public FrameSequence(java.lang.String directory)

Constructor that takes a directory name

Parameters:

directory - the directory to save the frames to

FrameSequence

public FrameSequence(java.lang.String directory,
                     java.lang.String baseName)

Constructor that takes a directory name and a base file name

Parameters:

directory - the directory to save the frames to

baseName - the base file name to use for the frames

Method Detail

getDirectory

public java.lang.String getDirectory()

Method to get the directory to write the frames to

Returns:

the directory to write the frames to

setDirectory

public void setDirectory(java.lang.String dir)

Method to set the directory to write the frames to

Parameters:

dir - the directory to use

getBaseName

public java.lang.String getBaseName()

Method to get the base name

Returns:

the base file name for the movie frames

setBaseName

public void setBaseName(java.lang.String name)

Method to set the base name

Parameters:

name - the new base name to use

getFrameNumber

public int getFrameNumber()

Method to get the frame number

Returns:

the next frame number for the next picture added

isShown

public boolean isShown()

Method to check if the frame sequence is being shown

Returns:

true if shown and false otherwise

setShown

public void setShown(boolean value)

Method to set the shown flag

Parameters:

value - the value to use

getNumFrames

public int getNumFrames()

Method to get the number of frames in this sequence

Returns:

the number of frames

setPictureFrame

public void setPictureFrame(PictureFrame frame)

Method to set the picture frame to use to shown this

Parameters:

frame - the picture frame to use

getPictureFrame

public PictureFrame getPictureFrame()

Method to get the picture frame to use to show this sequence

Returns:

the picture frame used to show this (may be null)

addFrame

public void addFrame(Picture picture)

Method to add a picture to the frame sequence

Parameters:

picture - the picture to add

show

public void show()

Method to show the frame sequence

replay

public void replay(int sleepTime)

Method to replay the frames (pictures) added so far

Parameters:

sleepTime - the amount to sleep in milliseconds between frames