Home

nevrax.com

Nevrax.org News Mailing-list Documentation CVS Bugs License

Documentation                       Search   material.h Go to the documentation of this file. /* Copyright, 2000 Nevrax Ltd. * * This file is part of NEVRAX NEL. * NEVRAX NEL is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2, or (at your option) * any later version. * NEVRAX NEL is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * You should have received a copy of the GNU General Public License * along with NEVRAX NEL; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, * MA 02111-1307, USA. */ #ifndef NL_MATERIAL_H #define NL_MATERIAL_H #include "nel/misc/types_nl.h" #include "nel/misc/smart_ptr.h" #include "nel/misc/rgba.h" #include "nel/misc/matrix.h" #include "3d/texture.h" #include "3d/shader.h" #include <memory> namespace NL3D { using NLMISC::CRefCount; using NLMISC::CRGBA; using NLMISC::CSmartPtr; using NLMISC::CRefPtr; // -------------------------------------------------- const uint32 IDRV_MAT_MAXTEXTURES = 4; const uint32 IDRV_TOUCHED_BLENDFUNC = 0x00000001; const uint32 IDRV_TOUCHED_BLEND = 0x00000002; const uint32 IDRV_TOUCHED_SHADER = 0x00000004; const uint32 IDRV_TOUCHED_ZFUNC = 0x00000008; const uint32 IDRV_TOUCHED_ZBIAS = 0x00000010; const uint32 IDRV_TOUCHED_COLOR = 0x00000020; const uint32 IDRV_TOUCHED_LIGHTING = 0x00000040; const uint32 IDRV_TOUCHED_DEFMAT = 0x00000080; const uint32 IDRV_TOUCHED_ZWRITE = 0x00000100; const uint32 IDRV_TOUCHED_DOUBLE_SIDED = 0x00000200; const uint32 IDRV_TOUCHED_LIGHTMAP = 0x00000400; const uint32 IDRV_TOUCHED_ALPHA_TEST = 0x00000800; const uint32 IDRV_TOUCHED_ALPHA_TEST_THRE = 0x00001000; // Start texture touch at 0x10000. const uint32 IDRV_TOUCHED_TEX[IDRV_MAT_MAXTEXTURES] = {0x00010000, 0x00020000, 0x00040000, 0x00080000}; const uint32 IDRV_TOUCHED_ALL = 0xFFFFFFFF; const uint32 IDRV_MAT_HIDE = 0x00000001; const uint32 IDRV_MAT_TSP = 0x00000002; const uint32 IDRV_MAT_ZWRITE = 0x00000004; const uint32 IDRV_MAT_ZLIST = 0x00000008; const uint32 IDRV_MAT_LIGHTING = 0x00000010; const uint32 IDRV_MAT_SPECULAR = 0x00000020; const uint32 IDRV_MAT_DEFMAT = 0x00000040; // NB: Deprecated, but may still exist streams. const uint32 IDRV_MAT_BLEND = 0x00000080; const uint32 IDRV_MAT_DOUBLE_SIDED = 0x00000100; const uint32 IDRV_MAT_ALPHA_TEST = 0x00000200; const uint32 IDRV_MAT_TEX_ADDR = 0x00000400; const uint32 IDRV_MAT_LIGHTED_VERTEX_COLOR = 0x00000800; const uint32 IDRV_MAT_GEN_TEX_0 = 0x00001000; const uint32 IDRV_MAT_GEN_TEX_1 = 0x00002000; const uint32 IDRV_MAT_GEN_TEX_2 = 0x00004000; const uint32 IDRV_MAT_GEN_TEX_3 = 0x00008000; const uint32 IDRV_MAT_GEN_TEX_4 = 0x00010000; const uint32 IDRV_MAT_GEN_TEX_5 = 0x00020000; const uint32 IDRV_MAT_GEN_TEX_6 = 0x00040000; const uint32 IDRV_MAT_GEN_TEX_7 = 0x00080000; const uint32 IDRV_MAT_USER_TEX_0_MAT = 0x00100000; const uint32 IDRV_MAT_USER_TEX_1_MAT = 0x00200000; const uint32 IDRV_MAT_USER_TEX_2_MAT = 0x00400000; const uint32 IDRV_MAT_USER_TEX_3_MAT = 0x00800000; const uint32 IDRV_MAT_USER_TEX_4_MAT = 0x01000000; const uint32 IDRV_MAT_USER_TEX_5_MAT = 0x02000000; const uint32 IDRV_MAT_USER_TEX_6_MAT = 0x04000000; const uint32 IDRV_MAT_USER_TEX_7_MAT = 0x08000000; const uint32 IDRV_MAT_USER_TEX_MAT_ALL = 0x0FF00000; const uint32 IDRV_MAT_USER_TEX_FIRST_BIT = 20; // *************************************************************************** /* *** IMPORTANT ******************** * *** IF YOU MODIFY THE STRUCTURE OF THIS CLASS, PLEASE INCREMENT IDriver::InterfaceVersion TO INVALIDATE OLD DRIVER DLL * ********************************** */ class CMaterial : public CRefCount { public: enum ZFunc { always=0,never,equal,notequal,less,lessequal,greater,greaterequal, zfuncCount }; enum TBlend { one=0, zero, srcalpha, invsrcalpha, srccolor, invsrccolor, blendConstantColor, blendConstantInvColor, blendConstantAlpha, blendConstantInvAlpha, blendCount }; enum TShader { Normal=0, Bump, UserColor, LightMap, Specular, Caustics, PerPixelLighting, PerPixelLightingNoSpec, Cloud, shaderCount}; // @{ enum TTexOperator { Replace=0, Modulate, Add, AddSigned, InterpolateTexture, InterpolatePrevious, InterpolateDiffuse, InterpolateConstant, EMBM }; enum TTexSource { Texture=0, Previous, Diffuse, Constant }; enum TTexOperand { SrcColor=0, InvSrcColor, SrcAlpha, InvSrcAlpha }; // @} // @{ enum TTexAddressingMode { TextureOff = 0 /* no texture */, FetchTexture, PassThrough, CullFragment, OffsetTexture, OffsetTextureScale, DependentARTexture, DependentGBTexture, DP3, DP3Texture2D, DP3CubeMap, DP3ReflectCubeMap, DP3ConstEyeReflectCubeMap, DP3DiffuseCubeMap, DP3DepthReplace, TexAddrCount }; // @} public: // @{ CMaterial(); CMaterial(const CMaterial &mat) {_Touched= 0;_Flags=0; operator=(mat);} ~CMaterial(); CMaterial &operator=(const CMaterial &mat); // @} void setShader(TShader val); TShader getShader() const {return _ShaderType;} // @{ void setTexture(uint8 stage, ITexture* ptex); ITexture* getTexture(uint8 stage) const; bool texturePresent(uint8 stage) const; // @} // @{ void setBlend(bool active); void setBlendFunc(TBlend src, TBlend dst); void setSrcBlend(TBlend val); void setDstBlend(TBlend val); bool getBlend() const { return (_Flags&IDRV_MAT_BLEND)!=0; } TBlend getSrcBlend(void) const { return(_SrcBlend); } TBlend getDstBlend(void) const { return(_DstBlend); } // @} // @{ void enableTexAddrMode(bool enable = true); bool texAddrEnabled() const; void setTexAddressingMode(uint8 stage, TTexAddressingMode mode); TTexAddressingMode getTexAddressingMode(uint8 stage); // @} // @{ void setDoubleSided(bool active); bool getDoubleSided() const { return (_Flags&IDRV_MAT_DOUBLE_SIDED)!=0; } // @} // @{ void setAlphaTest(bool active); bool getAlphaTest() const { return (_Flags&IDRV_MAT_ALPHA_TEST)!=0; } void setAlphaTestThreshold(float thre); float getAlphaTestThreshold() const { return _AlphaTestThreshold; } // @} // @{ void setZFunc(ZFunc val); void setZWrite(bool active); void setZBias(float val); ZFunc getZFunc(void) const { return(_ZFunction); } bool getZWrite(void) const{ return (_Flags&IDRV_MAT_ZWRITE)!=0; } float getZBias(void) const { return(_ZBias); } // @} // @{ void setColor(CRGBA rgba); void setLighting( bool active, CRGBA emissive=CRGBA(0,0,0), CRGBA ambient=CRGBA(0,0,0), CRGBA diffuse=CRGBA(0,0,0), CRGBA specular=CRGBA(0,0,0), float shininess= 10); void setEmissive( CRGBA emissive=CRGBA(0,0,0) ); void setAmbient( CRGBA ambient=CRGBA(0,0,0) ); void setDiffuse( CRGBA diffuse=CRGBA(0,0,0) ); void setOpacity( uint8 opa ); void setSpecular( CRGBA specular=CRGBA(0,0,0) ); void setShininess( float shininess ); void setLightedVertexColor (bool useLightedVertexColor); bool getLightedVertexColor () const; bool isLighted() const {return (_Flags&IDRV_MAT_LIGHTING)!=0;} bool isLightedVertexColor () const { return (_Flags&IDRV_MAT_LIGHTED_VERTEX_COLOR)!=0;} CRGBA getColor(void) const { return(_Color); } CRGBA getEmissive() const { return _Emissive;} CRGBA getAmbient() const { return _Ambient;} CRGBA getDiffuse() const { return _Diffuse;} uint8 getOpacity() const { return _Diffuse.A;} CRGBA getSpecular() const { return _Specular;} float getShininess() const { return _Shininess;} // @} // @{ void texEnvOpRGB(uint stage, TTexOperator ope); void texEnvArg0RGB(uint stage, TTexSource src, TTexOperand oper); void texEnvArg1RGB(uint stage, TTexSource src, TTexOperand oper); void texEnvOpAlpha(uint stage, TTexOperator ope); void texEnvArg0Alpha(uint stage, TTexSource src, TTexOperand oper); void texEnvArg1Alpha(uint stage, TTexSource src, TTexOperand oper); void texConstantColor(uint stage, CRGBA color); uint32 getTexEnvMode(uint stage); void setTexEnvMode(uint stage, uint32 packed); CRGBA getTexConstantColor(uint stage); void setTexCoordGen(uint stage, bool generate); bool getTexCoordGen(uint stage) const; // Enable a user texture matrix for the n-th stage. The initial matrix is set to identity. void enableUserTexMat(uint stage, bool enabled = true); // Test wether a user texture is enabled for the n-th stage bool isUserTexMatEnabled(uint stage) const; void setUserTexMat(uint stage, const NLMISC::CMatrix &m); const NLMISC::CMatrix &getUserTexMat(uint stage) const; void decompUserTexMat(uint stage, float &uTrans, float &vTrans, float &wRot, float &uScale, float &vScale); // @} // @{ void setUserColor(CRGBA userColor); CRGBA getUserColor() const; // @} // @{ void setLightMap(uint lmapId, ITexture *lmap); ITexture *getLightMap(uint lmapId) const; void setLightMapFactor(uint lmapId, CRGBA factor); // @} // @{ void initUnlit(); void initLighted(); // @} // \todo mb Clean this flag bool getStainedGlassWindow() { return _StainedGlassWindow; } void setStainedGlassWindow(bool val) { _StainedGlassWindow = val; } void flushTextures (IDriver &driver); void serial(NLMISC::IStream &f); // \name Multiple texture set managment // @{ void selectTextureSet(uint index); // @} // ********************************** // Private part. public: // Private. For Driver only. struct CTexEnv { union { uint32 EnvPacked; struct { uint32 OpRGB:4; uint32 SrcArg0RGB:2; uint32 OpArg0RGB:2; uint32 SrcArg1RGB:2; uint32 OpArg1RGB:2; uint32 OpAlpha:4; uint32 SrcArg0Alpha:2; uint32 OpArg0Alpha:2; uint32 SrcArg1Alpha:2; uint32 OpArg1Alpha:2; } Env; }; CRGBA ConstantColor; void setDefault() { // Don't worry, Visual optimize it quite well... // We cannot do better, because bit fields ordeinrg seems not to be standardized, so we can not // set Packed directly. Env.OpRGB= Modulate; Env.SrcArg0RGB= Texture; Env.OpArg0RGB= SrcColor; Env.SrcArg1RGB= Previous; Env.OpArg1RGB= SrcColor; Env.OpAlpha= Modulate; Env.SrcArg0Alpha= Texture; Env.OpArg0Alpha= SrcAlpha; Env.SrcArg1Alpha= Previous; Env.OpArg1Alpha= SrcAlpha; ConstantColor.set(255,255,255,255); } void serial(NLMISC::IStream &f) { Env.OpRGB= f.serialBitField8(Env.OpRGB); Env.SrcArg0RGB= f.serialBitField8(Env.SrcArg0RGB); Env.OpArg0RGB= f.serialBitField8(Env.OpArg0RGB); Env.SrcArg1RGB= f.serialBitField8(Env.SrcArg1RGB); Env.OpArg1RGB= f.serialBitField8(Env.OpArg1RGB); Env.OpAlpha= f.serialBitField8(Env.OpAlpha); Env.SrcArg0Alpha= f.serialBitField8(Env.SrcArg0Alpha); Env.OpArg0Alpha= f.serialBitField8(Env.OpArg0Alpha); Env.SrcArg1Alpha= f.serialBitField8(Env.SrcArg1Alpha); Env.OpArg1Alpha= f.serialBitField8(Env.OpArg1Alpha); f.serial(ConstantColor); } CTexEnv() { setDefault(); } }; private: TShader _ShaderType; uint32 _Flags; TBlend _SrcBlend,_DstBlend; ZFunc _ZFunction; float _ZBias; CRGBA _Color; CRGBA _Emissive, _Ambient, _Diffuse, _Specular; float _Shininess; float _AlphaTestThreshold; uint32 _Touched; bool _StainedGlassWindow; // \todo mb : clean this flag (add a CMaterialBuil class) struct CUserTexMat { NLMISC::CMatrix TexMat[IDRV_MAT_MAXTEXTURES]; }; std::auto_ptr<CUserTexMat> _TexUserMat; // user texture matrix CSmartPtr<ITexture> _Textures[IDRV_MAT_MAXTEXTURES]; public: // Private. For Driver only. uint8 _TexAddrMode[IDRV_MAT_MAXTEXTURES]; // texture addressing enum packed as bytes CTexEnv _TexEnvs[IDRV_MAT_MAXTEXTURES]; CRefPtr<IShader> pShader; // Private. For Driver only. LightMaps. struct CLightMap { CSmartPtr<ITexture> Texture; CRGBA Factor; CLightMap() { Factor.set(255, 255, 255, 255); } void serial(NLMISC::IStream &f); }; typedef std::vector<CLightMap> TTexturePtrs; TTexturePtrs _LightMaps; uint32 getFlags() const {return _Flags;} uint32 getTouched(void) const { return(_Touched); } void clearTouched(uint32 flag) { _Touched&=~flag; } }; } // NL3D #include "3d/driver_material_inline.h" #endif // NL_MATERIAL_H /* End of material.h */