Navigation
API > API/Plugins > API/Plugins/Water
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.
| Name | UGerstnerWaterWaves |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/GerstnerWaterWaves.h |
| Include Path | #include "GerstnerWaterWaves.h" |
Syntax
UCLASS (EditInlineNew, BlueprintType, MinimalAPI)
class UGerstnerWaterWaves : public UWaterWaves
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWaterWavesBase → UWaterWaves → UGerstnerWaterWaves
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UGerstnerWaterWaves() |
GerstnerWaterWaves.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GerstnerWaveGenerator | TObjectPtr< UGerstnerWaterWaveGeneratorBase > | GerstnerWaterWaves.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TArray< FGerstnerWave > & GetGerstnerWaves() |
GerstnerWaterWaves.h | ||
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) | GerstnerWaterWaves.h |
Overridden from UWaterWavesBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float GetMaxWaveHeight() |
Returns the maximum wave height that can be reached by those waves | GerstnerWaterWaves.h | |
virtual float GetSimpleWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height only (simple version : faster computation) | GerstnerWaterWaves.h | |
virtual float GetWaveAttenuationFactor
(
const FVector& InPosition, |
Computes the attenuation factor to apply to the raw wave perturbation. | GerstnerWaterWaves.h | |
virtual float GetWaveHeightAtPosition
(
const FVector& InPosition, |
Computes the raw wave perturbation of the water height/normal | GerstnerWaterWaves.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
GerstnerWaterWaves.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
GerstnerWaterWaves.h | ||
virtual void PostEditUndo() |
GerstnerWaterWaves.h |