CrystalSpace

Public API Reference

iengine/region.h

Go to the documentation of this 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 __CS_IENGINE_REGION_H__
00021 #define __CS_IENGINE_REGION_H__
00022 
00030 #include "csutil/scf.h"
00031 
00032 struct iCameraPosition;
00033 struct iCollection;
00034 struct iMaterialWrapper;
00035 struct iMeshWrapper;
00036 struct iMeshFactoryWrapper;
00037 struct iObject;
00038 struct iSector;
00039 struct iTextureWrapper;
00040 
00041 
00046 struct iRegion : public virtual iBase
00047 {
00048   SCF_INTERFACE(iRegion, 2,0,0);
00050   virtual iObject *QueryObject() = 0;
00051 
00055   virtual void Add (iObject *obj) = 0;
00056 
00060   virtual void Remove (iObject *obj) = 0;
00061 
00066   virtual void Clear () = 0;
00067 
00071   virtual void DeleteAll () = 0;
00072 
00076   virtual bool PrepareTextures () = 0;
00077 
00081   virtual bool ShineLights () = 0;
00082 
00089   virtual bool Prepare () = 0;
00090 
00092   virtual iSector *FindSector (const char *iName) = 0;
00094   virtual iMeshWrapper *FindMeshObject (const char *iName) = 0;
00096   virtual iMeshFactoryWrapper *FindMeshFactory (const char *iName) = 0;
00098   virtual iTextureWrapper *FindTexture (const char *iName) = 0;
00100   virtual iMaterialWrapper *FindMaterial (const char *iName) = 0;
00102   virtual iCameraPosition *FindCameraPosition (const char *iName) = 0;
00104   virtual iCollection *FindCollection (const char *iName) = 0;
00105 
00111   virtual bool IsInRegion (iObject* obj) = 0;
00112 };
00113 
00117 struct iRegionList : public virtual iBase
00118 {
00119   SCF_INTERFACE(iRegionList, 2,0,0);
00121   virtual int GetCount () const = 0;
00122 
00124   virtual iRegion *Get (int n) const = 0;
00125 
00127   virtual int Add (iRegion *obj) = 0;
00128 
00130   virtual bool Remove (iRegion *obj) = 0;
00131 
00133   virtual bool Remove (int n) = 0;
00134 
00136   virtual void RemoveAll () = 0;
00137 
00139   virtual int Find (iRegion *obj) const = 0;
00140 
00142   virtual iRegion *FindByName (const char *Name) const = 0;
00143 };
00144 
00147 #endif // __CS_IENGINE_REGION_H__

Generated for Crystal Space by doxygen 1.4.6