Public API Reference

propclass/region.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2001 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_REGION__
#define __CEL_PF_REGION__

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

struct iSector;
struct iPcCamera;
struct iRegion;

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

  virtual void SetWorldFile (const char* vfsdir, const char* name) = 0;
  virtual const char* GetWorldDir () const = 0;
  virtual const char* GetWorldFile () const = 0;

  virtual void SetRegionName (const char* name) = 0;
  virtual const char* GetRegionName () const = 0;

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

  virtual bool Load () = 0;

  virtual void Unload () = 0;

  virtual iSector* FindSector (const char* sectorname) = 0;

  virtual iSector* GetStartSector (const char* name = 0) = 0;

  virtual csVector3 GetStartPosition (const char* name = 0) = 0;

  virtual void PointCamera (iPcCamera* pccamera, const char* name = 0) = 0;

  virtual iRegion* GetRegion() = 0;
};

#endif // __CEL_PF_REGION__

---