C4PathFinder Class Reference

#include <C4PathFinder.h>

Public Types
typedef std::function< bool(int32_t x, int32_t y)>	PointFreeFn
typedef std::function< bool(int32_t x, int32_t y, C4Object *transfer_object)>	SetWaypointFn

Public Member Functions
	C4PathFinder ()
	~C4PathFinder ()
void	Draw (C4TargetFacet &cgo)
void	Clear ()
void	Default ()
void	Init (PointFreeFn fnPointFree, C4TransferZones *pTransferZones=nullptr)
bool	Find (int32_t iFromX, int32_t iFromY, int32_t iToX, int32_t iToY, SetWaypointFn fnSetWaypoint)
void	EnableTransferZones (bool fEnabled)
void	SetLevel (int iLevel)

Friends
class	C4PathFinderRay

Detailed Description

Definition at line 27 of file C4PathFinder.h.

Member Typedef Documentation

PointFreeFn

typedef std::function<bool(int32_t x, int32_t y)> C4PathFinder::PointFreeFn

Definition at line 34 of file C4PathFinder.h.

SetWaypointFn

typedef std::function<bool(int32_t x, int32_t y, C4Object *transfer_object)> C4PathFinder::SetWaypointFn

Definition at line 35 of file C4PathFinder.h.

Constructor & Destructor Documentation

C4PathFinder()

C4PathFinder::C4PathFinder

(

)

Definition at line 537 of file C4PathFinder.cpp.

{
    Default();
}

References Default().

Here is the call graph for this function:

~C4PathFinder()

C4PathFinder::~C4PathFinder

(

)

Definition at line 542 of file C4PathFinder.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4PathFinder::Clear

(

)

Definition at line 558 of file C4PathFinder.cpp.

{
    C4PathFinderRay *pRay,*pNext;
    for (pRay=FirstRay; pRay; pRay=pNext) { pNext=pRay->Next; delete pRay; }
    FirstRay=nullptr;
}

References C4PathFinderRay::Next.

Referenced by C4Game::Clear(), Find(), and ~C4PathFinder().

Here is the caller graph for this function:

Default()

void C4PathFinder::Default

(

)

Definition at line 547 of file C4PathFinder.cpp.

{
    PointFree=nullptr;
    SetWaypoint=nullptr;
    FirstRay=nullptr;
    Success=false;
    TransferZones=nullptr;
    TransferZonesEnabled=true;
    Level=1;
}

Referenced by C4PathFinder(), and C4Game::Default().

Here is the caller graph for this function:

Draw()

void C4PathFinder::Draw

(

C4TargetFacet &

cgo

)

Definition at line 582 of file C4PathFinder.cpp.

{
    if (TransferZones) TransferZones->Draw(cgo);
    for (C4PathFinderRay *pRay=FirstRay; pRay; pRay=pRay->Next) pRay->Draw(cgo);
}

References C4TransferZones::Draw(), and C4PathFinderRay::Next.

Referenced by C4Viewport::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

EnableTransferZones()

void C4PathFinder::EnableTransferZones

(

bool

fEnabled

)

Definition at line 572 of file C4PathFinder.cpp.

{
    TransferZonesEnabled = fEnabled;
}

Referenced by C4Command::MoveTo().

Here is the caller graph for this function:

Find()

bool C4PathFinder::Find	(	int32_t	iFromX,
		int32_t	iFromY,
		int32_t	iToX,
		int32_t	iToY,
		SetWaypointFn	fnSetWaypoint
	)

Definition at line 623 of file C4PathFinder.cpp.

{
 
    // Prepare
    Clear();
 
    // Parameter safety
    if (!fnSetWaypoint) return false;
    SetWaypoint=fnSetWaypoint;
 
    // Start & target coordinates must be free
    if (!PointFree(iFromX,iFromY) || !PointFree(iToX,iToY)) return false;
 
    // Add the first two rays
    if (!AddRay(iFromX,iFromY,iToX,iToY,0,C4PF_Direction_Left,nullptr)) return false;
    if (!AddRay(iFromX,iFromY,iToX,iToY,0,C4PF_Direction_Right,nullptr)) return false;
 
    // Run
    Run();
 
    // Success
    return Success;
 
}

References C4PF_Direction_Left, C4PF_Direction_Right, and Clear().

Referenced by C4Command::MoveTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

void C4PathFinder::Init	(	PointFreeFn	fnPointFree,
		C4TransferZones *	pTransferZones = nullptr
	)

Definition at line 565 of file C4PathFinder.cpp.

{
    // Set data
    PointFree = fnPointFree;
    TransferZones = pTransferZones;
}

SetLevel()

void C4PathFinder::SetLevel

(

int

iLevel

)

Definition at line 577 of file C4PathFinder.cpp.

{
    Level = Clamp(iLevel, 1, 10);
}

References Clamp().

Referenced by C4Command::MoveTo().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4PathFinderRay

friend class C4PathFinderRay

friend

Definition at line 29 of file C4PathFinder.h.

---

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

• C4PathFinder.h
• C4PathFinder.cpp