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 iMaterialWrapper;
00034 struct iMeshWrapper;
00035 struct iMeshFactoryWrapper;
00036 struct iObject;
00037 struct iSector;
00038 struct iTextureWrapper;
00039 
00050 struct iRegion : public virtual iBase
00051 {
00052   SCF_INTERFACE(iRegion, 2,1,0);
00054   virtual iObject *QueryObject() = 0;
00055 
00059   virtual void Add (iObject *obj) = 0;
00060 
00064   virtual void Remove (iObject *obj) = 0;
00065 
00070   virtual void Clear () = 0;
00071 
00075   virtual void DeleteAll () = 0;
00076 
00080   virtual bool PrepareTextures () = 0;
00081 
00085   virtual bool ShineLights () = 0;
00086 
00093   virtual bool Prepare () = 0;
00094 
00096   virtual iSector *FindSector (const char *iName) = 0;
00098   virtual iMeshWrapper *FindMeshObject (const char *iName) = 0;
00100   virtual iMeshFactoryWrapper *FindMeshFactory (const char *iName) = 0;
00102   virtual iTextureWrapper *FindTexture (const char *iName) = 0;
00104   virtual iMaterialWrapper *FindMaterial (const char *iName) = 0;
00106   virtual iCameraPosition *FindCameraPosition (const char *iName) = 0;
00107 
00113   virtual bool IsInRegion (iObject* obj) = 0;
00114 };
00115 
00122 struct iRegionList : public virtual iBase
00123 {
00124   SCF_INTERFACE(iRegionList, 2,0,0);
00126   virtual int GetCount () const = 0;
00127 
00129   virtual iRegion *Get (int n) const = 0;
00130 
00132   virtual int Add (iRegion *obj) = 0;
00133 
00135   virtual bool Remove (iRegion *obj) = 0;
00136 
00138   virtual bool Remove (int n) = 0;
00139 
00141   virtual void RemoveAll () = 0;
00142 
00144   virtual int Find (iRegion *obj) const = 0;
00145 
00147   virtual iRegion *FindByName (const char *Name) const = 0;
00148 };
00149 
00152 #endif // __CS_IENGINE_REGION_H__

Generated for Crystal Space 1.2.1 by doxygen 1.5.3