psPathPoint Class Reference

Represents a point on a path between two waypoints. More...

#include <pspath.h>

List of all members.

Public Member Functions
bool	Adjust (iDataConnection *db, csVector3 &pos, csString sector)
	Adjust the point position.
void	Adjust (csVector3 &pos, iSector *sector)
	Adjust the point position.
void	Adjust (csVector3 &pos, csString sector)
	Adjust the point position.
bool	Create (iDataConnection *db, int pathID)
	Establish this path point in the db.
uint32_t	GetEffectID (iEffectIDAllocator *allocator)
	Return the effect ID for this pathpoint or assign a new ID.
int	GetID ()
	Return the db id of the point.
int	GetID () const
csString	GetName ()
	Return the name of this path point.
psPath *	GetPath () const
	Return the parent path for this path point.
int	GetPathIndex () const
	Return the index of this point in the path.
const csVector3 &	GetPosition () const
int	GetPreviousPointId () const
	Get the previous point id.
float	GetRadius ()
float	GetRadius () const
iSector *	GetSector (iEngine *engine)
iSector *	GetSector (iEngine *engine) const
Waypoint *	GetWaypoint ()
bool	Load (iResultRow &row, iEngine *engine)
	Load the point from the db row.
	psPathPoint (psPath *parentPath)
bool	Remove (iDataConnection *db)
	Remove this path point in the db.
void	SetID (int id)
void	SetPrevious (int previous)
	Set the previous point id.
void	SetWaypoint (Waypoint *waypoint)
bool	UpdatePrevPointId (iDataConnection *db, int prevPointId)
	Update this path point in the db.

---

Detailed Description

Represents a point on a path between two waypoints.

Definition at line 58 of file pspath.h.

---

Constructor & Destructor Documentation

psPathPoint::psPathPoint

(

psPath *

parentPath

)

---

Member Function Documentation

bool psPathPoint::Adjust	(	iDataConnection *	db,
		csVector3 &	pos,
		csString	sector
	)

Adjust the point position.

void psPathPoint::Adjust	(	csVector3 &	pos,
		csString	sector
	)

Adjust the point position.

void psPathPoint::Adjust	(	csVector3 &	pos,
		iSector *	sector
	)

Adjust the point position.

bool psPathPoint::Create	(	iDataConnection *	db,
		int	pathID
	)

Establish this path point in the db.

uint32_t psPathPoint::GetEffectID

(

iEffectIDAllocator *

allocator

)

Return the effect ID for this pathpoint or assign a new ID.

Parameters:

allocator

int psPathPoint::GetID

(

)

Return the db id of the point.

int psPathPoint::GetID

(

)

const [inline]

Definition at line 96 of file pspath.h.

csString psPathPoint::GetName

(

)

Return the name of this path point.

Will only have a name if this is a waypoint as well.

psPath* psPathPoint::GetPath

(

)

const

Return the parent path for this path point.

int psPathPoint::GetPathIndex

(

)

const

Return the index of this point in the path.

const csVector3& psPathPoint::GetPosition

(

)

const [inline]

Definition at line 99 of file pspath.h.

int psPathPoint::GetPreviousPointId

(

)

const [inline]

Get the previous point id.

Definition at line 94 of file pspath.h.

float psPathPoint::GetRadius

(

)

const

float psPathPoint::GetRadius

(

)

iSector* psPathPoint::GetSector

(

iEngine *

engine

)

iSector* psPathPoint::GetSector

(

iEngine *

engine

)

const

Waypoint* psPathPoint::GetWaypoint

(

)

bool psPathPoint::Load	(	iResultRow &	row,
		iEngine *	engine
	)

Load the point from the db row.

bool psPathPoint::Remove

(

iDataConnection *

db

)

Remove this path point in the db.

void psPathPoint::SetID

(

int

id

)

[inline]

Definition at line 97 of file pspath.h.

void psPathPoint::SetPrevious

(

int

previous

)

[inline]

Set the previous point id.

Definition at line 91 of file pspath.h.

void psPathPoint::SetWaypoint

(

Waypoint *

waypoint

)

bool psPathPoint::UpdatePrevPointId	(	iDataConnection *	db,
		int	prevPointId
	)

Update this path point in the db.

---

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

• common/util/pspath.h