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:

Public Methods | |
virtual void | InitializeDefault (bool clear)=0 |
Initialize the lighting information to some default (mostly black). | |
virtual bool | ReadFromCache (iCacheManager *cache_mgr)=0 |
Read the lighting information from the cache. | |
virtual bool | WriteToCache (iCacheManager *cache_mgr)=0 |
Write the lighting information to the cache. | |
virtual void | PrepareLighting ()=0 |
Finally prepare the lighting for use. | |
virtual void | SetDynamicAmbientLight (const csColor &color)=0 |
Sets dynamic ambient light for this object. | |
virtual const csColor & | GetDynamicAmbientLight ()=0 |
Get dynamic ambient light. | |
virtual void | LightChanged (iLight *light)=0 |
Indicate that some light has changed. | |
virtual void | LightDisconnect (iLight *light)=0 |
Indicate that some light no longer affects this mesh. |
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 33 of file lighting.h.
Member Function Documentation
|
Get dynamic ambient light.
|
|
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. |
|
Indicate that some light has changed. This function will be called by the lighting system whenever a light that affects this mesh is changed in some way. |
|
Indicate that some light no longer affects this mesh.
|
|
Finally prepare the lighting for use. This function must be called last. |
|
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. |
|
Sets dynamic ambient light for this object.
|
|
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:
- imesh/lighting.h
Generated for Crystal Space by doxygen 1.2.18