#include "gfxlib.h"
#include "gl_light.h"
#include <stack>
#include <assert.h>
#include "vs_globals.h"
#include "config_xml.h"

Functions
void	GFXPushGlobalEffects ()

GFXBOOL	GFXPopGlobalEffects ()
	This function undoes the above function to restore the global lights after specialFX phase. More...

GFXBOOL	GFXSetCutoff (const float ttcutoff)
	Sets the intensity cutoff before picked lights are ignored. More...

void	GFXSetOptimalIntensity (const float intensity, const float saturate)
	Sets the optimal intensity given that Optimal number of lights is fulfilled. More...

GFXBOOL	GFXSetOptimalNumLights (const int numLights)
	Sets number of lights graphics can handle optimally. More...

GFXBOOL	GFXSetSeparateSpecularColor (const GFXBOOL spec)
	Sets the light model to have separate specular color (if available) More...

GFXBOOL	GFXLightContextAmbient (const GFXColor &amb)
	Sets the ambient light value. More...

GFXBOOL	GFXGetLightContextAmbient (GFXColor &amb)
	Gets the ambient light value. More...

GFXBOOL	GFXCreateLight (int &light, const GFXLight &templatecopy, const bool global)

void	GFXDeleteLight (const int light)
	Deletes a light, removing it from the light table if necessary. More...

GFXBOOL	GFXSetLight (const int light, const enum LIGHT_TARGET lt, const GFXColor &color)
	Modifies the parameters of the given light. More...

GFXBOOL	GFXEnableLight (int light)
	activates a light if not already activated More...

GFXBOOL	GFXDisableLight (int light)
	Deactivates an active light. More...

static void	SetupGLLightGlobals ()

void	GFXCreateLightContext (int &con_number)
	creates a light context (relevant to a star system) to add lights to More...

void	GFXDeleteLightContext (int con_number)
	Deletes a light context (hence a star system) More...

void	GFXSetLightContext (const int con_number)
	Sets active light context (restores all gllights in such context) More...

void	GFXDestroyAllLights ()

Variables
GLint	GFX_MAX_LIGHTS = 8

GLint	GFX_OPTIMAL_LIGHTS = 4

GFXBOOL	GFXLIGHTING = GFXFALSE

int	_currentContext = 0
	The curren tlight context. More...

vector< vector< gfx_light > >	_local_lights_dat
	The light data _llights points to one of these. More...

vector< GFXColor >	_ambient_light
	The ambient lights that are around. More...

vector< gfx_light > *	_llights = NULL
	The lights existing in a certain context. Points to _local_lights_dat. More...

OpenGLLights *	GLLights = NULL
	currently stored GL lights! More...

static stack< bool * >	GlobalEffects

static stack< bool * >	GlobalEffectsFreelist

static stack< GFXColor >	GlobalEffectsAmbient

Function Documentation

GFXBOOL GFXCreateLight	(	int &	light,
		const GFXLight &	,
		const bool	global
	)

GFXCreateLight gets a light as a parameter. It sets light to have the index of the created light for modification in the future. If the light is global, it will always affect objects in space. if the light is not global, it is local and goes into a 3d hashtable to be picked at a later point on a per object basis.

Definition at line 272 of file gl_light.cpp.

References _llights.

Referenced by Stars::Draw(), BaseInterface::Room::BaseShip::Draw(), Mesh::DrawNow(), SetupCloakState(), and Atmosphere::Update().

 {
     for (light = 0; light < static_cast<int>(_llights->size()); light++)
         if ( (*_llights)[light].Target() == -2 )
             break;
     if ( light == static_cast<int>(_llights->size()) )
         _llights->push_back( gfx_light() );
     return (*_llights)[light].Create( templatecopy, global );
 }

void GFXCreateLightContext ( int & con_number)

creates a light context (relevant to a star system) to add lights to

Definition at line 317 of file gl_light.cpp.

References _ambient_light, _currentContext, _local_lights_dat, GFXBOOL, GFXFALSE, GFXSetLightContext(), GFXTRUE, and SetupGLLightGlobals().

Referenced by GameStarSystem::GameStarSystem(), GFXInit(), and GameUniverse::StartGFX().

 {
     static GFXBOOL LightInit = GFXFALSE;
     if (!LightInit) {
         LightInit = GFXTRUE;
         SetupGLLightGlobals();
     }
     con_number = _local_lights_dat.size();
     _currentContext = con_number;
     _ambient_light.push_back( GFXColor( 0, 0, 0, 1 ) );
     _local_lights_dat.push_back( vector< gfx_light > () );
     GFXSetLightContext( con_number );
 }

void GFXDeleteLight ( const int light)

Deletes a light, removing it from the light table if necessary.

Definition at line 282 of file gl_light.cpp.

Referenced by Atmosphere::Draw(), Stars::Draw(), BaseInterface::Room::BaseShip::Draw(), Mesh::DrawNow(), and GamePlanet::Kill().

 {
     (*_llights)[light].Kill();
 }

void GFXDeleteLightContext ( int con_number)

Deletes a light context (hence a star system)

Definition at line 331 of file gl_light.cpp.

References _local_lights_dat.

 {
     _local_lights_dat[con_number] = vector< gfx_light > ();
 }

void GFXDestroyAllLights ( )

Definition at line 365 of file gl_light.cpp.

References lighttable.

Referenced by GFXShutdown().

 {
     lighttable.Clear();
     if (GLLights)
         free( GLLights );
 }

GFXBOOL GFXDisableLight ( int light)

Deactivates an active light.

Definition at line 306 of file gl_light.cpp.

References _llights, GFXFALSE, and GFXTRUE.

Referenced by GamePlanet::DisableLights(), and Atmosphere::Draw().

 {
     assert( light >= 0 && light <= static_cast<int>(_llights->size()) );
     if ( (*_llights)[light].Target() == -2 )
         return GFXFALSE;
     (*_llights)[light].Disable();
     return GFXTRUE;
 }

GFXBOOL GFXEnableLight ( int light)

activates a light if not already activated

Definition at line 296 of file gl_light.cpp.

References _llights, GFXFALSE, and GFXTRUE.

Referenced by GamePlanet::EnableLights(), and Atmosphere::Update().

 {
     assert( light >= 0 && light <= static_cast<int>(_llights->size()) );
     //return FALSE;
     if ( (*_llights)[light].Target() == -2 )
         return GFXFALSE;
     (*_llights)[light].Enable();
     return GFXTRUE;
 }

GFXBOOL GFXGetLightContextAmbient ( GFXColor & amb)

Gets the ambient light value.

Definition at line 264 of file gl_light.cpp.

References _ambient_light, _currentContext, GFXFALSE, and GFXTRUE.

Referenced by GameStarSystem::Draw(), SphereMesh::ProcessDrawQueue(), CityLights::ProcessDrawQueue(), Terrain::Render(), and Terrain::RenderAll().

 {
     if ( _currentContext >= static_cast<int>(_ambient_light.size()) )
         return GFXFALSE;
     amb = (_ambient_light[_currentContext]);
     return GFXTRUE;
 }

GFXBOOL GFXLightContextAmbient ( const GFXColor & amb)

Sets the ambient light value.

Definition at line 251 of file gl_light.cpp.

References _ambient_light, _currentContext, GFXColor::a, GFXColor::b, GFXColor::g, GFXFALSE, GFXTRUE, and GFXColor::r.

Referenced by GameStarSystem::Draw(), GFXPopGlobalEffects(), GFXPushGlobalEffects(), SphereMesh::ProcessDrawQueue(), CityLights::ProcessDrawQueue(), Terrain::Render(), Terrain::RenderAll(), and GameUniverse::StartGFX().

 {
     if ( _currentContext >= static_cast<int>(_ambient_light.size()) )
         return GFXFALSE;
     (_ambient_light[_currentContext]) = amb;
     //(_ambient_light[_currentContext])[1]=amb.g;
     //(_ambient_light[_currentContext])[2]=amb.b;
     //(_ambient_light[_currentContext])[3]=amb.a;
     float tmp[4] = {amb.r, amb.g, amb.b, amb.a};
     glLightModelfv( GL_LIGHT_MODEL_AMBIENT, tmp );
     return GFXTRUE;
 }

GFXBOOL GFXPopGlobalEffects ( )

This function undoes the above function to restore the global lights after specialFX phase.

Definition at line 67 of file gl_light.cpp.

References GFX_MAX_LIGHTS, GFXLightContextAmbient(), GlobalEffects, GlobalEffectsAmbient, GlobalEffectsFreelist, and i.

Referenced by GameStarSystem::Draw(), Stars::Draw(), and Mesh::ProcessUndrawnMeshes().

 {
     if ( GlobalEffects.empty() )
         return false;
     //VSFileSystem::Fprintf (stderr,"GES %d",GlobalEffects.size());
     for (int i = 0; i < GFX_MAX_LIGHTS; i++)
         if (GlobalEffects.top()[i])
             glEnable( GL_LIGHT0+i );
     
     if (GlobalEffectsFreelist.size() >= 10)
         delete[] GlobalEffects.top();
     else
         GlobalEffectsFreelist.push(GlobalEffects.top());
     GlobalEffects.pop();
     
     GFXLightContextAmbient( GlobalEffectsAmbient.top() );
     GlobalEffectsAmbient.pop();
     return true;
 }

void GFXPushGlobalEffects ( )

In the case of shields and other T&L based effects, the global lights must be disabled yet saved for later use while the selected lights are used shortly then disabled. This saves values of global lights

Definition at line 45 of file gl_light.cpp.

References _ambient_light, _currentContext, GFX_MAX_LIGHTS, GFXLightContextAmbient(), OpenGLL::GL_ENABLED, GlobalEffects, GlobalEffectsAmbient, GlobalEffectsFreelist, i, OpenGLLights::options, and unpicklights().

Referenced by Stars::Draw(), and Mesh::ProcessUndrawnMeshes().

 {
     bool *tmp;
     if (GlobalEffectsFreelist.empty()) {
         tmp = new bool[GFX_MAX_LIGHTS];
     } else {
         tmp = GlobalEffectsFreelist.top();
         GlobalEffectsFreelist.pop();
     }
     
     unpicklights();     //costly but necessary to get rid of pesky local enables that shoudln't be tagged to get reenabled
     for (int i = 0; i < GFX_MAX_LIGHTS; i++) {
         tmp[i] = ( 0 != (GLLights[i].options&OpenGLL::GL_ENABLED) );
         if (GLLights[i].options&OpenGLL::GL_ENABLED)
             glDisable( GL_LIGHT0+i );
     }
     //VSFileSystem::Fprintf (stderr,"PUSH %d",GlobalEffects.size());
     GlobalEffects.push( tmp );
     GlobalEffectsAmbient.push( _ambient_light[_currentContext] );
     GFXLightContextAmbient( GFXColor( 0, 0, 0, 1 ) );
 }

GFXBOOL GFXSetCutoff ( const float ttcutoff)

Sets the intensity cutoff before picked lights are ignored.

Definition at line 214 of file gl_light.cpp.

References GFXFALSE, GFXTRUE, and intensity_cutoff.

Referenced by SetupGLLightGlobals().

 {
     if (ttcutoff < 0)
         return GFXFALSE;
     intensity_cutoff = ttcutoff;
     return GFXTRUE;
 }

GFXBOOL GFXSetLight	(	const int	light,
		const enum LIGHT_TARGET	lt,
		const GFXColor &	color
	)

Modifies the parameters of the given light.

Definition at line 287 of file gl_light.cpp.

References _llights, GFXFALSE, and GFXTRUE.

Referenced by GamePlanet::Draw().

 {
     if ( (*_llights)[light].Target() == -2 )
         return GFXFALSE;
     (*_llights)[light].ResetProperties( lt, color );
 
     return GFXTRUE;
 }

void GFXSetLightContext ( const int con_number)

Sets active light context (restores all gllights in such context)

Definition at line 336 of file gl_light.cpp.

References _ambient_light, _currentContext, _llights, _local_lights_dat, GFX_MAX_LIGHTS, OpenGLL::GLL_OFF, i, OpenGLLights::index, lighttable, OpenGLLights::options, and unpicklights().

Referenced by ClientServerSetLightContext(), GFXCreateLightContext(), GameUniverse::StartGFX(), and GameStarSystem::SwapIn().

 {
     unpicklights();
     int GLLindex = 0;
     unsigned int i;
     lighttable.Clear();
     _currentContext = con_number;
     _llights = &_local_lights_dat[con_number];
     glLightModelfv( GL_LIGHT_MODEL_AMBIENT, (GLfloat*) &(_ambient_light[con_number]) );
     //reset all lights so they arean't in GLLights
     for (i = 0; i < _llights->size(); i++)
         (*_llights)[i].Target() = -1;
     for (i = 0; i < _llights->size() && GLLindex < GFX_MAX_LIGHTS; i++)
         if ( (*_llights)[i].enabled() ) {
             if ( (*_llights)[i].LocalLight() ) {
                 (*_llights)[i].AddToTable();
             } else {
                 GLLights[GLLindex].index = -1;                 //make it clobber completley! no trace of old light.
                 (*_llights)[i].ClobberGLLight( GLLindex );
                 GLLindex++;
             }
         }
     for (; GLLindex < GFX_MAX_LIGHTS; GLLindex++) {
         GLLights[GLLindex].index   = -1;
         GLLights[GLLindex].options = OpenGLL::GLL_OFF;
         glDisable( GL_LIGHT0+GLLindex );
     }
 }

void GFXSetOptimalIntensity	(	const float	intensity,
		const float	saturate
	)

Sets the optimal intensity given that Optimal number of lights is fulfilled.

Definition at line 222 of file gl_light.cpp.

References optintense, optsat, and saturate().

Referenced by SetupGLLightGlobals().

 {
     optintense = intensity;
     optsat     = saturate;
 }

GFXBOOL GFXSetOptimalNumLights ( const int numLights)

Sets number of lights graphics can handle optimally.

Definition at line 228 of file gl_light.cpp.

References GFX_MAX_LIGHTS, GFX_OPTIMAL_LIGHTS, GFXFALSE, and GFXTRUE.

Referenced by SetupGLLightGlobals().

 {
     if (numLights > GFX_MAX_LIGHTS || numLights < 0)
         return GFXFALSE;
     GFX_OPTIMAL_LIGHTS = numLights;
     return GFXTRUE;
 }

GFXBOOL GFXSetSeparateSpecularColor ( const GFXBOOL spec)

Sets the light model to have separate specular color (if available)

Definition at line 236 of file gl_light.cpp.

References GFXFALSE, and GFXTRUE.

Referenced by RestoreEnvmapState(), RestoreSpecMapState(), SetupEnvmapPass(), SetupGLLightGlobals(), SetupSpecMapFirstPass(), and SetupSpecMapSecondPass().

 {
 #if !defined (_WIN32) && !defined (__CYGWIN__)
     if (spec) {
         glLightModeli( GL_LIGHT_MODEL_COLOR_CONTROL, GL_SEPARATE_SPECULAR_COLOR );
     } else {
         glLightModeli( GL_LIGHT_MODEL_COLOR_CONTROL, GL_SINGLE_COLOR );
         return GFXFALSE;
     }
 #else
     return GFXFALSE;
 #endif
     return GFXTRUE;
 }

static void SetupGLLightGlobals ( )

static

Definition at line 372 of file gl_light.cpp.

References VegaConfig::getVariable(), GFX_MAX_LIGHTS, GFXFALSE, GFXSetCutoff(), GFXSetOptimalIntensity(), GFXSetOptimalNumLights(), GFXSetSeparateSpecularColor(), GFXTRUE, i, index, XMLSupport::parse_bool(), XMLSupport::parse_float(), XMLSupport::parse_int(), and vs_config.

Referenced by GFXCreateLightContext().

 {
     int i;
     glLightModeli( GL_LIGHT_MODEL_LOCAL_VIEWER, 1 );     //don't want lighting coming from infinity....we have to take the hit due to sphere mapping matrix tweaking
     //
     glGetIntegerv( GL_MAX_LIGHTS, &GFX_MAX_LIGHTS );
     if (!GLLights) {
         GLLights = (OpenGLLights*) malloc( sizeof (OpenGLLights)*GFX_MAX_LIGHTS );
         for (i = 0; i < GFX_MAX_LIGHTS; i++)
             GLLights[i].index = -1;
     }
     static float lightcutoff     = XMLSupport::parse_float( vs_config->getVariable( "graphics", "lightcutoff", ".06" ) );
     static float lightoptimalintensity =
         XMLSupport::parse_float( vs_config->getVariable( "graphics", "lightoptimalintensity", ".06" ) );
     static float lightsaturation = XMLSupport::parse_float( vs_config->getVariable( "graphics", "lightsaturation", ".95" ) );
     static int   numlights = XMLSupport::parse_int( vs_config->getVariable( "graphics", "numlights", "4" ) );
     static bool  separatespecularcolor =
         XMLSupport::parse_bool( vs_config->getVariable( "graphics", "separatespecularcolor", "false" ) );
 
     GFXSetCutoff( lightcutoff );
     GFXSetOptimalIntensity( lightoptimalintensity, lightsaturation );
     GFXSetOptimalNumLights( numlights );
     GFXSetSeparateSpecularColor( separatespecularcolor ? GFXTRUE : GFXFALSE );
 }