Public API Reference

                 

---

csFlareHalo Class Reference

This halo is used for (solar)flares. More...

#include <halo.h>

Inheritance diagram for csFlareHalo:

List of all members.

Public Methods
	csFlareHalo ()
	create an (empty) flare. More...
void	AddComponent (float pos, float w, float h, uint mode, iMaterialWrapper *image)
	Add a visual component to the flare. More...
csFlareComponent *	GetComponents () const
	Get the list of component. More...
virtual unsigned char *	Generate (int Size)
	Generate this halo's alpha map. More...
Public Attributes
csFlareHalo::FlareHalo	scfiFlareHalo
	iFlareHalo implementation. More...

---

Detailed Description

This halo is used for (solar)flares.

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

---

Constructor & Destructor Documentation

csFlareHalo::csFlareHalo (    )

create an (empty) flare.

---

Member Function Documentation

void csFlareHalo::AddComponent (  float    pos, float    w, float    h, uint    mode, iMaterialWrapper *    image )

Add a visual component to the flare. give position, size, image and mixmode. The component is added at the end of the list - to be displayed last.

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

Generate this halo's alpha map. Not used for this halo (returns 0) since the halo consists of multiple images. Implements csHalo.

csFlareComponent* csFlareHalo::GetComponents (    )  const [inline]

Get the list of component. Definition at line 172 of file csengine/halo.h.

---

Member Data Documentation

csFlareHalo::FlareHalo csFlareHalo::scfiFlareHalo

iFlareHalo implementation.

---

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

• csengine/halo.h

---