Public API Reference

Main Page Modules Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

csLight::Light Struct Reference

#include <light.h>

Inheritance diagram for csLight::Light:

Public Methods
virtual csLight *	GetPrivateObject ()
	Get private pointer to light object. UGLY. More...
virtual const char *	GetLightID ()
	Get the id of this light. This is a 16-byte MD5. More...
virtual iObject *	QueryObject ()
	Get the iObject for this light. More...
virtual const csVector3 &	GetCenter ()
	Get the position of this light. More...
virtual void	SetCenter (const csVector3 &pos)
	Set the position of this light. More...
virtual iSector *	GetSector ()
	Get the sector for this light. More...
virtual void	SetSector (iSector *sector)
	Set the sector for this light. More...
virtual float	GetRadius ()
	Get the radius. More...
virtual float	GetSquaredRadius ()
	Get the squared radius. More...
virtual float	GetInverseRadius ()
	Get the inverse radius. More...
virtual void	SetRadius (float r)
	Set the radius. More...
virtual const csColor &	GetColor ()
	Get the color of this light. More...
virtual void	SetColor (const csColor &col)
	Set the color of this light. More...
virtual bool	IsDynamic () const
	Return true if this light is pseudo-dynamic. More...
virtual int	GetAttenuation ()
	Return current attenuation mode. More...
virtual void	SetAttenuation (int a)
	Set attenuation mode. More...
virtual float	GetBrightnessAtDistance (float d)
	Get the brightness of a light at a given distance. More...
virtual iCrossHalo *	CreateCrossHalo (float intensity, float cross)
	Create a cross halo for this light. More...
virtual iNovaHalo *	CreateNovaHalo (int seed, int num_spokes, float roundness)
	Create a nova halo for this light. More...
virtual iFlareHalo *	CreateFlareHalo ()
	Create a flare halo for this light. More...
virtual csFlags &	GetFlags ()
	Get flags for this light. More...
virtual void	SetLightCallback (iLightCallback *cb)
	Set the light callback. More...
virtual void	RemoveLightCallback (iLightCallback *cb)
	Remove a light callback. More...
virtual int	GetLightCallbackCount () const
	Get the number of light callbacks. More...
virtual iLightCallback *	GetLightCallback (int idx) const
	Get the specified light callback. More...
virtual uint32	GetLightNumber () const
	Return a number that changes when the light changes (color, or position). More...

Detailed Description

iLight implementation.

Definition at line 330 of file csengine/light.h.

Member Function Documentation

virtual iCrossHalo* csLight::Light::CreateCrossHalo ( float intensity,

float cross

) [virtual]

Create a cross halo for this light.

Implements iLight.

virtual iFlareHalo* csLight::Light::CreateFlareHalo ( ) [virtual]

Create a flare halo for this light.

Implements iLight.

virtual iNovaHalo* csLight::Light::CreateNovaHalo ( int seed,

int num_spokes,

float roundness

) [virtual]

Create a nova halo for this light.

Implements iLight.

virtual int csLight::Light::GetAttenuation ( ) [inline, virtual]

Return current attenuation mode.

Implements iLight.
Definition at line 353 of file csengine/light.h.

virtual float csLight::Light::GetBrightnessAtDistance ( float d ) [inline, virtual]

Get the brightness of a light at a given distance.

Implements iLight.
Definition at line 356 of file csengine/light.h.

virtual const csVector3& csLight::Light::GetCenter ( ) [inline, virtual]

Get the position of this light.

Implements iLight.
Definition at line 336 of file csengine/light.h.

virtual const csColor& csLight::Light::GetColor ( ) [inline, virtual]

Get the color of this light.

Implements iLight.
Definition at line 349 of file csengine/light.h.

virtual csFlags& csLight::Light::GetFlags ( ) [inline, virtual]

Get flags for this light.
Supported flags:

CS_LIGHT_ACTIVEHALO
CS_LIGHT_THINGSHADOWS

Implements iLight.
Definition at line 377 of file csengine/light.h.
References csFlags::flags.

virtual float csLight::Light::GetInverseRadius ( ) [inline, virtual]

Get the inverse radius.

Implements iLight.
Definition at line 346 of file csengine/light.h.

virtual iLightCallback* csLight::Light::GetLightCallback ( int idx ) const [inline, virtual]

Get the specified light callback.

Implements iLight.
Definition at line 390 of file csengine/light.h.

virtual int csLight::Light::GetLightCallbackCount ( ) const [inline, virtual]

Get the number of light callbacks.

Implements iLight.
Definition at line 386 of file csengine/light.h.

virtual const char* csLight::Light::GetLightID ( ) [inline, virtual]

Get the id of this light. This is a 16-byte MD5.

Implements iLight.
Definition at line 334 of file csengine/light.h.

virtual uint32 csLight::Light::GetLightNumber ( ) const [inline, virtual]

Return a number that changes when the light changes (color, or position).

Implements iLight.
Definition at line 394 of file csengine/light.h.
References uint32.

virtual csLight* csLight::Light::GetPrivateObject ( ) [inline, virtual]

Get private pointer to light object. UGLY.

Implements iLight.
Definition at line 333 of file csengine/light.h.

virtual float csLight::Light::GetRadius ( ) [inline, virtual]

Get the radius.

Implements iLight.
Definition at line 344 of file csengine/light.h.

virtual iSector* csLight::Light::GetSector ( ) [virtual]

Get the sector for this light.

Implements iLight.

virtual float csLight::Light::GetSquaredRadius ( ) [inline, virtual]

Get the squared radius.

Implements iLight.
Definition at line 345 of file csengine/light.h.

virtual bool csLight::Light::IsDynamic ( ) const [inline, virtual]

Return true if this light is pseudo-dynamic.

Implements iLight.
Definition at line 351 of file csengine/light.h.

virtual iObject* csLight::Light::QueryObject ( ) [inline, virtual]

Get the iObject for this light.

Implements iLight.
Definition at line 335 of file csengine/light.h.

virtual void csLight::Light::RemoveLightCallback ( iLightCallback * cb ) [inline, virtual]

Remove a light callback.

Implements iLight.
Definition at line 382 of file csengine/light.h.

virtual void csLight::Light::SetAttenuation ( int a ) [inline, virtual]

Set attenuation mode.
The following values are possible (default is CS_ATTN_LINEAR):

CS_ATTN_NONE: light * 1
CS_ATTN_LINEAR: light * (radius - distance) / radius
CS_ATTN_INVERSE: light * (radius / distance)
CS_ATTN_REALISTIC: light * (radius^2 / distance^2)

Implements iLight.
Definition at line 354 of file csengine/light.h.

virtual void csLight::Light::SetCenter ( const csVector3 & pos ) [inline, virtual]

Set the position of this light.

Implements iLight.
Definition at line 337 of file csengine/light.h.

virtual void csLight::Light::SetColor ( const csColor & col ) [inline, virtual]

Set the color of this light.

Implements iLight.
Definition at line 350 of file csengine/light.h.

virtual void csLight::Light::SetLightCallback ( iLightCallback * cb ) [inline, virtual]

Set the light callback.
This will call IncRef() on the callback So make sure you call DecRef() to release your own reference.
Implements iLight.
Definition at line 378 of file csengine/light.h.

virtual void csLight::Light::SetRadius ( float r ) [inline, virtual]

Set the radius.

Implements iLight.
Definition at line 347 of file csengine/light.h.

virtual void csLight::Light::SetSector ( iSector * sector ) [virtual]

Set the sector for this light.

Implements iLight.

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

csengine/light.h

Generated for Crystal Space by doxygen 1.2.14

Public API Reference

csLight::Light Struct Reference

Public Methods

Detailed Description

Member Function Documentation