NL3D::CShadowMapManager Class Reference

A class to manage the render of shadow map. More...

#include <shadow_map_manager.h>

Public Member Functions
	CShadowMapManager ()
	Constructor.
	~CShadowMapManager ()
void	setQuadGridSize (uint size, float cellSize)
	change the QuadGrid size. it reset all the receivers!
void	clearAllShadowCasters ()
	clear both _ShadowCasters and _GenerateShadowCasters lists WARNING: the _GenerateShadowCasters list of shadow caster (added with addShadowCaster() / selectShadowMapsToGenerate()) must have valid Ptrs.
void	addShadowCaster (CTransform *model)
	Add a ShadowCaster that influence the scene this pass.
void	selectShadowMapsToGenerate (CScene *scene)
	From List of ShadowCaster, select a sub - part (so called Loding ShadowMap Casters) NB: Beware that this clear the currentlist of shadowMap to generate NB: model->setGeneratingShadowMap(true); are called for each model selected.
void	addShadowReceiver (CTransform *model)
	Add a ShadowRecevier visible in this scene for this pass.
void	renderGenerate (CScene *scene)
	render ShadowMap with ShadowCasters.
void	renderProject (CScene *scene)
	project ShadowMaps onto receivers.
void	enableShadowPolySmooth (bool enable)
	Enable Polygon Smoothing.
bool	getEnableShadowPolySmooth () const
	get Enable Polygon Smoothing flag
CMaterial &	getCasterShadowMaterial ()
	Get the typical Material for Caster.
Texture Allocation

ITexture *	allocateTexture (uint textSize)
	Allocate a texture for a shadowMap. NB: owned by a smartPtr. nlassert powerof2.
void	releaseTexture (ITexture *text)
	Release this one.
Private Types
typedef CQuadGrid< CTransform * >	TShadowReceiverGrid
typedef std::map< ITexture *, CSmartPtr< ITexture > >	TTextureMap
typedef TTextureMap::iterator	ItTextureMap
Private Member Functions
void	computeShadowDirection (CScene scene, CTransform sc, CVector &lightDir)
void	computeShadowColors (CScene scene, CTransform sc, CRGBA &ambient, CRGBA &diffuse)
void	fillBlackBorder (IDriver *drv, uint numPassText, uint numTextW, uint numTextH, uint baseTextureSize)
void	setBlackQuad (uint index, sint x, sint y, sint w, sint h)
void	updateBlurTexture (IDriver &drv, uint w, uint h)
void	copyScreenToBlurTexture (IDriver *drv, uint numPassText, uint numTextW, uint numTextH, uint baseTextureSize)
void	applyFakeGaussianBlur (IDriver *drv, uint numPassText, uint numTextW, uint numTextH, uint baseTextureSize, uint blurSource)
void	setBlurQuadFakeGaussian (uint index, sint x, sint y, sint w, sint h)
void	clearGenerateShadowCasters ()
void	garbageShadowTextures (CScene *scene)
Private Attributes
std::vector< CTransform * >	_ShadowCasters
std::vector< CTransform * >	_GenerateShadowCasters
TShadowReceiverGrid	_ShadowReceiverGrid
bool	_PolySmooth
CVertexBuffer	_FillQuads
CMaterial	_FillMaterial
CSmartPtr< ITexture >	_BlurTexture [2]
uint32	_BlurTextureW
uint32	_BlurTextureH
float	_BlurTextureOOW
float	_BlurTextureOOH
float	_BlurTextureD05W
float	_BlurTextureD05H
CMaterial	_BlurMaterial [2]
CVertexBuffer	_BlurQuads
CVertexBuffer	_CopyQuads
CMaterial	_CopyMaterial
CMaterial	_ReceiveShadowMaterial
NLMISC::CSmartPtr< ITexture >	_ClampTexture
CShadowMapProjector	_ShadowMapProjector
CMaterial	_CasterShadowMaterial
TTextureMap	_ShadowTextureMap
std::vector< ItTextureMap >	_FreeShadowTextures
NLMISC::CSmartPtr < ITexture::CTextureCategory >	_TextureCategory

Detailed Description

A class to manage the render of shadow map.

Author:: Lionel Berenguier; Nevrax France

Date:: 2003

Definition at line 56 of file shadow_map_manager.h.

Member Typedef Documentation

typedef TTextureMap::iterator NL3D::CShadowMapManager::ItTextureMap [private]

Definition at line 170 of file shadow_map_manager.h.

typedef CQuadGrid<CTransform*> NL3D::CShadowMapManager::TShadowReceiverGrid [private]

Definition at line 122 of file shadow_map_manager.h.

typedef std::map<ITexture *, CSmartPtr<ITexture> > NL3D::CShadowMapManager::TTextureMap [private]

Definition at line 169 of file shadow_map_manager.h.

Constructor & Destructor Documentation

NL3D::CShadowMapManager::CShadowMapManager ( )

Constructor.

Definition at line 58 of file shadow_map_manager.cpp.

NL3D::CShadowMapManager::~CShadowMapManager ( )

Definition at line 224 of file shadow_map_manager.cpp.

References clearAllShadowCasters().

Member Function Documentation

void NL3D::CShadowMapManager::addShadowCaster ( CTransform * model )

Add a ShadowCaster that influence the scene this pass.

Definition at line 236 of file shadow_map_manager.cpp.

References _ShadowCasters.

Referenced by NL3D::CClipTrav::clipShadowCasters().

void NL3D::CShadowMapManager::addShadowReceiver ( CTransform * model )

Add a ShadowRecevier visible in this scene for this pass.

Definition at line 242 of file shadow_map_manager.cpp.

References _ShadowReceiverGrid, NLMISC::CAABBox::getMax(), NLMISC::CAABBox::getMin(), NL3D::CTransform::getReceiverBBox(), and NL3D::CQuadGrid< T >::insert().

Referenced by NL3D::CLandscapeModel::traverseRender().

ITexture * NL3D::CShadowMapManager::allocateTexture ( uint textSize )

Allocate a texture for a shadowMap. NB: owned by a smartPtr. nlassert powerof2.

Definition at line 1150 of file shadow_map_manager.cpp.

References _FreeShadowTextures, _ShadowTextureMap, _TextureCategory, NL3D::ITexture::Clamp, NL3D::ITexture::generate(), NLMISC::CBitmap::getWidth(), NLMISC::isPowerOf2(), NL3D::ITexture::Linear, NL3D::ITexture::LinearMipMapOff, nlassert, NL3D::ITexture::setFilterMode(), NL3D::ITexture::setReleasable(), NL3D::ITexture::setRenderTarget(), NL3D::ITexture::setTextureCategory(), NL3D::ITexture::setWrapS(), and NL3D::ITexture::setWrapT().

Referenced by NL3D::CShadowMap::initTexture().

void NL3D::CShadowMapManager::applyFakeGaussianBlur	(	IDriver *	drv,
		uint	numPassText,
		uint	numTextW,
		uint	numTextH,
		uint	baseTextureSize,
		uint	blurSource
	)			`[private]`

Definition at line 984 of file shadow_map_manager.cpp.

References _BlurMaterial, _BlurQuads, NL3D::IDriver::activeVertexBuffer(), NL3D::IDriver::renderRawQuads(), and setBlurQuadFakeGaussian().

Referenced by renderGenerate().

void NL3D::CShadowMapManager::clearAllShadowCasters ( )

clear both _ShadowCasters and _GenerateShadowCasters lists WARNING: the _GenerateShadowCasters list of shadow caster (added with addShadowCaster() / selectShadowMapsToGenerate()) must have valid Ptrs.

=> Cannot leave this list non empty at end of CScene::render() because some CTransform may be deleted between render()

Definition at line 1129 of file shadow_map_manager.cpp.

References _ShadowCasters, _ShadowReceiverGrid, NL3D::CQuadGrid< T >::clear(), and clearGenerateShadowCasters().

Referenced by renderGenerate(), NL3D::CScene::renderPart(), renderProject(), and ~CShadowMapManager().

void NL3D::CShadowMapManager::clearGenerateShadowCasters ( ) [private]

Definition at line 1138 of file shadow_map_manager.cpp.

References _GenerateShadowCasters.

Referenced by clearAllShadowCasters(), renderGenerate(), and selectShadowMapsToGenerate().

void NL3D::CShadowMapManager::computeShadowColors	(	CScene *	scene,
		CTransform *	sc,
		CRGBA &	ambient,
		CRGBA &	diffuse
	)			`[private]`

Definition at line 787 of file shadow_map_manager.cpp.

References NL3D::CLightContribution::AttFactor, NLMISC::CRGBA::B, NL3D::CLightContribution::computeCurrentAmbient(), NLMISC::CRGBA::G, NL3D::CPointLight::getDiffuse(), NL3D::CTransform::getLightContribution(), NL3D::CScene::getSunAmbient(), NL3D::CScene::getSunDiffuse(), min, NL3D_MAX_LIGHT_CONTRIBUTION, NL3D::CLightContribution::PointLight, NLMISC::CRGBA::R, and NL3D::CLightContribution::SunContribution.

Referenced by renderProject().

void NL3D::CShadowMapManager::computeShadowDirection	(	CScene *	scene,
		CTransform *	sc,
		CVector &	lightDir
	)			`[private]`

void NL3D::CShadowMapManager::copyScreenToBlurTexture	(	IDriver *	drv,
		uint	numPassText,
		uint	numTextW,
		uint	numTextH,
		uint	baseTextureSize
	)			`[private]`

Definition at line 967 of file shadow_map_manager.cpp.

void NL3D::CShadowMapManager::enableShadowPolySmooth ( bool enable ) [inline]

Enable Polygon Smoothing.

Definition at line 96 of file shadow_map_manager.h.

References _PolySmooth.

Referenced by NL3D::CScene::enableShadowPolySmooth().

void NL3D::CShadowMapManager::fillBlackBorder	(	IDriver *	drv,
		uint	numPassText,
		uint	numTextW,
		uint	numTextH,
		uint	baseTextureSize
	)			`[private]`

Definition at line 830 of file shadow_map_manager.cpp.

References _FillMaterial, _FillQuads, NL3D::IDriver::activeVertexBuffer(), NL3D::IDriver::renderRawQuads(), setBlackQuad(), NL3D::CMaterial::setColor(), and NL3D::CVertexBuffer::setNumVertices().

Referenced by renderGenerate().

void NL3D::CShadowMapManager::garbageShadowTextures ( CScene * scene ) [private]

Definition at line 1209 of file shadow_map_manager.cpp.

References _FreeShadowTextures, _ShadowTextureMap, NL3D::CScene::getShadowMapTextureSize(), and NL3D_SMM_MAX_FREETEXT.

Referenced by renderGenerate().

CMaterial& NL3D::CShadowMapManager::getCasterShadowMaterial ( ) [inline]

Get the typical Material for Caster.

Definition at line 101 of file shadow_map_manager.h.

References _CasterShadowMaterial.

Referenced by NL3D::CSkeletonModel::generateShadowMap(), and NL3D::CMeshInstance::generateShadowMap().

bool NL3D::CShadowMapManager::getEnableShadowPolySmooth ( ) const [inline]

get Enable Polygon Smoothing flag

Definition at line 98 of file shadow_map_manager.h.

References _PolySmooth.

Referenced by NL3D::CScene::getEnableShadowPolySmooth().

void NL3D::CShadowMapManager::releaseTexture ( ITexture * text )

Release this one.

NB: the texture is not deleted, but still will be used for later use

Definition at line 1196 of file shadow_map_manager.cpp.

References _FreeShadowTextures, _ShadowTextureMap, and nlassert.

Referenced by NL3D::CShadowMap::resetTexture().

void NL3D::CShadowMapManager::renderGenerate ( CScene * scene )

render ShadowMap with ShadowCasters.

Generate ShadowMap only (with the AuxDriver). NB: current driver Frustum, ViewMatrix kept their initial state but ModelMatrix not.

Definition at line 251 of file shadow_map_manager.cpp.

References _BlurTexture, _BlurTextureH, _BlurTextureOOH, _BlurTextureOOW, _BlurTextureW, _CopyMaterial, _CopyQuads, _GenerateShadowCasters, _PolySmooth, _ShadowCasters, NL3D::IDriver::activeVertexBuffer(), applyFakeGaussianBlur(), NLMISC::clamp(), NL3D::IDriver::clear2D(), clearAllShadowCasters(), clearGenerateShadowCasters(), computeShadowDirection(), NL3D::IDriver::enableFog(), NL3D::IDriver::enablePolygonSmoothing(), fillBlackBorder(), NL3D::IDriver::fogEnabled(), garbageShadowTextures(), NL3D::CTransform::generateShadowMap(), NL3D::CRenderTrav::getAuxDriver(), NL3D::CScene::getNumRender(), NL3D::CScene::getRenderTrav(), NL3D::CTransform::getShadowMap(), NL3D::CScene::getShadowMapBlurSize(), NL3D::CScene::getShadowMapTextureSize(), NL3D::CShadowMap::getTexture(), NL3D::IDriver::getViewport(), NL3D::IDriver::getWindowSize(), H_AUTO, NLMISC::CMatrix::Identity, NL3D::CScissor::init(), NL3D::CViewport::init(), NL3D::CViewport::initFullScreen(), NL3D::CScissor::initFullScreen(), NLMISC::isPowerOf2(), NL3D::CShadowMap::LastGenerationFrame, NL3D::CVertexBuffer::lock(), min, NL3D_SMM_MAX_TEXTDEST_SIZE, NLMISC::raiseToNextPowerOf2(), NL3D::IDriver::renderRawQuads(), NL3D::IDriver::setColorMask(), NL3D::IDriver::setFrustum(), NL3D::IDriver::setRenderTarget(), NL3D::CVertexBufferReadWrite::setTexCoord(), NL3D::CMaterial::setTexture(), NL3D::CRenderTrav::setupDriverCamera(), NL3D::IDriver::setupModelMatrix(), NL3D::IDriver::setupScissor(), NL3D::IDriver::setupViewMatrix(), NL3D::IDriver::setupViewport(), and updateBlurTexture().

Referenced by NL3D::CRenderTrav::traverse().

void NL3D::CShadowMapManager::renderProject ( CScene * scene )

project ShadowMaps onto receivers.

NB: renderGenerate() must have been called before. NB: current driver Frustum, ViewMatrix kept their initial state but ModelMatrix not. call clearShadowCaster

Get The Mean Ambiant and Diffuse the caster receive (and cast, by approximation)

Finally "modulate" with FinalFade.

Definition at line 519 of file shadow_map_manager.cpp.

References _ReceiveShadowMaterial, _ShadowCasters, _ShadowMapProjector, _ShadowReceiverGrid, NL3D::CShadowMapProjector::applyToMaterial(), NLMISC::CRGBA::B, NL3D::CQuadGrid< T >::begin(), NLMISC::CRGBA::Black, NL3D::CQuadGrid< CTransform * >::CIterator, NLMISC::clamp(), clearAllShadowCasters(), computeShadowColors(), NL3D::IDriver::enableLight(), NL3D::CQuadGrid< T >::end(), G, NLMISC::CRGBA::G, NLMISC::CAABBox::getCenter(), NL3D::CRenderTrav::getDriver(), NL3D::CShadowMap::getFinalFade(), NL3D::IDriver::getFogColor(), NL3D::IDriver::getFogEnd(), NL3D::IDriver::getFogStart(), NLMISC::CAABBox::getMax(), NLMISC::CAABBox::getMin(), NLMISC::CMatrix::getPos(), NL3D::CTransform::getReceiverRenderWorldMatrix(), NL3D::CScene::getRenderTrav(), NL3D::CTransform::getShadowMap(), NL3D::CShadowMap::getTexture(), NL3D::CScene::getVisualCollisionManagerForShadow(), NL3D::CTransform::getWorldMatrix(), H_AUTO, NLMISC::CMatrix::invert(), NL3D::CShadowMap::LocalBoundingBox, NL3D::CShadowMap::LocalProjectionMatrix, nlassert, NLMISC::OptFastFloor(), NLMISC::CRGBA::R, NL3D::CVisualCollisionManager::receiveShadowMap(), NL3D::CTransform::receiveShadowMap(), NL3D::CRenderTrav::resetLightSetup(), NL3D::CQuadGrid< T >::select(), NLMISC::CAABBox::setCenter(), NL3D::CMaterial::setColor(), NLMISC::CMatrix::setPos(), NL3D::CMaterial::setTexture(), NL3D::IDriver::setupFog(), and NL3D::CShadowMapProjector::setWorldSpaceTextMat().

Referenced by NL3D::CRenderTrav::traverse().

void NL3D::CShadowMapManager::selectShadowMapsToGenerate ( CScene * scene )

From List of ShadowCaster, select a sub - part (so called Loding ShadowMap Casters) NB: Beware that this clear the currentlist of shadowMap to generate NB: model->setGeneratingShadowMap(true); are called for each model selected.

Definition at line 1064 of file shadow_map_manager.cpp.

References _GenerateShadowCasters, _ShadowCasters, NL3D::CTravCameraScene::CamPos, NL3D::CShadowMapSort::Caster, clearGenerateShadowCasters(), NL3D::UScene::FilterSkeleton, NL3D::CScene::getFilterRenderFlags(), NL3D::CShadowMap::getFinalFade(), NL3D::CScene::getNumRender(), NLMISC::CMatrix::getPos(), NL3D::CScene::getRenderTrav(), NL3D::CTransform::getShadowMap(), NL3D::CTransform::getWorldMatrix(), NL3D::CShadowMap::LastGenerationFrame, min, and NL3D::CShadowMapSort::Weight.