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/classNL3D_1_1UWaterInstance.html | 249 ++++++++++++++++++++++ 1 file changed, 249 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1UWaterInstance.html (limited to 'docs/doxygen/nel/classNL3D_1_1UWaterInstance.html') diff --git a/docs/doxygen/nel/classNL3D_1_1UWaterInstance.html b/docs/doxygen/nel/classNL3D_1_1UWaterInstance.html new file mode 100644 index 00000000..8087a930 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1UWaterInstance.html @@ -0,0 +1,249 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# 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::UWaterInstance Class Reference

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. +More... +

+#include <u_water.h> +

+

Inheritance diagram for NL3D::UWaterInstance: +

+ +NL3D::CWaterInstanceUser +NL3D::CWaterModel + +List of all members. + + + + + + + + + +

Public Methods

virtual uint32 getWaterHeightMapID () const=0
 Get the ID of the water height map attached with this surface of water. More...

virtual float getHeightFactor () const=0
 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. More...

virtual float getHeight (const NLMISC::CVector2f &pos)=0
 Get the height of the water in world space at the given location. More...

virtual float getAttenuatedHeight (const NLMISC::CVector2f &pos, const NLMISC::CVector &viewer)=0
 Get the attenuated height of the water in world space at the given location. More...

+

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.

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.

+

+ + + + +
+ + + + + + + + + + +
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.

+

+ + + + +
+ + + + + + + + + +
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.

+

+ + + + +
+ + + + + + + + + +
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.

+

The documentation for this class was generated from the following file: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1