crystalspace.jbind.interfaces.imesh.lighting
Interface iLightingInfo

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csLightingInfo

public interface iLightingInfo

extends iBase

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, ...

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/devapi/structiLightingInfo.php

Method Summary

csColor	getDynamicAmbientLight() Get dynamic ambient light.
void	initializeDefault(boolean clear) Initialize the lighting information to some default (mostly black);.
void	lightChanged(iLight light) Indicate that some light has changed.
void	lightDisconnect(iLight light) Indicate that some light no longer affects this mesh.
void	prepareLighting() Finally prepare the lighting for use.
boolean	readFromCache(iCacheManager cache_mgr) Read the lighting information from the cache.
void	setDynamicAmbientLight(csColor color) Sets dynamic ambient light for this object.
boolean	writeToCache(iCacheManager cache_mgr) Write the lighting information to the cache.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

getDynamicAmbientLight

public csColor getDynamicAmbientLight()

Get dynamic ambient light. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

Returns:

initializeDefault

public void initializeDefault(boolean clear)

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. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

Parameters:

clear -

lightChanged

public void lightChanged(iLight light)

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. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

Parameters:

light -

lightDisconnect

public void lightDisconnect(iLight light)

Indicate that some light no longer affects this mesh. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

Parameters:

light -

prepareLighting

public void prepareLighting()

Finally prepare the lighting for use. This function must be called last. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

readFromCache

public boolean readFromCache(iCacheManager cache_mgr)

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. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

Parameters:

cache_mgr -

Returns:

setDynamicAmbientLight

public void setDynamicAmbientLight(csColor color)

Sets dynamic ambient light for this object. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

Parameters:

color -

writeToCache

public boolean writeToCache(iCacheManager cache_mgr)

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. Implemented in csBezierMesh::LightingInfo, and csThing::LightingInfo.

Parameters:

cache_mgr -

Returns: