CrystalSpace

Public API Reference

iengine/halo.h

Go to the documentation of this file.
00001 /*
00002     Copyright (C) 2001 by Jorrit Tyberghein
00003 
00004     This library is free software; you can redistribute it and/or
00005     modify it under the terms of the GNU Library General Public
00006     License as published by the Free Software Foundation; either
00007     version 2 of the License, or (at your option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful,
00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012     Library General Public License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public
00015     License along with this library; if not, write to the Free
00016     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00017 */
00018 
00019 #ifndef __CS_IENGINE_HALO_H__
00020 #define __CS_IENGINE_HALO_H__
00021 
00029 #include "csutil/scf.h"
00030 
00031 struct iMaterialWrapper;
00032 
00036 enum csHaloType
00037 {
00039   cshtCross,
00041   cshtNova,
00043   cshtFlare
00044 };
00045 
00049 struct iBaseHalo : public virtual iBase
00050 {
00051   SCF_INTERFACE(iBaseHalo,2,0,0);
00053   virtual void SetIntensity (float i) = 0;
00055   virtual float GetIntensity () = 0;
00057   virtual csHaloType GetType () = 0;
00058 };
00059 
00063 struct iCrossHalo : public virtual iBase
00064 {
00065   SCF_INTERFACE(iCrossHalo,2,0,0);
00067   virtual void SetIntensityFactor (float i) = 0;
00069   virtual float GetIntensityFactor () = 0;
00071   virtual void SetCrossFactor (float i) = 0;
00073   virtual float GetCrossFactor () = 0;
00074 };
00075 
00079 struct iNovaHalo : public virtual iBase
00080 {
00081   SCF_INTERFACE(iNovaHalo,2,0,0);
00083   virtual void SetRandomSeed (int s) = 0;
00085   virtual int GetRandomSeed () = 0;
00087   virtual void SetSpokeCount (int s) = 0;
00089   virtual int GetSpokeCount () = 0;
00091   virtual void SetRoundnessFactor (float r) = 0;
00093   virtual float GetRoundnessFactor () = 0;
00094 };
00095 
00099 struct iFlareHalo : public virtual iBase
00100 {
00101   SCF_INTERFACE(iFlareHalo,2,0,0);
00107   virtual void AddComponent (float pos, float w, float h, uint mode,
00108     iMaterialWrapper *image) = 0;
00109 };
00110 
00113 #endif // __CS_IENGINE_HALO_H__

Generated for Crystal Space by doxygen 1.4.6