UGerstnerWaterWaves::GetWaveAttenuationFactor

Computes the attenuation factor to apply to the raw wave perturbation.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

UWaterWavesBase::GetWaveAttenuationFactor()

UGerstnerWaterWaves::GetWaveAttenuationFactor()

References

Module

Water

Header

/Engine/Plugins/Experimental/Water/Source/Runtime/Public/GerstnerWaterWaves.h

Include

#include "GerstnerWaterWaves.h"

Source

/Engine/Plugins/Experimental/Water/Source/Runtime/Private/GerstnerWaterWaves.cpp

Syntax

virtual float GetWaveAttenuationFactor
(
    const FVector & InPosition,
    float InWaterDepth,
    float InTargetWaveMaskDepth
) const

Remarks

Computes the attenuation factor to apply to the raw wave perturbation. Attenuates : normal/wave height/max wave height. Should match the GPU version (ComputeWaveDepthAttenuationFactor)