CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

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 
00029 #include "csutil/scf.h"
00030 
00031 struct iSector;
00032 struct iSprite;
00033 struct iSpriteTemplate;
00034 struct iMeshWrapper;
00035 struct iMeshFactoryWrapper;
00036 struct iTextureWrapper;
00037 struct iMaterialWrapper;
00038 struct iCameraPosition;
00039 struct iObject;
00040 struct iCollection;
00041 
00042 SCF_VERSION (iRegion, 0, 1, 6);
00043 
00048 struct iRegion : public iBase
00049 {
00051   virtual iObject *QueryObject() = 0;
00052 
00057   virtual void Clear () = 0;
00058 
00062   virtual void DeleteAll () = 0;
00063 
00067   virtual bool PrepareTextures () = 0;
00068 
00072   virtual bool ShineLights () = 0;
00073 
00080   virtual bool Prepare () = 0;
00081 
00083   virtual iSector *FindSector (const char *iName) = 0;
00085   virtual iMeshWrapper *FindMeshObject (const char *iName) = 0;
00087   virtual iMeshFactoryWrapper *FindMeshFactory (const char *iName) = 0;
00089   virtual iTextureWrapper *FindTexture (const char *iName) = 0;
00091   virtual iMaterialWrapper *FindMaterial (const char *iName) = 0;
00093   virtual iCameraPosition *FindCameraPosition (const char *iName) = 0;
00095   virtual iCollection *FindCollection (const char *iName) = 0;
00096 
00102   virtual bool IsInRegion (iObject* obj) = 0;
00103 };
00104 
00105 
00106 SCF_VERSION (iRegionList, 0, 0, 1);
00107 
00111 struct iRegionList : public iBase
00112 {
00114   virtual int GetCount () const = 0;
00115 
00117   virtual iRegion *Get (int n) const = 0;
00118 
00120   virtual int Add (iRegion *obj) = 0;
00121 
00123   virtual bool Remove (iRegion *obj) = 0;
00124 
00126   virtual bool Remove (int n) = 0;
00127 
00129   virtual void RemoveAll () = 0;
00130 
00132   virtual int Find (iRegion *obj) const = 0;
00133 
00135   virtual iRegion *FindByName (const char *Name) const = 0;
00136 };
00137 
00140 #endif // __CS_IENGINE_REGION_H__

Generated for Crystal Space by doxygen 1.2.14