Package org.opensourcephysics.media.gif

Class GifVideo

java.lang.Object

org.opensourcephysics.display.OSPRuntime.Supported

org.opensourcephysics.media.core.VideoAdapter

org.opensourcephysics.media.gif.GifVideo

All Implemented Interfaces:

PropertyChangeListener, EventListener, Drawable, Interactive, Measurable, DrawableImage, InteractiveImage, Trackable, Video

public class GifVideo
extends VideoAdapter

This is a video that wraps an animated gif image.

Version:

1.0

Author:

Douglas Brown

Field Summary

Fields

Modifier and Type	Field	Description
protected GifDecoder	decoder

Fields inherited from class org.opensourcephysics.media.core.VideoAdapter

aspects, baseDir, bufferedImage, clearRaster, coords, displayedSize, endFrameNumber, filteredImage, filterStack, frameCount, frameNumber, isMeasured, isValidFilteredImage, isValidImage, isValidMeasure, looping, maxX, maxY, minX, minY, mouseEnabled, playing, properties, rate, rawImage, size, startFrameNumber, startTimesMS, visible, widthDominates

Fields inherited from interface org.opensourcephysics.media.core.Trackable

PROPERTY_ADJUSTING

Fields inherited from interface org.opensourcephysics.media.core.Video

PROPERTY_VIDEO_COORDS, PROPERTY_VIDEO_ENDFRAME, PROPERTY_VIDEO_FILTERCHANGED, PROPERTY_VIDEO_FRAMENUMBER, PROPERTY_VIDEO_IMAGE, PROPERTY_VIDEO_LOOPING, PROPERTY_VIDEO_NEXTFRAME, PROPERTY_VIDEO_PLAYING, PROPERTY_VIDEO_RATE, PROPERTY_VIDEO_SIZE, PROPERTY_VIDEO_VIDEOVISIBLE

Constructor Summary

Constructors

Constructor	Description
GifVideo(String gifName)	Creates a GifVideo and loads a gif image specified by name

Method Summary

Modifier and Type	Method	Description
void	draw(DrawingPanel panel, Graphics g)	Draws the video image on the panel.
double	getEndTime()	Gets the end time in milliseconds.
double	getFrameCountDurationMS()	Gets the duration of the video.
static XML.ObjectLoader	getLoader()	Returns an XML.ObjectLoader to save and load GifVideo data.
String	getTypeName()	Returns the VideoType name of this video.
protected void	load(String gifName)	Loads a gif image specified by name.
void	play()	Plays the video at the current rate.
void	setFrameNumber(int n)	Overrides ImageVideo setFrameNumber method.
protected void	setStartTimes()
void	stop()	Stops the video.

Methods inherited from class org.opensourcephysics.media.core.VideoAdapter

back, dispose, finalize, findInteractive, findMinMaxValues, getAbsolutePath, getAngle, getCoords, getEndFrameNumber, getFilterStack, getFrameCount, getFrameDuration, getFrameNumber, getFrameTime, getHeight, getImage, getImageSize, getProperty, getPropertyNames, getRate, getRawBufferedImage, getRelativeAspect, getStartFrameNumber, getStartTime, getWidth, getX, getXMax, getXMin, getY, getYMax, getYMin, goToEnd, goToStart, initialize, invalidateVideoAndFilter, isEnabled, isLooping, isMeasured, isPlaying, isVisible, notifyFrame, notifySize, propertyChange, refreshBufferedImage, reset, setAngle, setCoords, setEnabled, setEndFrameNumber, setEndTime, setFilterStack, setFrameAngle, setFrameCount, setFrameHeight, setFrameRelativeAspect, setFrameWidth, setFrameX, setFrameXY, setFrameY, setHeight, setLooping, setNotify, setPlaying, setProperty, setRate, setRelativeAspect, setStartFrameNumber, setStartTime, setVisible, setWidth, setX, setXY, setY, step, updateBufferedImage

Methods inherited from class org.opensourcephysics.display.OSPRuntime.Supported

addListeners, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListenerSafely, dispose, firePropertyChange, firePropertyChange, removeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensourcephysics.display.Interactive

isInteractive

Methods inherited from interface org.opensourcephysics.media.core.Video

addListener, addPropertyChangeListener, addPropertyChangeListener, getAverageFrameDuration, getAverageFrameRate, getOutliers, isValid, removeListener, removePropertyChangeListener, removePropertyChangeListener

Field Details

decoder

protected GifDecoder decoder

Constructor Details

GifVideo

public GifVideo(String gifName)
         throws IOException

Creates a GifVideo and loads a gif image specified by name

Parameters:

gifName - the name of the image file

Throws:

IOException

Method Details

draw

public void draw(DrawingPanel panel,
 Graphics g)

Draws the video image on the panel.

Specified by:

draw in interface Drawable

Overrides:

draw in class VideoAdapter

Parameters:

panel - the drawing panel requesting the drawing

g - the graphics context on which to draw

play

public void play()

Plays the video at the current rate.

stop

public void stop()

Stops the video.

setFrameNumber

public void setFrameNumber(int n)

Overrides ImageVideo setFrameNumber method.

Specified by:

setFrameNumber in interface Video

Overrides:

setFrameNumber in class VideoAdapter

Parameters:

n - the desired frame number

See Also:

• Video.getStartFrameNumber()
• Video.getEndFrameNumber()

getEndTime

public double getEndTime()

Gets the end time in milliseconds.

Specified by:

getEndTime in interface Video

Overrides:

getEndTime in class VideoAdapter

Returns:

the end time in milliseconds, or -1 if not known

getFrameCountDurationMS

public double getFrameCountDurationMS()

Gets the duration of the video.

Returns:

the duration of the video in milliseconds, or -1 if not known

load

protected void load(String gifName)
             throws IOException

Loads a gif image specified by name.

Parameters:

gifName - the gif image name

Throws:

IOException

setStartTimes

protected void setStartTimes()

Specified by:

setStartTimes in class VideoAdapter

getLoader

public static XML.ObjectLoader getLoader()

Returns an XML.ObjectLoader to save and load GifVideo data.

Returns:

the object loader

getTypeName

public String getTypeName()

Description copied from interface: Video

Returns the VideoType name of this video.