org.openimaj.vis.timeline

Interface TimelineObject

All Superinterfaces:

VisualisationImageProvider

All Known Implementing Classes:

AudioOverviewVisualisation, ShotBoundaryVideoBarVisualisation, TimelineObjectAdapter, VideoBarVisualisation, VideoObjectVisualisation

public interface TimelineObject
extends VisualisationImageProvider

An object that can be drawn into a timeline needs to be able to provide the start and end time of its data, and also be able to accept a size at which it should draw itself. The object should draw itself in the given image size with the start and end times fitting in the image exactly. This allows the Timeline visualisation to scale the object as necessary and allow it to align with the time ruler.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

19 Jun 2013

Method Summary

Modifier and Type	Method and Description
long	getEndTimeMilliseconds() Returns the end time of the timeline object in the timeline.
Dimension	getPreferredSize() The timeline object needs to be able to suggest a size, if it needs a particular amount.
Dimension	getRequiredSize() Returns the size that this object wishes to be.
long	getStartTimeMilliseconds() Returns the start time of the timeline object in the timeline.
void	setDataPixelTransformer(DataUnitsTransformer<Float[],double[],int[]> dpt) The timeline object will need to know how to convert between time and pixels, and the DataUnitsTransformer given here should be able to do that.
void	setStartTimeMilliseconds(long l) Set the start time of this object

Methods inherited from interface org.openimaj.vis.VisualisationImageProvider

getVisualisationImage, setRequiredSize, updateVis

Method Detail

setDataPixelTransformer

void setDataPixelTransformer(DataUnitsTransformer<Float[],double[],int[]> dpt)

The timeline object will need to know how to convert between time and pixels, and the DataUnitsTransformer given here should be able to do that. Use it to paint the image.

Parameters:

dpt -

getStartTimeMilliseconds

long getStartTimeMilliseconds()

Returns the start time of the timeline object in the timeline.

Returns:

The start time

setStartTimeMilliseconds

void setStartTimeMilliseconds(long l)

Set the start time of this object

Parameters:

l - The start time in milliseconds

getEndTimeMilliseconds

long getEndTimeMilliseconds()

Returns the end time of the timeline object in the timeline.

Returns:

The end time.

getPreferredSize

Dimension getPreferredSize()

The timeline object needs to be able to suggest a size, if it needs a particular amount. It's not guaranteed it will get this size, but it may ask for it by implementing this method.

Returns:

A Dimension

getRequiredSize

Dimension getRequiredSize()

Returns the size that this object wishes to be.

Returns:

The size the object wishes to be.