CrystalSpace

Public API Reference

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

iLightingProcessInfo Struct Reference
[Lighting]

The iLightingProcessInfo interface holds information for the lighting system. More...

#include <light.h>

Inheritance diagram for iLightingProcessInfo:

iFrustumViewUserdata iBase List of all members.

Public Methods

virtual iLightGetLight () const=0
 Get the light.

virtual bool IsDynamic () const=0
 Return true if dynamic.

virtual void SetColor (const csColor &col)=0
 Set the current color.

virtual const csColorGetColor () const=0
 Get the current color.

virtual void AttachUserdata (iLightingProcessData *userdata)=0
 Attach some userdata to the process info.

virtual csPtr< iLightingProcessDataQueryUserdata (scfInterfaceID id, int version)=0
 Query for userdata based on SCF type.

virtual void FinalizeLighting ()=0
 Finalize lighting.


Detailed Description

The iLightingProcessInfo interface holds information for the lighting system.

You can query the userdata from iFrustumView for this interface while in a 'portal' callback. This way you can get specific information from the lighting system for your null-portal.

Definition at line 397 of file light.h.


Member Function Documentation

virtual void iLightingProcessInfo::AttachUserdata iLightingProcessData   userdata [pure virtual]
 

Attach some userdata to the process info.

You can later query for this by doing QueryUserdata() with the correct SCF version number.

virtual void iLightingProcessInfo::FinalizeLighting   [pure virtual]
 

Finalize lighting.

This function is called by the lighting routines after performing CheckFrustum(). It will call FinalizeLighting() on all user datas.

virtual const csColor& iLightingProcessInfo::GetColor   [pure virtual]
 

Get the current color.

virtual iLight* iLightingProcessInfo::GetLight   [pure virtual]
 

Get the light.

virtual bool iLightingProcessInfo::IsDynamic   [pure virtual]
 

Return true if dynamic.

virtual csPtr<iLightingProcessData> iLightingProcessInfo::QueryUserdata scfInterfaceID    id,
int    version
[pure virtual]
 

Query for userdata based on SCF type.

virtual void iLightingProcessInfo::SetColor const csColor   col [pure virtual]
 

Set the current color.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18