CrystalSpace

Public API Reference

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

iLightingInfo Struct Reference

This interface is implemented by mesh objects that have some kind of lighting system. More...

#include <lighting.h>

Inheritance diagram for iLightingInfo:

iBase List of all members.

Public Methods

virtual void InitializeDefault (bool clear)=0
 Initialize the lighting information to some default (mostly black). More...

virtual bool ReadFromCache (iCacheManager *cache_mgr)=0
 Read the lighting information from the cache. More...

virtual bool WriteToCache (iCacheManager *cache_mgr)=0
 Write the lighting information to the cache. More...

virtual void PrepareLighting ()=0
 Finally prepare the lighting for use. More...

virtual void SetDynamicAmbientLight (const csColor &color)=0
 Sets dynamic ambient light for this object. More...

virtual const csColorGetDynamicAmbientLight ()=0
 Get dynamic ambient light. More...

virtual void DynamicLightChanged (iDynLight *dynlight)=0
 Indicate that some dynamic light has changed. More...

virtual void DynamicLightDisconnect (iDynLight *dynlight)=0
 Indicate that some dynamic light no longer affects this mesh. More...

virtual void StaticLightChanged (iStatLight *statlight)=0
 Indicate that some pseudo-dynamic light has changed color. More...

virtual void StaticLightDisconnect (iStatLight *statlight)=0
 Indicate that some pseudo-dynamic light no longer affects this mesh. More...


Detailed Description

This interface is implemented by mesh objects that have some kind of lighting system.

It has features to initialize lighting, to read it from a cache, ...

Definition at line 35 of file imesh/lighting.h.


Member Function Documentation

virtual void iLightingInfo::DynamicLightChanged iDynLight   dynlight [pure virtual]
 

Indicate that some dynamic light has changed.

This function will be called by the lighting system whenever a dynamic light that affects this mesh is changed in some way.

virtual void iLightingInfo::DynamicLightDisconnect iDynLight   dynlight [pure virtual]
 

Indicate that some dynamic light no longer affects this mesh.

virtual const csColor& iLightingInfo::GetDynamicAmbientLight   [pure virtual]
 

Get dynamic ambient light.

virtual void iLightingInfo::InitializeDefault bool    clear [pure virtual]
 

Initialize the lighting information to some default (mostly black).

If clear is true then the lighting is really cleared to black. Otherwise the lighting system is just warned that lighting information is going to be added. This is useful in case a single light is added.

virtual void iLightingInfo::PrepareLighting   [pure virtual]
 

Finally prepare the lighting for use.

This function must be called last.

virtual bool iLightingInfo::ReadFromCache iCacheManager   cache_mgr [pure virtual]
 

Read the lighting information from the cache.

Call this instead of InitializeDefault(). Returns false if there was a problem. This function will read the data from the current VFS dir.

virtual void iLightingInfo::SetDynamicAmbientLight const csColor   color [pure virtual]
 

Sets dynamic ambient light for this object.

virtual void iLightingInfo::StaticLightChanged iStatLight   statlight [pure virtual]
 

Indicate that some pseudo-dynamic light has changed color.

virtual void iLightingInfo::StaticLightDisconnect iStatLight   statlight [pure virtual]
 

Indicate that some pseudo-dynamic light no longer affects this mesh.

virtual bool iLightingInfo::WriteToCache iCacheManager   cache_mgr [pure virtual]
 

Write the lighting information to the cache.

Returns false if there was a problem. This function will write the data to the current VFS dir.


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