jfreerails.world.train
Interface PathWalker

All Superinterfaces:
FreerailsMutableSerializable, FreerailsPathIterator, java.io.Serializable
All Known Implementing Classes:
PathWalkerImpl

public interface PathWalker
extends FreerailsPathIterator, FreerailsMutableSerializable

This interface lets the caller retrieve a path broken into a series of steps, whose length the caller specifies. E.g. it could be used to get the sub section of a path that a train travels during an given time inteval.

Author:
Luke

Method Summary
 boolean canStepForward()
          Returns true if we have not reached the end of the path.
 void stepForward(double distance)
          Moves this path walker forward by the specified distance along the path and returns a path iterator to retrieve the section of the path travelled during this move.
 
Methods inherited from interface jfreerails.world.common.FreerailsPathIterator
hasNext, nextSegment
 

Method Detail

canStepForward

boolean canStepForward()
Returns true if we have not reached the end of the path.


stepForward

void stepForward(double distance)
Moves this path walker forward by the specified distance along the path and returns a path iterator to retrieve the section of the path travelled during this move.