Home

nevrax.com

Nevrax.org News Mailing-list Documentation CVS Bugs License

Documentation                       Search   NL3D::CWaterShape Class Reference A water shape. More... #include <water_shape.h> Inheritance diagram for NL3D::CWaterShape: List of all members. Geometry setup void  setWaterPoolID (uint32 id)   all water shape that have the same weter id will share the same height map for wave propagations. More... uint32  getWaterPoolID () const void  setShape (const NLMISC::CPolygon2D &poly) const NLMISC::CPolygon2D &  getShape () const   get the polygon used by this shape, in the object space. More... void  getShapeInWorldSpace (NLMISC::CPolygon &poly) const   get the polygon this shape, in world space. More... void  setWaveHeightFactor (float f)   Set a factor that is applied to waves height when they are displayed. default is 1. More... float  getWaveHeightFactor () const   Get the factor that is applied to waves height when they are displayed. default is 1. More... void  setScreenGridSize (uint32 x, uint32 y)   set the resolution for the grid that is used for tesselation. More... void  setGridBorderSize (uint32 x, uint32 y)   set the size of borders. This is needed when water move is high, to avoid hole on the border of the screen. More... uint32  getScreenXGridSize () uint32  getScreenYGridSize () uint32  getXGridBorder () uint32  getYGridBorder () Public Methods   NLMISC_DECLARE_CLASS (CWaterShape) virtual CTransformShape *  createInstance (CScene &scene)   inherited from IShape. More... virtual bool  clip (const std::vector< CPlane > &pyramid, const CMatrix &worldMatrix)   inherited from IShape. More... virtual void  render (IDriver *drv, CTransformShape *trans, bool opaquePass)   inherited from IShape. Does nothing. A new observer was set for that. More... virtual void  getAABBox (NLMISC::CAABBox &bbox) const   inherited from IShape. More... virtual float  getNumTriangles (float distance)   inherited from ishape. More... virtual void  flushTextures (IDriver &driver)   inherited from ishape. More... void  enableLightMapping (bool enable=true)   Tells this shape that it can replace its colormap by a lightmap during the zone lighting. More... bool  isLightMappingEnabled () const Object   CWaterShape ()   ctor. More...   ~CWaterShape ()   dtor. More... void  serial (NLMISC::IStream &f) throw (NLMISC::EStream)   serial this shape. More... Texture setup void  setEnvMap (uint index, ITexture *envMap) ITexture *  getEnvMap (uint index) const ITexture *  getEnvMap (uint index) const void  setHeightMap (uint k, ITexture *hm)   Set a height map, used to generate a bumpmap (useful if supported by hardware...) NB : not to be confused with the height map used to modify the geometry, it only modify texture. More... ITexture *  getHeightMap (uint k) const ITexture *  getHeightMap (uint k) const void  setHeightMapScale (uint k, const NLMISC::CVector2f &scale) NLMISC::CVector2f  getHeightMapScale (uint k) const void  setHeightMapSpeed (uint k, const NLMISC::CVector2f &speed) NLMISC::CVector2f  getHeightMapSpeed (uint k) const void  setColorMap (ITexture *map) ITexture *  getColorMap () const ITexture *  getColorMap () const void  setColorMapMat (const NLMISC::CVector2f &column0, const NLMISC::CVector2f &column1, const NLMISC::CVector2f &pos) void  getColorMapMat (NLMISC::CVector2f &column0, NLMISC::CVector2f &column1, NLMISC::CVector2f &pos) LOD void  setTransitionRatio (float percent) float  getTransitionRatio () const access default tracks. CTrackDefaultVector *  getDefaultPos () CTrackDefaultVector *  getDefaultScale () CTrackDefaultQuat *  getDefaultRotQuat () Private Methods void  computeBBox () void  envMapUpdate () void  updateHeightMapNormalizationFactors () Static Private Methods void  initVertexProgram () void  setupVertexBuffer () Private Attributes NLMISC::CAABBox  _BBox NLMISC::CPolygon2D  _Poly uint32  _WaterPoolID NLMISC::CSmartPtr< ITexture >  _EnvMap [2] NLMISC::CSmartPtr< ITexture >  _BumpMap [2] NLMISC::CSmartPtr< ITexture >  _ColorMap NLMISC::CVector2f  _HeightMapScale [2] NLMISC::CVector2f  _HeightMapSpeed [2] NLMISC::CVector2f  _ColorMapMatColumn0 NLMISC::CVector2f  _ColorMapMatColumn1 NLMISC::CVector2f  _ColorMapMatPos CTrackDefaultVector  _DefaultPos CTrackDefaultVector  _DefaultScale CTrackDefaultQuat  _DefaultRotQuat float  _TransitionRatio float  _WaveHeightFactor bool  _ComputeLightmap bool  _HeightMapTouch [2] float  _HeightMapNormalizationFactor [2] Static Private Attributes uint32  _XScreenGridSize = 40 uint32  _YScreenGridSize = 40 uint32  _MaxGridSize uint32  _XGridBorder = 4 uint32  _YGridBorder = 4 CVertexBuffer  _VB std::vector< uint32 >  _IBUpDown std::vector< uint32 >  _IBDownUp bool  _GridSizeTouched = true std::auto_ptr< CVertexProgram >  _VertexProgramBump1 std::auto_ptr< CVertexProgram >  _VertexProgramBump2 std::auto_ptr< CVertexProgram >  _VertexProgramBump1Diffuse std::auto_ptr< CVertexProgram >  _VertexProgramBump2Diffuse std::auto_ptr< CVertexProgram >  _VertexProgramNoBump std::auto_ptr< CVertexProgram >  _VertexProgramNoBumpDiffuse Friends class  CWaterModel class  CWaterRenderObs Detailed Description A water shape. On recent gfx boards with 4 texture stages, it uses the following : -A environment map computed from the hemisphere that is above the water. -A bump map used to perturbate the envmap (bump map 1). -A bump map used to perturbate the bump map 1 (bump map 0). This simulate local water motion -A color map whose both alpha and rgb are modulated with the envmap to get transparency and color of the water. These maps can be scaled, but not rotated. The bump maps can scroll at regular speed over time The envmap, when set to a CTextureBlend, will automatically blend for all shape when CWaterPoolManager::setBlend is called. This may be used to simulate a night / day transition. The color / alpha map may have arbritrary orientation over the surface Author: Nicolas Vizerie , Nevrax France Date: 2001 Definition at line 79 of file water_shape.h. Constructor & Destructor Documentation NL3D::CWaterShape::CWaterShape (    )    ctor. Definition at line 218 of file water_shape.cpp. References _ColorMapMatColumn0, _ColorMapMatColumn1, _ColorMapMatPos, _DefaultPos, _DefaultRotQuat, _DefaultScale, _HeightMapScale, _HeightMapSpeed, _HeightMapTouch, NLMISC::CVector::Null, and NLMISC::CVector2f::set. NL3D::CWaterShape::~CWaterShape (    )    dtor. Definition at line 237 of file water_shape.cpp. References _EnvMap, and NL3D::GetWaterPoolManager. Member Function Documentation bool NL3D::CWaterShape::clip (  const std::vector< CPlane > &    pyramid, const CMatrix &    worldMatrix )  [virtual]   inherited from IShape. Reimplemented from NL3D::IShape. Definition at line 493 of file water_shape.cpp. References _BBox, and NLMISC::CAABBox::clipBack. void NL3D::CWaterShape::computeBBox (    )  [private]   Definition at line 396 of file water_shape.cpp. References _BBox, _Poly, NLMISC::CVector2f::maxof, min, NLMISC::CVector2f::minof, nlassert, NLMISC::CAABBox::setMinMax, NLMISC::CPolygon2D::Vertices, NLMISC::CVector2f::x, and NLMISC::CVector2f::y. Referenced by setShape. CTransformShape * NL3D::CWaterShape::createInstance (  CScene &    scene )  [virtual]   inherited from IShape. Reimplemented from NL3D::IShape. Definition at line 324 of file water_shape.cpp. References _DefaultPos, _DefaultRotQuat, _DefaultScale, NL3D::CAnimatedValueQuat, NL3D::CAnimatedValueVector, CWaterModel, and NL3D::WaterModelClassId. void NL3D::CWaterShape::enableLightMapping (  bool    enable = true )  [inline]   Tells this shape that it can replace its colormap by a lightmap during the zone lighting. Definition at line 196 of file water_shape.h. void NL3D::CWaterShape::envMapUpdate (    )  [private]   Definition at line 554 of file water_shape.cpp. References _EnvMap, and NL3D::GetWaterPoolManager. void NL3D::CWaterShape::flushTextures (  IDriver &    driver )  [virtual]   inherited from ishape. Implements NL3D::IShape. Definition at line 346 of file water_shape.cpp. References _BumpMap, _ColorMap, and _EnvMap. virtual void NL3D::CWaterShape::getAABBox (  NLMISC::CAABBox &    bbox )  const [inline, virtual]   inherited from IShape. Reimplemented from NL3D::IShape. Definition at line 108 of file water_shape.h. References _BBox. const ITexture* NL3D::CWaterShape::getColorMap (    )  const [inline]   Definition at line 173 of file water_shape.h. References _ColorMap. ITexture* NL3D::CWaterShape::getColorMap (    )  [inline]   Definition at line 172 of file water_shape.h. References _ColorMap. void NL3D::CWaterShape::getColorMapMat (  NLMISC::CVector2f &    column0, NLMISC::CVector2f &    column1, NLMISC::CVector2f &    pos )    Definition at line 545 of file water_shape.cpp. References _ColorMapMatColumn0, _ColorMapMatColumn1, and _ColorMapMatPos. CTrackDefaultVector* NL3D::CWaterShape::getDefaultPos (    )  [inline]   Definition at line 187 of file water_shape.h. References _DefaultPos. CTrackDefaultQuat* NL3D::CWaterShape::getDefaultRotQuat (    )  [inline]   Definition at line 189 of file water_shape.h. References _DefaultRotQuat. CTrackDefaultVector* NL3D::CWaterShape::getDefaultScale (    )  [inline]   Definition at line 188 of file water_shape.h. References _DefaultScale. const ITexture* NL3D::CWaterShape::getEnvMap (  uint    index )  const [inline]   Definition at line 155 of file water_shape.h. References _EnvMap, index, and nlassert. ITexture* NL3D::CWaterShape::getEnvMap (  uint    index )  [inline]   Definition at line 154 of file water_shape.h. References _EnvMap, index, and nlassert. const ITexture * NL3D::CWaterShape::getHeightMap (  uint    k )  const   Definition at line 435 of file water_shape.cpp. References _BumpMap, and nlassert. ITexture * NL3D::CWaterShape::getHeightMap (  uint    k )    Definition at line 427 of file water_shape.cpp. References _BumpMap, and nlassert. NLMISC::CVector2f NL3D::CWaterShape::getHeightMapScale (  uint    k )  const   Definition at line 512 of file water_shape.cpp. References _HeightMapScale, and nlassert. NLMISC::CVector2f NL3D::CWaterShape::getHeightMapSpeed (  uint    k )  const   Definition at line 528 of file water_shape.cpp. References _HeightMapSpeed, and nlassert. float NL3D::CWaterShape::getNumTriangles (  float    distance )  [virtual]   inherited from ishape. Implements NL3D::IShape. Definition at line 338 of file water_shape.cpp. uint32 NL3D::CWaterShape::getScreenXGridSize (    )  [inline, static]   Definition at line 126 of file water_shape.h. References _XScreenGridSize. uint32 NL3D::CWaterShape::getScreenYGridSize (    )  [inline, static]   Definition at line 127 of file water_shape.h. References _YScreenGridSize. const NLMISC::CPolygon2D& NL3D::CWaterShape::getShape (  void    )  const [inline]   get the polygon used by this shape, in the object space. Definition at line 136 of file water_shape.h. References _Poly. void NL3D::CWaterShape::getShapeInWorldSpace (  NLMISC::CPolygon &    poly )  const   get the polygon this shape, in world space. Definition at line 595 of file water_shape.cpp. References _DefaultPos, _DefaultRotQuat, _DefaultScale, _Poly, NL3D::CAnimatedValueQuat, NL3D::CAnimatedValueVector, NLMISC::CMatrix::identity, NLMISC::CMatrix::rotate, NLMISC::CMatrix::scale, NLMISC::CMatrix::translate, NLMISC::CPolygon2D::Vertices, and NLMISC::CPolygon::Vertices. float NL3D::CWaterShape::getTransitionRatio (    )  const [inline]   Definition at line 182 of file water_shape.h. References _TransitionRatio. uint32 NL3D::CWaterShape::getWaterPoolID (    )  const [inline]   Definition at line 121 of file water_shape.h. References _WaterPoolID. float NL3D::CWaterShape::getWaveHeightFactor (    )  const [inline]   Get the factor that is applied to waves height when they are displayed. default is 1. Definition at line 145 of file water_shape.h. References _WaveHeightFactor. uint32 NL3D::CWaterShape::getXGridBorder (    )  [inline, static]   Definition at line 128 of file water_shape.h. References _XGridBorder. uint32 NL3D::CWaterShape::getYGridBorder (    )  [inline, static]   Definition at line 129 of file water_shape.h. References _YGridBorder. void NL3D::CWaterShape::initVertexProgram (    )  [static, private]   Definition at line 250 of file water_shape.cpp. References _VertexProgramBump1, _VertexProgramBump1Diffuse, _VertexProgramBump2, _VertexProgramBump2Diffuse, _VertexProgramNoBump, _VertexProgramNoBumpDiffuse, and NL3D::BuildWaterVP. bool NL3D::CWaterShape::isLightMappingEnabled (    )  const [inline]   Definition at line 197 of file water_shape.h. References _ComputeLightmap. NL3D::CWaterShape::NLMISC_DECLARE_CLASS (  CWaterShape    )  virtual void NL3D::CWaterShape::render (  IDriver *    drv, CTransformShape *    trans, bool    opaquePass )  [inline, virtual]   inherited from IShape. Does nothing. A new observer was set for that. Implements NL3D::IShape. Definition at line 105 of file water_shape.h. void NL3D::CWaterShape::serial (  NLMISC::IStream &    f )  throw (NLMISC::EStream) [virtual]   serial this shape. Implements NLMISC::IStreamable. Definition at line 443 of file water_shape.cpp. void NL3D::CWaterShape::setColorMap (  ITexture *    map )    Definition at line 579 of file water_shape.cpp. References _ColorMap. void NL3D::CWaterShape::setColorMapMat (  const NLMISC::CVector2f &    column0, const NLMISC::CVector2f &    column1, const NLMISC::CVector2f &    pos )    Definition at line 536 of file water_shape.cpp. References _ColorMapMatColumn0, _ColorMapMatColumn1, and _ColorMapMatPos. void NL3D::CWaterShape::setEnvMap (  uint    index, ITexture *    envMap )    Definition at line 587 of file water_shape.cpp. References _EnvMap, index, and nlassert. void NL3D::CWaterShape::setGridBorderSize (  uint32    x, uint32    y )  [static]   set the size of borders. This is needed when water move is high, to avoid hole on the border of the screen. Definition at line 378 of file water_shape.cpp. References _GridSizeTouched, _XGridBorder, _YGridBorder, x, and y. void NL3D::CWaterShape::setHeightMap (  uint    k, ITexture *    hm )    Set a height map, used to generate a bumpmap (useful if supported by hardware...) NB : not to be confused with the height map used to modify the geometry, it only modify texture. Definition at line 413 of file water_shape.cpp. References _BumpMap, _HeightMapTouch, and nlassert. void NL3D::CWaterShape::setHeightMapScale (  uint    k, const NLMISC::CVector2f &    scale )    Definition at line 504 of file water_shape.cpp. References _HeightMapScale, and nlassert. void NL3D::CWaterShape::setHeightMapSpeed (  uint    k, const NLMISC::CVector2f &    speed )    Definition at line 520 of file water_shape.cpp. References _HeightMapSpeed, and nlassert. void NL3D::CWaterShape::setScreenGridSize (  uint32    x, uint32    y )  [static]   set the resolution for the grid that is used for tesselation. Definition at line 368 of file water_shape.cpp. References _GridSizeTouched, _XScreenGridSize, _YScreenGridSize, nlassert, x, and y. void NL3D::CWaterShape::setShape (  const NLMISC::CPolygon2D &    poly )    Definition at line 387 of file water_shape.cpp. References _Poly, computeBBox, nlassert, and NLMISC::CPolygon2D::Vertices. void NL3D::CWaterShape::setTransitionRatio (  float    percent )  [inline]   Definition at line 181 of file water_shape.h. References _TransitionRatio. void NL3D::CWaterShape::setupVertexBuffer (    )  [static, private]   Definition at line 271 of file water_shape.cpp. References _GridSizeTouched, _IBDownUp, _IBUpDown, _MaxGridSize, _VB, _XGridBorder, _XScreenGridSize, _YScreenGridSize, w, NL3D::WATER_VB_DX, NL3D::WATER_VB_POS, and x. void NL3D::CWaterShape::setWaterPoolID (  uint32    id )  [inline]   all water shape that have the same weter id will share the same height map for wave propagations. Definition at line 120 of file water_shape.h. References _WaterPoolID, and id. void NL3D::CWaterShape::setWaveHeightFactor (  float    f )  [inline]   Set a factor that is applied to waves height when they are displayed. default is 1. Definition at line 142 of file water_shape.h. References _WaveHeightFactor. void NL3D::CWaterShape::updateHeightMapNormalizationFactors (    )  [private]   Definition at line 613 of file water_shape.cpp. References _BumpMap, _HeightMapNormalizationFactor, and _HeightMapTouch. Friends And Related Function Documentation friend class CWaterModel [friend]   Definition at line 200 of file water_shape.h. Referenced by createInstance. friend class CWaterRenderObs [friend]   Definition at line 201 of file water_shape.h. Member Data Documentation NLMISC::CAABBox NL3D::CWaterShape::_BBox [private]   Definition at line 208 of file water_shape.h. Referenced by clip, computeBBox, and getAABBox. NLMISC::CSmartPtr<ITexture> NL3D::CWaterShape::_BumpMap[2] [private]   Definition at line 212 of file water_shape.h. Referenced by flushTextures, getHeightMap, setHeightMap, and updateHeightMapNormalizationFactors. NLMISC::CSmartPtr<ITexture> NL3D::CWaterShape::_ColorMap [private]   Definition at line 213 of file water_shape.h. Referenced by flushTextures, getColorMap, and setColorMap. NLMISC::CVector2f NL3D::CWaterShape::_ColorMapMatColumn0 [private]   Definition at line 217 of file water_shape.h. Referenced by CWaterShape, getColorMapMat, and setColorMapMat. NLMISC::CVector2f NL3D::CWaterShape::_ColorMapMatColumn1 [private]   Definition at line 217 of file water_shape.h. Referenced by CWaterShape, getColorMapMat, and setColorMapMat. NLMISC::CVector2f NL3D::CWaterShape::_ColorMapMatPos [private]   Definition at line 217 of file water_shape.h. Referenced by CWaterShape, getColorMapMat, and setColorMapMat. bool NL3D::CWaterShape::_ComputeLightmap [private]   Definition at line 224 of file water_shape.h. Referenced by isLightMappingEnabled. CTrackDefaultVector NL3D::CWaterShape::_DefaultPos [private]   Definition at line 219 of file water_shape.h. Referenced by createInstance, CWaterShape, getDefaultPos, and getShapeInWorldSpace. CTrackDefaultQuat NL3D::CWaterShape::_DefaultRotQuat [private]   Definition at line 221 of file water_shape.h. Referenced by createInstance, CWaterShape, getDefaultRotQuat, and getShapeInWorldSpace. CTrackDefaultVector NL3D::CWaterShape::_DefaultScale [private]   Definition at line 220 of file water_shape.h. Referenced by createInstance, CWaterShape, getDefaultScale, and getShapeInWorldSpace. NLMISC::CSmartPtr<ITexture> NL3D::CWaterShape::_EnvMap[2] [private]   Definition at line 211 of file water_shape.h. Referenced by envMapUpdate, flushTextures, getEnvMap, setEnvMap, and ~CWaterShape. bool NL3D::CWaterShape::_GridSizeTouched = true [static, private]   Definition at line 177 of file water_shape.cpp. Referenced by setGridBorderSize, setScreenGridSize, and setupVertexBuffer. float NL3D::CWaterShape::_HeightMapNormalizationFactor[2] [private]   Definition at line 226 of file water_shape.h. Referenced by updateHeightMapNormalizationFactors. NLMISC::CVector2f NL3D::CWaterShape::_HeightMapScale[2] [private]   Definition at line 215 of file water_shape.h. Referenced by CWaterShape, getHeightMapScale, and setHeightMapScale. NLMISC::CVector2f NL3D::CWaterShape::_HeightMapSpeed[2] [private]   Definition at line 216 of file water_shape.h. Referenced by CWaterShape, getHeightMapSpeed, and setHeightMapSpeed. bool NL3D::CWaterShape::_HeightMapTouch[2] [private]   Definition at line 225 of file water_shape.h. Referenced by CWaterShape, setHeightMap, and updateHeightMapNormalizationFactors. std::vector< uint32 > NL3D::CWaterShape::_IBDownUp [static, private]   Definition at line 175 of file water_shape.cpp. Referenced by setupVertexBuffer. std::vector< uint32 > NL3D::CWaterShape::_IBUpDown [static, private]   Definition at line 174 of file water_shape.cpp. Referenced by setupVertexBuffer. uint32 NL3D::CWaterShape::_MaxGridSize [static, private]   Definition at line 172 of file water_shape.cpp. Referenced by setupVertexBuffer. NLMISC::CPolygon2D NL3D::CWaterShape::_Poly [private]   Definition at line 209 of file water_shape.h. Referenced by computeBBox, getShape, getShapeInWorldSpace, and setShape. float NL3D::CWaterShape::_TransitionRatio [private]   Definition at line 222 of file water_shape.h. Referenced by getTransitionRatio, and setTransitionRatio. CVertexBuffer NL3D::CWaterShape::_VB [static, private]   Definition at line 173 of file water_shape.cpp. Referenced by setupVertexBuffer. std::auto_ptr< CVertexProgram > NL3D::CWaterShape::_VertexProgramBump1 [static, private]   Definition at line 178 of file water_shape.cpp. Referenced by initVertexProgram. std::auto_ptr< CVertexProgram > NL3D::CWaterShape::_VertexProgramBump1Diffuse [static, private]   Definition at line 180 of file water_shape.cpp. Referenced by initVertexProgram. std::auto_ptr< CVertexProgram > NL3D::CWaterShape::_VertexProgramBump2 [static, private]   Definition at line 179 of file water_shape.cpp. Referenced by initVertexProgram. std::auto_ptr< CVertexProgram > NL3D::CWaterShape::_VertexProgramBump2Diffuse [static, private]   Definition at line 181 of file water_shape.cpp. Referenced by initVertexProgram. std::auto_ptr< CVertexProgram > NL3D::CWaterShape::_VertexProgramNoBump [static, private]   Definition at line 182 of file water_shape.cpp. Referenced by initVertexProgram. std::auto_ptr< CVertexProgram > NL3D::CWaterShape::_VertexProgramNoBumpDiffuse [static, private]   Definition at line 183 of file water_shape.cpp. Referenced by initVertexProgram. uint32 NL3D::CWaterShape::_WaterPoolID [private]   Definition at line 210 of file water_shape.h. Referenced by getWaterPoolID, and setWaterPoolID. float NL3D::CWaterShape::_WaveHeightFactor [private]   Definition at line 223 of file water_shape.h. Referenced by getWaveHeightFactor, and setWaveHeightFactor. uint32 NL3D::CWaterShape::_XGridBorder = 4 [static, private]   Definition at line 170 of file water_shape.cpp. Referenced by getXGridBorder, setGridBorderSize, and setupVertexBuffer. uint32 NL3D::CWaterShape::_XScreenGridSize = 40 [static, private]   Definition at line 168 of file water_shape.cpp. Referenced by getScreenXGridSize, setScreenGridSize, and setupVertexBuffer. uint32 NL3D::CWaterShape::_YGridBorder = 4 [static, private]   Definition at line 171 of file water_shape.cpp. Referenced by getYGridBorder, and setGridBorderSize. uint32 NL3D::CWaterShape::_YScreenGridSize = 40 [static, private]   Definition at line 169 of file water_shape.cpp. Referenced by getScreenYGridSize, setScreenGridSize, and setupVertexBuffer. The documentation for this class was generated from the following files: water_shape.h water_shape.cpp