UGerstnerWaterWaveGeneratorSimple | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/Water

Default implementation of a gerstner wave generator using a simple custom range based set of parameters to generate waves.


Name	UGerstnerWaterWaveGeneratorSimple
Type	class
Header File	/Engine/Plugins/Experimental/Water/Source/Runtime/Public/GerstnerWaterWaves.h
Include Path	#include "GerstnerWaterWaves.h"

Syntax

UCLASS (EditInlineNew, BlueprintType, MinimalAPI, NotBlueprintable)  
class UGerstnerWaterWaveGeneratorSimple : public UGerstnerWaterWaveGeneratorBase

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UGerstnerWaterWaveGeneratorBase → UGerstnerWaterWaveGeneratorSimple

Variables

Public

Name	Type	Include Path	Unreal Specifiers
AmplitudeFalloff	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, UIMax=100.0, Category="Amplitude")
DirectionAngularSpreadDeg	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(DisplayName="Direction Angular Spread", Category="Directions", UIMin=0, ClampMin=0, Units=deg)
LargeWaveSteepness	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, UIMax=1.0, Category="Steepness")
MaxAmplitude	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0.0001, ClampMin=0.0001, UIMax=1000.0, Category="Amplitude")
MaxWavelength	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, UIMax=10000.0, Category="Wavelengths")
MinAmplitude	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0.0001, ClampMin=0.0001, UIMax=1000.0, Category="Amplitude")
MinWavelength	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, UIMax=10000.0, Category="Wavelengths")
NumWaves	int32	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=1, ClampMin=1, UIMax=128, ClampMax=4096, Category="Default")
Randomness	float	GerstnerWaterWaves.h	EditDefaultsOnly BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, Category="Default")
Seed	int32	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite AdvancedDisplay Category="Default"
SmallWaveSteepness	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, UIMax=1.0, Category="Steepness")
SteepnessFalloff	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, UIMax=100.0, Category="Steepness")
WavelengthFalloff	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0, UIMax=100.0, Category="Wavelengths")
WindAngleDeg	float	GerstnerWaterWaves.h	EditAnywhere BlueprintReadWrite Meta=(DisplayName="Dominant Wind Angle", Category="Directions", UIMin=180, ClampMin=180, UIMax=180, ClampMax=180, Units=deg)

Functions

Public

Overridden from UGerstnerWaterWaveGeneratorBase

Name	Remarks	Include Path	Unreal Specifiers
virtual void GenerateGerstnerWaves_Implementation ( TArray< FGerstnerWave >& OutWaves ) const		GerstnerWaterWaves.h

Navigation

Syntax

Inheritance Hierarchy

Variables

Public

Functions

Public

Overridden from UGerstnerWaterWaveGeneratorBase