movements
Class HandMovement

java.lang.Object
  movements.HandMovement

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

HandMovementFixed, HandMovementInStraightLine, HandMovementInTransition, HandMovementWhileHolding

abstract class HandMovement

extends java.lang.Object

implements java.io.Serializable

This defines a movement for a hand. Classes are derived from this for the various types of hand movements. - hand held in a unit - hand held outside a unit - hand extending to or retracting from a hand hold

Hand Movements do not have to be contiguous. Each hand movement contains both the point of time at which the hand movement starts and the length of time over which the hand movement occurs. Any gaps in the hand movement are periods in which the hand is withdrawn (no hands are taken and the hand is not in the process of reaching out to a hand hold or retracting from a hand hold or moving from one hand hold to another).

Field Summary

protected int	startTick
protected int	tickLength

Constructor Summary

(package private)

HandMovement(int startTick, int tickLength) Creates a new HandMovement object.

Method Summary

(package private) int	getEndTick() DOCUMENT ME!
(package private) abstract void	getPosition(Position position, int ticksIntoMovement) Given the number of ticks into this movement, return the position where the hand is located at that time.
(package private) int	getStartTick() DOCUMENT ME!
(package private) int	getTickLength() DOCUMENT ME!
(package private) void	Trace(java.lang.String indent) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

startTick

protected int startTick

tickLength

protected int tickLength

Constructor Detail

HandMovement

HandMovement(int startTick,
             int tickLength)

Creates a new HandMovement object.

Parameters:

startTick - DOCUMENT ME!

tickLength - DOCUMENT ME!

Method Detail

getStartTick

int getStartTick()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getEndTick

int getEndTick()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getTickLength

int getTickLength()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getPosition

abstract void getPosition(Position position,
                          int ticksIntoMovement)

Given the number of ticks into this movement, return the position where the hand is located at that time.

Parameters:

position - This is a return parameter and is set to the position where the hand is located.

ticksIntoMovement - This parameter must be greater than or equal to zero and less than or equal to the number of ticks in this hand movement (the value passed in the 'ticks' parameter to the constructor).

Trace

void Trace(java.lang.String indent)

DOCUMENT ME!

Parameters:

indent - DOCUMENT ME!