Navigation
API > API/Plugins > API/Plugins/Water
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UWaterWavesBase
- UWaterWaves
- UGerstnerWaterWaves
- UWaterWavesAssetReference
References
| Module | Water |
| Header | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterWaves.h |
| Include | #include "WaterWaves.h" |
Syntax
UCLASS (EditInlineNew, BlueprintType, NotBlueprintable, Abstract)
class UWaterWavesBase : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FOnUpdateWavesData | OnUpdateWavesData |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
float | Returns the maximum wave height that can be reached by those waves | |
   |
float | GetSimpleWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height only (simple version : faster computation) |
   |
const UWaterWaves * | Return the underlying Water class type. | |
  |
UWaterWaves * | ||
   |
float | GetWaveAttenuationFactor
(
const FVector& InPosition, |
Computes the attenuation factor to apply to the raw wave perturbation. |
   |
float | GetWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height/normal |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
Typedefs
| Name | Description |
|---|---|
| FOnUpdateWavesData | Delegate called whenever the waves data is updated. |