Public API Reference

                 

---

csHalo Class Reference

This is the basic class for all types of halos. More...

#include <halo.h>

Inheritance diagram for csHalo:

List of all members.

Public Methods
	csHalo (csHaloType iType)
	Constructor. More...
virtual	~csHalo ()
	Destructor. More...
virtual unsigned char *	Generate (int Size)=0
	Generate the alphamap for this halo of size Size x Size. More...
virtual float	GetIntensity ()
	Get halo intensity. More...
virtual void	SetIntensity (float iInt)
	Set halo intensity. More...
Public Attributes
csHaloType	Type
	The type of halo. More...

---

Detailed Description

This is the basic class for all types of halos.

The csLight class contains a pointer to a object derived from this class.

Definition at line 35 of file csengine/halo.h.

---

Constructor & Destructor Documentation

csHalo::csHalo (  csHaloType    iType )

Constructor.

virtual csHalo::~csHalo (    )  [virtual]

Destructor.

---

Member Function Documentation

virtual unsigned char* csHalo::Generate (  int    Size )  [pure virtual]

Generate the alphamap for this halo of size Size x Size. Implemented in csCrossHalo.

virtual float csHalo::GetIntensity (    )  [inline, virtual]

Get halo intensity. Implements iBaseHalo. Definition at line 53 of file csengine/halo.h.

virtual void csHalo::SetIntensity (  float    iInt )  [inline, virtual]

Set halo intensity. Implements iBaseHalo. Definition at line 55 of file csengine/halo.h.

---

Member Data Documentation

csHaloType csHalo::Type

The type of halo. Definition at line 42 of file csengine/halo.h.

---

The documentation for this class was generated from the following file:

• csengine/halo.h

---