Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

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 ()=0
 Initialize the lighting information to some default (mostly black).

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

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

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

virtual void SetCacheName (const char *cachename)=0
 Set the name of the lightmap cache to use for this. More...

virtual const char* GetCacheName () const=0
 Get the name of the lightmap cache used for this. 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, ...


Member Function Documentation

const char * iLightingInfo::GetCacheName ( ) const [pure virtual]
 

Get the name of the lightmap cache used for this.

Returns NULL if none given.

void iLightingInfo::PrepareLighting ( ) [pure virtual]
 

Finally prepare the lighting for use.

This function must be called last.

bool iLightingInfo::ReadFromCache ( iCacheManager * cache_mgr,
int id ) [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. The id is used to uniquely identify the elements of this cache.

void iLightingInfo::SetCacheName ( const char * cachename ) [pure virtual]
 

Set the name of the lightmap cache to use for this.

If not given then the 'id' will be used for uniqueness.

bool iLightingInfo::WriteToCache ( iCacheManager * cache_mgr,
int id ) [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 id is used to uniquely identify the elements of this cache.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000