tools/celgraph.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2006 by Jorrit Tyberghein
  
    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_CELGRAPH__
#define __CEL_CELGRAPH__

#include "cstypes.h"
#include "csutil/scf.h"
#include "csutil/flags.h"
#include "csutil/stringarray.h"
#include <ivaria/mapnode.h>

struct iCelNode;

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

  virtual void SetState (bool open) = 0;

  virtual void SetSuccessor (iCelNode* node) = 0;
  
  virtual bool GetState () = 0;

  virtual iCelNode* GetSuccessor () = 0;

  virtual float GetWeight () const = 0;

  virtual void SetWeight (float weight) = 0;
};


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

  virtual size_t AddSuccessor (iCelNode* node, bool state) = 0;
  
  virtual void SetMapNode (iMapNode* node) = 0;

  virtual void SetParent (iCelNode* par)= 0;
  
  virtual void SetName (const char* par)= 0;
  
  virtual void Heuristic (float cost, iCelNode* goal)= 0;

  virtual iMapNode* GetMapNode () = 0;

  virtual csVector3 GetPosition () = 0;

  virtual const char* GetName () = 0;
  
  virtual iCelNode* GetParent () = 0;

  virtual csArray<iCelNode*> GetSuccessors () = 0;

  virtual csArray<iCelNode*> GetAllSuccessors () = 0;

  virtual float  GetHeuristic () = 0;

  virtual float  GetCost () = 0;

   virtual size_t GetEdgeCount () = 0;

  virtual iCelEdge* GetEdge (size_t idx) = 0;

  virtual void RemoveEdge (size_t idx) = 0;

  virtual size_t AddSuccessor (iCelNode* node, bool state, float weight) = 0;

  virtual csRefArray<iCelEdge> GetEdges () const = 0;
};


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

  virtual iObject* QueryObject () = 0;

  virtual void AddNode (iMapNode* node) = 0;
  
  virtual void InsertNode (size_t pos, iMapNode* node) = 0;
  
  virtual iMapNode* Next () = 0;
  
  virtual iMapNode* Previous () = 0;
  
  virtual iMapNode* Current () = 0;
  
  virtual csVector3 CurrentPosition () = 0;

  virtual iSector* CurrentSector () = 0;
  
  virtual bool HasNext () = 0;

  virtual bool HasPrevious () = 0;

  virtual void Restart () = 0;

  virtual void Clear () = 0;

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


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

  virtual iObject* QueryObject () = 0;

  virtual iCelNode* CreateNode (const char* name, csVector3 &pos) = 0;

  virtual size_t AddNode (iCelNode* node) = 0;

  virtual void AddEdge (iCelNode* from, iCelNode* to, bool state) = 0;

  virtual bool AddEdgeByNames (const char* from, const char* to, bool state) = 0;

  virtual iCelNode* GetClosest (csVector3 position) = 0; 

  virtual bool ShortestPath (iCelNode* from, iCelNode* goal, iCelPath* path) = 0;

  virtual iCelNode* RandomPath (iCelNode* from, int distance, iCelPath* path) = 0;

   virtual size_t GetNodeCount () = 0;

  virtual iCelNode* GetNode (size_t idx) = 0;

  virtual void RemoveNode (size_t idx) = 0;

  virtual void RemoveEdge (iCelNode* from, size_t idx) = 0;

  virtual size_t AddEdge (iCelNode* from, iCelNode* to, bool state, float weight) = 0;

  virtual iCelNode* CreateEmptyNode (size_t& index) = 0;

  virtual bool ShortestPath2 (iCelNode* from, iCelNode* goal, iCelPath* path) = 0;
  
};

#endif //__CEL_CELGRAPH__