region.h Source File

00001 /*
00002     Crystal Space 3D engine
00003     Copyright (C) 2000 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., 675 Mass Ave, Cambridge, MA 02139, USA.
00018 */
00019 
00020 #ifndef __IENGINE_REGION_H__
00021 #define __IENGINE_REGION_H__
00022 
00023 #include "csutil/scf.h"
00024 
00025 struct iSector;
00026 struct iSprite;
00027 struct iSpriteTemplate;
00028 struct iMeshWrapper;
00029 struct iMeshFactoryWrapper;
00030 struct iTextureWrapper;
00031 struct iMaterialWrapper;
00032 struct iCameraPosition;
00033 struct iObject;
00034 struct iCollection;
00035 
00036 SCF_VERSION (iRegion, 0, 1, 6);
00037 
00042 struct iRegion : public iBase
00043 {
00045   virtual iObject *QueryObject() = 0;
00046 
00051   virtual void Clear () = 0;
00052 
00056   virtual void DeleteAll () = 0;
00057 
00061   virtual bool PrepareTextures () = 0;
00062 
00066   virtual bool ShineLights () = 0;
00067 
00074   virtual bool Prepare () = 0;
00075 
00077   virtual iSector *FindSector (const char *iName) = 0;
00079   virtual iMeshWrapper *FindMeshObject (const char *iName) = 0;
00081   virtual iMeshFactoryWrapper *FindMeshFactory (const char *iName) = 0;
00083   virtual iTextureWrapper *FindTexture (const char *iName) = 0;
00085   virtual iMaterialWrapper *FindMaterial (const char *iName) = 0;
00087   virtual iCameraPosition *FindCameraPosition (const char *iName) = 0;
00089   virtual iCollection *FindCollection (const char *iName) = 0;
00090 
00096   virtual bool IsInRegion (iObject* obj) = 0;
00097 };
00098 
00099 
00100 SCF_VERSION (iRegionList, 0, 0, 1);
00101 
00105 struct iRegionList : public iBase
00106 {
00108   virtual int GetCount () const = 0;
00109 
00111   virtual iRegion *Get (int n) const = 0;
00112 
00114   virtual int Add (iRegion *obj) = 0;
00115 
00117   virtual bool Remove (iRegion *obj) = 0;
00118 
00120   virtual bool Remove (int n) = 0;
00121 
00123   virtual void RemoveAll () = 0;
00124 
00126   virtual int Find (iRegion *obj) const = 0;
00127 
00129   virtual iRegion *FindByName (const char *Name) const = 0;
00130 };
00131 
00132 #endif // __IENGINE_REGION_H__