|
|
|
|
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 ReferenceHelps 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:
List of all members.
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
|
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:
|
|