location.h

Go to the documentation of this file.

/*
 * location.h
 *
 * Copyright (C) 2004 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 __LOCATION_H__
#define __LOCATION_H__

#include <csutil/csstring.h>
#include <csgeom/vector3.h>
#include <csgeom/box.h>
#include <csutil/parray.h>
#include <csutil/list.h>
#include <iengine/sector.h>
#include <csutil/weakref.h>

#include "util/psconst.h"
#include "util/psdatabase.h"

struct iEngine;
class LocationType;
class psWorld;
class iEffectIDAllocator;

class Location
{
public:
    int                 id;                     
    csString            name;                   
    csVector3           pos;                    
    float               rot_angle;              
    float               radius;                 
    csArray<Location*>  locs;                   
    int                 id_prev_loc_in_region;  
    csString            sectorName;             

    csBox2              boundingBox;            
    csWeakRef<iSector>  sector;                 
    LocationType*       type;                   
    uint32_t            effectID;               
    Location*           region;                 

    Location();

    Location(LocationType* locationType, const char* locationName, const csVector3 &pos, iSector* sector, float radius, float rot_angle, const csString &flags);

    ~Location();

    int GetID() const
    {
        return id;
    }

    void SetID(int id)
    {
        this->id = id;
    }

    const csVector3 &GetPosition() const
    {
        return pos;
    }

    csString GetFlags() const
    {
        return csString();
    }

    bool SetFlags(const csString &flags)
    {
        return false;
    }

    bool SetFlag(const csString &flag, bool enable)
    {
        return false;
    }

    float GetRadius() const
    {
        return radius;
    }

    bool SetRadius(iDataConnection* db, float radius);

    void SetRadius(float radius);

    float GetRotationAngle() const
    {
        return rot_angle;
    }

    const char* GetTypeName() const;

    bool Load(iResultRow &row, iEngine* engine, iDataConnection* db);

    bool CreateUpdate(iDataConnection* db);

    bool Import(iDocumentNode* node, iDataConnection* db, int typeID);

    bool IsRegion()
    {
        return locs.GetSize() != 0;
    }

    bool IsCircle()
    {
        return locs.GetSize() == 0;
    }

    iSector*            GetSector(iEngine* engine);

    iSector*            GetSector(iEngine* engine) const;

    const csBox2 &GetBoundingBox() const;

    void CalculateBoundingBox();

    bool CheckWithinBounds(iEngine* engine,const csVector3 &pos,const iSector* sector);

    bool GetRandomPosition(iEngine* engine,csVector3 &pos,iSector* &sector);

    static int GetSectorID(iDataConnection* db, const char* name);

    const char* GetName() const
    {
        return name.GetDataSafe();
    }

    void SetName(const csString &name)
    {
        this->name = name;
    }

    uint32_t GetEffectID(iEffectIDAllocator* allocator);

    bool Adjust(iDataConnection* db, const csVector3 &pos, iSector* sector);

    bool Adjust(iDataConnection* db, const csVector3 &pos, iSector* sector, float rot_angle);

    bool Adjust(const csVector3 &pos, iSector* sector);

    bool Adjust(const csVector3 &pos, iSector* sector, float rot_angle);
    
    Location* Insert(iDataConnection* db, csVector3 &pos, iSector* sector);

    Location* Insert(int id, csVector3 &pos, iSector* sector);

    csString ToString() const;
};

class LocationType
{
public:
    int                   id;   
    csString              name; 
    csArray<Location*>    locs; 

    LocationType();

    LocationType(int id, const csString &name);

    ~LocationType();

    bool CreateUpdate(iDataConnection* db);

    bool Load(iDocumentNode* node);
    bool Import(iDocumentNode* node, iDataConnection* db);
    bool ImportLocations(iDocumentNode* node, iDataConnection* db);

    bool Load(iResultRow &row, iEngine* engine, iDataConnection* db);

    void AddLocation(Location* location);

    void RemoveLocation(Location* location);

    bool CheckWithinBounds(iEngine* engine,const csVector3 &pos,const iSector* sector);

    bool GetRandomPosition(iEngine* engine,csVector3 &pos,iSector* &sector, const iSector* inSector);

    int GetID() const
    {
        return id;
    }

    const char* GetName() const
    {
        return name.GetDataSafe();
    }
};

class LocationManager
{
public:
    LocationManager();

    virtual ~LocationManager();

    bool Load(iEngine* engine, iDataConnection* db);

    int GetNumberOfLocations() const;

    Location* GetLocation(int index);

    LocationType* FindRegion(const char* regname);

    LocationType* FindLocation(const char* typeName);

    Location* FindLocation(const char* typeName, const char* name);

    Location* FindLocation(LocationType* type, const char* name);

    Location* FindLocation(int id);

    size_t FindLocationsInSector(iEngine* engine, iSector* sector, csList<Location*> &list);

    Location* FindNearestLocation(psWorld* world, csVector3 &pos, iSector* sector, float range, float* found_range);

    Location* FindNearestLocation(psWorld* world, const char* typeName, csVector3 &pos, iSector* sector, float range, float* found_range);

    Location* FindRandomLocation(psWorld* world, const char* typeName, csVector3 &pos, iSector* sector, float range, float* found_range);

    csHash<LocationType*, csString>::GlobalIterator GetIterator();

    Location* CreateLocation(iDataConnection* db, LocationType* locationType, const char* locationName,
                             const csVector3 &pos, iSector* sector, float radius, float rot_angle,
                             const csString &flags);

    Location* CreateLocation(const char* locationTypeName, const char* locationName,
                             const csVector3 &pos, iSector* sector, float radius, float rot_angle,
                             const csString &flags);

    Location* CreateLocation(LocationType* locationType, const char* locationName,
                             const csVector3 &pos, iSector* sector, float radius, float rot_angle,
                             const csString &flags);

    LocationType* CreateLocationType(iDataConnection* db, const csString &locationName);

    LocationType* CreateLocationType(const csString &locationName);

    LocationType* CreateLocationType(int id, const csString &locationName);

    bool RemoveLocationType(iDataConnection* db, const csString &locationName);

    bool RemoveLocationType(const csString &locationName);

private:
    csHash<LocationType*, csString> loctypes;          
    csArray<Location*>              all_locations;     
};

#endif