tools/celnavmesh.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_NAVMESHAPI__
#define __CEL_NAVMESHAPI__

#include <csutil/scf.h>
#include <csutil/list.h>
#include <csgeom/poly3d.h>

class csBox3;
class csOBB;
class csVector3;
struct csSimpleRenderMesh;
struct iFile;
struct iSector;



struct iCelNavMeshParams : public virtual iBase
{
  virtual iCelNavMeshParams* Clone () const = 0;

  virtual void SetSuggestedValues (float agentHeight, float agentRadius, float agentMaxSlopeAngle) = 0;

  virtual float GetAgentHeight () const = 0;
  virtual void SetAgentHeight (const float height) = 0;

  virtual float GetAgentRadius () const = 0;
  virtual void SetAgentRadius (const float radius) = 0;

  virtual float GetAgentMaxSlopeAngle () const = 0;
  virtual void SetAgentMaxSlopeAngle (const float angle) = 0;

  virtual float GetAgentMaxClimb () const = 0;
  virtual void SetAgentMaxClimb (const float maxClimb) = 0;

  virtual float GetCellSize () const = 0;
  virtual void SetCellSize (const float size) = 0;

  virtual float GetCellHeight () const = 0;
  virtual void SetCellHeight (const float height) = 0;

  virtual float GetMaxSimplificationError () const = 0;
  virtual void SetMaxSimplificationError (const float error) = 0;

  virtual float GetDetailSampleDist () const = 0;
  virtual void SetDetailSampleDist (const float dist) = 0;

  virtual float GetDetailSampleMaxError () const = 0;
  virtual void SetDetailSampleMaxError (const float error) = 0;
  
  virtual int GetMaxEdgeLength () const = 0;
  virtual void SetMaxEdgeLength (const int length) = 0;

  virtual int GetMinRegionSize () const = 0;
  virtual void SetMinRegionSize (const int size) = 0;

  virtual int GetMergeRegionSize () const = 0;
  virtual void SetMergeRegionSize (const int size) = 0;

  virtual int GetMaxVertsPerPoly () const = 0;
  virtual void SetMaxVertsPerPoly (const int maxVerts) = 0;

  virtual int GetTileSize () const = 0;
  virtual void SetTileSize (const int size) = 0;

  virtual int GetBorderSize () const = 0;
  virtual void SetBorderSize (const int size) = 0;

  virtual csVector3 GetPolygonSearchBox () const = 0;
  virtual void SetPolygonSearchBox (const csVector3 box) = 0;
};



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

  virtual iSector* GetSector () const = 0;

  virtual void Current (csVector3& vector) const = 0;

  virtual void Next (csVector3& vector) = 0;

  virtual void Previous (csVector3& vector) = 0;

  virtual void GetFirst (csVector3& vector) const = 0;

  virtual void GetLast (csVector3& vector) const = 0;

  virtual bool HasNext () const = 0;

  virtual bool HasPrevious () const = 0;

  virtual void Invert () = 0;

  virtual void Restart () = 0;

  virtual void AddNode (csVector3 node) = 0;

  virtual void InsertNode (int pos, csVector3 node) = 0;

  virtual float Length() const = 0;

  virtual int GetNodeCount () const = 0;

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



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

  virtual iCelNavMeshPath* ShortestPath (const csVector3& from, const csVector3& goal, 
                                         int maxPathSize = 32) = 0;

  virtual bool Update (const csBox3& boundingBox) = 0;

  virtual bool Update (const csOBB& boundingBox) = 0;

  virtual iSector* GetSector () const = 0;

  virtual void SetSector (iSector* sector) = 0;

  virtual iCelNavMeshParams* GetParameters () const = 0;

  virtual csBox3 GetBoundingBox() const = 0;

  // obtain a list of polygons overlapping a box
  virtual csArray<csPoly3D> QueryPolygons(const csBox3& box) const = 0;

  virtual bool SaveToFile (iFile* file) const = 0;

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

  virtual csList<csSimpleRenderMesh>* GetAgentDebugMeshes (const csVector3& pos) const = 0;

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



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

  virtual bool SetSector (iSector* sector) = 0;

  THREADED_INTERFACE(BuildNavMesh);

  virtual iCelNavMesh* LoadNavMesh (iFile* file) = 0;

  virtual const iCelNavMeshParams* GetNavMeshParams () const = 0;

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

  virtual iSector* GetSector () const = 0;
 
};

#endif // __CEL_NAVMESHAPI__