tools/celhpf.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2010 by Leonardo Rodrigo Domingues
  
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
  
    This library 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
    Library General Public License for more details.
  
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_HPFAPI__
#define __CEL_HPFAPI__

#include <csutil/scf.h>
#include <csutil/list.h>
#include <tools/celnavmesh.h>

class csBox3;
class csOBB;
class csString;
class csVector3;
struct csSimpleRenderMesh;
struct iCelNavMeshParams;
struct iCelPath;
struct iSector;
struct iSectorList;
struct iMapNode;



struct iCelHPath : public virtual iBase
{
  SCF_INTERFACE (iCelHPath, 1, 0, 0);

  virtual bool HasNext () const = 0;

  virtual bool HasPrevious () const = 0;

  virtual iMapNode* Next () = 0;
  
  virtual iMapNode* Previous () = 0;
    
  virtual iMapNode* Current () = 0;

  virtual iMapNode* GetFirst () = 0;
  
  virtual iMapNode* GetLast () = 0;
  
  virtual void Invert () = 0;

  virtual void Restart () = 0;

  virtual float GetDistance () const = 0;
  
  virtual csList<csSimpleRenderMesh>* GetDebugMeshes () = 0;
};



struct iCelHNavStruct : public virtual iBase
{
  SCF_INTERFACE (iCelHNavStruct, 1, 0, 0);

  virtual iCelHPath* ShortestPath (const csVector3& from, iSector* fromSector, const csVector3& goal,
    iSector* goalSector) = 0;

  virtual iCelHPath* ShortestPath (iMapNode* from, iMapNode* goal) = 0;
  
  virtual bool Update (const csBox3& boundingBox, iSector* sector = 0) = 0;

  virtual bool Update (const csOBB& boundingBox, iSector* sector = 0) = 0;

  virtual bool SaveToFile (iVFS* vfs, const char* directory) = 0;

  virtual const iCelNavMeshParams* GetNavMeshParams () const = 0;

  virtual csList<csSimpleRenderMesh>* GetDebugMeshes () const = 0;

  virtual csList<csSimpleRenderMesh>* GetAgentDebugMeshes (const csVector3& pos, int red, int green,
                                                           int blue, int alpha) const = 0;
};



struct iCelHNavStructBuilder : public virtual iBase
{
  SCF_INTERFACE (iCelHNavStructBuilder, 1, 0, 0);

  virtual bool SetSectors(csList<iSector*> sectorList) = 0;

  virtual iCelHNavStruct* BuildHNavStruct () = 0;

  virtual iCelHNavStruct* LoadHNavStruct (iVFS* vfs, const char* directory) = 0;

  virtual const iCelNavMeshParams* GetNavMeshParams () const = 0;

  virtual void SetNavMeshParams (const iCelNavMeshParams* parameters) = 0;
};

#endif // __CEL_HPFAPI__