Waypoint Class Reference

#include <TerrainLogic.h>

Inherits MemoryPoolObject.

Public Types
enum	{ MAX_LINKS =8 }

Public Member Functions
	Waypoint (WaypointID id, AsciiString name, const Coord3D *pLoc, AsciiString label1, AsciiString label2, AsciiString label3, Bool biDirectional)
void	setNext (Waypoint *pNext)
void	addLink (Waypoint *pLink)
Waypoint *	getNext (void) const
	Enumerate all waypoints using getNext.
Int	getNumLinks (void) const
	Enumerate the directed links from a waypoint using this,a nd getLink.
Waypoint *	getLink (Int ndx) const
	Get the n'th directed link. (May be NULL).
AsciiString	getName (void) const
	Get the waypoint's name.
WaypointID	getID (void) const
	Get the integer id.
const Coord3D *	getLocation (void) const
	Get the waypoint's position.
AsciiString	getPathLabel1 (void) const
	Get the waypoint's first path label.
AsciiString	getPathLabel2 (void) const
	Get the waypoint's second path label.
AsciiString	getPathLabel3 (void) const
	Get the waypoint's third path label.
Bool	getBiDirectional (void) const
	Get bi-directionality.
void	setLocationZ (Real z)
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Protected Attributes
WaypointID	m_id
	Unique integer identifier.
AsciiString	m_name
	Name.
Coord3D	m_location
	Location.
Waypoint *	m_pNext
	Linked list of all waypoints.
Waypoint *	m_links [MAX_LINKS]
	Directed graph of waypoints.
Int	m_numLinks
	Number of links in m_links.
AsciiString	m_pathLabel1
AsciiString	m_pathLabel2
AsciiString	m_pathLabel3
Bool	m_biDirectional

Additional Inherited Members
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Detailed Description

Helper class for waypoint info in terrain logic.

Definition at line 64 of file TerrainLogic.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MAX_LINKS

Definition at line 74 of file TerrainLogic.h.

Constructor & Destructor Documentation

Waypoint()

Waypoint::Waypoint	(	WaypointID	id,
		AsciiString	name,
		const Coord3D *	pLoc,
		AsciiString	label1,
		AsciiString	label2,
		AsciiString	label3,
		Bool	biDirectional )

Definition at line 78 of file TerrainLogic.cpp.

Member Function Documentation

addLink()

void Waypoint::addLink ( Waypoint * pLink )

inline

Definition at line 95 of file TerrainLogic.h.

getBiDirectional()

Bool Waypoint::getBiDirectional ( void ) const

inline

Get bi-directionality.

Definition at line 124 of file TerrainLogic.h.

getID()

WaypointID Waypoint::getID ( void ) const

inline

Get the integer id.

Definition at line 114 of file TerrainLogic.h.

getLink()

Waypoint * Waypoint::getLink ( Int ndx ) const

inline

Get the n'th directed link. (May be NULL).

Definition at line 110 of file TerrainLogic.h.

getLocation()

const Coord3D * Waypoint::getLocation ( void ) const

inline

Get the waypoint's position.

Definition at line 116 of file TerrainLogic.h.

getName()

AsciiString Waypoint::getName ( void ) const

inline

Get the waypoint's name.

Definition at line 112 of file TerrainLogic.h.

getNext()

Waypoint * Waypoint::getNext ( void ) const

inline

Enumerate all waypoints using getNext.

Definition at line 106 of file TerrainLogic.h.

getNumLinks()

Int Waypoint::getNumLinks ( void ) const

inline

Enumerate the directed links from a waypoint using this,a nd getLink.

Definition at line 108 of file TerrainLogic.h.

getPathLabel1()

AsciiString Waypoint::getPathLabel1 ( void ) const

inline

Get the waypoint's first path label.

Definition at line 118 of file TerrainLogic.h.

getPathLabel2()

AsciiString Waypoint::getPathLabel2 ( void ) const

inline

Get the waypoint's second path label.

Definition at line 120 of file TerrainLogic.h.

getPathLabel3()

AsciiString Waypoint::getPathLabel3 ( void ) const

inline

Get the waypoint's third path label.

Definition at line 122 of file TerrainLogic.h.

setLocationZ()

void Waypoint::setLocationZ ( Real z )

inline

Definition at line 126 of file TerrainLogic.h.

setNext()

void Waypoint::setNext ( Waypoint * pNext )

inline

Definition at line 90 of file TerrainLogic.h.

Member Data Documentation

m_biDirectional

Bool Waypoint::m_biDirectional

protected

Definition at line 86 of file TerrainLogic.h.

m_id

WaypointID Waypoint::m_id

protected

Unique integer identifier.

Definition at line 77 of file TerrainLogic.h.

m_links

Waypoint* Waypoint::m_links[MAX_LINKS]

protected

Directed graph of waypoints.

Definition at line 81 of file TerrainLogic.h.

m_location

Coord3D Waypoint::m_location

protected

Location.

Definition at line 79 of file TerrainLogic.h.

m_name

AsciiString Waypoint::m_name

protected

Name.

Definition at line 78 of file TerrainLogic.h.

m_numLinks

Int Waypoint::m_numLinks

protected

Number of links in m_links.

Definition at line 82 of file TerrainLogic.h.

m_pathLabel1

AsciiString Waypoint::m_pathLabel1

protected

Definition at line 83 of file TerrainLogic.h.

m_pathLabel2

AsciiString Waypoint::m_pathLabel2

protected

Definition at line 84 of file TerrainLogic.h.

m_pathLabel3

AsciiString Waypoint::m_pathLabel3

protected

Definition at line 85 of file TerrainLogic.h.

m_pNext

Waypoint* Waypoint::m_pNext

protected

Linked list of all waypoints.

Definition at line 80 of file TerrainLogic.h.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/GameLogic/TerrainLogic.h
• Code/GameEngine/Source/GameLogic/Map/TerrainLogic.cpp