CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

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 iCameraPosition;
00032 struct iCollection;
00033 struct iMaterialWrapper;
00034 struct iMeshWrapper;
00035 struct iMeshFactoryWrapper;
00036 struct iObject;
00037 struct iSector;
00038 struct iTextureWrapper;
00039 
00040 SCF_VERSION (iRegion, 0, 1, 7);
00041 
00046 struct iRegion : public iBase
00047 {
00049   virtual iObject *QueryObject() = 0;
00050 
00054   virtual void Add (iObject *obj) = 0;
00055 
00059   virtual void Remove (iObject *obj) = 0;
00060 
00065   virtual void Clear () = 0;
00066 
00070   virtual void DeleteAll () = 0;
00071 
00075   virtual bool PrepareTextures () = 0;
00076 
00080   virtual bool ShineLights () = 0;
00081 
00088   virtual bool Prepare () = 0;
00089 
00091   virtual iSector *FindSector (const char *iName) = 0;
00093   virtual iMeshWrapper *FindMeshObject (const char *iName) = 0;
00095   virtual iMeshFactoryWrapper *FindMeshFactory (const char *iName) = 0;
00097   virtual iTextureWrapper *FindTexture (const char *iName) = 0;
00099   virtual iMaterialWrapper *FindMaterial (const char *iName) = 0;
00101   virtual iCameraPosition *FindCameraPosition (const char *iName) = 0;
00103   virtual iCollection *FindCollection (const char *iName) = 0;
00104 
00110   virtual bool IsInRegion (iObject* obj) = 0;
00111 };
00112 
00113 
00114 SCF_VERSION (iRegionList, 0, 0, 1);
00115 
00119 struct iRegionList : public iBase
00120 {
00122   virtual int GetCount () const = 0;
00123 
00125   virtual iRegion *Get (int n) const = 0;
00126 
00128   virtual int Add (iRegion *obj) = 0;
00129 
00131   virtual bool Remove (iRegion *obj) = 0;
00132 
00134   virtual bool Remove (int n) = 0;
00135 
00137   virtual void RemoveAll () = 0;
00138 
00140   virtual int Find (iRegion *obj) const = 0;
00141 
00143   virtual iRegion *FindByName (const char *Name) const = 0;
00144 };
00145 
00148 #endif // __CS_IENGINE_REGION_H__

Generated for Crystal Space by doxygen 1.4.4