Navigation
API > API/Plugins > API/Plugins/Buoyancy
Gerstner wave implementation - self-contained copy of wave params for physics thread use. Math mirrors UGerstnerWaterWaves::GetWaveHeightAtPosition / GetSimpleWaveHeightAtPosition.
| Name | FBuoyancyGerstnerWaveData |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Buoyancy/Source/Runtime/Public/BuoyancyWaveData.h |
| Include Path | #include "BuoyancyWaveData.h" |
Syntax
struct FBuoyancyGerstnerWaveData : public FBuoyancyWaveData
Inheritance Hierarchy
- FBuoyancyWaveData → FBuoyancyGerstnerWaveData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBuoyancyGerstnerWaveData
(
const TArray< FGerstnerWave >& InWaveParams, |
BuoyancyWaveData.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MaxWaveHeightValue | float | BuoyancyWaveData.h | ||
| TargetWaveMaskDepth | float | BuoyancyWaveData.h | ||
| WaveParams | TArray< FGerstnerWave > | BuoyancyWaveData.h |
Functions
Public
Public Virtual
Overridden from FBuoyancyWaveData
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float GetMaxWaveHeight() |
BuoyancyWaveData.h | ||
virtual float GetSimpleWaveHeightAtPosition
(
const FVector& InPosition, |
Fast version: height only, no normal perturbation. | BuoyancyWaveData.h | |
virtual float GetWaveAttenuationFactor
(
const FVector& InPosition, |
Attenuation factor (0-1) based on water depth (e.g. shore dampening) | BuoyancyWaveData.h | |
virtual float GetWaveHeightAtPosition
(
const FVector& InPosition, |
Full version: height + perturbed normal. | BuoyancyWaveData.h |