____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

pathfinder.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1998-2007 by Lutz Sammer, Russell Smith
//
//      This program is free software; you can redistribute it and/or modify
//      it under the terms of the GNU General Public License as published by
//      the Free Software Foundation; only version 2 of the License.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.

#ifndef __PATHFINDER_H__
#define __PATHFINDER_H__


#ifdef _MSC_VER
#define STDCALL __stdcall
#else
#define STDCALL
#endif

#if defined(DEBUG_ASTAR)
#define AstarDebugPrint(x) DebugPrint(x)
#else
#define AstarDebugPrint(x)
#endif

/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/

class CUnit;

enum _move_return_ {
    PF_FAILED = -3,       
    PF_UNREACHABLE = -2,  
    PF_REACHED = -1,      
    PF_WAIT = 0,          
    PF_MOVE = 1,          
};

#define NewResetPath(unit) \
    do { unit->Data.Move.Fast = 1; unit->Data.Move.Length = 0; } while (0)

/*----------------------------------------------------------------------------
--  Variables
----------------------------------------------------------------------------*/

extern int AStarFixedUnitCrossingCost;
extern int AStarMovingUnitCrossingCost;
extern bool AStarKnowUnseenTerrain;
extern int AStarUnknownTerrainCost;

//
//  Convert heading into direction.
//  N NE  E SE  S SW  W NW
extern const int Heading2X[9];
extern const int Heading2Y[9];
extern const int XY2Heading[3][3];

/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/

extern void InitPathfinder();
extern void FreePathfinder();

extern unsigned char *CreateMatrix(void);
extern unsigned char *MakeMatrix(void);
extern int NewPath(CUnit *unit);
extern int NextPathElement(CUnit *unit, int *xdp, int *ydp);
extern int UnitReachable(const CUnit *unit, const CUnit *dst, int range);
extern int PlaceReachable(const CUnit *src, int x, int y, int w, int h,
    int minrange, int maxrange);

//
// in astar.cpp
//
extern void InitAStar(int mapWidth, int mapHeight, int (STDCALL *costMoveTo)(int x, int y, void *data));

extern void FreeAStar(void);

extern int AStarFindPath(int sx, int sy, int gx, int gy, int gw, int gh,
    int tilesizex, int tilesizey, int minrange, int maxrange, char *path, int pathlen, void *data);

extern void SetAStarFixedUnitCrossingCost(int cost);
extern int GetAStarFixedUnitCrossingCost();

extern void SetAStarMovingUnitCrossingCost(int cost);
extern int GetAStarMovingUnitCrossingCost();

extern void SetAStarUnknownTerrainCost(int cost);
extern int GetAStarUnknownTerrainCost();


#endif // !__PATHFINDER_H__

---