CrystalSpace

Public API Reference

iengine/shadows.h

Go to the documentation of this file.
00001 /*
00002     Crystal Space 3D engine
00003     Copyright (C) 2001 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_SHADOWS_H__
00021 #define __CS_IENGINE_SHADOWS_H__
00022 
00030 #include "csutil/scf.h"
00031 
00032 struct iShadowBlock;
00033 struct iShadowBlockList;
00034 
00035 class csBox3;
00036 class csFrustum;
00037 class csPlane3;
00038 class csTransform;
00039 class csVector3;
00040 
00045 struct iShadowIterator : public virtual iBase
00046 {
00047   SCF_INTERFACE(iShadowIterator, 2,0,0);
00049   virtual void Reset () = 0;
00051   virtual bool HasNext () = 0;
00053   virtual csFrustum* Next () = 0;
00055   virtual void* GetUserData () = 0;
00057   virtual bool IsRelevant () = 0;
00059   virtual void MarkRelevant (bool rel) = 0;
00061   virtual void DeleteCurrent () = 0;
00063   virtual iShadowBlock* GetCurrentShadowBlock () = 0;
00065   virtual iShadowBlock* GetNextShadowBlock () = 0;
00066 };
00067 
00072 struct iShadowBlock : public virtual iBase
00073 {
00074   SCF_INTERFACE(iShadowBlock,2,0,0);
00076   virtual iShadowIterator* GetShadowIterator (bool reverse = false) = 0;
00078   virtual void DeleteShadows () = 0;
00079 
00086   virtual void AddRelevantShadows (iShadowBlock* source,
00087     csTransform* trans = 0) = 0;
00088 
00094   virtual void AddRelevantShadows (iShadowBlockList* source) = 0;
00095 
00101   virtual void AddAllShadows (iShadowBlockList* source) = 0;
00102 
00108   virtual void AddUniqueRelevantShadows (iShadowBlockList* source) = 0;
00109 
00115   virtual csFrustum* AddShadow (const csVector3& origin, void* userData,
00116     int num_verts, csPlane3& backplane) = 0;
00117 
00119   virtual void UnlinkShadow (int idx) = 0;
00120 
00122   virtual int GetShadowCount () = 0;
00123 
00125   virtual csFrustum* GetShadow (int idx) = 0;
00126 
00130   virtual void Transform (csTransform* trans) = 0;
00131 
00133   virtual const csBox3& GetBoundingBox () = 0;
00134 };
00135 
00140 struct iShadowBlockList : public virtual iBase
00141 {
00142   SCF_INTERFACE(iShadowBlockList,2,0,0);
00144   virtual iShadowIterator* GetShadowIterator (bool reverse = false) = 0;
00151   virtual iShadowIterator* GetShadowIterator (
00152     const csBox3& bbox, bool reverse = false) = 0;
00153 
00155   virtual iShadowBlock* NewShadowBlock (int num_shadows = 30) = 0;
00156 
00158   virtual iShadowBlock* GetFirstShadowBlock () = 0;
00160   virtual iShadowBlock* GetLastShadowBlock () = 0;
00162   virtual iShadowBlock* GetNextShadowBlock (iShadowBlock* s) = 0;
00164   virtual iShadowBlock* GetPreviousShadowBlock (iShadowBlock* s) = 0;
00166   virtual void RemoveLastShadowBlock () = 0;
00168   virtual void DeleteAllShadows () = 0;
00169 
00176   virtual uint32 MarkNewRegion () = 0;
00177 
00182   virtual void RestoreRegion (uint32 prev) = 0;
00183 
00188   virtual bool FromCurrentRegion (iShadowBlock* block) = 0;
00189 };
00190 
00193 #endif // __CS_IENGINE_SHADOWS_H__
00194 

Generated for Crystal Space 1.2.1 by doxygen 1.5.3