Public API Reference

propclass/zone.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2004 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_PF_ZONE__
#define __CEL_PF_ZONE__

#include "cstypes.h"
#include "csgeom/vector3.h"
#include "csutil/scf.h"

struct iSector;
struct iPcCamera;
struct iPcMesh;
struct iCelEntity;
struct iStringArray;
struct iString;
struct iDocumentNode;

SCF_VERSION (iCelMapFile, 0, 1, 0);

struct iCelMapFile : public iBase
{
  virtual void SetPath (const char* path) = 0;

  virtual void SetFile (const char* file) = 0;

  virtual const char* GetPath () const = 0;

  virtual const char* GetFile () const = 0;

  virtual void SetSectorName (const char* name) = 0;

  virtual const char* GetSectorName () const = 0;
};

SCF_VERSION (iCelRegion, 0, 2, 1);

struct iCelRegion : public iBase
{
  virtual const char* GetName () const = 0;

  virtual const char* GetCsRegionName () const = 0;

  virtual void SetCachePath (const char* path) = 0;

  virtual const char* GetCachePath () const = 0;

  virtual iCelMapFile* CreateMapFile () = 0;

  virtual size_t GetMapFileCount () const = 0;

  virtual iCelMapFile* GetMapFile (int idx) const = 0;

  virtual bool RemoveMapFile (iCelMapFile* mapfile) = 0;

  virtual void RemoveAllMapFiles () = 0;

  virtual void AssociateEntity (iCelEntity* entity) = 0;
  
  virtual void DissociateEntity (iCelEntity* entity) = 0;
};

SCF_VERSION (iCelZone, 0, 1, 0);

struct iCelZone : public iBase
{
  virtual const char* GetName () const = 0;

  virtual void LinkRegion (iCelRegion* region) = 0;

  virtual size_t GetRegionCount () const = 0;

  virtual iCelRegion* GetRegion (size_t idx) const = 0;

  virtual iCelRegion* FindRegion (const char* name) const = 0;

  virtual bool UnlinkRegion (iCelRegion* region) = 0;

  virtual void UnlinkAllRegions () = 0;
};


#define CEL_ZONEERROR_OK 0

#define CEL_ZONEERROR_BADREGION 1

#define CEL_ZONEERROR_BADSTART 2

#define CEL_ZONEERROR_LOAD 3


#define CEL_ZONE_NORMAL 0

#define CEL_ZONE_KEEP 1

#define CEL_ZONE_LOADALL 2

SCF_VERSION (iPcZoneManager, 0, 1, 2);

struct iPcZoneManager : public iBase
{
  virtual void EnableColliderWrappers (bool en) = 0;

  virtual bool IsColliderWrappers () const = 0;

  virtual void SetLoadingMode (int mode) = 0;

  virtual int GetLoadingMode () const = 0;

  virtual bool Load (iDocumentNode* node) = 0;

  virtual bool Load (const char* path, const char* file) = 0;

  virtual iCelZone* CreateZone (const char* name) = 0;

  virtual size_t GetZoneCount () const = 0;

  virtual iCelZone* GetZone (int idx) const = 0;

  virtual iCelZone* FindZone (const char* name) const = 0;

  virtual bool RemoveZone (iCelZone* zone) = 0;

  virtual void RemoveAllZones () = 0;

  virtual iCelRegion* CreateRegion (const char* name) = 0;

  virtual size_t GetRegionCount () const = 0;

  virtual iCelRegion* GetRegion (int idx) const = 0;

  virtual iCelRegion* FindRegion (const char* name) const = 0;

  virtual bool RemoveRegion (iCelRegion* region) = 0;

  virtual void RemoveAllRegions () = 0;

  virtual void FindStartLocations (iStringArray* regionnames,
        iStringArray* startnames) = 0;

  virtual void GetLastStartLocation (iString* regionname,
        iString* startname) = 0;
  virtual const char *GetLastStartRegionName () = 0;

  virtual const char *GetLastStartName () = 0;

  virtual int PointCamera (const char* entity, const char* regionname,
        const char* startname = 0) = 0;

  virtual int PointMesh (const char* entity, const char* regionname,
        const char* startname = 0) = 0;

  virtual bool ActivateRegion (iCelRegion* region,
      bool allow_entity_addon = true) = 0;
};

#endif // __CEL_PF_ZONE__

---