Public API Reference

               

---

iIsoLight Struct Reference

A light for the isometric engine. More...

#include <iso.h>

Inheritance diagram for iIsoLight:

List of all members.

Public Methods
virtual void	SetGrid (iIsoGrid *grid)=0
	set the grid for this light, first set the light dynamic if you want. More...
virtual iIsoGrid *	GetGrid () const=0
	get the grid for this light. More...
virtual csFlags &	Flags ()=0
	get the light flags (for get and set) (CSISO_LIGHT above). More...
virtual void	SetAttenuation (int attn)=0
	set attentuation type of light (CSISO_ATTN_... see above). More...
virtual int	GetAttenuation () const=0
	get attentuation type of light. More...
virtual void	SetPosition (const csVector3 &pos)=0
	set the position of the light. More...
virtual const csVector3 &	GetPosition () const=0
	get the position of the light. More...
virtual void	SetColor (const csColor &col)=0
	set the color of the light. More...
virtual const csColor &	GetColor () const=0
	get the color of the light. More...
virtual void	SetRadius (float radius)=0
	set the radius of the light. More...
virtual float	GetRadius () const=0
	get the radius of the light. More...
virtual void	ShineGrid ()=0
	shine the light, add light to all visible areas of the grid. More...
virtual void	ShineSprite (iIsoSprite *sprite)=0
	shine the light on a sprite, adding to all the vertex colors. More...
virtual iLight *	GetFakeLight ()=0
	return an iLight interface that mostly works. For internal use. More...
virtual float	GetVis (int gridx, int gridy) const=0
	how much does the light shine on a particular grid square? More...

---

Detailed Description

A light for the isometric engine.

Definition at line 502 of file iso.h.

---

Member Function Documentation

virtual csFlags& iIsoLight::Flags (    )  [pure virtual]

get the light flags (for get and set) (CSISO_LIGHT above).

virtual int iIsoLight::GetAttenuation (    )  const [pure virtual]

get attentuation type of light.

virtual const csColor& iIsoLight::GetColor (    )  const [pure virtual]

get the color of the light.

virtual iLight* iIsoLight::GetFakeLight (    )  [pure virtual]

return an iLight interface that mostly works. For internal use.

virtual iIsoGrid* iIsoLight::GetGrid (    )  const [pure virtual]

get the grid for this light.

virtual const csVector3& iIsoLight::GetPosition (    )  const [pure virtual]

get the position of the light.

virtual float iIsoLight::GetRadius (    )  const [pure virtual]

get the radius of the light.

virtual float iIsoLight::GetVis (  int    gridx, int    gridy )  const [pure virtual]

how much does the light shine on a particular grid square?

virtual void iIsoLight::SetAttenuation (  int    attn )  [pure virtual]

set attentuation type of light (CSISO_ATTN_... see above).

virtual void iIsoLight::SetColor (  const csColor &    col )  [pure virtual]

set the color of the light.

virtual void iIsoLight::SetGrid (  iIsoGrid *    grid )  [pure virtual]

set the grid for this light, first set the light dynamic if you want.

virtual void iIsoLight::SetPosition (  const csVector3 &    pos )  [pure virtual]

set the position of the light.

virtual void iIsoLight::SetRadius (  float    radius )  [pure virtual]

set the radius of the light.

virtual void iIsoLight::ShineGrid (    )  [pure virtual]

shine the light, add light to all visible areas of the grid.

virtual void iIsoLight::ShineSprite (  iIsoSprite *    sprite )  [pure virtual]

shine the light on a sprite, adding to all the vertex colors.

---

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

• iso.h

---