CrystalSpace

Public API Reference

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

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 
00028 #include "csutil/scf.h"
00029 #include "csutil/flags.h"
00030 
00031 struct iMaterialWrapper;
00032 
00036 enum csHaloType
00037 {
00039   cshtCross,
00041   cshtNova,
00043   cshtFlare
00044 };
00045 
00046 SCF_VERSION (iBaseHalo, 0, 0, 1);
00047 
00051 struct iBaseHalo : public iBase
00052 {
00054   virtual void SetIntensity (float i) = 0;
00056   virtual float GetIntensity () = 0;
00058   virtual csHaloType GetType () = 0;
00059 };
00060 
00061 SCF_VERSION (iCrossHalo, 0, 0, 1);
00062 
00066 struct iCrossHalo : public iBase
00067 {
00069   virtual void SetIntensityFactor (float i) = 0;
00071   virtual float GetIntensityFactor () = 0;
00073   virtual void SetCrossFactor (float i) = 0;
00075   virtual float GetCrossFactor () = 0;
00076 };
00077 
00078 SCF_VERSION (iNovaHalo, 0, 0, 1);
00079 
00083 struct iNovaHalo : public iBase
00084 {
00086   virtual void SetRandomSeed (int s) = 0;
00088   virtual int GetRandomSeed () = 0;
00090   virtual void SetSpokeCount (int s) = 0;
00092   virtual int GetSpokeCount () = 0;
00094   virtual void SetRoundnessFactor (float r) = 0;
00096   virtual float GetRoundnessFactor () = 0;
00097 };
00098 
00099 SCF_VERSION (iFlareHalo, 0, 0, 1);
00100 
00104 struct iFlareHalo : public iBase
00105 {
00111   virtual void AddComponent (float pos, float w, float h, uint mode,
00112     iMaterialWrapper *image) = 0;
00113 };
00114 
00117 #endif // __CS_IENGINE_HALO_H__

Generated for Crystal Space by doxygen 1.3.9.1