Package org.opensourcephysics.media.core

Interface DataTrack

All Superinterfaces:

Drawable, Trackable

public interface DataTrack
extends Trackable

An interface for a Trackable object that gets its position (and optional time) data from an external source. Since it is drawn on a TrackerPanel, DataTrack includes methods related to the associated Video (start frame) and VideoPanel as well as the Data (DataClip, source, time, etc).

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)	Adds a PropertyChangeListener.
Data	getData()	Gets the Data.
DataClip	getDataClip()	Gets the DataClip, which defines the start index, stepcount and stride.
double	getFrameDuration()	Gets the data-based video frame duration in seconds if available
java.lang.Object	getSource()	Gets the source.
int	getStartFrame()	Gets the video start frame at which the first data point is displayed.
VideoPanel	getVideoPanel()	Gets the VideoPanel on which this DataTrack is drawn.
double	getVideoStartTime()	Gets the data-based video start time in seconds if available
boolean	isTimeDataAvailable()	Determines if time is defined by the Data.
void	setData(Data data, java.lang.Object source)	Sets the Data for the track.
void	setStartFrame(int start)	Sets the video start frame at which the first data point is displayed.

Methods inherited from interface org.opensourcephysics.display.Drawable

draw

Method Detail

setStartFrame

void setStartFrame(int start)

Sets the video start frame at which the first data point is displayed.

Parameters:

start - the start frame number

getStartFrame

int getStartFrame()

Gets the video start frame at which the first data point is displayed.

Returns:

the start frame number

setData

void setData(Data data,
             java.lang.Object source)
      throws java.lang.Exception

Sets the Data for the track. Data must define "x" and "y" positions, and may define "t". Optional source may be a JPanel control panel.

Parameters:

data - the Data

source - a source object (may be null)

Throws:

java.lang.Exception

getData

Data getData()

Gets the Data.

Returns:

the Data

getSource

java.lang.Object getSource()

Gets the source.

Returns:

the source (may be null)

getDataClip

DataClip getDataClip()

Gets the DataClip, which defines the start index, stepcount and stride.

Returns:

the DataClip

getVideoPanel

VideoPanel getVideoPanel()

Gets the VideoPanel on which this DataTrack is drawn.

Returns:

the VideoPanel

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Adds a PropertyChangeListener.

Parameters:

listener - the PropertyChangeListener

isTimeDataAvailable

boolean isTimeDataAvailable()

Determines if time is defined by the Data.

Returns:

true if time data is available

getVideoStartTime

double getVideoStartTime()

Gets the data-based video start time in seconds if available

Returns:

the start time, or Double.NaN if undefined

getFrameDuration

double getFrameDuration()

Gets the data-based video frame duration in seconds if available

Returns:

the frame duration, or Double.NaN if undefined