Path Class Reference

List of all members.

Public Member Functions

 Path (const Coordinate &from, const Coordinate &to)
 ~Path ()
const CoordinategetFrom () const
const CoordinategetTo () const
void setFrom (const Coordinate &from)
void setTo (const Coordinate &to)
long length () const
const Coordinatedirection () const
std::vector< Coordinateroute () const


Detailed Description

Definition at line 32 of file Path.h.


Constructor & Destructor Documentation

Path::Path ( const Coordinate from,
const Coordinate to 
)

Constructor

Parameters:
from Starting point
to Destination

Path::~Path (  )  [inline]

Destructor

Definition at line 45 of file Path.h.


Member Function Documentation

const Coordinate& Path::getFrom (  )  const

Getter

Returns:
Returns our start point

const Coordinate& Path::getTo (  )  const

Getter

Returns:
Returns our destination

void Path::setFrom ( const Coordinate from  ) 

Setter

Parameters:
from Sets our start point

void Path::setTo ( const Coordinate to  ) 

Setter

Parameters:
to Sets our destination

long Path::length (  )  const

Gets the length of the largest component since all other components can be combined into the largest

Returns:
The largest component

const Coordinate& Path::direction (  )  const

The direction one should travel in from 'from' to reach 'to'

Returns:
Unit coord for approx direction

std::vector<Coordinate> Path::route (  )  const

Retreives the exact path between From to To.

Returns:
Set of exact directions


Generated for UnsignedByte by  doxygen 1.5.3
SourceForge.net Logo