Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Water > UGerstnerWaterWaveGeneratorBase

Light Theme

Dark Theme

UGerstnerWaterWaveGeneratorBase

Base class for the gerstner water wave generation.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGerstnerWaterWaveGeneratorBase

	UGerstnerWaterWaveGeneratorSimple
	UGerstnerWaterWaveGeneratorSpectrum

References

Module	Water
Header	/Engine/Plugins/Experimental/Water/Source/Runtime/Public/GerstnerWaterWaves.h
Include	#include "GerstnerWaterWaves.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, BlueprintType, MinimalAPI, Abstract, Blueprintable)
class UGerstnerWaterWaveGeneratorBase : public UObject

Remarks

Base class for the gerstner water wave generation. This can be overridden by either C++ classes or Blueprint classes. Simply implement GenerateGerstnerWaves (or GenerateGerstnerWaves_Implementation in C++) to return the set of waves to be used. Waves will automatically be sorted based on wave length.

Functions

		Name	Description
	void	GenerateGerstnerWaves ( TArray< FGerstnerWave >& OutWaves )
	void	GenerateGerstnerWaves_Implementation ( TArray< FGerstnerWave >& OutWaves )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss