pspathnetwork.h

Go to the documentation of this file.

/*
 * pspathnetwork.h
 *
 * Copyright (C) 2007 Atomic Blue (info@planeshift.it, http://www.atomicblue.org) 
 *
 *
 * 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 (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 __PSPATHNETWORK_H__
#define __PSPATHNETWORK_H__

#include <csutil/array.h>
#include <csutil/list.h>

#include <idal.h>

#include "util/pspath.h"

class Edge;
class Waypoint;
class WaypointAlias;
class psPath;
class psWorld;

class psPathNetwork
{
public:

    class RouteFilter
    {
      public:
        virtual bool Filter(const Waypoint* wp) const = 0;
    };


    csPDelArray<Waypoint> waypoints;
    csPDelArray<psPath> paths;
    
    csArray<csString> waypointGroupNames;
    csArray< csList<Waypoint*> > waypointGroups;

    csWeakRef<iEngine> engine;
    csWeakRef<iDataConnection> db;
    psWorld * world;
    
    
    bool Load(iEngine *engine, iDataConnection *db, psWorld * world);

    size_t AddWaypointToGroup(csString group, Waypoint * wp);

    Waypoint *FindWaypoint(int id);

    Waypoint *FindWaypoint(const char * name, WaypointAlias** alias = NULL);
    
    Waypoint *FindWaypoint(const csVector3& v, iSector *sector);

    Waypoint *FindNearestWaypoint(const csVector3& v,iSector *sector, float range, float * found_range = NULL);

    Waypoint *FindRandomWaypoint(const csVector3& v, iSector *sector, float range, float * found_range = NULL);

    Waypoint *FindNearestWaypoint(int group, const csVector3& v,iSector *sector, float range, float * found_range = NULL);

    Waypoint *FindRandomWaypoint(int group, const csVector3& v, iSector *sector, float range, float * found_range = NULL);

    int FindWaypointGroup(const char * groupName);

    psPathPoint* FindPathPoint(int id);

    psPathPoint* FindPoint(const psPath* path, const csVector3& pos, iSector* sector, float range, int& index);
    
    psPathPoint* FindNearestPoint(const psPath* path, const csVector3& v, const iSector *sector, float range);

    psPath *FindNearestPath(const csVector3& v, iSector *sector, float range, float * found_range = NULL, int * index = NULL, float * fraction = NULL);
    
    psPath *FindNearestPoint(const csVector3& v, iSector *sector, float range, float * found_range = NULL, int * index = NULL);
    
    csList<Waypoint*> FindWaypointRoute(Waypoint * start, Waypoint * end, const RouteFilter* routeFilter);

    csList<Edge*> FindEdgeRoute(Waypoint * start, Waypoint * end, const RouteFilter* routeFilter);

    size_t FindPointsInSector(iSector *sector, csList<psPathPoint*>& list);

    size_t FindWaypointsInSector(iSector *sector, csList<Waypoint*>& list);

    
    void ListWaypoints(const char *pattern);
    
    void ListPaths(const char *pattern);

    psPath* FindPath(const char *name);

    psPath* FindPath(int id);
    
    Edge* FindEdge(const Waypoint * wp1, const Waypoint * wp2);


    Waypoint* CreateWaypoint( iDataConnection *db, csString& name, csVector3& pos, csString& sectorName, float radius, csString& flags);

    Waypoint* CreateWaypoint( csString& name, csVector3& pos, csString& sectorName, float radius, csString& flags);
    
    psPath* CreatePath(iDataConnection *db, const csString& name, Waypoint* wp1, Waypoint* wp2, const csString& flags);

    psPath* CreatePath(iDataConnection *db, psPath * path);

    psPath* CreatePath(psPath * path);
    
    int GetNextWaypointCheck();

    bool Delete(psPath * path);
};

#endif