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/a03956.html | 163 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 docs/doxygen/nel/a03956.html (limited to 'docs/doxygen/nel/a03956.html') diff --git a/docs/doxygen/nel/a03956.html b/docs/doxygen/nel/a03956.html new file mode 100644 index 00000000..efe0da0d --- /dev/null +++ b/docs/doxygen/nel/a03956.html @@ -0,0 +1,163 @@ + + +NeL: NL3D::UWaterHeightMapManager class Reference + + + +
+Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 
+

NL3D::UWaterHeightMapManager Class Reference

#include <u_water.h> +

+

Detailed Description

+Interface to the water height map manager. +

+ +

+Definition at line 80 of file u_water.h. + + + + + + + + + +

Static Public Member Functions

UWaterHeightMap & getWaterHeightMapFromID (uint32 ID)
 Retrieve a water heightmap from its ID. An assertion is raised if a wrong ID is provided.

void releaseBlendTextures ()
void setBlendFactor (UDriver *driver, float value)
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
UWaterHeightMap & NL3D::UWaterHeightMapManager::getWaterHeightMapFromID ( uint32  ID  )  [static]
+
+ + + + + +
+   + + +

+Retrieve a water heightmap from its ID. An assertion is raised if a wrong ID is provided. +

+ +

+Definition at line 40 of file water_user.cpp. +

+References NL3D::CWaterPoolManager::getPoolByID(), NL3D::GetWaterPoolManager(), NL3D_MEM_WATER, nlassert, and uint32. +

+

00041 {
+00042         NL3D_MEM_WATER
+00043         nlassert(GetWaterPoolManager().hasPool(ID)); // unknown pool ID!
+00044         return  GetWaterPoolManager().getPoolByID(ID);
+00045 }
+
+

+ + + + +
+ + + + + + + + + +
void NL3D::UWaterHeightMapManager::releaseBlendTextures (   )  [static]
+
+ + + + + +
+   + + +

+release blend textures from memory +

+Definition at line 57 of file water_user.cpp. +

+References NL3D::GetWaterPoolManager(), and NL3D::CWaterPoolManager::releaseBlendTextures(). +

+

00058 {
+00059         GetWaterPoolManager().releaseBlendTextures();
+00060 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::UWaterHeightMapManager::setBlendFactor ( UDriver *  driver,
float  value
)  [static]
+
+ + + + + +
+   + + +

+Blend factor for water surfaces that use CTextureBlend (day / night mgt for example) The blend factor if clamped to [0, 1] NB : when transition has finished, one should call releaseBlendTexture to eventually release textures from system memory +

+Definition at line 49 of file water_user.cpp. +

+References NLMISC::clamp(), NL3D::GetWaterPoolManager(), NL3D_MEM_WATER, NL3D::CWaterPoolManager::setBlendFactor(), and value. +

+

00050 {
+00051         NL3D_MEM_WATER
+00052         NLMISC::clamp(value, 0.f, 1.f);
+00053         GetWaterPoolManager().setBlendFactor(NLMISC::safe_cast<CDriverUser *>(drv)->getDriver(), value);
+00054 }
+
+

The documentation for this class was generated from the following files: +
Generated on Tue Mar 16 08:53:34 2004 for NeL by + +doxygen +1.3.6
+ + -- cgit v1.2.1