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 #include "csgeom/vector4.h"
00031 
00032 struct iMaterialWrapper;
00033 
00037 enum csHaloType
00038 {
00040   cshtCross,
00042   cshtNova,
00044   cshtFlare
00045 };
00046 
00050 struct iBaseHalo : public virtual iBase
00051 {
00052   SCF_INTERFACE(iBaseHalo,2,0,0);
00054   virtual void SetIntensity (float i) = 0;
00056   virtual float GetIntensity () = 0;
00058   virtual csHaloType GetType () = 0;
00059 };
00060 
00064 struct iCrossHalo : public virtual iBase
00065 {
00066   SCF_INTERFACE(iCrossHalo,2,0,0);
00068   virtual void SetIntensityFactor (float i) = 0;
00070   virtual float GetIntensityFactor () = 0;
00072   virtual void SetCrossFactor (float i) = 0;
00074   virtual float GetCrossFactor () = 0;
00075 };
00076 
00080 struct iNovaHalo : public virtual iBase
00081 {
00082   SCF_INTERFACE(iNovaHalo,2,0,0);
00084   virtual void SetRandomSeed (int s) = 0;
00086   virtual int GetRandomSeed () = 0;
00088   virtual void SetSpokeCount (int s) = 0;
00090   virtual int GetSpokeCount () = 0;
00092   virtual void SetRoundnessFactor (float r) = 0;
00094   virtual float GetRoundnessFactor () = 0;
00095 };
00096 
00100 struct iFlareHalo : public virtual iBase
00101 {
00102   SCF_INTERFACE(iFlareHalo,2,0,0);
00109   virtual uint AddComponent (float pos, float w, float h, uint mode,
00110     iMaterialWrapper *image) = 0;
00111 
00115   virtual void SetComponentColor (uint component, const csVector4& color) = 0;
00116 };
00117 
00120 #endif // __CS_IENGINE_HALO_H__

Generated for Crystal Space by doxygen 1.4.7