From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a03957.html | 179 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 179 insertions(+) create mode 100644 docs/doxygen/nel/a03957.html (limited to 'docs/doxygen/nel/a03957.html') diff --git a/docs/doxygen/nel/a03957.html b/docs/doxygen/nel/a03957.html new file mode 100644 index 00000000..41a6dbb9 --- /dev/null +++ b/docs/doxygen/nel/a03957.html @@ -0,0 +1,179 @@ + + +NeL: NL3D::UWaterInstance class Reference + + + +
+Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 
+

NL3D::UWaterInstance Class Reference

#include <u_water.h> +

+

Inheritance diagram for NL3D::UWaterInstance: +

+ +NL3D::CWaterInstanceUser +NL3D::CWaterModel + +

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: +
Generated on Tue Mar 16 08:53:36 2004 for NeL by + +doxygen +1.3.6
+ + -- cgit v1.2.1