Package net.paulhertz.pixelaudio.schedule

Class TimedLocation

java.lang.Object

net.paulhertz.pixelaudio.schedule.TimedLocation

All Implemented Interfaces:

Comparable<TimedLocation>

Direct Known Subclasses:

WaveSynthSequencer.NoteTimedLocation

public class TimedLocation
extends Object
implements Comparable<TimedLocation>

Used to schedule or track events that take place at specific coordinate locations. Used in multiple example sketches.

Field Summary

Fields

Modifier and Type	Field	Description
private int	durationMs
private int	eventTime
private boolean	isStale
private int	x
private int	y

Constructor Summary

Constructors

Constructor	Description
TimedLocation(int x, int y, int eventTime)	Creates a timed location with no duration.
TimedLocation(int x, int y, int eventTime, int durationMs)	Creates a timed location with a duration.

Method Summary

Modifier and Type	Method	Description
int	compareTo(TimedLocation tl)
int	eventTime()
int	getDurationMs()
int	getX()
int	getY()
boolean	isStale()
void	setDurationMs(int durationMs)
void	setStale(boolean stale)

Methods inherited from class java.lang.Object

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

Field Details

x

private int x

y

private int y

eventTime

private int eventTime

isStale

private boolean isStale

durationMs

private int durationMs

Constructor Details

TimedLocation

public TimedLocation(int x,
 int y,
 int eventTime,
 int durationMs)

Creates a timed location with a duration.

Parameters:

x - x-coordinate

y - y-coordinate

eventTime - event time in milliseconds

durationMs - duration in milliseconds

TimedLocation

public TimedLocation(int x,
 int y,
 int eventTime)

Creates a timed location with no duration.

Parameters:

x - x-coordinate

y - y-coordinate

eventTime - event time in milliseconds

Method Details

getX

public int getX()

Returns:

x-coordinate

getY

public int getY()

Returns:

y-coordinate

eventTime

public int eventTime()

Returns:

event time in milliseconds

isStale

public boolean isStale()

Returns:

true when this location should be ignored by consumers

setStale

public void setStale(boolean stale)

Parameters:

stale - true to mark this location stale

getDurationMs

public int getDurationMs()

Returns:

duration in milliseconds

setDurationMs

public void setDurationMs(int durationMs)

Parameters:

durationMs - duration in milliseconds

compareTo

public int compareTo(TimedLocation tl)

Specified by:

compareTo in interface Comparable<TimedLocation>