NL3D::CMeshVPPerPixelLight Class Reference

#include <meshvp_per_pixel_light.h>

Inheritance diagram for NL3D::CMeshVPPerPixelLight:

---

Detailed Description

This vertex program is used to perform perpixel lighting with meshs. Its ouputs are :

Coord Tex 0 : duplicate the tex Coord 0 set from the v.b. Coord Tex 1 : The light vector in tangent space. Coord Tex 2 : The half-angle vector in tangent space.

This is designed to work with material that got a 'PerPixelLighting' shader. Note that no bump is used with this shader.

It requires that the input mesh has its tangent space first column vector encoded in the 2nd texture coordinate. Other stages are not supported for now.

Note that this can be mixed with gouraud rendered light (the gouraud diffuse and specular component are still computed)

Author:

Nicolas Vizerie

Nevrax France

Date:

2002

Definition at line 58 of file meshvp_per_pixel_light.h.

Public Member Functions
	CMeshVPPerPixelLight ()
virtual std::string	getClassName ()=0
virtual float	getMaxVertexMove ()
const sint &	getRefCount () const
IMeshVertexProgram implementation
virtual bool	begin (IDriver *drv, CScene *scene, CMeshBaseInstance *mbi, const NLMISC::CMatrix &invertedModelMat, const NLMISC::CVector &viewerPos)
virtual void	end (IDriver *drv)
virtual void	initInstance (CMeshBaseInstance *mbi)
virtual bool	needTangentSpace () const
	NLMISC_DECLARE_CLASS (CMeshVPPerPixelLight)
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
virtual void	setupForMaterial (const CMaterial &mat, IDriver *drv, CScene *scene, IVertexBufferHard *vb)
virtual void	setupForMaterial (const CMaterial &mat, IDriver *drv, CScene *scene, CVertexBuffer *vb)
MBR support.
Actually, it's targeted to work optimally with WindTree. Requirement are: No special Validity test per instance (hence isMBRVpOk() takes only the driver). begin(), end(), setupForMaterial() is replaced with the following interface. there is no setupMBRMaterial(), because the caller has just to call per material (and must do it): renderTrav->changeVPLightSetupMaterial(mat, false); beginMBRMesh MUST activate the VertexProgram, because called before VB activation beginMBRInstance still can change of VertexProgram, but cannot disable VP!!
virtual void	beginMBRInstance (IDriver *drv, CScene *scene, CMeshBaseInstance *mbi, const NLMISC::CMatrix &invertedModelMat)
virtual void	beginMBRMesh (IDriver *drv, CScene *scene)
virtual void	endMBRMesh (IDriver *drv)
virtual bool	isMBRVpOk (IDriver *drv) const
virtual bool	supportMeshBlockRendering () const
MBR support.
Actually, it's targeted to work optimally with WindTree. Requirement are: No special Validity test per instance (hence isMBRVpOk() takes only the driver). begin(), end(), setupForMaterial() is replaced with the following interface. there is no setupMBRMaterial(), because the caller has just to call per material (and must do it): renderTrav->changeVPLightSetupMaterial(mat, false); beginMBRMesh MUST activate the VertexProgram, because called before VB activation beginMBRInstance still can change of VertexProgram, but cannot disable VP!!
virtual void	beginMBRInstance (IDriver *drv, CScene *scene, CMeshBaseInstance *mbi, const NLMISC::CMatrix &invertedModelMat)
virtual void	beginMBRMesh (IDriver *drv, CScene *scene)
virtual void	endMBRMesh (IDriver *drv)
virtual bool	isMBRVpOk (IDriver *drv) const
virtual bool	supportMeshBlockRendering () const
Data Fields
sint	crefs
CPtrInfo *	pinfo
bool	SpecularLighting
	true if want Specular Lighting.
Static Public Attributes
CPtrInfo	NullPtrInfo
Private Types
enum	{ NumVp = 8 }
Private Member Functions
void	enable (bool enabled, IDriver *drv)
virtual bool	setupForMaterial (const CMaterial &mat, IDriver *drv, CScene *scene)
Private Attributes
bool	_Enabled
bool	_IsPointLight
Static Private Attributes
std::auto_ptr< CVertexProgram >	_VertexProgram [NumVp]
Friends
struct	CPtrInfo

---

Member Enumeration Documentation

anonymous enum [private]

Enumeration values: NumVp  Definition at line 99 of file meshvp_per_pixel_light.h. { NumVp = 8};

---

Constructor & Destructor Documentation

NL3D::CMeshVPPerPixelLight::CMeshVPPerPixelLight (   )  [inline]

Definition at line 64 of file meshvp_per_pixel_light.h. References _Enabled, and SpecularLighting. : SpecularLighting(true), _Enabled(false) {}

---

Member Function Documentation

bool NL3D::CMeshVPPerPixelLight::begin (  IDriver *  drv, CScene *  scene, CMeshBaseInstance *  mbi, const NLMISC::CMatrix &  invertedModelMat, const NLMISC::CVector &  viewerPos )  [virtual]

Setup for gouraud lighting Todo: disabling of specular lighting with this shader Implements NL3D::IMeshVertexProgram. Definition at line 433 of file meshvp_per_pixel_light.cpp. References _IsPointLight, NL3D::CRenderTrav::beginVPLightSetup(), enable(), NL3D::CLight::getDirection(), NL3D::CRenderTrav::getDriverLight(), NL3D::CLight::getMode(), NL3D::CLight::getPosition(), NL3D::CScene::getRenderTrav(), NL3D::CRenderTrav::getStrongestLightIndex(), NL3D::IDriver::isVertexProgramEmulated(), NL3D::IDriver::isVertexProgramSupported(), NLMISC::CMatrix::mulVector(), NL3D::IDriver::setConstant(), NL3D::IDriver::setConstantMatrix(), sint, SpecularLighting, and NL3D::IDriver::supportPerPixelLighting(). { // test if supported by driver if (! (drv->isVertexProgramSupported() && !drv->isVertexProgramEmulated() && drv->supportPerPixelLighting(SpecularLighting) ) ) { return false; } // CRenderTrav *renderTrav= &scene->getRenderTrav(); renderTrav->beginVPLightSetup(VPLightConstantStart, SpecularLighting, invertedModelMat); // sint strongestLightIndex = renderTrav->getStrongestLightIndex(); if (strongestLightIndex == -1) return false; // if no strongest light, disable this vertex program // setup the strongest light const CLight &strongestLight = renderTrav->getDriverLight(strongestLightIndex); switch (strongestLight.getMode()) { case CLight::DirectionalLight: { // put light direction in object space NLMISC::CVector lPos = invertedModelMat.mulVector(strongestLight.getDirection()); drv->setConstant(4, lPos); _IsPointLight = false; } break; case CLight::PointLight: { // put light in object space NLMISC::CVector lPos = invertedModelMat * strongestLight.getPosition(); drv->setConstant(4, lPos); _IsPointLight = true; } break; default: return false; break; } if (SpecularLighting) { // viewer pos in object space NLMISC::CVector vPos = invertedModelMat * viewerPos; drv->setConstant(5, vPos); } // c[0..3] take the ModelViewProjection Matrix. After setupModelMatrix(); drv->setConstantMatrix(0, IDriver::ModelViewProjection, IDriver::Identity); // enable(true, drv); // must enable the vertex program before the vb is activated // return true; }

virtual void NL3D::IMeshVertexProgram::beginMBRInstance (  IDriver *  drv, CScene *  scene, CMeshBaseInstance *  mbi, const NLMISC::CMatrix &  invertedModelMat )  [inline, virtual, inherited]

Reimplemented in NL3D::CMeshVPWindTree. Definition at line 123 of file mesh_vertex_program.h. {};

virtual void NL3D::IMeshVertexProgram::beginMBRMesh (  IDriver *  drv, CScene *  scene )  [inline, virtual, inherited]

Reimplemented in NL3D::CMeshVPWindTree. Definition at line 122 of file mesh_vertex_program.h. {};

void NL3D::CMeshVPPerPixelLight::enable (  bool  enabled, IDriver *  drv )  [private]

Definition at line 517 of file meshvp_per_pixel_light.cpp. References _Enabled, _IsPointLight, NL3D::IDriver::activeVertexProgram(), NL3D::IDriver::isForceNormalize(), nlassert, SpecularLighting, and uint. Referenced by begin(), end(), and setupForMaterial(). { if (enabled != _Enabled) { nlassert(drv); if (enabled) { /* for (uint k = 0; k < NumVp; ++k) { nlinfo("test vp %d", k); drv->activeVertexProgram(_VertexProgram[k].get()); } */ uint idVP = (drv->isForceNormalize() ? 4 : 0) | (SpecularLighting ? 2 : 0) | (_IsPointLight ? 1 : 0); // drv->activeVertexProgram(_VertexProgram[idVP].get()); } else { drv->activeVertexProgram(NULL); } _Enabled = enabled; } }

void NL3D::CMeshVPPerPixelLight::end (  IDriver *  drv  )  [virtual]

Setup for gouraud lighting Todo: disabling of specular lighting with this shader Implements NL3D::IMeshVertexProgram. Definition at line 502 of file meshvp_per_pixel_light.cpp. References enable(). { enable(false, drv); }

virtual void NL3D::IMeshVertexProgram::endMBRMesh (  IDriver *  drv  )  [inline, virtual, inherited]

Reimplemented in NL3D::CMeshVPWindTree. Definition at line 124 of file mesh_vertex_program.h. {}

virtual std::string NLMISC::IClassable::getClassName (   )  [pure virtual, inherited]

Implemented in NLAIAGENT::CNumericIndex, NLAIC::IPointerGestion, NLAIC::CIdentType, and CAutomataDesc. Referenced by NLMISC::CClassRegistry::checkObject(), and NL3D::GetTextureSize().

virtual float NL3D::IMeshVertexProgram::getMaxVertexMove (   )  [inline, virtual, inherited]

This return the (over-evaluated) max delta the VertexProgram apply to vertex (in world basis) NB: This method call is relevant only after begin() or beginMBRInstance() Reimplemented in NL3D::CMeshVPWindTree. Definition at line 131 of file mesh_vertex_program.h. {return 0;}

const sint& NLMISC::CRefCount::getRefCount (   )  const [inline, inherited]

Definition at line 70 of file smart_ptr.h. References NLMISC::CRefCount::crefs, and sint. { return crefs; }

void NL3D::CMeshVPPerPixelLight::initInstance (  CMeshBaseInstance *  mbi  )  [virtual]

Setup for gouraud lighting Todo: disabling of specular lighting with this shader Implements NL3D::IMeshVertexProgram. Definition at line 371 of file meshvp_per_pixel_light.cpp. References nlassert, nlwarning, NumVp, CVPParser::parse(), NL3D::PPLightingDirectionnalNoSpecVPCodeBegin, NL3D::PPLightingDirectionnalNoSpecVPNormalizeCodeBegin, NL3D::PPLightingDirectionnalVPCodeBegin, NL3D::PPLightingDirectionnalVPNormalizeCodeBegin, NL3D::PPLightingNoSpecVPCodeBegin, NL3D::PPLightingVPCodeBegin, NL3D::PPLightingVPCodeEnd, NL3D::PPLightingVPNormalizeCodeBegin, NL3D::PPLightingVPNormalizeNoSpecCodeBegin, CVPParser::TProgram, and uint. { // init the vertexProgram code. static bool vpCreated= false; if(!vpCreated) { vpCreated= true; // Gives each vp name // Bit 0 : 1 when it is a directionnal light // Bit 1 : 1 when specular is needed // Bit 2 : 1 when normalization of the tangent space is needed static const char *vpName[] = { // no spec PPLightingDirectionnalNoSpecVPCodeBegin, PPLightingNoSpecVPCodeBegin, // specular PPLightingDirectionnalVPCodeBegin, PPLightingVPCodeBegin, // no spec PPLightingDirectionnalNoSpecVPNormalizeCodeBegin, PPLightingVPNormalizeNoSpecCodeBegin, // spec PPLightingDirectionnalVPNormalizeCodeBegin, PPLightingVPNormalizeCodeBegin, }; uint numvp = sizeof(vpName) / sizeof(const char *); nlassert(NumVp == numvp); // make sure that it is in sync with header..todo : compile time assert :) for (uint vp = 0; vp < NumVp; ++vp) { // \todo yoyo TODO_OPTIM Manage different number of pointLights // NB: never call getLightVPFragment() with normalize, because already done by PerPixel fragment before. std::string vpCode = std::string(vpName[vp]) + std::string("# ***************") // temp for debug + CRenderTrav::getLightVPFragment(CRenderTrav::MaxVPLight-1, VPLightConstantStart, (vp & 2) != 0, false) + std::string("# ***************") // temp for debug + std::string(PPLightingVPCodeEnd); #ifdef NL_DEBUG CVPParser vpParser; CVPParser::TProgram result; std::string parseOutput; if (!vpParser.parse(vpCode.c_str(), result, parseOutput)) { nlwarning(parseOutput.c_str()); nlassert(0); } #endif _VertexProgram[vp]= std::auto_ptr<CVertexProgram>(new CVertexProgram(vpCode.c_str())); } } }

virtual bool NL3D::IMeshVertexProgram::isMBRVpOk (  IDriver *  drv  )  const [inline, virtual, inherited]

Reimplemented in NL3D::CMeshVPWindTree. Definition at line 121 of file mesh_vertex_program.h. {return false;}

virtual bool NL3D::CMeshVPPerPixelLight::needTangentSpace (   )  const [inline, virtual]

Setup for gouraud lighting Todo: disabling of specular lighting with this shader Reimplemented from NL3D::IMeshVertexProgram. Definition at line 84 of file meshvp_per_pixel_light.h. { return true; }

NL3D::CMeshVPPerPixelLight::NLMISC_DECLARE_CLASS (  CMeshVPPerPixelLight   )

Setup for gouraud lighting Todo: disabling of specular lighting with this shader

void NL3D::CMeshVPPerPixelLight::serial (  NLMISC::IStream &  f  )  throw (NLMISC::EStream) [virtual]

Setup for gouraud lighting Todo: disabling of specular lighting with this shader Implements NLMISC::IStreamable. Definition at line 509 of file meshvp_per_pixel_light.cpp. { (void)f.serialVersion(0); f.serial(SpecularLighting); }

bool NL3D::CMeshVPPerPixelLight::setupForMaterial (  const CMaterial &  mat, IDriver *  drv, CScene *  scene )  [private, virtual]

Definition at line 544 of file meshvp_per_pixel_light.cpp. References _Enabled, NL3D::CRenderTrav::changeVPLightSetupMaterial(), enable(), NL3D::CScene::getRenderTrav(), NL3D::CMaterial::getShader(), NL3D::CMaterial::getShininess(), NL3D::CRenderTrav::getStrongestLightColors(), and NL3D::IDriver::setPerPixelLightingLight(). { bool enabled = (mat.getShader() == CMaterial::PerPixelLighting || mat.getShader() == CMaterial::PerPixelLightingNoSpec); if (enabled) { CRenderTrav *renderTrav= &scene->getRenderTrav(); renderTrav->changeVPLightSetupMaterial(mat, true /* exclude strongest*/); NLMISC::CRGBA pplDiffuse, pplSpecular; renderTrav->getStrongestLightColors(pplDiffuse, pplSpecular); drv->setPerPixelLightingLight(pplDiffuse, pplSpecular, mat.getShininess()); } bool change = (enabled != _Enabled); enable(enabled, drv); // enable disable the vertex program (for material that don't have the right shader) return change; }

void NL3D::CMeshVPPerPixelLight::setupForMaterial (  const CMaterial &  mat, IDriver *  drv, CScene *  scene, IVertexBufferHard *  vb )  [virtual]

Setup for gouraud lighting Todo: disabling of specular lighting with this shader Implements NL3D::IMeshVertexProgram. Definition at line 577 of file meshvp_per_pixel_light.cpp. References NL3D::IDriver::activeVertexBufferHard(), and setupForMaterial(). { if (setupForMaterial(mat, drv, scene)) // a switch from v.p enabled / disabled force to reactivate the vertex buffer. { drv->activeVertexBufferHard(vb); } }

void NL3D::CMeshVPPerPixelLight::setupForMaterial (  const CMaterial &  mat, IDriver *  drv, CScene *  scene, CVertexBuffer *  vb )  [virtual]

Setup for gouraud lighting Todo: disabling of specular lighting with this shader Implements NL3D::IMeshVertexProgram. Definition at line 564 of file meshvp_per_pixel_light.cpp. References NL3D::IDriver::activeVertexBuffer(). Referenced by setupForMaterial(). { if (setupForMaterial(mat, drv, scene)) // a switch from v.p enabled / disabled force to reactivate the vertex buffer. { drv->activeVertexBuffer(*vb); } }

virtual bool NL3D::IMeshVertexProgram::supportMeshBlockRendering (   )  const [inline, virtual, inherited]

Reimplemented in NL3D::CMeshVPWindTree. Definition at line 120 of file mesh_vertex_program.h. { return false; }

---

Friends And Related Function Documentation

friend struct CPtrInfo [friend, inherited]

Definition at line 67 of file smart_ptr.h.

---

Field Documentation

bool NL3D::CMeshVPPerPixelLight::_Enabled [private]

Definition at line 96 of file meshvp_per_pixel_light.h. Referenced by CMeshVPPerPixelLight(), enable(), and setupForMaterial().

bool NL3D::CMeshVPPerPixelLight::_IsPointLight [private]

Definition at line 97 of file meshvp_per_pixel_light.h. Referenced by begin(), and enable().

std::auto_ptr< CVertexProgram > NL3D::CMeshVPPerPixelLight::_VertexProgram [static, private]

Definition at line 44 of file meshvp_per_pixel_light.cpp.

sint NLMISC::CRefCount::crefs [mutable, inherited]

Definition at line 79 of file smart_ptr.h. Referenced by NLMISC::CRefCount::CRefCount(), NLMISC::CRefCount::getRefCount(), and NLMISC::CRefCount::~CRefCount().

CRefCount::CPtrInfo NLMISC::CRefCount::NullPtrInfo [static, inherited]

Referenced by NLMISC::CRefCount::CRefCount().

CPtrInfo* NLMISC::CRefCount::pinfo [mutable, inherited]

Definition at line 80 of file smart_ptr.h. Referenced by NLMISC::CRefCount::CRefCount(), and NLMISC::CRefCount::~CRefCount().

bool NL3D::CMeshVPPerPixelLight::SpecularLighting

true if want Specular Lighting. Definition at line 62 of file meshvp_per_pixel_light.h. Referenced by begin(), CMeshVPPerPixelLight(), and enable().

---

The documentation for this class was generated from the following files:

• meshvp_per_pixel_light.h
• meshvp_per_pixel_light.cpp

---