NL3D::UWaterInstance Class Reference

#include <u_water.h>

Inheritance diagram for NL3D::UWaterInstance:

---

Detailed Description

Helps to get infos about a water model You can get this interface by using a dynamic_cast on a UInstance that is a water instance

Author:

Nicolas Vizerie

Nevrax France

Date:

2001

Definition at line 53 of file u_water.h.

Public Member Functions
virtual float	getAttenuatedHeight (const NLMISC::CVector2f &pos, const NLMISC::CVector &viewer)=0
virtual float	getHeight (const NLMISC::CVector2f &pos)=0
	Get the height of the water in world space at the given location.
virtual float	getHeightFactor () const=0
virtual uint32	getWaterHeightMapID () const=0

---

Member Function Documentation

virtual float NL3D::UWaterInstance::getAttenuatedHeight (  const NLMISC::CVector2f &  pos, const NLMISC::CVector &  viewer )  [pure virtual]

Get the attenuated height of the water in world space at the given location. You must provide the viewer position This is useful if you want to compute the position of a floating object Implemented in NL3D::CWaterModel, and NL3D::CWaterInstanceUser.

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

Get the height of the water in world space at the given location. Implemented in NL3D::CWaterModel, and NL3D::CWaterInstanceUser.

virtual float NL3D::UWaterInstance::getHeightFactor (   )  const [pure virtual]

When displaying the water height field, the value in the height field is actually multiplied by a factor to get the height in world space. This returns this factor Implemented in NL3D::CWaterModel, and NL3D::CWaterInstanceUser.

virtual uint32 NL3D::UWaterInstance::getWaterHeightMapID (   )  const [pure virtual]

Get the ID of the water height map attached with this surface of water. Once you got it, you can get an interface on it from the water height map manager. NB : a water height map is usually shared between several wtare instances Implemented in NL3D::CWaterModel, and NL3D::CWaterInstanceUser.

---

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

• u_water.h

---