movements
Class DanceData

java.lang.Object
  extended bymovements.DanceData
All Implemented Interfaces:
java.io.Serializable

public class DanceData
extends java.lang.Object
implements java.io.Serializable

DOCUMENT ME!

Version:
$Revision: 1.2 $
Author:
$author$
See Also:
Serialized Form

Method Summary
 double getDirection(int personIndex, int tick)
          DOCUMENT ME!
 double getHandPositionAcross(int personIndex, int handIndex, int tick)
          DOCUMENT ME!
 double getHandPositionDown(int personIndex, int handIndex, int tick)
          DOCUMENT ME!
 java.lang.String getName(int personIndex)
          Get the name of a person.
 int getNumberOfParticipants()
          DOCUMENT ME!
 long getNumberOfTicksInDance()
          DOCUMENT ME!
 double getPositionAcross(int personIndex, int tick)
          DOCUMENT ME!
 double getPositionDown(int personIndex, int tick)
          DOCUMENT ME!
 int getTicksPerBar()
          DOCUMENT ME!
 void playNote(int tick)
          If a note starts on the given tick then this method will play the note.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getTicksPerBar

public int getTicksPerBar()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getName

public java.lang.String getName(int personIndex)
Get the name of a person.

Parameters:
personIndex - The index of the person, where the first person has an index of zero.
Returns:
The name of the person as given in the XML specification.

getPositionDown

public double getPositionDown(int personIndex,
                              int tick)
DOCUMENT ME!

Parameters:
personIndex - DOCUMENT ME!
tick - DOCUMENT ME!
Returns:
DOCUMENT ME!

getPositionAcross

public double getPositionAcross(int personIndex,
                                int tick)
DOCUMENT ME!

Parameters:
personIndex - DOCUMENT ME!
tick - DOCUMENT ME!
Returns:
DOCUMENT ME!

getDirection

public double getDirection(int personIndex,
                           int tick)
DOCUMENT ME!

Parameters:
personIndex - DOCUMENT ME!
tick - DOCUMENT ME!
Returns:
DOCUMENT ME!

getHandPositionDown

public double getHandPositionDown(int personIndex,
                                  int handIndex,
                                  int tick)
DOCUMENT ME!

Parameters:
personIndex - DOCUMENT ME!
handIndex - DOCUMENT ME!
tick - DOCUMENT ME!
Returns:
DOCUMENT ME!

getHandPositionAcross

public double getHandPositionAcross(int personIndex,
                                    int handIndex,
                                    int tick)
DOCUMENT ME!

Parameters:
personIndex - DOCUMENT ME!
handIndex - DOCUMENT ME!
tick - DOCUMENT ME!
Returns:
DOCUMENT ME!

getNumberOfParticipants

public int getNumberOfParticipants()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getNumberOfTicksInDance

public long getNumberOfTicksInDance()
DOCUMENT ME!

Returns:
DOCUMENT ME!

playNote

public void playNote(int tick)
If a note starts on the given tick then this method will play the note. If no note starts on the given tick then this method does nothing.

Parameters:
tick - DOCUMENT ME!


Copyright © 2003 Nigel Westbury