# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NL3D::UWaterHeightMap Class Reference

Interface to water height maps. More...

#include <u_water.h>

Inheritance diagram for NL3D::UWaterHeightMap:

NL3D::CWaterHeightMap List of all members.

Public Methods

virtual float getUnitSize () const=0
 get the size in meter of a heightmap texel. More...

virtual void perturbate (const NLMISC::CVector2f &pos, float strenght, float radius)=0
 Apply a perturbation on this heightmap at the given location. More...

virtual void perturbatePoint (const NLMISC::CVector2f &pos, float strenght)=0
 Apply a point perturbation on this heightmap at the given location. More...

virtual float getHeight (const NLMISC::CVector2f &pos)=0
 Get the value of the height map at the given location. More...

Detailed Description

Interface to water height maps.

Definition at line 93 of file u_water.h.

Member Function Documentation

virtual float NL3D::UWaterHeightMap::getHeight (  const NLMISC::CVector2f &    pos )  [pure virtual]
 

Get the value of the height map at the given location.

To get the height in world coordinate, You should use getHeight

Implemented in NL3D::CWaterHeightMap.

virtual float NL3D::UWaterHeightMap::getUnitSize (    )  const [pure virtual]
 

get the size in meter of a heightmap texel.

Implemented in NL3D::CWaterHeightMap.

virtual void NL3D::UWaterHeightMap::perturbate (  const NLMISC::CVector2f &    pos,
float    strenght,
float    radius
)  [pure virtual]
 

Apply a perturbation on this heightmap at the given location.

Parameters:
pos, The  x and y coords of the perturbation.
strenght  Strenght of the impulsion
radius  Radius of the impulsion

Implemented in NL3D::CWaterHeightMap.

virtual void NL3D::UWaterHeightMap::perturbatePoint (  const NLMISC::CVector2f &    pos,
float    strenght
)  [pure virtual]
 

Apply a point perturbation on this heightmap at the given location.

Parameters:
pos, The  x and y coords of the perturbation.
strenght  Strenght of the impulsion

Implemented in NL3D::CWaterHeightMap.

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