propclass/region.h Source File (CEL: Crystal Entity Layer 2.0 Public API Reference)

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2001 by Jorrit Tyberghein
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __CEL_PF_REGION__
00021 #define __CEL_PF_REGION__
00022 
00023 #include "cstypes.h"
00024 #include "csgeom/vector3.h"
00025 #include "csutil/scf.h"
00026 
00027 struct iSector;
00028 struct iPcCamera;
00029 struct iCollection;
00030 
00044 struct iPcRegion : public virtual iBase
00045 {
00046   SCF_INTERFACE (iPcRegion, 0, 1, 1);
00047 
00051   virtual void SetWorldFile (const char* vfsdir, const char* name) = 0;
00055   virtual const char* GetWorldDir () const = 0;
00059   virtual const char* GetWorldFile () const = 0;
00060 
00064   virtual void SetRegionName (const char* name) = 0;
00068   virtual const char* GetRegionName () const = 0;
00069 
00077   virtual void CreateEmptySector (const char* name) = 0;
00078 
00083   virtual bool Load () = 0;
00084 
00088   virtual void Unload () = 0;
00089 
00093   virtual iSector* FindSector (const char* sectorname) = 0;
00094 
00100   virtual iSector* GetStartSector (const char* name = 0) = 0;
00101 
00107   virtual csVector3 GetStartPosition (const char* name = 0) = 0;
00108 
00115   virtual void PointCamera (iPcCamera* pccamera, const char* name = 0) = 0;
00116 
00121   virtual iCollection* GetCollection() = 0;
00122 };
00123 
00124 #endif // __CEL_PF_REGION__
00125