Navigation
API > API/Plugins > API/Plugins/Water
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UWaterWavesBase
- UWaterWaves
- UGerstnerWaterWaves
References
| Module | Water |
| Header | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/GerstnerWaterWaves.h |
| Include | #include "GerstnerWaterWaves.h" |
Syntax
UCLASS (EditInlineNew, BlueprintType, MinimalAPI)
class UGerstnerWaterWaves : public UWaterWaves
Remarks
Waves implementation based off Gerstner waves. They provide a decent look, are relatively cheap to evaluate and have the advantage of being only dependent on the time variable, which makes them perfect for online simulations.
Variables
| Type | Name | Description | |
|---|---|---|---|
     |
TObjectPtr< UGerstnerWaterWaveGeneratorBase > | GerstnerWaveGenerator | |
    |
TArray< FGerstnerWave > | GerstnerWaves | |
    |
float | MaxWaveHeight |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const TArray< FGerstnerWave > & | ||
 |
void | RecomputeWaves
(
bool bAllowBPScript |
Call RecomputeWaves whenever wave data changes, so that all cached data can be recomputed (do not call OnPostLoad... can call BP script internally) |
Overridden from UWaterWavesBase
| 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) |
   |
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 | PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | PostEditUndo () |
Called after applying a transaction to the object. |